Diode is a data ingestion service for NetBox that greatly simplifies and enhances the process of adding and updating data in NetBox, ensuring your network source of truth is always accurate and up to date. Our guiding principle in designing Diode has been to make it as easy as possible to get data into NetBox, removing as much burden as possible from the user while shifting that effort to technology.
The Diode project is currently in the Public Preview stage. Please see NetBox Labs Product and Feature Lifecycle for more details. We actively welcome feedback to help identify and prioritize bugs, new features and areas of improvement.
- NetBox 4.2.3 or later
- Python 3.8 or later (for Python SDK)
- Go 1.18 or later (for Go SDK)
- Network connectivity between Diode and NetBox
-
Deploy the Diode Server See deployment instructions
-
Install the Diode NetBox Plugin See installation instructions
-
Choose Your Data Ingestion Method
- Use the NetBox Discovery agent for automated network discovery: see instructions to run Orb agent.
- Build custom integrations using our SDKs:
- diode-netbox-plugin - The Diode NetBox plugin is a NetBox plugin and a required component of the Diode ingestion service.
- diode-sdk-python - Diode SDK Python is a Python library for interacting with the Diode ingestion service utilizing gRPC.
- diode-sdk-go - Diode SDK Go is a Go module for interacting with the Diode ingestion service utilizing gRPC.
- orb-agent - The NetBox Discovery agent.
Distributed under the NetBox Limited Use License 1.0. See LICENSE.md for more information.
Diode protocol buffers are distributed under the Apache 2.0 License. See LICENSE.txt for more information.
Copyright NetBox Labs, Inc.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
