verbosemode / netcliparsers

Parser library for screen scraping CLI output from network devices

netcliparsers - Parser library for screen scraping CLI output from network devices

This will become a library of parsers based on pyparsing for parsing screen scraped CLI text output from network devices.

NOT PRODUCTION READY, yet. Please be aware, that data returned by parsers might change from one commit to the other at the moment. As soon as tests are in place and I have more parsers ready, I'll try to keep the interfaces and return data stable.

Usage Examples

Functions return a pyparsing parser instance.

from netcliparsers.cisco.ios import show_cdp_neighbor_detail

parser = show_cdp_neighbor_detail()
for e in parser.parseString(text):
    print("{deviceid} {localinterface} {remoteinterface}".format(**e)):

ap1.example.com FastEthernet0/25 GigabitEthernet0.1
ap2.example.com FastEthernet0/37 GigabitEthernet0.1
sw1.example.com GigabitEthernet0/1 GigabitEthernet2/4
sw2.example.com GigabitEthernet0/2 GigabitEthernet0/26


parser = show_ip_interface()
for e in parser.parseString(text):
    print("{interface_name}\tstate: {interface_status}\tline-state: {line_status}".format(**e))

Embedded-Service-Engine0/0      state: down     line-state: down
GigabitEthernet0/0      state: up       line-state: up
GigabitEthernet0/0.10   state: up       line-state: up
GigabitEthernet0/0.20   state: up       line-state: up
GigabitEthernet0/1      state: up       line-state: up
GigabitEthernet0/1.10   state: deleted  line-state: down
GigabitEthernet0/1.20   state: deleted  line-state: down

For convenience all functions also exist with a prepended parse_.

for e in parse_show_cdp_neighbor_detail(text)
    print(e['deviceid'])

TODO

• Tests
  • CLI output examples: netcliparsers/tests/data
• Version number scheme
• Should be Python >= 2.7 compatible
  • Pyparsing is Python 3 compatible
• PyPi if the topics above are implemented
• Use Sphinx/autodoc for generating documentation under docs/
• Move some parser building blocks for IP addresses and prefixes to a separate file to make them reusable
• Add small guide on how to debug parse errors with pyparsing
  • Incremental testing of individual pieces of the parser
    • text = '192.0.2.1'
    • parser.parseString(text)
  • text.split('n')[30]
    • If parser failed in text output on line 29
  • text[18:39]
    • If parser failed at character 28
    • Have a look at lines +/- at where the parser failed

How to contribute

• A parser should parse CLI output from top to bottom, excluding the command prompt
• Parsers should be as strict as possible to ensure they fail instead of returing data that can not be trusted
• However it is ok to use SkipTo for example during development of a new parser or to skip irrelevant output
• Code should follow PEP8
• If you add CLI output to the tests (netcliparsers/tests/data), make sure you are sanitizing the output to not leak any data of your network equipment.
• Feel free to fix grammer mistakes. I'm not a native English speaker
• Make a pull request

Windows

If you run the setup on Windows you'll need to have git installed. Pbr tries to figure out the version number via git. I'll need to fix this "soon".

License

GPLv3

Feedback

Bug reports, patches and ideas are welcome.

Just send me an e-mail ([email protected]) or open an issue on GitHub

netcliparsers's Issues

Working on Cisco IOS / show_ip_interface parser

Until I have a separate branch for development on GH, I'll track here on which parsers I'm working on.

This is just to avoid duplicate work.

Please consider an explicit license for the repo

Hi Jochen,

How is this repo licensed? If it's licensed MIT, then that's permissive and I can almost do anything with it; however, if it's licensed GPL, derived works must be licensed the same way and published. I'm interested in potentially integrating this with other libraries, but I'd like to understand the terms and conditions. If you're not sure which license to use, there is a pretty good guide here:

http://choosealicense.com/

Even if you just declare it as WTFPL, that's better than no explicit licensing terms