Skip to main content

Utility for pushing configuration data to network devices and retrieving state data

Project description


NetworkConfigUtility is currently a small program to assist with pushing configuration data to network devices. It can also retrieve state data. This utility is built using the Nornir framework:

Source Code

PyPI package


pip install networkconfigutility

See sample hosts, groups, and defaults file for reference. Also see the following for more information on Nornir and SimpleInventory

Also - see the sample 'configuration.ini' file on how to set it up properly

Lastly - this requires that ntc-templates are downloaded to the host running this program:


Easiest method is to download and keep the ntc-templates in the home directory of the user running this program.

git clone

Otherwise you can explicitly tell the program (namely Netmiko) where to look for them (example is for Linux):

export NET_TEXTFSM=/path/to/ntc-templates/templates/

More information is here:


Run using the following:

python -m networkconfigutility [options\files\filters]

Example of current capabilities:

usage: networkconfigutility [-h] -config path to config file for device(s |
                        -getters GETTERS [GETTERS ...] | -cli command)
                        configuration_file ftype filter

positional arguments:
  configuration_file    name of configuration file for program itself
  ftype                 type of filter to use
  filter                name of device or group

optional arguments:
  -h, --help            show this help message and exit
  -config path to config file for device(s)
                        change configuration on a device or groups of devices
  -merge path to config file for device(s)
                    merge a configuration to a device or group of devices

  -getters GETTERS [GETTERS ...]
                        use built-in NAPALM getters to retrieve information
  -cli command          use the system CLI to retrieve information
    -getters_extra GETTERS_EXTRA [GETTERS_EXTRA ...]
                    optional, additional getters to use
  -cli_extra command    optional, additional CLI to retrieve information

Example execution of the getters looks like such:

Enter username: test-user
Input password: 
* test-device ** changed : False ***********************************************
vvvv napalm_get ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
{ 'get_interfaces_ip': { 'Vlan10': { 'ipv4': { '': { 'prefix_length': 24}}}}}
^^^^ END napalm_get ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Returned output is utilized from the Nornir 'print_result()' method

Project details

Download files

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

Source Distribution

networkconfigutility-1.0.3.tar.gz (4.6 kB view hashes)

Uploaded Source

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