DevNet Open NX-OS Sandbox

Here you will find Sample Code, Scripts and Information for use in the DevNet Open NX-OS Sandbox.

DevNet Sandboxes are all about providing an environment where developers can explore and test out whatever they are learning or working on. But sometimes having a starting point, or inspiration can be helpful, and that's what this repository is all about.

And should you develop some interesting code targeting the Sandbox and want to share with the community, we'd love to include it here!!! Just fork the repo and review our Pull Request instructions.

Repo Resources

Sandbox Management

This DevNet Sandbox leverages VIRL for building and managing the environment, however there is no need for you as the user to be familiar with VIRL to leverage the Sandbox resources.

Should you run into issues with one or more of the nodes in the sandbox, or simply wish to restart the full environment, the following scripts are available to use within the sbx-mgmt folder.

• node_console_info.py: Print the console port connection information for each node in the simulation. With this information you can telnet and connect directly to the console of each node.
• status-sbx.py: Check the status of the devices in the simulation. A status of ACTIVE indicates a node that is booted.
• restart-sbx.py: Restart an individual the nodes, or all nodes, in the simulation. The restart of the nodes takes about 2 minutes, but the Nexus 9000v's can take up to 15 minutes to fully boot. The script will provide console connection details for monitoring boot.

Using the Scripts

Before you can run the scripts, you need to install the Python module dependencies. For convenience a requirements.txt file is included in the sbx-mgmt directory.

# from the sbx_nxos directory and virtual env

pip install -r sbx-mgmt/requirements.txt 

Now you can execute the scripts like this:

Get Console Info

# from the sbx_nxos directory and virtual env
cd sbx-mgmt

python node_console_info.py

VIRL Simulation Name: API-POAP

Retrieving Console Connection Details:
    Console to csr1000v-1 -> `telnet 10.10.20.160 17012`
    Console to nx-osv9000-4 -> `telnet 10.10.20.160 17020`
    Console to nx-osv9000-1 -> `telnet 10.10.20.160 17014`
    Console to nx-osv9000-3 -> `telnet 10.10.20.160 17018`
    Console to nx-osv9000-2 -> `telnet 10.10.20.160 17016`

Get Status

# from the sbx_nxos directory and virtual env
cd sbx-mgmt

python status-sbx.py

# Sample output
VIRL Simulation Name: nxos_9k-34mbMF

~mgmt-lxc: Status ACTIVE
nx-osv9000-4: Status ACTIVE
nx-osv9000-1: Status ACTIVE
nx-osv9000-3: Status ACTIVE
nx-osv9000-2: Status ACTIVE
server-2: Status ACTIVE
server-1: Status ACTIVE

Restart Nodes

# from the sbx_nxos directory and virtual env
cd sbx-mgmt

python restart-sbx.py

VIRL Simulation Name: API-POAP

Which node would you like to restart?
  0 - csr1000v-1: Status ACTIVE
  1 - ~mgmt-lxc: Status ACTIVE
  2 - nx-osv9000-4: Status ACTIVE
  3 - nx-osv9000-1: Status ACTIVE
  4 - nx-osv9000-3: Status ACTIVE
  5 - nx-osv9000-2: Status ACTIVE
  a - Restart All Nodes
Enter 0 - 5 to choose a node, or a for all

Learning Labs

This sandbox is leveraged in different NX-OS Learning Labs. Within the learning_labs directory are different code samples used in these learning labs. Feel free to explore these samples on their own, or use the sandbox along with the Learning Labs.

Ansible Playbooks

Ansible is a great technology for Configuration Management of the network, and we've provided some sample playbooks to take a look at. Take a look at what's available here: ansible-playbooks/README.md.

NX-API REST Examples

Interested in using NX-API? Checkout samples here: nx-api/README.md

Coming Soon!!!

Standard Model Driven Programmability with YANG

Looking for details on YANG Data Models and using NETCONF, RESTCONF, or gRPC with NX-OS? Checkout samples here: yang/README.md

Coming Soon!!!

Guest Shell Use Cases

Want to run Linux utilities and apps on your Nexus devices? Checkout samples here: guestshell/README.md

Coming Soon!!!

Other Use Cases

Interested in what else is possible? Checkout ideas here: other/README.md

Coming Soon!!!