Diode Netbox Plugin banner
netboxlabs netboxlabs

Diode Netbox Plugin

Development community

Description

Official NetBox Labs plugin for NetBox for Diode

Installation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open the source below and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

README

Diode NetBox Plugin

The Diode NetBox plugin is a [NetBox](https://netboxlabs.com/oss/netbox/) plugin. It is a required component of the [Diode](https://github.com/netboxlabs/diode) ingestion service.

Diode is a NetBox ingestion service that greatly simplifies and enhances the process to add and update network data in NetBox, ensuring your network source of truth is always accurate and can be trusted to power your network automation pipelines.

More information about Diode can be found at [https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/](https://netboxlabs.com/blog/introducing-diode-streamlining-data-ingestion-in-netbox/).

Compatibility

NetBox Version Plugin Version
>= 3.7.2 0.1.0
>= 4.1.0 0.4.0
>= 4.2.3 1.0.0
>= 4.2.3 1.1.0
>= 4.2.3 1.2.0
>= 4.4.0 1.4.0
>= 4.4.0 1.4.1
>= 4.4.10 1.7.0
>= 4.5.0 1.7.0
>= 4.6.0 1.12.0

Installation

Source the NetBox Python virtual environment:

cd /opt/netbox
source venv/bin/activate

Install the plugin:

pip install netboxlabs-diode-netbox-plugin

In your NetBox `configuration.py` file, add `netbox_diode_plugin` to the `PLUGINS` list.

PLUGINS = [
    "netbox_diode_plugin",
]

Also in your `configuration.py` file, in order to customise the plugin settings, add `netbox_diode_plugin`to the `PLUGINS_CONFIG` dictionary, e.g.:

PLUGINS_CONFIG = {
    "netbox_diode_plugin": {
        # Diode gRPC target for communication with Diode server
        "diode_target_override": "grpc://localhost:8080/diode",

        # Username associated with changes applied via plugin
        "diode_username": "diode",

        # netbox-to-diode client_secret created during diode bootstrap.
        "netbox_to