Home
NetBox Napalm Plugin¶
NetBox plugin for Napalm.
- Free software: Apache-2.0
- Documentation: https://netbox-community.github.io/netbox-napalm-plugin/.
Features¶
The features the plugin provides should be listed here.
Compatibility¶
| NetBox Version | Plugin Version |
|---|---|
| 3.5 | 0.1.0 |
| 3.5.8 | 0.1.4 |
| 3.6.0 | 0.1.5 |
| 3.7.6 | 0.1.7 |
| < 4.0.11 | 0.2.1 |
| >= 4.1.0 < 4.2.0 | 0.3.0 |
| >= 4.2.0 | 0.3.1 |
| >= 4.3.0 | 0.3.2 |
| >= 4.4.0 | 0.3.3 |
Installation¶
For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.
$ source /opt/netbox/venv/bin/activate
(venv) pip install netbox-napalm-plugin
or by adding to your local_requirements.txt or plugin_requirements.txt (netbox-docker):
(venv) netbox-napalm-plugin
Enable the Plugin¶
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py,
or if you use netbox-docker, your /configuration/plugins.py file :
PLUGINS = [
'netbox_napalm_plugin'
]
Configure Plugin¶
Configure the plugin in configuration.py under the PLUGINS_CONFIG parameter.
PLUGINS_CONFIG = {
'netbox_napalm_plugin': {
'NAPALM_USERNAME': 'xxx',
'NAPALM_PASSWORD': 'yyy',
},
}
Run Database Migrations¶
Run the provided schema migrations:
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrate
Collect Static Files¶
Ensure the static files are copied to the static root directory with the collectstatic management command:
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py collectstatic
Restart WSGI Service¶
Restart the WSGI service to load the new plugin:
# sudo systemctl restart netbox
Credits¶
Based on the NetBox plugin tutorial:
This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin project template.