Parse, Audit, Query, Build, and Modify Cisco IOS-style and JunOS-style configs

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mpenning from gravatar.com mpenning

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: GNU General Public License (GPL), GNU General Public License v3 (GPLv3) (GPL-3.0-only)

Author: Mike Pennington

Tags Parse, audit, query, modify, Cisco IOS, Cisco, NXOS, ASA, Juniper

Requires: Python >=3.7.2, <4.0.0

Classifiers

Project description

ciscoconfparse

Github unittest workflow Code Health git commits Repo Code Grade Version Downloads License

Introduction: What is ciscoconfparse?

Short answer: ciscoconfparse is a Python library that helps you quickly answer questions like these about your Cisco configurations:

  • What interfaces are shutdown?
  • Which interfaces are in trunk mode?
  • What address and subnet mask is assigned to each interface?
  • Which interfaces are missing a critical command?
  • Is this configuration missing a standard config line?

It can help you:

  • Audit existing router / switch / firewall / wlc configurations
  • Modify existing configurations
  • Build new configurations

Speaking generally, 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.

Cisco IOS config: Parent / child

Usage

The following code will parse a configuration stored in 'exampleswitch.conf' and select interfaces that are shutdown.

from ciscoconfparse import CiscoConfParse

parse = CiscoConfParse('exampleswitch.conf', syntax='ios')

for intf_obj in parse.find_objects_w_child('^interface', '^\s+shutdown'):
    print("Shutdown: " + intf_obj.text)

The next example will find the IP address assigned to interfaces.

from ciscoconfparse import CiscoConfParse

parse = CiscoConfParse('exampleswitch.conf', syntax='ios')

for intf_obj in parse.find_objects('^interface'):

    intf_name = intf_obj.re_match_typed('^interface\s+(\S.+?)$')

    # Search children of all interfaces for a regex match and return
    # the value matched in regex match group 1.  If there is no match,
    # return a default value: ''
    intf_ip_addr = intf_obj.re_match_iter_typed(
        r'ip\saddress\s(\d+\.\d+\.\d+\.\d+)\s', result_type=str,
        group=1, default='')
    print("{0}: {1}".format(intf_name, intf_ip_addr))

Are there private copies of CiscoConfParse()?

Yes. Cisco Systems maintains their own copy of CiscoConfParse(). The terms of the GPLv3 license allow this as long as they don't distribute their modified private copy in binary form. Also refer to this GPLv3 License primer / GPLv3 101. Officially, modified copies of CiscoConfParse source-code must also be licensed as GPLv3.

Dear Cisco Systems: please consider porting your improvements back into the github ciscoconfparse repo.

Is this a tool, or is it artwork?

That depends on who you ask. Many companies use CiscoConfParse as part of their network engineering toolbox; others regard it as a form of artwork.

What if we don't use Cisco IOS?

Don't let that stop you.

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 can parse these configurations:

  • Juniper Networks Junos
  • Palo Alto Networks Firewall configurations
  • F5 Networks configurations

CiscoConfParse also handles 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
  • Screenos

Docs

Editing the Package

  • git clone https://github.com/mpenning/ciscoconfparse
  • cd ciscoconfparse
  • git checkout -b develop
  • Add / modify / delete on the develop branch
  • make test
  • If tests run clean, git commit all the pending changes on the develop branch
  • (as required) Edit the version number in pyproject.toml
  • git checkout main
  • git merge develop
  • make test
  • make repo-push
  • make pypi

Pre-requisites

