conftodict

KO | EN

gitlite — search

#javascript #python #hacktoberfest #llm #machine-learning #deep-learning #nodejs #macos #java #awesome #cli #pytorch #security #open-source

(★ 15)

Python module to convert Cisco IOS config to a python dictionary

conftodict Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#conftodict
Python module to convert Cisco IOS config to a python dictionary.  
I built this module to help with auditing device configurations.  
Since a dictionary is a hash of key/value pairs its efficient for auditing  
large sets of configurations.

Built and tested with Python 3. Python 2 not tested at this time.

###Overview
Cisco IOS config is a series of parent and child relationships, IE;  
```
!  
interface Loopback0                         # Parent
 ip address 10.10.10.10 255.255.255.255      # Child
 ip flow ingress                             # Child
 h323-gateway voip interface                 # Child
 h323-gateway voip bind srcaddr 10.10.10.10  # Child 
!
```

This will be converted into a dictionary with the parent as the key and children a list of values
```python
{'interface Loopback0': [                        
    'ip address 10.10.10.10 255.255.255.255',  
    'ip flow ingress',                         
    'h323-gateway voip interface',               
    'h323-gateway voip bind srcaddr 10.10.10.10',
    ]}
 ```

Parents with no children will have an empty list for a value
```python
{'logging trap debugging': []}
```
 
Note: It is assumed that the config will be in the same format as show run output.

###Installation
```bash
mkdir path/to/ise
cd path/to/ise
git clone https://github.com/bobthebutcher/conftodict.git
```

###Add to path
```python
import sys
sys.path.append('/path/to/conftodict/')
```

###Example Usage
```python
from conftodict import ConfToDict
from configaudit import search_keys, search_values

# Create a config dictionary
c = ConfToDict('tests/test.txt', from_file=True)
config = c.to_dict()

# List of commands to check exist
commands = ['voice rtp send-recv', 'sccp local Loopback0', 'voice service voip']

# configaudit has some helper functions for auditing config
# helper functions return an AuditResult object
# There are helper functions for auditing a list of keys/values or single key/value
result = search_keys(config, commands)

result.ok
False

result.error
'extra key(s) found'

result.extra
['interface GigabitEthernet1/0',
 'mgcp profile default',
 'line vty 5 15',
 'voice class codec 1',
 'service password-encryption',
 'ip cef',
 'dspfarm profile 2 conference',
 'interface Vlan1',
 ...]

commands = ['no ip address', 'shutdown', 'duplex auto', 'speed auto']
result = search_values(config['interface GigabitEthernet0/1'], commands)

result.ok
True
```

conftodict

conftodict Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

conftodict

conftodict Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README