Diode NetBox Plugin
The Diode NetBox plugin is a NetBox plugin. It is a required component of the 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/.
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 |
| >= 4.7.0 | 1.17.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_pluginto 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_diode_client_secret": "..."
},
}
If you are running diode locally via the quickstart, the netbox-to-diode client_secret may be found in /path/to/diode/oauth2/client/client-credentials.json. eg:
echo $(jq -r '.[] | select(.client_id == "netbox-to-diode") | .client_secret' /path/to/diode/oauth2/client/client-credentials.json)
Note: Once you customise usernames with PLUGINS_CONFIG during first installation, you should not change or remove them later on. Doing so will cause the plugin to stop working properly.
Restart NetBox services to load the plugin:
sudo systemctl restart netbox netbox-rq
See NetBox Documentation for details.
Configuration
Source the NetBox Python virtual environment (if not already):
cd /opt/netbox
source venv/bin/activate
Run migrations to create all necessary resources:
cd /opt/netbox/netbox
./manage.py migrate netbox_diode_plugin
Running Tests
make docker-compose-netbox-plugin-test
Generating Documentation
Generates documentation on how diode entities are matched. The generated documentation is output to here.
make docker-compose-generate-matching-docs
License
Distributed under the NetBox Limited Use License 1.0. See LICENSE.md for more information.
Required Notice
Copyright NetBox Labs, Inc.
1 maintainer
Metadata
1 maintainer
Release files for netboxlabs-diode-netbox-plugin 1.18.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| netboxlabs_diode_netbox_plugin-1.18.2.tar.gz | 179.3 kB | With provenance | Details |
Release files / netboxlabs_diode_netbox_plugin-1.18.2.tar.gz
| Download URL | netboxlabs_diode_netbox_plugin-1.18.2.tar.gz |
|---|---|
| Size | 179.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea6360f9f7a0047f951e39c5baa25bc3b46cc59cefaa3ea112345e0361488fd2
|
|
BLAKE2b-256 checksum How to use checksums |
cdcafcf1b81a85b78650961d5f61a7e8dc1f436a27927f2823d96cb0ac578561
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.
Transparency logSecurity for netboxlabs-diode-netbox-plugin 1.18.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 1 file in this release has been uploaded with provenance metadata.
Attestation for netboxlabs_diode_netbox_plugin-1.18.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
