NetBox plugin for Config Diff.
- Free software: Apache-2.0
- Documentation: https://miaow2.github.io/netbox-config-diff/
With this plugin you can find diff between the rendered configuration for a device to its actual configuration, retrieved from the device itself, or stored in DataSource. Read about DataSources for further details.
Device configuration renders natively in NetBox. This feature was introduced in 3.5 version. NetBox Labs blog post about it.
Plugin supports a wide list of vendors (Cisco, Juniper, Huawei, MicroTik etc.) with the help of Scrapli. Read Scrapli and scrapli-community documentations to find full list of vendors.
Also you can push rendered configuration from NetBox to device and apply it.
Supported platforms:
arista_eos
cisco_iosxe
cisco_iosxr
cisco_nxos
juniper_junos
This is possible thanks to the scrapli_cfg. Read Scrapli documentation for more info.
NetBox Version | Plugin Version |
---|---|
3.5, 3.6 | =>0.1.0 |
For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.
Install with pip:
pip install netbox-config-diff
Add to local_requirements.txt
:
echo netbox-config-diff >> local_requirements.txt
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py
,
or if you use netbox-docker, your /configuration/plugins.py
file,
and define credentials for devices connection:
PLUGINS = [
"netbox_config_diff",
]
PLUGINS_CONFIG = {
"netbox_config_diff": {
"USERNAME": "foo",
"PASSWORD": "bar",
"AUTH_SECONDARY": "foobar", # define here password for accessing Privileged EXEC mode, this variable is optional
},
}
Run database migrations:
python manage.py migrate
Collect static from the plugin:
python manage.py collectstatic --noinput
Restart NetBox service:
systemctl restart netbox netbox-rq
Read this doc about collecting diffs, for configuration management read this
My presention about plugin at October NetBox community call (19.10.2023).
Compliance finished with error
Render diff between configurations
No diff
Configuration request
Completed Configuration request
Based on the NetBox plugin tutorial:
This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin
project template.