Code ExchangeSearchRepository
This repository is deprecated; please follow the main search page or use the ‘Related code repos’ widget on the right side of the current page.

Challenges With Network Automation

DevNet Sandbox

All code has been tested on the Cisco DevNet Multi-IOS Cisco Test Network Sandbox HERE.

Please see the sandbox pages for credentials and reservations, virl default passwords are used on all routers (cisco/cisco). This demo example is based on Python 3.6 and was tested successfully under that version.

Code

All of the code and examples for this are located in this directory. Clone and access it with the following commands:

git clone https://github.com/bigevilbeard/challenges_with-network_automation.git
cd challenges_with-network_automation

Python Environment Setup

It is recommended that this demo be completed using Python 3.6.

It is highly recommended to leverage Python Virtual Environments for completing exercises in this course.

Follow these steps to create and activate a venv.

# OS X or Linux
virtualenv venv --python=python3.6
source venv/bin/activate

Install the code requirements

pip install -r requirements.txt

Reservation Setup

This lesson leverages a specific VIRL topology, as such virl default passwords are used on all routers (cisco/cisco). Before beginning this lesson run the following command to reconfigure the Sandbox with the proper topology.

From the challenges_with-network_automation directory

# Get a list of currently running simulations
virl ls --all


Stop any running simulations.


virl down --sim-name <Simulation name>


Start the VIRL Simulation for demo


virl up


Monitor status of simulation


virl nodes   # Node startup

Once the VIRL simulation is built, the following will be seen.

(venv) [developer@devbox challenges_with-network_automation]$virl ls
Running Simulations
╒═══════════════════════════════════════════════════╤══════════╤════════════════════════════╤═══════════╕
│ Simulation                                        │ Status   │ Launched                   │ Expires   │
╞═══════════════════════════════════════════════════╪══════════╪════════════════════════════╪═══════════╡
│ challenges_with-network_automation_default_yNccAp │ ACTIVE   │ 2019-03-04T16:19:46.778031 │           │
╘═══════════════════════════════════════════════════╧══════════╧════════════════════════════╧═══════════╛

NOTE: IP addresses will differ in your own simulation

(venv) [developer@devbox challenges_with-network_automation]$virl nodes
Here is a list of all the running nodes
╒═══════════╤══════════╤═════════╤═════════════╤════════════╤══════════════════════╤════════════════════╕
│ Node      │ Type     │ State   │ Reachable   │ Protocol   │ Management Address   │ External Address   │
╞═══════════╪══════════╪═════════╪═════════════╪════════════╪══════════════════════╪════════════════════╡
│ PE-2      │ CSR1000v │ ACTIVE  │ REACHABLE   │ telnet     │ 172.16.30.91         │ N/A                │
├───────────┼──────────┼─────────┼─────────────┼────────────┼──────────────────────┼────────────────────┤
│ PE-1      │ CSR1000v │ ACTIVE  │ REACHABLE   │ telnet     │ 172.16.30.90         │ N/A                │
├───────────┼──────────┼─────────┼─────────────┼────────────┼──────────────────────┼────────────────────┤
│ CE-1      │ CSR1000v │ ACTIVE  │ REACHABLE   │ telnet     │ 172.16.30.89         │ N/A                │
├───────────┼──────────┼─────────┼─────────────┼────────────┼──────────────────────┼────────────────────┤
│ ~mgmt-lxc │ mgmt-lxc │ ACTIVE  │ REACHABLE   │ ssh        │ 172.16.30.87         │ 172.16.30.88       │
╘═══════════╧══════════╧═════════╧═════════════╧════════════╧══════════════════════╧════════════════════╛

Running the code examples

Configuration is done using the Representational State Transfer Configuration Protocol (RESTCONF). RESTCONF is an HTTP based protocol. It provides a programmatic interface based on standard mechanisms for accessing configuration data, state data, data-model-specific Remote Procedure Call (RPC) operations and events defined in a YANG model. This code is using native YANG models for IOS-XE - models that are specific to IOS-XE platforms.

  • get_bgp.py - Passes static configuration IP Address/Port/User/Password and will get all device BGP information. Results are printed using Tabulate

  • get_interfaces.py - Passes static configuration IP Address/Port/User/Password and will get all device interface information. Results are printed using Tabulate

  • get_device.py - Passes static configuration IP Address/Port/User/Password and will get device hostname and version information. Results are printed using Tabulate

  • router_info.py - This code uses Object-Oriented Programming (OOP). This is a programming paradigm where different components of a computer program are modeled after real-world objects. An object is anything that has some characteristics and can perform a function. All args used in the running of the code are handled using CLICK. Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary.

