A collection of utilities for interacting with Cisco Modeling Labs (CML) v2.0+.
virl (or cml) is a devops style cli which supports the most common VIRL/CML operations. Adding new ones is easy...
Usage: cml [OPTIONS] COMMAND [ARGS]...
Options:
--debug / --no-debug Print any debugging output.
--help Show this message and exit.
Commands:
clear clear the current lab ID
cockpit opens the Cockpit UI
command send a command or config to a node (requires pyATS)
console console for node
definitions manage image and node definitions
down stop a lab
extract extract configurations from all nodes in a lab
generate generate inv file for various tools
id get the current lab title and ID
license work with product licensing
ls lists running labs and optionally those in the cache
nodes get node list for the current lab
pull pull topology.yaml from repo
rm remove a lab
save save lab to a local yaml file
search list topologies available via github
ssh ssh to a node
start start a node
stop stop a node
telnet telnet to a node
tmux console to all nodes using tmux
ui opens the Workbench for the current lab
up start a lab
use use lab launched elsewhere
version version information
wipe wipe a lab or nodes within a lab- Python 3.8+ (tested with Python 3.8, 3.9, 3.10, 3.11 and 3.12)
1.Clone this repo
git clone https://github.com/CiscoDevNet/virlutils
cd virlutils2.Either (2a) use pip, or (2b) use setup.py
2a. Use pip
pip install cmlutilsOr
pip install virlutils2b. Use setup.py
python3 -m venv venv
source venv/bin/activate
python setup.py installThere really isn't much to configure, just set your CML credentials. There are a few different ways to accomplish this, pick whichever one works best for you. The options listed below are in the preferred order.
Add a .virlrc to the working directory, this will always be checked first and is useful when you want to override one or more parameters for a particular project directory.
The contents would look something like this.
VIRL_HOST=specialvirlserver.foo.comYou can also add them as environment variables. This is useful if you want to override the global VIRL settings.
export VIRL_HOST=192.0.2.100
export VIRL_USERNAME=admin
export VIRL_PASSWORD=admin123Configure VIRL credentials globally by putting them in ~/.virlrc the formatting
VIRL_USERNAME=netadmins
VIRL_PASSWORD=cancodetoo!In addition to basic credentials, the following configuration options are supported using any of the methods mentioned previously
-
VIRL_TELNET_COMMAND- allows the user to customize the telnet command that is called. This command will be passed the host/ip information from the running simulationExample:
export VIRL_TELNET_COMMAND="mytelnet {host}"
-
VIRL_SSH_COMMAND- allows the user to customize the ssh command that is called. This command will be passed the host/ip as well as the username from the running simulationExample:
export VIRL_SSH_COMMAND="myssh {username}@{host}"
-
CML_VERIFY_CERT- The path to a PEM-encoded certificate file to use to verify the CML controller VM's SSL certificate. If you do not wish to verify the certificate, set this to "False"Example:
export CML_VERIFY_CERT=/etc/certs/ca_bundle.pem -
CML_CONSOLE_COMMAND- allows the user to customize the SSH command that is called.This command will be passed the CML controller VM IP, the console path of the node, and the CML controller username (note: you may have to force a TTY allocation in your SSH command)
Example:
export CML_CONSOLE_COMMAND="myssh {user}@{host} {console}"
-
CML_PLUGIN_PATH- A delimiter-separated list of directories in which to find cmlutils plugins. See the plugin documentation for more details. By default, thepluginsdirectory in the current.virldirectory will be searched.Example:
export CML_PLUGIN_PATH="~/cmlutils/plugins:/opt/cmlutils/plugins"
Understanding the precedence allows you to do some pretty cool things.
Assume the following directory structure...
.
├── dev
│ ├── .virlrc
│ └── topology.yaml
├── prod
│ ├── .virlrc
│ └── topology.yaml
└── test
├── .virlrc
└── topology.yaml
This allows three major benefits.
- you can easily use different credentials/servers for various environments
- you can customize your lab .yaml files to include different tags, different node configurations, etc.
- you have a badass workflow.
$ cml ls
Labs on Server
╒════════╤════════════════════════════════╤═════════════════════════╤═════════════════╤═════════╤═════════╤══════════════╕
│ ID │ Title │ Description │ Status │ Nodes │ Links │ Interfaces │
╞════════╪════════════════════════════════╪═════════════════════════╪═════════════════╪═════════╪═════════╪══════════════╡
| | | | | | | |
╘════════╧════════════════════════════════╧═════════════════════════╧═════════════════╧═════════╧═════════╧══════════════╛
$ cd ../test
$ cml ls
Labs on Server
╒════════╤════════════════════════════════╤═════════════════════════╤═════════════════╤═════════╤═════════╤══════════════╕
│ ID │ Title │ Description │ Status │ Nodes │ Links │ Interfaces │
╞════════╪════════════════════════════════╪═════════════════════════╪═════════════════╪═════════╪═════════╪══════════════╡
│ 7c2cf3 │ Small Branch Test │ │ STARTED │ 9 │ 8 │ 23 │
╘════════╧════════════════════════════════╧═════════════════════════╧═════════════════╧═════════╧═════════╧══════════════╛
$ cd ../prod
$ cml ls
Running Simulations
╒════════╤════════════════════════════════╤═════════════════════════╤═════════════════╤═════════╤═════════╤══════════════╕
│ ID │ Title │ Description │ Status │ Nodes │ Links │ Interfaces │
╞════════╪════════════════════════════════╪═════════════════════════╪═════════════════╪═════════╪═════════╪══════════════╡
│ 7c2cf3 │ Small Branch Prod │ │ STARTED │ 9 │ 8 │ 23 │
╘════════╧════════════════════════════════╧═════════════════════════╧═════════════════╧═════════╧═════════╧══════════════╛in the absence of better documentation, here's a sample workflow
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml ls
Labs on Server
╒════════╤════════════════════════════════╤═════════════════════════╤═════════════════╤═════════╤═════════╤══════════════╕
│ ID │ Title │ Description │ Status │ Nodes │ Links │ Interfaces │
╞════════╪════════════════════════════════╪═════════════════════════╪═════════════════╪═════════╪═════════╪══════════════╡
│ 02f6c6 │ CCIE Enterprise Infrastructure │ │ DEFINED_ON_CORE │ 54 │ 67 │ 216 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 332eab │ Branch Test │ │ DEFINED_ON_CORE │ 6 │ 5 │ 15 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 7c2cf3 │ Small Branch │ │ STOPPED │ 9 │ 8 │ 23 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ e5afaf │ Dynamic Split Tunnel │ │ STOPPED │ 10 │ 9 │ 36 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 66defd │ Lab at Tue 14:45 PM │ │ STOPPED │ 2 │ 1 │ 6 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ bc518e │ Lab at Wed 21:39 PM │ │ STOPPED │ 9 │ 1 │ 26 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 0e1bb2 │ DFN │ German Research Network │ DEFINED_ON_CORE │ 51 │ 80 │ 211 │
╘════════╧════════════════════════════════╧═════════════════════════╧═════════════════╧═════════╧═════════╧══════════════╛
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml id
Small Branch (ID: 7c2cf3)
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml up
Lab Small Branch (ID: 7c2cf3) is already set as the current lab
Starting lab Small Branch (ID: 7c2cf3)
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml ls
Labs on Server
╒════════╤════════════════════════════════╤═════════════════════════╤═════════════════╤═════════╤═════════╤══════════════╕
│ ID │ Title │ Description │ Status │ Nodes │ Links │ Interfaces │
╞════════╪════════════════════════════════╪═════════════════════════╪═════════════════╪═════════╪═════════╪══════════════╡
│ 02f6c6 │ CCIE Enterprise Infrastructure │ │ DEFINED_ON_CORE │ 54 │ 67 │ 216 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 332eab │ Branch Test │ │ DEFINED_ON_CORE │ 6 │ 5 │ 15 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 7c2cf3 │ Small Branch │ │ STARTED │ 9 │ 8 │ 23 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ e5afaf │ Dynamic Split Tunnel │ │ STOPPED │ 10 │ 9 │ 36 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 66defd │ Lab at Tue 14:45 PM │ │ STOPPED │ 2 │ 1 │ 6 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ bc518e │ Lab at Wed 21:39 PM │ │ STOPPED │ 9 │ 1 │ 26 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 0e1bb2 │ DFN │ German Research Network │ DEFINED_ON_CORE │ 51 │ 80 │ 211 │
╘════════╧════════════════════════════════╧═════════════════════════╧═════════════════╧═════════╧═════════╧══════════════╛
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml nodes
Here is a list of nodes in this lab
╒══════╤════════════════╤════════════════════╤═════════╤══════════╤══════════════════╕
│ ID │ Label │ Type │ State │ Wiped? │ L3 Address(es) │
╞══════╪════════════════╪════════════════════╪═════════╪══════════╪══════════════════╡
│ n0 │ branch-rtr │ csr1000v │ BOOTED │ False │ 192.168.10.219 │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n1 │ Internet │ external_connector │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n2 │ branch-sw │ iosvl2 │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n3 │ client-desktop │ desktop │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n4 │ WAN Link 1 │ wan_emulator │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n5 │ rtr-2 │ iosv │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n8 │ ext-conn-1 │ external_connector │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n6 │ trex-0 │ trex │ BOOTED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n7 │ VLAN 10 │ external_connector │ BOOTED │ False │ │
╘══════╧════════════════╧════════════════════╧═════════╧══════════╧══════════════════╛
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml console branch-rtr
[email protected]'s password:
Connecting to console for
Connected to terminalserver.
Escape character is '^]'.
branch-rtr#
branch-rtr#
branch-rtr#
branch-rtr#
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml down
Shutting down lab Small Branch (ID: 7c2cf3).....
SUCCESS
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml ls
Labs on Server
╒════════╤════════════════════════════════╤═════════════════════════╤═════════════════╤═════════╤═════════╤══════════════╕
│ ID │ Title │ Description │ Status │ Nodes │ Links │ Interfaces │
╞════════╪════════════════════════════════╪═════════════════════════╪═════════════════╪═════════╪═════════╪══════════════╡
│ 02f6c6 │ CCIE Enterprise Infrastructure │ │ DEFINED_ON_CORE │ 54 │ 67 │ 216 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 332eab │ Branch Test │ │ DEFINED_ON_CORE │ 6 │ 5 │ 15 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 7c2cf3 │ Small Branch │ │ STOPPED │ 9 │ 8 │ 23 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ e5afaf │ Dynamic Split Tunnel │ │ STOPPED │ 10 │ 9 │ 36 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 66defd │ Lab at Tue 14:45 PM │ │ STOPPED │ 2 │ 1 │ 6 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ bc518e │ Lab at Wed 21:39 PM │ │ STOPPED │ 9 │ 1 │ 26 │
├────────┼────────────────────────────────┼─────────────────────────┼─────────────────┼─────────┼─────────┼──────────────┤
│ 0e1bb2 │ DFN │ German Research Network │ DEFINED_ON_CORE │ 51 │ 80 │ 211 │
╘════════╧════════════════════════════════╧═════════════════════════╧═════════════════╧═════════╧═════════╧══════════════╛
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml use --lab-name "Small Branch"
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml nodes
Here is a list of nodes in this lab
╒══════╤════════════════╤════════════════════╤═════════╤══════════╤══════════════════╕
│ ID │ Label │ Type │ State │ Wiped? │ L3 Address(es) │
╞══════╪════════════════╪════════════════════╪═════════╪══════════╪══════════════════╡
│ n0 │ branch-rtr │ csr1000v │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n1 │ Internet │ external_connector │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n2 │ branch-sw │ iosvl2 │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n3 │ client-desktop │ desktop │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n4 │ WAN Link 1 │ wan_emulator │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n5 │ rtr-2 │ iosv │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n8 │ ext-conn-1 │ external_connector │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n6 │ trex-0 │ trex │ STOPPED │ False │ │
├──────┼────────────────┼────────────────────┼─────────┼──────────┼──────────────────┤
│ n7 │ VLAN 10 │ external_connector │ STOPPED │ False │ │
╘══════╧════════════════╧════════════════════╧═════════╧══════════╧══════════════════╛
If you are a tmux user you can console to all nodes with the following command:
❯ cml tmux --help
Usage: cml tmux [OPTIONS]
console to all nodes using tmux
Options:
--group [panes|windows] 'panes': group all nodes in one window, 'windows':
one node per window [default: panes]
--help Show this message and exit.
❯ cml nodes
Here is a list of nodes in this lab
╒══════════════════════════════════════╤════════════════════╤════════════════════╤════════════════╤═════════╤══════════╤══════════════════╕
│ ID │ Label │ Type │ Compute Node │ State │ Wiped? │ L3 Address(es) │
╞══════════════════════════════════════╪════════════════════╪════════════════════╪════════════════╪═════════╪══════════╪══════════════════╡
│ 5fdb38b6-7ff7-4792-b685-5eeaa41d8865 │ c8v-2 │ cat8000v │ cml-01 │ BOOTED │ False │ │
├──────────────────────────────────────┼────────────────────┼────────────────────┼────────────────┼─────────┼──────────┼──────────────────┤
│ 7bdedc4a-a196-4ad0-b1f3-888cf77eee8b │ c8v-1 │ cat8000v │ cml-01 │ BOOTED │ False │ │
├──────────────────────────────────────┼────────────────────┼────────────────────┼────────────────┼─────────┼──────────┼──────────────────┤
│ ab3ee63d-109d-424e-a2c0-7581a61b1d1d │ unmanaged-switch-0 │ unmanaged_switch │ cml-01 │ BOOTED │ False │ │
├──────────────────────────────────────┼────────────────────┼────────────────────┼────────────────┼─────────┼──────────┼──────────────────┤
│ 9a068ec0-0565-44a0-bf16-8e4690108ac9 │ ext-conn-0 │ external_connector │ cml-01 │ BOOTED │ False │ │
╘══════════════════════════════════════╧════════════════════╧════════════════════╧════════════════╧═════════╧══════════╧══════════════════╛This will create a new tmux session with title "lab name + first 4 lab id chars" (e.g. PPK-c93a).
By default, the nodes will be grouped into one window (cml tmux --group panes),
❯ printf '\033]2;%s\033\\' 'c8v-2'
❯ ssh -t admin@cml-01 open /PPK/c8v-2/0
admin@cml-01's password:
Connecting to console for c8v-2
Connected to CML terminalserver.
Escape character is '^]'.
c8v2#
─────────────────────────────────────────────────────────────────────────
❯ printf '\033]2;%s\033\\' 'c8v-1'
❯ ssh -t admin@cml-01 open /PPK/c8v-1/0
admin@cml-01's password:
Connecting to console for c8v-1
Connected to CML terminalserver.
Escape character is '^]'.
c8v1#
PPK-c93a >> 1 > ssh > < 20:20Note: the command
printf '\033]2;%s\033\\' 'c8v-2'is used to set the pane's title see: tmux man
if you prefer having one connection per window, use: cml tmux --group windows.
❯ ssh -t admin@cml-01 open /PPK/c8v-2/0
admin@cml-01's password:
Connecting to console for c8v-2
Connected to CML terminalserver.
Escape character is '^]'.
c8v2#
PPK-c93a >> 1 > c8v-2 >> 2 > c8v-1 > < 20:32virlutils will generate inventories for various management systems
quickly turn your simulations into a testbed file that can be used for pyATS/Genie
cml generate pyatsUsing the same pyATS framework, virlutils can execute CLI EXEC-level (e.g., "show") commands as well as configuration commands on nodes within a lab. These nodes do not have to be externally reachable or have any IP connectivity. This is a great way to test operational aspects of a completely isolated topology. Before using the command command you must install pyATS. You can install pyATS by running pip install pyats.
[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml command "branch-rtr" "show version"
Cisco IOS XE Software, Version 16.11.01b
Cisco IOS Software [Gibraltar], Virtual XE Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Version 16.11.1b, RELEASE SOFTWARE (fc2)
Technical Support: http://www.cisco.com/techsupport
...[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml command --config "branch-rtr" "snmp-server community notpublic"
quickly turn your simulations into an inventory file that can be used to run your playbooks against. Both INI and YAML(default) formats are supported by the tool.
Usage: cml generate ansible [OPTIONS]
generate ansible inventory
Options:
-o, --output TEXT output File name
--style [ini|yaml] output format (default is yaml)
--help Show this message and exit.The ansible group membership can be controlled by adding the "ansible_group" tag to nodes in your CML labs. Multiple "ansible_group" tags can be assigned to a single node, and that node will be placed into each Ansible inventory group.
nodes:
- id: n0
label: branch-rtr
node_definition: csr1000v
tags:
- ansible_group=mygroupwould result in the following inventory entry
all:
children:
mygroup:
hosts:
branch-router:
ansible_host: 192.0.2.1
NOTE: if the ansible_group tag is not specified for a node, that node will not be included during inventory generation. Additionally, CML needs to know each node's management IP address before it will be placed into the inventory file
You can add/update Network Services Orchestrator with your VIRL simulation.
Usage
Usage: cml generate nso [OPTIONS]
generate nso inventory
Options:
-o, --output TEXT just dump the payload to file without sending
--syncfrom / --no-syncfrom Perform sync-from after updating devices
--help Show this message and exit.output
Updating NSO....
Enter NSO IP/Hostname: localhost
Enter NSO username: admin
Enter NSO password:
Successfully added CML devices to NSO
NOTE: NSO environment is also attempted to be determined using the following environment variables
- NSO_HOST
- NSO_USERNAME
- NSO_PASSWORD
NSO Configuration Example
export NSO_HOST=localhost
export NSO_USERNAME=admin
export NSO_PASSWORD=admin[venv]jclarke@jamahal:~/src/git/virlutils|cmlutils
⇒ cml l<tab>
license lsYou can activate VIRL autocompletions by executing the following command
eval "$(_VIRL_COMPLETE=bash_source virl)"To do the same for the cml command, do the following
eval "$(_CML_COMPLETE=bash_source cml)"zsh users may need to run the following prior
autoload bashcompinit
bashcompinitAnd then the following to properly enable completions for zsh
eval "$(_VIRL_COMPLETE=zsh_source virl)"
eval "$(_CML_COMPLETE=zsh_source cml)"If you have an idea for a feature you would like to see, we gladly accept pull requests. To get started developing, simply run the following..
git clone https://github.com/CiscoDevNet/virlutils
cd virlutils
python setup.py developWe use flake 8 to lint our code. Please keep the repository clean by running:
flake8We have some testing implemented, but would love to have better coverage. If you
add a feature, or just feel like writing tests please update the appropriate files
in the tests folder.
To run the tests in the tests folder, you can simply run make test from
the project root.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent