# Zero Touch Provisioning (ZTP) for IOS XE based devices 

# Introduction
When a network device like a switch or a router comes on-line, a fair amount of manual configuration has to happen before it is fully functional. At minimum, it needs to be updated to the proper software image and a golden configuration.  Day zero automation techniques automate these processes, bringing up network devices into a functional state with minimal to no-touch. Hence the name Zero touch.  The goal of ZTP is to enable you to plug in a new network device and have it configured and transitioned into production automatically without the need for manual configuration.


## Getting Started

Cisco IOS XE supports three Day Zero technologies: Network Plug-N-Play, Zero Touch Provisioning (ZTP) and Preboot eXectuion Environment (PXE).  To keep us on track with our goal we will only talk about ZTP here.

On IOS XE ZTP is supported in following ways,

 1. AutoInstall 
 
All Cisco IOS-XE (and Cisco IOS) based devices try to automatically download a configuration file during the first boot.  This is called as Autoinstall. when a IOS device boots, the AutoInstall process tries to download a the configuration via TFTP.  If a custom TFTP server is used, the configuration provided to the device can be built with information gathered from DHCP Server .

2. Python based

When a device that supports python Zero-Touch Provisioning boots up, and does not find the startup configuration (during fresh install on Day Zero), the device enters the Zero-Touch Provisioning mode. The device locates a Dynamic Host Control Protocol (DHCP) server, bootstraps itself with its interface IP address, gateway, and Domain Name System (DNS) server IP address, and enables Guest Shell. The device then obtains the IP address or URL of a TFTP server, and downloads the Python script to configure the device. Guest Shell provides the environment for the Python script to run. Guest Shell executes the downloaded Python script and configures the device for Day Zero. After Day Zero provisioning is complete, Guest Shell remains enabled.


3. Hybrid(Autoinstall+Python)

On devices that support python ZTP and AutoInstall we can enable hybrid mode. Python based ZTP will always takes priority and will trigger a python script as in option 2 above and if that fails it will fallback to AutoInstall for generic configuration(cisconet.cfg) to establish remote connectivity. 

DHCP Server Configuration for Python + AutoInstall

DHCP Option 67: “http://<http-server-ip>/ztp.py”
 
DHCP Option 150: “<tftp-server-ip>”
 
When ZTP runs, option 67 will be used to download and execute ztp.py When AutoInstall runs, option 150 will be used to download and apply “cisconet.cfg” from the TFTP server



## Prerequisites

|Platform	           |       ZTP Minimum Release	   |       XE Minimum Release
|------------------  |  :-------------------------: |-------------------------:
|Catalyst 9200	      |  16.12.1	                    |    16.9.2
|Catalyst 9300/9500	 |  16.5.1a	                    |    16.5.1a
|Catalyst 9800	      |  16.12.1	                    |    16.10.1
|ASR 1000 Fixed	     |  16.7.1	                     |   3.12.0 (1001-X) / 16.2.1 (1002-HX)
|ASR 1000 Modular	   |  16.8.2	                     |   Varies (3.x)
|Catalyst 8000	      |  17.3.2	                     |   17.3.2

2. HTTP-based download of ZTP Python script download available as of 16.8.1
3. ZTP not supported in IOS XE 16.12.4 due to defect


## Deployment

When an XE device boots and there is no config and when DHCP provides option 67 with python file this python file will be automatically downloaded to device and executed

### What the Script Does ? 

Logs ZTP process to persistent storage on the device flash for failure analysis

Expects input from user about http server address, target version to upgrade/downgrade, image name, image MD5

checks if upgrade/downgrade required and takes appropriate action

If upgrade required, transfers image from http server to device flash

Deploys an EEM script to perform upgarde steps and post upgrade(cleanup) steps

Runs the EEM script 

Pushes the entire golden config or a partial config

Notifies user of success/failure on both CLI prompt/logs 

## Usage

See the support matrix above and use this script accordingly. This script is tested across all XE versions that supports ZTP


## Support Information

•	GuestShell/ZTP needs 1.1GB free space on bootflash.  May be unable to launch GuestShell to execute ZTP if < 1.1 GB is free on bootflash.

•	Md5 checksum will fail on IOSXE V16.6 and V16.7 due to known issue , so the script will bypass that MD5 checksum on that specific versions and continue with the rest of the workflow

•	On 16.6.x and 16.7.x  ZTP If image file transfer need to happen , it *might* intermittently fail for first time and ZTP could report fail ,but an *automatic* re attempt will be done and it should be successful in the subsequent attempt.


### Support Contacts

Arun Kumar Sakthivel (arsakthi) <arsakthi@cisco.com>

Chitransh Pratyush (cpratyus) <cpratyus@cisco.com>

### Health Monitoring

Log Files from running this Python Script are enabled by default , Logging can be disabled by setting the flag log_tofile = False in the script
On IOS XE 17.2.x and above log files are stored at '/flash/guest-share/ztp.log'. In all other version logs will be located at '/flash/ztp.log'


## Contributing

TBD


## Authors

Arun Kumar Sakthivel (arsakthi@cisco.com)


## License

This project is covered under the terms described in [LICENSE](./LICENSE)

## Acknowledgments