API key for the Diode service to interact with NetBox
The following instructions assume you have installed NetBox in the /opt/netbox directory. Adjust instructions as necessary if you've installed NetBox in a different directory.
Network discovery and device detection features
View all tagsThe following instructions assume you have installed NetBox in the /opt/netbox directory. Adjust instructions as necessary if you've installed NetBox in a different directory.
Agent configuration file
Here is a collection of configuration samples supported by orb agent
The device discovery backend leverages NAPALM to connect to network devices and collect network information.
The Diode project is currently in Public Preview. Please see NetBox Labs Product and Feature Lifecycle for more details.
The Diode Agent is a lightweight network device discovery tool that uses NAPALM to streamline data entry into NetBox through the Diode ingestion service. The following is a basic set of instructions to get started using Diode Agent on a local machine.
The Diode SDK is a Python library for sending data to the Diode server over gRPC/protbuf for ingestion in to NetBox.
Requirements
reference architecture
Before getting started
This guide will help you set up and start using Diode to ingest data into NetBox.
Complete setup and configuration guide for NetBox Discovery across Cloud, Enterprise, and Community deployments with step-by-step instructions
Complete setup and configuration guide for NetBox Assurance - from installation to your first operational workflow with step-by-step instructions
Automated operational drift detection for NetBox - continuously monitor network infrastructure and maintain accurate documentation with proactive remediation capabilities
Advanced network discovery and observability solution for automated network documentation and drift detection across all NetBox deployments
The NetBox Discovery agent is based on the Orb open source project. Orb agent is one component of the NetBox Discovery solution and provides network discovery and observability capabilities.
The network discovery backend leverages NMAP to scan networks and discover IP information.
Looking to try NetBox Discovery as quickly and easily as possible? The Quickstart Guide on the NetBox Labs blog has you covered! In a few commands you will install and pre-configure everything you need to start experimenting:
The home of documentation for NetBox Cloud, Enterprise, Integrations, SDKs and Extensions.