Skip to main content

Parse, Audit, Query, Build, and Modify Cisco IOS-style configurations

Project description

Travis CI Status Version License Downloads

Introduction: What is ciscoconfparse?

ciscoconfparse is a Python library, which parses through Cisco IOS-style (and other vendor) configurations. It can:

  • Audit existing router / switch / firewall / wlc configurations
  • Retrieve portions of the configuration
  • Modify existing configurations
  • Build new configurations

The library examines an IOS-style config and breaks it into a set of linked parent / child relationships. You can perform complex queries about these relationships.

CiscoConfParse Parent / Child relationships


These are a few selected public mentions about CiscoConfParse; I usually try not to share private emails without asking, thus the quotes aren’t long at this time.

CiscoConfParse Parent / Child relationships Twitter mentions

We don’t use Cisco

Don’t let that stop you. CiscoConfParse parses anything that has a Cisco IOS style of configuration, which includes:

  • Cisco IOS, Cisco Nexus, Cisco IOS-XR, Cisco IOS-XE, Aironet OS, Cisco ASA, Cisco CatOS
  • Arista EOS
  • Brocade
  • HP Switches
  • Force 10 Switches
  • Dell PowerConnect Switches
  • Extreme Networks
  • Enterasys

As of CiscoConfParse 1.2.4, you can parse brace-delimited configurations into a Cisco IOS style (see Github Issue #17), which means that CiscoConfParse understands these configurations too:

  • Juniper Networks Junos, and Screenos
  • F5 Networks configurations


The latest copy of the docs are archived on the web


ciscoconfparse requires Python versions 2.6, 2.7 or 3.2+; the OS should not matter. If you want to run it under a Python virtualenv, it’s been heavily tested in that environment as well.

Bug Tracker and Support

  • Please report any suggestions, bug reports, or annoyances with ciscoconfparse through the github bug tracker.
  • If you’re having problems with general python issues, consider searching for a solution on Stack Overflow. If you can’t find a solution for your problem or need more help, you can ask a question.
  • If you’re having problems with your Cisco devices, you can open a case with Cisco TAC; if you prefer crowd-sourcing, you can ask on the Stack Exchange Network Engineering site.

License and Copyright

ciscoconfparse is licensed GPLv3; Copyright David Michael Pennington, 2007-2014.

The ipaddr module is distributed with ciscoconfparse to facilitate unit tests. ipaddr uses the ASF License 2.0; ipaddr is part of the Python standard library, starting in Python 3.3 (it’s called ipaddress in Python3).

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ciscoconfparse-1.2.7.tar.gz (369.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page