6.5. ZTP Command Reference

6.5.1. Command Hierarchies

6.5.1.1. Configuration Commands

bof
— auto-boot [management-port] [inband [vlan vlan-id]] [ipv4] [ipv6] [client-identifier {string ascii-string | hex hex-string | chassis-mac}] [include-user-class]
— no auto-boot
tools
— auto-boot {retry | terminate}
— auto-boot echo [debugger]
— no auto-boot echo [debugger]
— dump
— auto-boot [detail]
— auto-boot log
— perform
— system
— auto-node-provisioning
— file provisioning-file-url [save-provision-file-destination file-url] [reboot-on-success]

6.5.2. Configuration Commands

6.5.2.1. ZTP BOF Commands

auto-boot

Syntax 
auto-boot [management-port] [inband [vlan vlan-id]] [ipv4] [ipv6] [client-identifier {string ascii-string | hex hex-string | chassis-mac}] [include-user-class]
no auto-boot
Context 
bof
Description 

This command enables the auto-boot flag in the BOF and configures the auto-boot options for ZTP. When modifying auto-boot options using CLI, all required options must be explicitly configured as the default cases will no longer be used.

The no form of this command disables the auto-boot flag.

Default 

no auto-boot

Parameters 
management-port—
Specifies that the out-of-band management port (Mgmt port) should be used for ZTP.
inband—
Specifies that in-band management through an Ethernet port should be used for ZTP.
vlan-id—
Specifies an in-band VLAN to use for the auto-boot process.
Values—
0 to 4094

 

ipv4—
Enables IPv4 DHCP discovery. This parameter is mandatory if the ipv6 parameter is not specified.
ipv6—
Enables IPv6 DHCP solicitation. This parameter is mandatory if the ipv4 parameter is not specified.
ascii-string—
Specifies a DHCP client identification string, up to 58 ASCII characters, to be used for Option 61 (IPv4) or Option 1 (IPv6).
hex-string—
Specifies a DHCP client identification string, up to 116 hexadecimal nibbles, to be used for Option 61 (IPv4) or Option 1 (IPv6).
Values—
0x0 to 0xFFFFFFFF

 

chassis-mac—
Specifies that the chassis MAC address should be used as the DHCP client identification string for Option 61 (IPv4) or Option 1 (IPv6).
include-user-class—
Specifies that Option 77 should be included in DHCP messages.

6.5.2.2. ZTP Tools Commands

auto-boot

Syntax 
auto-boot {retry | terminate}
auto-boot echo [debugger]
no auto-boot echo [debugger]
Context 
tools
Description 

This command starts and stops the auto-boot process. It is also used to enable the display of auto-discovery information in the CLI.

This command can be used only if the auto-boot flag is enabled in the BOF.

The no form of this command disables the display of auto-discovery information.

Parameters 
retry—
Executes the auto-boot process.
terminate—
Stops an executing auto-boot process.
echo—
Enables the display of auto-discovery information in the CLI.
debugger—
Includes debugging information in the displayed auto-discovery information.

auto-boot

Syntax 
auto-boot [detail]
auto-boot log
Context 
tools>dump
Description 

This command displays auto-boot process information.

Parameters 
detail—
Displays detailed information.
log—
Saves auto-boot process information to a log file.

auto-node-provisioning

Syntax 
auto-node-provisioning
Context 
tools>perform>system
Description 

This command enables the context to configure auto-provisioning process parameters and manually execute the auto-provisioning process.

file

Syntax 
file provisioning-file-url [save-provision-file-destination file-url] [reboot-on-success]
Context 
tools>perform>system>auto-node-provisioning
Description 

This command executes the auto-provisioning process. When the auto-provisioning process is executed using the file command, DHCP discovery and solicitation is not performed.

Parameters 
provisioning-file-url—
Specifies the location of the provisioning file.
Values—
local-url, remote-url
local-url — [cflash-id/]file-path; 200 characters max
remote-url — {ftp | http | https}://[login:password@]remote-locn/[file-path]
remote-locn — {hostname | ipv4-address | ipv6-address}[:port]
ipv4-address — a.b.c.d
ipv6-address — x:x:x:x:x:x:x:x[-interface]
                          x:x:x:x:x:x:d.d.d.d[-interface]
                          x — 0 to FFFF (hexadecimal)
                          d — 0 to 255 (decimal)
port — 0 to 65535
cflash-id — cf1:m cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

file-url—
Specifies the location to save the provisioning file.
Values—
[cflash-id/]file-path
cflash-id — cf1:m cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

reboot-on-success—
Reboots the router when the auto-provisioning process completes successfully.