NetBox Napalm Plugin

NetBox plugin for Napalm.

• Free software: Apache-2.0
• Documentation: https://netbox-community.github.io/netbox-napalm/.

Features

The features the plugin provides should be listed here.

Compatibility

:warning: NetBox 3.5 Beta: This plugin is for NetBox 3.5 (Beta)

Installation

For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.

While this is still in development and not yet on pypi you can install with pip:

$ source /opt/netbox/venv/bin/activate
(venv) pip install git+https://github.com/netbox-community/netbox-napalm

or by adding to your local_requirements.txt or plugin_requirements.txt (netbox-docker):

(venv) git+https://github.com/netbox-community/netbox-napalm

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:

• demo repository
• tutorial

This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin project template.