The ciscoconfparse python package requires Python versions 3.7+ (note: Python version 3.7.0 has a bug - ref Github issue #117, but version 3.7.1 works); the OS should not matter.

Installation and Downloads

  • Use poetry for Python3.x... :

    python -m pip install ciscoconfparse

If you're interested in the source, you can always pull from the github repo:

  • Download from the github repo: :

      git clone git://github.com/mpenning/ciscoconfparse
  cd ciscoconfparse/
  python -m pip install .

Github Star History

Github Star History Chart

Other Resources

Bug Tracker and Support

Unit-Tests

The project's test workflow checks ciscoconfparse on Python versions 3.7 and higher, as well as a pypy JIT executable.

Click the image below for details; the current build status is: Github unittest status

Sphinx Documentation

Building the ciscoconfparse documentation tarball comes down to this one wierd trick:

  • cd sphinx-doc/
  • pip install -r ./requirements.txt; # install Sphinx dependencies
  • pip install -r ../requirements.txt; # install ccp dependencies
  • make html

License and Copyright

ciscoconfparse is licensed GPLv3

  • Copyright (C) 2021-2023 David Michael Pennington
  • Copyright (C) 2020-2021 David Michael Pennington at Cisco Systems (post-acquisition: Cisco acquired ThousandEyes)
  • Copyright (C) 2019 David Michael Pennington at ThousandEyes
  • Copyright (C) 2012-2019 David Michael Pennington at Samsung Data Services
  • Copyright (C) 2011-2012 David Michael Pennington at Dell Computer Corp
  • Copyright (C) 2007-2011 David Michael Pennington

The word "Cisco" is a registered trademark of Cisco Systems.

Author

ciscoconfparse was written by David Michael Pennington (mike [~at~] pennington [.dot.] net).

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mpenning from gravatar.com mpenning

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: GNU General Public License (GPL), GNU General Public License v3 (GPLv3) (GPL-3.0-only)

Author: Mike Pennington

Tags Parse, audit, query, modify, Cisco IOS, Cisco, NXOS, ASA, Juniper

Requires: Python >=3.7.2, <4.0.0

Classifiers

Release history Release notifications | RSS feed

1.9.50 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.48 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.47 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.46 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.45 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.44 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.43 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.42 yanked

Reason this release was yanked:

Preserve backwards compatibility

1.9.41

1.9.40

1.9.39

1.9.38

1.9.37

1.9.36

1.9.35

1.9.34

1.9.33

1.9.32

1.9.31

1.9.30

1.9.29

1.9.28

1.9.27

1.9.26 yanked

1.9.25 yanked

1.9.23 yanked

1.9.22

1.9.21

1.9.20

1.9.19

1.9.18

1.9.17

1.9.16 yanked

Reason this release was yanked:

CiscoConfParse Github Issue number #290

1.9.15

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.0

1.8.2

1.8.1

1.7.24

1.7.23 yanked

Reason this release was yanked:

Github_Issue_277

1.7.22 yanked

Reason this release was yanked:

Github_Issue_277

1.7.21 yanked

1.7.18

1.7.17

1.7.16

1.7.15

This version

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.53

1.6.52

1.6.51

1.6.50

1.6.49

1.6.48

1.6.47

1.6.46

1.6.45

1.6.44

1.6.43

1.6.42

1.6.41 yanked

Reason this release was yanked:

CiscoConfParse Github Issue #289

1.6.40

1.6.38

1.6.36

1.6.35

1.6.34

1.6.33

1.6.32

1.6.31

1.6.30

1.6.29

1.6.28

1.6.27

1.6.26

1.6.25

1.6.24

1.6.23

1.6.22

1.6.21

1.6.20

1.6.19

1.6.18

1.6.17

1.6.16

1.6.15

1.6.13

1.6.12

1.6.11

1.6.10

1.6.9

1.6.8

1.6.7

1.6.6

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.51

1.5.50

1.5.49

1.5.48

1.5.46

1.5.45

1.5.36

1.5.35

1.5.34

1.5.33

1.5.32

1.5.31

1.5.30

1.5.29

1.5.28

1.5.27

1.5.26

1.5.25

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.43

1.3.42

1.3.41

1.3.40

1.3.39

1.3.38

1.3.37

1.3.36

1.3.35

1.3.34

1.3.33

1.3.32

1.3.31

1.3.30

1.3.29

1.3.28

1.3.27

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.1

1.2.55

1.2.54

1.2.53

1.2.52

1.2.51

1.2.50

1.2.49

1.2.47

1.2.46

1.2.45

1.2.44

1.2.43

1.2.42

1.2.41

1.2.40

1.2.39

1.2.38

1.2.37

1.2.36

1.2.35

1.2.34

1.2.33

1.2.32

1.2.31

1.2.30

1.2.29

1.2.28

1.2.27

1.2.26

1.2.25

1.2.24

1.2.23

1.2.22

1.2.21

1.2.20

1.2.19

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.24

1.1.23

1.1.22

1.1.21

1.1.20

1.1.19

1.1.18

1.1.17

1.1.16

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.8

1.1.7

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.9.35

0.9.34

0.9.33

0.9.32

0.9.31

0.9.30

0.9.29

0.9.28

0.9.27

0.9.26

0.9.25

0.9.24

0.9.23

0.9.22

0.9.21

0.9.20

0.9.19

0.9.18

0.9.17

0.9.16

0.9.15

0.9.14

0.9.13

0.9.12

0.9.11

0.9.10

0.9.9

0.9.8

0.9.7

0.9.6

0.9.5

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.8.5

0.8.4

0.8.3a pre-release

0.8.2

0.8.1

0.8.0

Download files

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

Source Distribution

ciscoconfparse-1.7.14.tar.gz (152.6 kB view hashes)

Uploaded Source

Built Distribution

ciscoconfparse-1.7.14-py3-none-any.whl (171.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page