In the spirit of pyEOS for Arista EOS devices and pyEZ for JUNOS devices, pyIOSXR is a python library to help interact with Cisco devices running IOS-XR.

To install, execute:

pip install pyIOSXR

Connect to an IOS-XR device:

>>> from pyIOSXR import IOSXR
>>> device = IOSXR(hostname='lab001', username='ejasinska', password='passwd', port=22, timeout=120)
>>> device.open()

Load a candidate configuration from a file and show the diff that is going to be applied when committing the config:

>>> device.load_candidate_config(filename='unit/test/config.txt')
>>> device.compare_config()
---
+++
@@ -704,0 +705,3 @@
+interface TenGigE0/0/0/21
+ description testing-xml-from-file
+!

If an already loaded configuration should be discarded without committing it, call discard_config():

>>> device.discard_config()
>>> device.compare_config()
>>>

If you want to commit the loaded configuration and merge it with the existing configuration, call commit_config():

>>> device.load_candidate_config(filename='unit/test/other_config.txt')
>>> device.compare_config()
---
+++
@@ -704,0 +705,3 @@
+interface TenGigE0/0/0/21
+ description testing-xml-from-the-other-file
+!
>>> device.commit_config()

If you would rather commit the config by replacing the existing configuration, call commit_replace_config():

>>> device.load_candidate_config(filename='unit/test/full_config.txt')
>>> device.compare_replace_config()
>>> device.commit_replace_config()

After a previous commit, rollback() will return to the configuration prior to the commit:

>>> device.rollback()

Any show command can be executed in the following fashion, with the command embedded into the call:

>>> device.show_bgp_summary()
...
>>> device.show_interfaces()
...

An arbitrary XML command can be executed with the command:

>>> device.make_rpc_call("<Get><Operational><LLDP><NodeTable></NodeTable></LLDP></Operational></Get>")
...

Call close() to close the connection to the device:

>>> device.close()

A special thanks to David Barroso! This library is entirely based on David's pyEOS, which is a wrapper around Arista's eAPI for EOS.

Also, many thanks go out to Brady Walsh, without whom staying sane while digging through Cisco docs and XML would have been impossible.

Copyright 2015-2016 Netflix, Inc.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0