If you want to hard code a script to be executed every boot, configure the following.

conf t
    ztp bootscript /disk0:/myscript
commit

The above configuration will wait for the first data-plane interface to be configured and then wait an additional minute for the management interface to be configured with an IP address, to ensure that we have connectivity in the third party namespace for applications to use. If the delay is not desired, use:

conf t
    ztp bootscript preip /disk0:/myscript
commit

Note	When the above command is first configured, you will be prompted if you wish to invoke it now. The prompt helps with testing.

ZTP includes a set of shell utilities that can be sourced within the user script. ztp_helper.sh is a shell script that can be sourced by the user script. ztp_helper.sh provides simple utilities to access some XR functionalities. Following are the bash functions that can be invoked:

• xrcmd—Used to run a single XR exec command:

  xrcmd “show running”

• xrapply—Applies the block of configuration, specified in a file:

  
  cat >/tmp/config <<%%
  !! XR config example
  hostname node1-mgmt-via-xrapply
  %%
  xrapply /tmp/config

• xrapply_with_reason—Used to apply a block of XR configuration along with a reason for logging purpose:

  
  cat >/tmp/config <<%%
  !! XR config example
  hostname node1-mgmt-via-xrapply
  %%
  xrapply_with_reason "this is a system upgrade" /tmp/config

• xrapply_string—Used to apply a block of XR configuration in one line:

  
  xrapply_string "hostname foo\ninterface GigabitEthernet0/0/0/0\nipv4 address 1.2.3.44 255.255.255.0\n"

• xrapply_string_with_reason—Used to apply a block of XR configuration in one line along with a reason for logging purposes:

  
  xrapply_string_with_reason ”system renamed again" "hostname venus\n interface TenGigE0/0/0/0\n ipv4 address 172.30.0.144/24\n”

• xrreplace—Used to apply XR configuration replace in XR namespace via a file.

  
  cat rtr.cfg <<%%
  !! XR config example
  hostname node1-mgmt-via-xrreplace
  %%
  xrreplace rtr.cfg

• admincmd—Used to run an admin CLI command in XR namespace. Logs can be found in /disk0:/ztp/ztp_admincmd.log

  
  admincmd running [show platform]
  
  ztp-user connected from 192.0168.0.1 using console on host
  sysadmin-vm:0_RP0# show platform | nomore
  Tue Jan 30 23:12:30.757 UTC
  Location Card Type HW State SW State Config State 
  ----------------------------------------------------------------------------
  0/RP0 NCS-5501 OPERATIONAL OPERATIONAL NSHUT 
  0/FT0 NCS-1RU-FAN-FW OPERATIONAL N/A NSHUT 
  0/FT1 NCS-1RU-FAN-FW OPERATIONAL N/A NSHUT 
  0/PM0 NCS-1100W-ACFW OPERATIONAL N/A NSHUT 
  0/PM1 NCS-1100W-ACFW OPERATIONAL N/A NSHUT 
  
  

• xrapply_with_extra_auth—Used to apply XR configuration that requires authentication, in XR namespace via a file. The xrapply_with_extra_auth API is used when configurations that require additional authentication to be applied such as alias, flex groups.

  
  cat >/tmp/config <<%%
  !! XR config example
  alias exec alarms show alarms brief system active
  alias exec version run cat /etc/show_version.txt
  %%
  xrapply_with_extra_auth >/tmp/config 
  
  

• xrreplace_with_extra_auth—Used to apply XR configuration replace in XR namespace via a file The xrreplace_with_extra_auth API is used when configurations that require additional authentication to be applied such as alias, flex groups

  
  cat >/tmp/config <<%%
  !! XR config example
  alias exec alarms show alarms brief system active
  alias exec version run cat /etc/show_version.txt
  %%
  xrreplace_with_extra_auth >/tmp/config 

ZTP logs its operation on the flash file system in the directory /disk0:/ztp/. ZTP logs all the transaction with the DHCP server and all the state transition. Prior executions of ZTP are also logged in /disk0:/ztp/old_logs/.

The following example displays the execution of a simple configuration script downloaded from a data interface using the command ztp initiate interface Ten 0/0/0/0 verbose , this script will unshut all the interfaces of the system and configure a load interval of 30 seconds on all of them.

#!/bin/bash
#############################################################################
# *** Be careful this is powerful and can potentially destroy your system ***
#                *** !!! Use at your own risk !!! ***
#
# Script file should be saved on the backend HTTP server
#############################################################################

source ztp_helper.sh
config_file="/tmp/config.txt"
interfaces=$(xrcmd "show interfaces brief")

function activate_all_if(){
  arInt=($(echo $interfaces | grep -oE '(Te|Fo|Hu)[0-9]*/[0-9]*/[0-9]*/[0-9]*'))
  for int in ${arInt[*]}; do
    echo -ne "interface $int\n no shutdown\n load-interval 30\n" >> $config_file
  done
  xrapply_with_reason "Initial ZTP configuration" $config_file
}

### Script entry point
if [ -f $config_file ]; then
  /bin/rm -f $config_file
else
  /bin/touch $config_file
fi
activate_all_if;
exit 0

The following example displays the ZTP logging output:

Oct 11 11:05:38 172.30.0.54 ztp-script: Hello from ncs-5001-c !!!
Oct 11 11:05:40 172.30.0.54 ztp-script: current=6.1.1, desired=6.1.1
Oct 11 11:05:40 172.30.0.54 ztp-script: Version match, proceeding to configuration
Oct 11 11:05:41 172.30.0.54 ztp-script: Starting autoprovision process...
Oct 11 11:05:42 172.30.0.54 ztp-script: ### XR K9SEC INSTALL ###
Oct 11 11:05:44 172.30.0.54 ztp-script: ### Downloading complete ###
Oct 11 11:05:55 172.30.0.54 ztp-script: Waiting for k9sec package to be activated
Oct 11 11:06:01 172.30.0.54 ztp-script: ### XR K9SEC INSTALL COMPLETE ###
Oct 11 11:06:03 172.30.0.54 ztp-script: ### Installing midnight commander ###
Oct 11 11:06:04 172.30.0.54 ztp-script: ### Downloading system configuration ###
Oct 11 11:06:05 172.30.0.54 ztp-script: ### Downloading system configuration complete ###
Oct 11 11:06:06 172.30.0.54 ztp-script: ### Applying initial system configuration ###
Oct 11 11:06:11 172.30.0.54 ztp-script: !!! Checking for errors !!!
Oct 11 11:06:14 172.30.0.54 ztp-script: ### Applying system configuration complete ###
Oct 11 11:06:15 172.30.0.54 ztp-script: Autoprovision complete...