Genie Generic Recipes
1. How to install Genie¶
Internal employee:¶
Install pyATS - Follow the information on the pyATS wiki.
Get libraries permission - Make sure to request permission to bitbucket.
If you are using a machine in the lab, source the proxy: source /auto/pyats/bin/lab_proxy.sh (.csh)
Install Genie - pip install genie
DevNet¶
Install pyATS - Follow the information on pyATS install guide.
Install Genie - pip install genie
Note
Visit Genie installation page for more information
Note
Make sure to visit :pyats:`pyAts <http>`website for all information about pyATS.
Note
It is recommended to create a virtual environment for any pyATS installation.
2. How to keep Genie up to date - How to upgrade Genie?¶
One simple command:
pip install genie --upgrade
This will give you the latest version of Genie
3. Summary of Genie Libraries and how to keep those up to date.¶
Genie is a modular package. It is divided into the following packages:
genie Main Genie package
genie.libs.conf Libraries for Configuration object
genie.libs.filetransferutils Libraries for File Transfer utils
genie.libs.ops Genie core for Operation state object
genie.libs.parser Libraries containing all the parsers
genie.libs.robot Libraries containing all Robot keywords
genie.libs.sdk Libraries containing all Triggers and Verifications
genie.telemetry Genie Core for telemetry - Monitor testbed
Each is separate pip packages which can be updated at any time with the following command:
pip install <package name> --upgrade
For example:
pip install genie.libs.robot --upgrade
pip install genie.telemetry --upgrade
4. Genie Libraries and Recording¶
Below Genie packages are Open source libraries. Ready for your contribution!
Library |
Git repository |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Recording
Watch these recordings on how to install them and start contributing!
Subject |
Link |
password |
|---|---|---|
Contribute to Genie - Getting started |
GenieTraining1 |
|
Modify existing Trigger |
GenieTraining1 |
|
Create a new Trigger |
GenieTraining1 |
|
Genie.abstraction introduction |
GenieTraining1 |
|
Create a new trigger under new abstraction package |
GenieTraining1 |
5. Set up your testbed file and connect to a device¶
Create your own Testbed file related to your device by following the pyATS guide.
devices:
nx-osv-1:
alias: 'uut'
type: 'Nexus'
os: 'nxos'
tacacs:
login_prompt: "login:"
password_prompt: "Password:"
username: "admin"
passwords:
tacacs: Cisc0123
enable: admin
line: admin
connections:
defaults:
class: 'unicon.Unicon'
cli:
protocol: telnet
ip: "172.25.192.90"
port: 17052
Here are a few important details to keep in mind:
1) The device name must match the hostname of the device, otherwise, the connection will hang.
At least one device need to have the alias ‘uut’ in the testbed yaml file.
Your testbed is now ready to be used within Genie.
from genie import testbed
testbed = testbed.load('testbed.yaml')
device = testbed.devices['nx-osv-1']
device.connect()
Note
More information on the testbed page.
Note
Genie follows the same concept as pyATS. For more information visit pyATS website.
Create a Testbed from an Excel sheet¶
You can also create a testbed yaml from an excel sheet with pyats create testbed command, here’s an example:
Here is an excel sheet containing device data:
we can turn it into a testbed yaml file by running the following command:
[genie] demo:373> pyats create testbed file --path my_devices.xls --output yaml/my_testbed.yaml
... Testbed file generated: yaml/my_testbed.yaml
This will give us the below yaml:
devices:
R1:
connections:
cli:
ip: 172.25.192.101
port: 17013
protocol: ssh
credentials:
default:
password: cisco
username: admin
enable:
password: cisco
os: iosxe
type: iosxe
R2:
connections:
cli:
ip: 172.25.192.102
port: 17015
protocol: ssh
credentials:
default:
password: cisco
username: admin
enable:
password: cisco
os: iosxr
type: iosxr
R3:
connections:
cli:
ip: 172.25.192.103
port: 17019
protocol: ssh
credentials:
default:
password: cisco
username: admin
enable:
password: cisco
os: nxos
type: nxos
For more info on creating a testbed from Excel, please read Create Testbed.
Create a Testbed from a Dictionary¶
Genie testbed also support creating a testbed directly from a dictionary without a yaml file. This feature is convenient for quick testing without complicated configurations, and it allows seamless transition from json if the device data obtained from a remote server.
The below code shows the minimum data required for a successful creation, please consult pyats create testbed for the minimum key requirement.
Note
port here is an optional key and it is separate from the ip address.
from genie.testbed import load
o = {"devices":{
"R1_xe":{
"ip":"172.25.192.104",
"port": 17005,
"protocol": "telnet",
"username": "admin",
"password": "cisco",
"os": "iosxe",
}
}}
testbed = load(o)
device=testbed.devices['R1_xe']
device.connect()
6. Extra connections!¶
There are multiple ways to connect to a device. Using Telnet, ssh, Rest, Yang, etc.
devices:
nx-osv-1:
alias: 'uut'
type: 'Nexus'
os: 'nxos'
tacacs:
login_prompt: "login:"
password_prompt: "Password:"
username: "admin"
passwords:
tacacs: Cisc0123
enable: admin
line: admin
connections:
defaults:
class: 'unicon.Unicon'
a:
protocol: telnet
ip: "172.25.192.90"
port: 17052
vty:
protocol: telnet
ip: "10.1.3.2"
To connect with these connections:
# Default to 'a'
device.connect()
device.execute('show version')
# Use Telnet
device.connect(via=vty, alias='vty')
device.vty.execute('show version')
For Genie, it needs to know which connection to use for each device.
device.mapping['cli'] = 'vty'
Note
the supported keys are: cli, xml, rest and yang.
7. Control devices’ connections!¶
If no mapping datafile provided or devices passed in the job
file/command line argument, Genie by default will connect to all the devices in
the testbed yaml file.
If user wants to control the connection method per device, this can be controlled by;
Using the mapping datafile explained here
Passing argument
devicesin the job file/command line argument, check here for detailsIn that case, each device passed in the
deviceslist argument need to either;1 - Have a single connection defined in the testbed yaml file
devices: nx-osv-1: alias: 'uut' type: 'Nexus' os: 'nxos' tacacs: login_prompt: "login:" password_prompt: "Password:" username: "admin" passwords: tacacs: Cisc0123 enable: admin line: admin connections: defaults: class: 'unicon.Unicon' vty: protocol: telnet ip: "100.100.100.100" port: 170522 - Have multiple connections defined in the testbed yaml file but at least one of them named
clidevices: nx-osv-1: alias: 'uut' type: 'Nexus' os: 'nxos' tacacs: login_prompt: "login:" password_prompt: "Password:" username: "admin" passwords: tacacs: Cisc0123 enable: admin line: admin connections: defaults: class: 'unicon.Unicon' vty: protocol: telnet ip: "100.100.100.100" port: 17052 cli: ------ > Here it is required to be named `cli` protocol: telnet ip: "172.25.192.90" port: 17052
8. Parse device output¶
Parsing a device output is as easy as just asking for it.
# Default to 'a'
device.connect()
output = device.parse('show version')
import pprint
pprint.pprint(output)
{'platform': {'hardware': {'bootflash': '3184776 kB',
'chassis': 'NX-OSv Supervisor Module',
'device_name': 'nx-osv-1',
'model': 'NX-OSv',
'processor_board_id': 'TM00010000B',
'slots': 'None'},
...
9. Learn device feature¶
Learning a whole device feature is also very easy.
# Default to 'a'
device.connect()
output = device.learn('ospf')
import pprint
pprint.pprint(output)
{
'feature_ospf': True,
'vrf': {
'default': {
'address_family': {
'ipv4': {
'instance': {
'1': {
'nsr': {
'enable': True,
},
'enable': True,
'auto_cost': {
...