netbox/docs/plugins/index.md

Plugins

Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can introduce their own models and views, but cannot interfere with existing components. A NetBox user may opt to install plugins provided by the community or build his or her own.

Capabilities

The NetBox plugin architecture allows for the following:

• Add new data models. A plugin can introduce one or more models to hold data. (A model is essentially a table in the SQL database.)
• Add new URLs and views. Plugins can register URLs under the /plugins root path to provide browsable views for users.
• Add content to existing model templates. A template content class can be used to inject custom HTML content within the view of a core NetBox model. This content can appear in the left side, right side, or bottom of the page.
• Add navigation menu items. Each plugin can register new links in the navigation menu. Each link may have a set of buttons for specific actions, similar to the built-in navigation items.
• Add custom middleware. Custom Django middleware can be registered by each plugin.
• Declare configuration parameters. Each plugin can define required, optional, and default configuration parameters within its unique namespace. Plug configuration parameter are defined by the user under PLUGINS_CONFIG in configuration.py.
• Limit installation by NetBox version. A plugin can specify a minimum and/or maximum NetBox version with which it is compatible.

Limitations

Either by policy or by technical limitation, the interaction of plugins with NetBox core is restricted in certain ways. A plugin may not:

• Modify core models. Plugins may not alter, remove, or override core NetBox models in any way. This rule is in place to ensure the integrity of the core data model.
• Register URLs outside the /plugins root. All plugin URLs are restricted to this path to prevent path collisions with core or other plugins.
• Override core templates. Plugins can inject additional content where supported, but may not manipulate or remove core content.
• Modify core settings. A configuration registry is provided for plugins, however they cannot alter or delete the core configuration.
• Disable core components. Plugins are not permitted to disable or hide core NetBox components.

Installing Plugins

The instructions below detail the process for installing and enabling a NetBox plugin.

Install Package

Download and install the plugin package per its installation instructions. Plugins published via PyPI are typically installed using pip. Be sure to install the plugin within NetBox's virtual environment.

$ source /opt/netbox/venv/bin/activate
(venv) $ pip install <package>

Alternatively, you may wish to install the plugin manually by running python setup.py install. If you are developing a plugin and want to install it only temporarily, run python setup.py develop instead.

Enable the Plugin

In configuration.py, add the plugin's name to the PLUGINS list:

PLUGINS = [
    'plugin_name',
]

Configure Plugin

If the plugin requires any configuration, define it in configuration.py under the PLUGINS_CONFIG parameter. The available configuration parameters should be detailed in the plugin's README file.

PLUGINS_CONFIG = {
    'plugin_name': {
        'foo': 'bar',
        'buzz': 'bazz'
    }
}

Run Database Migrations

If the plugin introduces new database models, run the provided schema migrations:

(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrate

Collect Static Files

Plugins may package static files to be served directly by the HTTP front end. Ensure that these 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 and RQ workers to load the new plugin:

# sudo systemctl restart netbox netbox-rq

Removing Plugins

Follow these steps to completely remove a plugin.

Update Configuration

Remove the plugin from the PLUGINS list in configuration.py. Also remove any relevant configuration parameters from PLUGINS_CONFIG.

Remove the Python Package

Use pip to remove the installed plugin:

$ source /opt/netbox/venv/bin/activate
(venv) $ pip uninstall <package>

Restart WSGI Service

Restart the WSGI service:

# sudo systemctl restart netbox

Drop Database Tables

!!! note

This step is necessary only for plugin which have created one or more database tables (generally through the introduction of new models). Check your plugin's documentation if unsure.

Enter the PostgreSQL database shell to determine if the plugin has created any SQL tables. Substitute pluginname in the example below for the name of the plugin being removed. (You can also run the \dt command without a pattern to list all tables.)

netbox=> \dt pluginname_*
                   List of relations
                   List of relations
 Schema |       Name     | Type  | Owner
--------+----------------+-------+--------
 public | pluginname_foo | table | netbox
 public | pluginname_bar | table | netbox
(2 rows)

!!! warning

Exercise extreme caution when removing tables. Users are strongly encouraged to perform a backup of their database immediately before taking these actions.

Drop each of the listed tables to remove it from the database:

netbox=> DROP TABLE pluginname_foo;
DROP TABLE
netbox=> DROP TABLE pluginname_bar;
DROP TABLE