ZTP Commands
  • 10 May 2023
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

ZTP Commands

  • Dark
    Light
  • PDF

Article Summary

ZTP (Zero Touch Provisioning) CLI commands are categorized as follows:

Configuration Commands

This section includes ZTP configuration commands.

set beacon advertisment

Command Objective:
This command enables or disables the status for sending out the beacon advertisement frames.

Syntax:
set beacon advertisment {enable |disable}

Parameter Description:

  • enable - Enables the status for sending out the beacon advertisement frames.
  • disable - Disables the status for sending out the beacon advertisement frames.

Mode:
Global Configuration Mode

Default:
Enable

Example:

Your Product (config)# set beacon advertisment enable

set beacon advertisment interval

Command Objective:
This command configures the interval for sending out the beacon advertisement frames. This value ranges from 3 to 3600 (3/60/600/3600) seconds.

Syntax:
set beacon advertisment interval <integer (3-3600)>

Mode:
Global Configuration Mode

Default:
60

Example:

Your Product (config)# set beacon advertisment interval 60

set beacon discovery

Command Objective:
This command enables or disables the status for beacon discovery which decides whether the beacon packet should be processed on the interface.

Syntax:
set beacon discovery {enable|disable}

Parameter Description:

  • enable – Enables the status for beacon discovery
  • disable – Disables the status for beacon discovery

Mode:
Interface Configuration Mode

Default:
enable

Example:

Your Product (config-if)# set beacon discovery enable

set beacon domain-id-value

Command Objective:

This command configures the beacon domain-id which is used for comparing the domain id of the incoming beacon. This value is of type string with maximum size of 64.

Syntax:
set beacon domain-id-value <string(64)>

Mode:
Global Configuration Mode

Default:
default Domain

Example:

Your Product (config)# set beacon domain-id-value ztp1

set beacon domain-id-match

Command Objective:
This command enables or disables the beacon domain-id-match for matching the beacon domain-id with incoming beacon.

Syntax:
set beacon domain-id-match {enable | disable}

Parameter Description:

  • enable – Enables the beacon domain-id-match
  • disable – Disables the beacon domain-id-match

Mode:
Global Configuration Mode

Default:
Disable

Example:

Your Product (config)# set beacon domain-id-match enable

set use-beacon-rate

Command Objective:
This command enables or disables the status of the use beacon rate, where the beacon rate is present in the beacon packet should be used as interval for sending the Advertisement packet

Syntax:
set use-beacon-rate { enable | disable }

Parameter Description:
enable – Enables the status of the use beacon rate for sending advertisement packets.
disable – Disables the status of the use beacon rate for sending advertisement packets.

Mode:
Global Configuration Mode

Default:
Enable

Example:

Your Product (config)# set use-beacon-rate enable

Display Command

This section includes the ZTP display command.

show ztp globals

Command Objective:
This command displays the global configuration details of the ZTP module.

Syntax:
show ztp globals

Mode:
Privileged EXEC Mode

Example:

Your Product # show ztp globals
ZTP Global Configurations:
 Beacon Domain-ID is defaultDomain
 Beacon Domain-ID Match is disabled
 Use Beacon Rate is enabled
 Beacon Advertisment is enabled
 Beacon Advertisement Interval is 60 secs
 Beacon discovery is enabled for Interface XL-ethernet 0/1
 Beacon discovery is enabled for Interface XL-ethernet 0/2
 Beacon discovery is enabled for Interface XL-ethernet 0/3
 Beacon discovery is enabled for Interface XL-ethernet 0/4
 Beacon discovery is enabled for Interface gigabitethernet 0/1

Debug Command

This section includes the ZTP debug command.

debug ztp

Command Objective:
This command enables tracing in ZTP module as per the configured debug levels.

The no form of the command disables the tracing in ZTP module as per the configured debug levels.

Syntax:
debug ztp [level ( [fn_entry_exit] [critical] [resource] [mgmt] [info] [failure] [all])]

no debug ztp [level ( [fn_entry_exit] [critical] [resource] [mgmt] [info] [failure] [all])]

Parameter Description:

  • fn_entry_exit - Generates debug statements for the function entry exit traces.
  • critical - Generates debug statements for the critical traces.
  • resource - Generates debug statements for the OS resource related traces. This trace is generated during failure in message queues.
  • mgmt - Generates debug statements for the management traces.
  • info - Generates debug statements for the basic port information trace message.
  • failure - Generates debug statements for all kind of failure traces.
  • all - Generates debug statements for all types of traces.

Mode:
Privileged EXEC Mode

Default:
Critical

Example:

Your Product # debug ztp all

© 2024 Accedian Networks Inc. All rights reserved. Accedian®, Accedian Networks®,  the Accedian logo™, Skylight™, Skylight Interceptor™ and per-packet intel™, are trademarks or registered trademarks of Accedian Networks Inc. To view a list of Accedian trademarks visit: http://accedian.com/legal/trademarks/. 


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.