In this code, we can show the router BGP and interface information (shown in json format). We can also add an access list to an interface with the patch and delete. As with REST, with RESTCONF we can use Methods. Methods are HTTPS operations (GET/PATCH/POST/DELETE/OPTIONS/PUT) performed on a target resource. Use either a single IP or update the JSON file with devices IP addresses.

Use the --help to see the Options and Commands

(venv) STUACLAR-M-R6EU:challenges_with-network_automation stuaclar$ python router_info.py --help
Usage: router_info.py [OPTIONS] COMMAND [ARGS]...


  Gather and Add IOS XE device information using restconf


Options:
  --ip TEXT        ip or dns address of device
  --file TEXT      file ip addresses of devices
  --port INTEGER   device port, default = 443
  --username TEXT  device username (default lab username = cisco)
  --password TEXT  device password (default lab password = cisco)
  --help           Show this message and exit.


Commands:
  add_drop        Add ACL to Interface
  delete_drop     Remove ACL from Interface
  get_bgp         Gather BGP information
  get_device      Gather Device information
  get_interfaces  Gather Interface information

Example Use Commands

  • python router_info.py --ip 172.16.30.62 get_interfaces
    python router_info.py --file routers.json get_device
(venv) STUACLAR-M-R6EU:challenges_with-network_automation stuaclar$ python router_info.py --ip  172.16.30.89 get_device
Username: cisco
Password:
Working....
{
    "Cisco-IOS-XE-native:native": {
        "device": {
            "hostname": "csr1000v",
            "version": "16.8"
        }
    }
}
Task completed

About me

Network Automation Developer Advocate for Cisco DevNet.
I'm like Hugh Hefner... minus the mansion, the exotic cars, the girls, the magazine and the money. So basically, I have a robe.

Find me here: LinkedIn / Twitter

Use Case

Configuration is done using the Representational State Transfer Configuration Protocol (RESTCONF), an HTTP based protocol. It provides a programmatic interface based on standard mechanisms for accessing configuration data, state data, data-model-specific Remote Procedure Call (RPC) operations and events defined in a YANG model. This code is using native YANG models for IOS-XE - models that are specific to IOS-XE platforms.

  • get_bgp.py - Passes static configuration IP Address/Port/User/Password and will get all device BGP information. Results are printed using Tabulate

  • get_interfaces.py - Passes static configuration IP Address/Port/User/Password and will get all device interface information. Results are printed using Tabulate

  • get_device.py - Passes static configuration IP Address/Port/User/Password and will get device hostname and version information. Results are printed using Tabulate

  • router_info.py - This code uses Object-Oriented Programming (OOP). This is a programming paradigm where different components of a computer program are modeled after real-world objects. An object is anything that has some characteristics and can perform a function. All args used in the running of the code are handled using CLICK. Click is a Python package for creating command line interfaces with minimum code.

This code shows the router BGP and interface information (shown in json format). You can also add an access list to an interface with patch and delete. RESTCONF uses Methods, similar to REST. Methods are HTTPS operations (GET, PATCH, POST, DELETE, OPTIONS, and PUT) performed on a target resource. Use either a single IP or update the JSON file with devices IP addresses.

Example Use Commands

  • python router_info.py --ip 172.16.30.62 get_interfaces
  • python router_info.py --file routers.json get_device
(venv) $ python router_info.py --ip 172.16.30.89 get_deviceUsername: ciscoPassword:Working....{    "Cisco-IOS-XE-native:native": {        "device": {            "hostname": "csr1000v",            "version": "16.8"        }    }}Task completed

Demo

View code on GitHub
Related code repos

    Code Exchange Community

    Get help, share code, and collaborate with other developers in the Code Exchange community.View Community
    Disclaimer:
    Cisco provides Code Exchange for convenience and informational purposes only, with no support of any kind. This page contains information and links from third-party websites that are governed by their own separate terms. Reference to a project or contributor on this page does not imply any affiliation with or endorsement by Cisco.