Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 4.02 KB

README.md

File metadata and controls

47 lines (32 loc) · 4.02 KB
Raw

customdata-examples

This repository provides examples and scripts to help users easily write Custom Data bootstrap Day0 Configuration for CSR1000v in Azure.

The official documentation of Custom Data feature resides at: https://www.cisco.com/c/en/us/td/docs/routers/csr1000/software/azu/b_csr1000config-azure.html

The official documentation for IOS XE - Guestshell can be found at: https://www.cisco.com/c/en/us/td/docs/ios-xml/ios/prog/configuration/166/b_166_programmability_cg/guest_shell.html

Scripts

Scripts directory in this repository contains various scripts that can be provided in "Scripts" section of Customdata to achieve its purpose. List of Scripts and its purpose:

  • packetDropsReporter.py - Periodically (every 5 mins) checks the output of "show platform hardware qfp active statistics drop clear" and if finds any packet drops in cli output, writes the drop counts in ~/dropsReporterOutput/drops_report.txt.

  • smartLicensingConfigurator.py- It takes idtoken of your Cisco Smart Licensing account and Throughput level as Input. Configures Smart licensing on CSR with provided Throughput level.

  • smartLicensingConfiguratorForC8KV.py- It takes idtoken of your Cisco Smart Licensing account and Throughput level as Input. Configures Smart licensing on C8KV with provided Throughput level. Please note it is REQUIRED to configure "license boot level " on the device for this script to work.

    If you are passing this script in customdata/userdata, below is the example on how to pass via userdata section. Note that along with "Section: scripts" "Section: license" is REQUIRED

    Example:

      Section: license
  techpackage:<value>

  Section: scripts
  https://raw.githubusercontent.com/csr1000v/customdata-examples/master/scripts/smartLicensingConfiguratorForC8KV.py --idtoken <value> --throughput <value>

Examples

Examples directory in this repository contains examples of Custom Data bootstrap config files. Any of the examples in Examples dir can be used as a input to Custom Data for CSR in Azure.

  • customdata1.txt - This sample Custom Data bootstrap file provides an example of how to use following Sections - "IOS configuration", "Python package" and "Scripts". If this example bootstrap file provided as a input to Custom data for CSR in Azure, It will achieve the following on first boot up - Day 0:

      1. Configure the CSR with Configuration commands provided in section - 'IOS configuration'
      2. Run the packetDropsReporter.py script in Guestshell.
      3. Install python package ncclient's version 0.6.0. ncclient is a set of python library to write your netconf client to programmatically configure IOS XE devices. More info on ncclient, please visit https://github.com/ncclient/ncclient.

  • customdata2.txt - This sample Custom Data bootstrap file provides an example of how to use following Sections - "Scripts" and "License". If this example bootstrap file provided as a input to Custom data for CSR in Azure, It will do the following on first boot up - Day 0:

      1. Run the smartLicensingConfigurator.py script in Guestshell. This script will configure the smart licensing on CSR on Day 0 with the throughput value you provided.
      2. Configure CSR with the technology package mentioned in "license" section of Custom data

E.g., To launch a CSR with customdata1.txt as a input to Custom data for CSR in Azure use --custom-data argument.

az vm create -n <vm_name> -g <rg_name> --image cisco:cisco-csr-1000v:16_7:16.7.120171201 --custom-data customdata1.txt --data-disk-sizes-gb 8 --availability-set <av_set_name> --nics nic1 nic2 --admin-username <username> --admin-password <password> --authentication-type password -l westus --size Standard_DS4_v2