557 docs tagged with "Cloud"

To invite a new user to a NetBox Cloud Free instance, the user will need to have a valid email address, and be added as an administrator in the NetBox Labs Console.

To invite a new user to a NetBox Cloud Free instance, the user will need to have a valid email address, and be added as an administrator in the NetBox Labs Console.

To invite a new user to a NetBox Cloud Free instance, the user will need to have a valid email address, and be added as an administrator in the NetBox Labs Console.

To invite a new user to a NetBox Cloud Free instance, the user will need to have a valid email address, and be added as an administrator in the NetBox Labs Console.

Diagnostic procedures and solutions for common NetBox Enterprise issues

NetBox Enterprise is designed to harness the power of Kubernetes while minimizing the amount of work the average person needs to manage it.

Diagnostic procedures and solutions for common NetBox Enterprise issues

Diagnostic procedures and solutions for common NetBox Enterprise issues

Diagnostic procedures and solutions for common NetBox Enterprise issues

Threading

The agent configuration file is the single file passed to the agent at startup via the -c flag. It defines the agent's identity, how policies are loaded, which backends are active, and optional secrets management.

API

API

API

Delivery via AWS Direct Connect in two regions, with replicated NetBoxes, Single (or Dual) Direct Connect in each region. Customer IP space (2 x /25's) is assigned for the VPCs. This is to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

Delivery via AWS Direct Connect in two regions, with replicated NetBoxes, Single (or Dual) Direct Connect in each region. Customer IP space (2 x /25's) is assigned for the VPCs. This is to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

Delivery via AWS Direct Connect in two regions, with replicated NetBoxes, Single (or Dual) Direct Connect in each region. Customer IP space (2 x /25's) is assigned for the VPCs. This is to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

Delivery via AWS Direct Connect in two regions, with replicated NetBoxes, Single (or Dual) Direct Connect in each region. Customer IP space (2 x /25's) is assigned for the VPCs. This is to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

AWS Direct Connect is available via hosted connections from BT, Equinix Fabric, MegaPort, Optus, PCCW, Zayo etc. VLAN hand-off is with BGP and Single or Dual Direct Connect services are available. Customer IP space (/24 or /25) is assigned for the VPC, as this is required to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

AWS Direct Connect is available via hosted connections from BT, Equinix Fabric, MegaPort, Optus, PCCW, Zayo etc. VLAN hand-off is with BGP and Single or Dual Direct Connect services are available. Customer IP space (/24 or /25) is assigned for the VPC, as this is required to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

AWS Direct Connect is available via hosted connections from BT, Equinix Fabric, MegaPort, Optus, PCCW, Zayo etc. VLAN hand-off is with BGP and Single or Dual Direct Connect services are available. Customer IP space (/24 or /25) is assigned for the VPC, as this is required to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

AWS Direct Connect is available via hosted connections from BT, Equinix Fabric, MegaPort, Optus, PCCW, Zayo etc. VLAN hand-off is with BGP and Single or Dual Direct Connect services are available. Customer IP space (/24 or /25) is assigned for the VPC, as this is required to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.

Configure multi-region deployment for NetBox Cloud Premium Tier with automatic failover for high availability. Learn about architecture, replication, disaster recovery procedures, and monitoring strategies.

Configure multi-region deployment for NetBox Cloud Premium Tier with automatic failover for high availability. Learn about architecture, replication, disaster recovery procedures, and monitoring strategies.

Configure multi-region deployment for NetBox Cloud Premium Tier with automatic failover for high availability. Learn about architecture, replication, disaster recovery procedures, and monitoring strategies.

NetBox Cloud includes multi-region deployment options as an add-on available to Premium Tier customers to improve availability and resilience. In this setup, your NetBox data is replicated across regions, allowing for a failover strategy in the event of a regional AWS outage.

Delivery via Private Link between a customer's existing AWS account and the NetBox Labs AWS account, with VPC endpoints using private IPs. This option has fast turn-up times and standard Internet delivery can optionally be disabled.

Delivery via Private Link between a customer's existing AWS account and the NetBox Labs AWS account, with VPC endpoints using private IPs. This option has fast turn-up times and standard Internet delivery can optionally be disabled.

Delivery via Private Link between a customer's existing AWS account and the NetBox Labs AWS account, with VPC endpoints using private IPs. This option has fast turn-up times and standard Internet delivery can optionally be disabled.

Delivery via Private Link between a customer's existing AWS account and the NetBox Labs AWS account, with VPC endpoints using private IPs. This option has fast turn-up times and standard Internet delivery can optionally be disabled.

Bills of Materials - NetBox Asset Lifecycle feature guide

Bills of Materials - NetBox Asset Lifecycle data model reference

BOM Line Items - NetBox Asset Lifecycle data model reference

BOM Objects - NetBox Asset Lifecycle data model reference

BOM Scope Rules - NetBox Asset Lifecycle data model reference

Branch lifecycle operations (provisioning, syncing, merging, etc.) are recorded as branch events. The list of events associated with a branch serves as its operational history.

A branch represents a divergent state of the NetBox database, isolated within a dedicated PostgreSQL schema. Changes made within a branch do not affect main (or any other branch) until the branch is merged.

The NetBox branching plugin lets you create branches in NetBox, much like a version control system. Changes made within a branch are isolated from the main schema and can later be merged.

NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity of manual setup. These plugins are pre-integrated and supported within the platform, ensuring streamlined deployment and reliable performance.

Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support

Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support

NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity of manual setup. These plugins are pre-integrated and supported within the platform, ensuring streamlined deployment and reliable performance.

Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support

Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support

Cable Types - NetBox Asset Lifecycle data model reference

A change diff summarizes the net effect of all changes to a particular NetBox object within a branch. It simplifies the process of reviewing changes within a branch by collapsing successive individual changes into a single comparison, and is also the model used to detect and surface conflicts between a branch and main.

Release notes and changelog for NetBox Change Management

v1.1.0

Change request model for NetBox Change Management workflow

0.4.0

This page documents the special methods available on Circuits models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint reference.

Automatically discover and synchronize Cisco ACI fabric inventory - devices, interfaces, VRFs, prefixes, VLANs, and IP addresses - into NetBox via the Diode SDK.

Common Issues

Cisco ACI to NetBox Object Mapping

Automatically discover and synchronize network infrastructure from Cisco Catalyst Center into NetBox Discovery. Synchronizes devices, platforms, IP addresses, and more to maintain an accurate network inventory.

Common Issues

Cisco Catalyst Center to NetBox Object Mapping

Overview

This document provides answers to commonly asked questions about the NetBox Cisco Meraki integration.

Cisco Meraki to NetBox Object Mapping

IPSEC VPN Tunnels

IPSEC VPN Tunnels

IPSEC VPN Tunnels

IPSEC VPN Tunnels

Comment reply model for NetBox Change Management reviews

Comment model for NetBox Change Management reviews

Plugin configuration parameters for NetBox Change Management

This page documents the configuration parameters specific to the NetBox Branching plugin. They are set under the netboxbranching key of NetBox's PLUGINSCONFIG dictionary, for example:

Here is a collection of configuration samples supported by orb agent

NetBox Cloud supports SAML-based authentication, including group mappings to enforce role-based access control. For group mapping, you will need to provide your Identity Provider (IdP) group names so we can associate them with the desired NetBox groups.

NetBox Cloud supports SAML-based authentication, including group mappings to enforce role-based access control. For group mapping, you will need to provide your Identity Provider (IdP) group names so we can associate them with the desired NetBox groups.

NetBox Cloud supports SAML-based authentication, including group mappings to enforce role-based access control. For group mapping, you will need to provide your Identity Provider (IdP) group names so we can associate them with the desired NetBox groups.

NetBox Cloud supports SAML-based authentication, including group mappings to enforce role-based access control. For group mapping, you will need to provide your Identity Provider (IdP) group names so we can associate them with the desired NetBox groups.

NetBox Cloud supports SAML-based authentication, including group mappings to enforce role-based access control. For group mapping, you will need to provide your Identity Provider (IdP) group names so we can associate them with the desired NetBox groups.

Setting up Group Mapping for SAML requires the base SAML SSO Setup to be configured and working first.

This guide covers administrative tasks for the NetBox Labs Console, including managing administrator accounts and console settings.

This guide covers administrative tasks for the NetBox Labs Console, including managing administrator accounts and console settings.

This guide covers administrative tasks for the NetBox Labs Console, including managing administrator accounts and console settings.

This guide covers administrative tasks for the NetBox Labs Console, including managing administrator accounts and console settings.

orb-agent hosts the discovery backends (device, network, snmp, gnmi) and the

This page documents the special methods available on Core models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint reference.

This page documents the core classes that form pynetbox's API surface.

Courier Accounts - NetBox Asset Lifecycle data model reference

Couriers - NetBox Asset Lifecycle data model reference

First, navigate to Branching > Branches to view the list of existing branches. Click the Add button at the top right to create a new branch.

This directory contains custom NAPALM drivers shipped directly with device-discovery. Each driver

The following attributes are available when creating or editing a Custom Object Type Field.

The NetBox Custom Objects plugin lets you define user-defined object types (and their fields) at runtime, then create instances of those types under /api/plugins/custom-objects//.

The Orb Agent can integrate with CyberArk Privileged Access Manager (PAM) via the Central Credential Provider (CCP) to retrieve secrets at runtime. This feature allows you to reference accounts stored in CyberArk directly in your policy configurations without hardcoding sensitive values.

This page documents the special methods available on DCIM models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint reference.

The Orb Agent can integrate with Delinea Secret Server (both Secret Server Cloud and on-prem / Platform) to securely manage sensitive information such as passwords and API keys. This feature allows you to reference secrets stored in Delinea directly in your policy configurations without hardcoding sensitive values.

Thanks for your interest in contributing to pynetbox! This page covers the project's branch layout, how to propose changes, and where to get help.

The device discovery backend leverages NAPALM to connect to network devices and collect network information.

The device discovery backend uses an intelligent five-tier priority system to automatically determine interface types. This system provides zero-configuration support for common network equipment while allowing fine-grained customization through user-defined patterns.

This page lists the vendors, operating systems, and NAPALM drivers supported by the device discovery backend — currently 48 drivers (7 standard + 41 custom) covering 17+ network vendors, all available out of the box.

Orb device discovery backend

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.

Source: NetBox v4.6.0

Source: NetBox v4.6.0

Diode SDK Go is a Go library for interacting with the Diode ingestion service utilizing gRPC.

Diode SDK Python is a Python library for interacting with the Diode ingestion service utilizing gRPC.

See updated docs in README

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments.

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments.

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments.

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments.

The Orb Agent can integrate with Doppler to securely manage sensitive information such as passwords and API keys. This feature allows you to reference secrets stored in Doppler directly in your policy configurations without hardcoding sensitive values.

Endpoint objects provide CRUD operations for NetBox API endpoints. They are created automatically when you access an attribute on an App instance.

Orb Agent's configuration always starts from the YAML file(s) passed with -c. On top of that file, the agent layers a generic environment-variable overlay so an operator can set or override any orb. config value with ORB_ environment variables — without editing or templating the YAML. The primary use case is selecting and configuring the secrets manager independently of the config manager, especially useful for injecting secrets via Kubernetes/Docker at deploy time — but the mechanism works for any config key, not just secrets-manager selection.

When addbranchcontext is configured in NetBox's EVENTSPIPELINE (see Configuration), branch context is available throughout event rule processing. This applies to all action types — webhooks, scripts, and notifications.

Real-time integration between NetBox and external systems via event streaming and webhooks

Real-time integration between NetBox and external systems via event streaming and webhooks

Real-time integration between NetBox and external systems via event streaming and webhooks

pynetbox raises a small set of dedicated exceptions in response to error conditions. They all live in pynetbox.core.query and are re-exported at the top level of the pynetbox package, so they can also be imported as pynetbox.RequestError, pynetbox.ContentError, pynetbox.AllocationError, and pynetbox.ParameterValidationError.

pynetbox's extension framework lets you (or a plugin author) register custom Record subclasses, JSON-field markers, and content-type mappings for NetBox plugins — without modifying pynetbox itself.

Common questions, troubleshooting steps, and operational guidance for v2.0.0.

Common questions, troubleshooting steps, and operational guidance for v2.0.0.

Features - NetBox Asset Lifecycle feature guide

This guide walks through setting up a pynetbox development environment and running the test suite.

This guide will help you set up and start using Diode to ingest data into NetBox.

This guide will help you set up, configure, and start using NetBox Assurance to maintain accurate network documentation and proactive drift detection. Follow these steps to go from installation to your first operational workflow.

This guide will help you set up, configure, and start using NetBox Assurance to maintain accurate network documentation and proactive drift detection. Follow these steps to go from installation to your first operational workflow.

This guide will help you set up, configure, and start using NetBox Assurance to maintain accurate network documentation and proactive drift detection. Follow these steps to go from installation to your first operational workflow.

You can view an on-demand Webinar Getting Started with Network Test Automation: NetBox + pyATS hosted by NetBox Labs.

The Cisco ACI integration is currently in customer preview. Contact support@netboxlabs.com if you have not already been onboarded.

This guide will help you set up and start using the Catalyst Center Integration for NetBox.

This guide will help you set up and start using the Cisco Meraki Integration for NetBox.

This guide will help you set up and start using the HPE Juniper Networking Mist Integration for NetBox.

The Infoblox NIOS integration is currently in customer preview. Contact support@netboxlabs.com if you have not already been onboarded.

Pull the sync container, configure credentials, validate schema compatibility, and run NetBox-to-Jira Assets synchronization.

This guide will help you set up and start using the Lightyear Integration for NetBox.

The Microsoft DHCP integration is currently in customer preview. Contact support@netboxlabs.com if you have not already been onboarded.

The Microsoft DNS integration is currently in customer preview. Contact support@netboxlabs.com if you have not already been onboarded.

The Proxmox VE integration is currently experimental and is not yet available for customer preview. Contact product@netboxlabs.com if you would like to be notified when this is available to preview.

This guide will help you set up and start using the VMware vCenter Integration for NetBox.

The Git configuration manager outlines a policy management system where an agent fetches policies from a Git repository.

The gNMI discovery backend is an event-driven network discovery service that maintains long-lived gNMI subscriptions and ingests device, interface, and hardware-inventory changes into NetBox via Diode within seconds of them occurring.

Orb gNMI discovery backend — an event-driven network discovery service that maintains long-lived gNMI subscriptions and ingests device, interface, and hardware-inventory changes into NetBox via Diode within seconds of them occurring.

Upgrade your Single Sign-On experience with Group Mapping for Okta SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Okta Single Sign-On, streamlines the synchronization of group memberships from Okta to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Okta SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Okta Single Sign-On, streamlines the synchronization of group memberships from Okta to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Okta SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Okta Single Sign-On, streamlines the synchronization of group memberships from Okta to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Okta SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Okta Single Sign-On, streamlines the synchronization of group memberships from Okta to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Okta SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Okta Single Sign-On, streamlines the synchronization of group memberships from Okta to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

hpe-mist-integration\}

hpe-mist-integration-faq-and-troubleshooting\}

HPE Juniper Networking Mist to NetBox Object Mapping \{#hpe-mist-to-netbox-object-mapping\}

The Infoblox NIOS integration is currently in customer preview and is not yet generally available. Contact support@netboxlabs.com to join the preview.

This document provides answers to commonly asked questions about the NetBox Infoblox NIOS integration.

Infoblox NIOS to NetBox Object Mapping

Requirements

Requirements

Install and configure NetBox Labs CMDB Integration v2.0.0 in ServiceNow.

Install and configure NetBox Labs CMDB Integration v2.0.0 in ServiceNow.

While NetBox Enterprise comes with a variety of certified and other community plugins built-in, there are cases where you will want to include additional plugins in your NetBox runtime.

Extend NetBox Enterprise with custom plugins using wheelhouse archives, delivered via PVC or S3 storage

While NetBox Enterprise comes with a variety of certified and other community plugins built-in, there are cases where you will want to include additional plugins in your NetBox runtime.

Extend NetBox Enterprise with custom plugins using wheelhouse archives for standalone and multi-node/HA deployments

Extend NetBox Enterprise with custom plugins using wheelhouse archives for standalone and multi-node/HA deployments

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments:

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments:

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments:

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments:

This page documents the special methods available on IPAM models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint reference.

In this solution NetBox Cloud is securely delivered over an IPSEC VPN. You have single or dual tunnel options, and use a static route or the preferred option of BGP routing. Customer IP space (/24 or /25) is assigned for the VPC as this is required to host load balancers and proxies within the dedicated customer Account/VPC.

In this solution NetBox Cloud is securely delivered over an IPSEC VPN. You have single or dual tunnel options, and use a static route or the preferred option of BGP routing. Customer IP space (/24 or /25) is assigned for the VPC as this is required to host load balancers and proxies within the dedicated customer Account/VPC.

In this solution NetBox Cloud is securely delivered over an IPSEC VPN. You have single or dual tunnel options, and use a static route or the preferred option of BGP routing. Customer IP space (/24 or /25) is assigned for the VPC as this is required to host load balancers and proxies within the dedicated customer Account/VPC.

In this solution NetBox Cloud is securely delivered over an IPSEC VPN. You have single or dual tunnel options, and use a static route or the preferred option of BGP routing. Customer IP space (/24 or /25) is assigned for the VPC as this is required to host load balancers and proxies within the dedicated customer Account/VPC.

Synchronize NetBox inventory into Jira Service Management Assets - devices, sites, virtual machines, plugin objects, and custom fields - via a one-way Docker sync container.

Frequently asked questions and troubleshooting guidance for the Jira Assets integration.

Object mappings, schema design, configuration parameters, and sync behavior for the NetBox-to-Jira Assets integration.

Known issues, workarounds, and status for v2.0.0.

Known issues, workarounds, and status for v2.0.0.

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

1. In the Admin Console for NetBox Enterprise, navigate to the Config tab and scroll to the bottom to check Advanced Settings

Overview

This document provides answers to commonly asked questions about the NetBox Lightyear integration.

This document covers the Lightyear to NetBox object mappings, API details, and configuration reference for the integration.

This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to directories, files, and runtime configurations affected under /.

Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation

Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation

Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation

This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to directories, files, and runtime configurations affected under /.

Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation

The local config manager reads policies directly from the agent config file (agent.yaml) under orb.policies. No external sources or credentials are required.

This guide covers running orb-agent with local code changes.

NetBox Labs designates the following weekly upgrade windows specifically to upgrade the version of NetBox and NetBox components for NetBox Cloud customers on Tuesdays and Thursdays. These upgrade windows are used for patch, minor, and major upgrades to NetBox. Customers are assigned to one of these windows based on their time zone.

Available Metrics

Available Metrics

Synchronize DHCP scopes, exclusion ranges, reservations, and leases from Microsoft Windows Server DHCP into NetBox. Automatically maps scopes to prefixes, exclusion ranges to IP ranges, and reservations and leases to IP addresses.

This document provides answers to commonly asked questions about the NetBox Microsoft DHCP integration.

Microsoft DHCP to NetBox Object Mapping

Synchronize DNS records from Microsoft Windows Server DNS into NetBox. Automatically ingests A and AAAA records as IP addresses from forward-lookup zones on your Windows DNS servers.

This document provides answers to commonly asked questions about the NetBox Microsoft DNS integration.

Microsoft DNS to NetBox Object Mapping

Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise

Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise

Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise

Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise

Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise

This guide explains how to configure single sign-on (SSO) support for NetBox Enterprise using Microsoft Entra ID (formerly Azure Active Directory) as an authentication backend.

Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise

Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise

Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise

Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

NetBox Asset Lifecycle plugin for procurement and equipment lifecycle management

NetBox Assurance automatically detects operational drift between your intended network design (documented in NetBox) and your actual network infrastructure. It continuously monitors network and infrastructure, comparing your intended design against real-world infrastructure to uncover discrepancies and provide proactive remediation capabilities.

NetBox Assurance automatically detects operational drift between your intended network design (documented in NetBox) and your actual network infrastructure. It continuously monitors network and infrastructure, comparing your intended design against real-world infrastructure to uncover discrepancies and provide proactive remediation capabilities.

NetBox Assurance automatically detects operational drift between your intended network design (documented in NetBox) and your actual network infrastructure. It continuously monitors network and infrastructure, comparing your intended design against real-world infrastructure to uncover discrepancies and provide proactive remediation capabilities.

This guide will help you set up, configure, and start using NetBox Assurance to maintain accurate network documentation and proactive drift detection. Follow these steps to go from installation to your first operational workflow.

NetBox Assurance automatically detects operational drift between your intended network design (documented in NetBox) and your actual network infrastructure. It continuously monitors network and infrastructure, comparing your intended design against real-world infrastructure to uncover discrepancies and provide proactive remediation capabilities.

The NetBox Assurance plugin provides a comprehensive web interface within NetBox for monitoring network drift, viewing deviation reports, and managing remediation workflows. This guide covers the interface features, navigation, and operational workflows for day-to-day use of NetBox Assurance.

The NetBox Assurance plugin provides a comprehensive web interface within NetBox for monitoring network drift, viewing deviation reports, and managing remediation workflows. This guide covers the interface features, navigation, and operational workflows for day-to-day use of NetBox Assurance.

The NetBox Assurance plugin provides a comprehensive web interface within NetBox for monitoring network drift, viewing deviation reports, and managing remediation workflows. This guide covers the interface features, navigation, and operational workflows for day-to-day use of NetBox Assurance.

The NetBox Assurance plugin provides a comprehensive web interface within NetBox for monitoring network drift, viewing deviation reports, and managing remediation workflows. This guide covers the interface features, navigation, and operational workflows for day-to-day use of NetBox Assurance.

NetBox is the world's leading source of truth for network infrastructure, featuring an extensive and complex data model. But sometimes it can be challenging to orchestrate changes, especially when working within a large team. This plugin introduces a new paradigm for NetBox to help overcome these challenges: branching.

This document describes the underlying architecture and best practices for using NetBox Branching effectively.

This document describes the underlying architecture and best practices for using NetBox Branching effectively.

This document describes the underlying architecture and best practices for using NetBox Branching effectively.

This guidance applies to NetBox Branching version 0.7.3 and previous versions.

This guidance applies to NetBox Branching version 0.7.3 and previous versions.

Change management support with policy and workflow controls for NetBox

This is the accurate, 100% validated connectivity architecture diagram for NetBox Cloud.

This is the accurate, 100% validated connectivity architecture diagram for NetBox Cloud.

This is the accurate, 100% validated connectivity architecture diagram for NetBox Cloud.

This is the accurate, 100% validated connectivity architecture diagram for NetBox Cloud.

You should already have access to the NetBox Labs Console when you sign up for NetBox Cloud.

You should already have access to the NetBox Labs Console when you sign up for NetBox Cloud.

You should already have access to the NetBox Labs Console when you sign up for NetBox Cloud.

You should already have access to the NetBox Labs Console when you sign up for NetBox Cloud.

Welcome to NetBox Cloud - the fully-managed SaaS version of NetBox that eliminates infrastructure complexity while providing enterprise-grade network documentation and automation capabilities.

Welcome to NetBox Cloud - the fully-managed SaaS version of NetBox that eliminates infrastructure complexity while providing enterprise-grade network documentation and automation capabilities.

Welcome to NetBox Cloud - the fully-managed SaaS version of NetBox that eliminates infrastructure complexity while providing enterprise-grade network documentation and automation capabilities.

Welcome to NetBox Cloud - the fully-managed SaaS version of NetBox that eliminates infrastructure complexity while providing enterprise-grade network documentation and automation capabilities.

Features and capabilities exclusive to NetBox Cloud

Features and capabilities exclusive to NetBox Cloud

Features and capabilities exclusive to NetBox Cloud

Features and capabilities exclusive to NetBox Cloud

1. From within the NetBox Labs Console click on Settings and then Hostnames Manager in the left-hand main menu to view the settings for your Organization:

1. From within the NetBox Labs Console click on Settings and then Hostnames Manager in the left-hand main menu to view the settings for your Organization:

1. From within the NetBox Labs Console click on Settings and then Hostnames Manager in the left-hand main menu to view the settings for your Organization:

1. From within the NetBox Labs Console click on Settings and then Hostnames Manager in the left-hand main menu to view the settings for your Organization:

From within the NetBox Labs Console, you can view installed Plugins for a specific NetBox instance in addition to their Scope and Version.

From within the NetBox Labs Console, you can easily view installed NetBox Cloud Plugins, along with their Scope and Version number. Simply follow these steps:

From within the NetBox Labs Console, you can easily view installed NetBox Cloud Plugins, along with their Scope and Version number. Simply follow these steps:

From within the NetBox Labs Console, you can easily view installed NetBox Cloud Plugins, along with their Scope and Version number. Simply follow these steps:

From within the NetBox Labs Console, you can easily view installed NetBox Cloud Plugins, along with their Scope and Version number. Simply follow these steps:

Configure SAML-based Single Sign-On (SSO) for NetBox Cloud. Set up your Identity Provider, configure entity IDs, assertion URLs, and enable secure authentication for your users.

Configure SAML-based Single Sign-On (SSO) for NetBox Cloud. Set up your Identity Provider, configure entity IDs, assertion URLs, and enable secure authentication for your users.

Configure SAML-based Single Sign-On (SSO) for NetBox Cloud. Set up your Identity Provider, configure entity IDs, assertion URLs, and enable secure authentication for your users.

Overview

To invite a new user to a NetBox Cloud Free instance, the user will need to have a valid email address, and be added as an administrator in the NetBox Labs Console.

Console Access

Console Access

Console Access

Console Access

Create and manage API keys for authenticating with the NetBox Cloud API

NetBox Validation REST API and agentic integration

Use the NetBox Cloud API to request, retrieve, and restore backups

Authenticate requests to the NetBox Cloud API using API keys

This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture.

This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture.

Configure multi-region deployment for NetBox Cloud Premium Tier with automatic failover for high availability. Learn about architecture, replication, disaster recovery procedures, and monitoring strategies.

This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture.

Reference for all built-in NetBox Validation checks

Programmatic access to NetBox Cloud platform operations via API keys

These connectivity options are no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture.

This guide covers administrative tasks for the NetBox Labs Console, including managing administrator accounts and console settings.

Policies, rules, runs, results, findings, and compliance scores in NetBox Validation

Real-time event streaming from NetBox Cloud to AWS SNS and Azure Service Bus

Frequently asked questions about NetBox Validation

Run your first NetBox Validation policy and review results

Upgrade your Single Sign-On experience with Group Mapping for Microsoft Entra ID SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Entra ID Single Sign-On, streamlines the synchronization of group memberships from Microsoft Entra ID to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Microsoft Entra ID SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Entra ID Single Sign-On, streamlines the synchronization of group memberships from Microsoft Entra ID to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Microsoft Entra ID SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Entra ID Single Sign-On, streamlines the synchronization of group memberships from Microsoft Entra ID to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Microsoft Entra ID SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Entra ID Single Sign-On, streamlines the synchronization of group memberships from Microsoft Entra ID to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Upgrade your Single Sign-On experience with Group Mapping for Microsoft Entra ID SSO – a smarter, more secure way to manage user access. The Group Mapping feature for Entra ID Single Sign-On, streamlines the synchronization of group memberships from Microsoft Entra ID to groups in NetBox Cloud, allowing you to align your user access efficiently and accurately.

Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable for the majority of use cases and environments:

This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Entra ID (formerly Azure Active Directory) as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Entra ID (formerly Azure Active Directory) as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Entra ID (formerly Azure Active Directory) as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Entra ID (formerly Azure Active Directory) as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Entra ID (formerly Azure Active Directory) as an authentication backend.

Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward

Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward

Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward

Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward

Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward

You should already have access to the NetBox Labs Console when you sign up for NetBox Cloud.

Welcome to NetBox Cloud - the fully-managed SaaS version of NetBox that eliminates infrastructure complexity while providing enterprise-grade network documentation and automation capabilities.

Features and capabilities exclusive to NetBox Cloud

The NetBox Cloud Free Plan is perfect for small networks, lab environments, and targeted use cases. It includes up to 100 devices, 500 IP addresses, 10k API requests/month, and 2 operational branches.

The NetBox Cloud Free Plan is perfect for small networks, lab environments, and targeted use cases. It includes up to 100 devices, 500 IP addresses, 10k API requests/month, and 2 operational branches.

The NetBox Cloud Free Plan is perfect for small networks, lab environments, and targeted use cases. It includes up to 100 devices, 500 IP addresses, 10k API requests/month, and 2 operational branches.

The NetBox Cloud Free Plan is perfect for small networks, lab environments, and targeted use cases. It includes up to 100 devices, 500 IP addresses, 10k API requests/month, and 2 operational branches.

The NetBox Cloud Free Plan is perfect for small networks, lab environments, and targeted use cases. It includes up to 100 devices, 500 IP addresses, 10k API requests/month, and 2 operational branches.

1. From within the NetBox Labs Console click on Settings and then navigate to the Hostnames tab.

Configure SAML-based Single Sign-On (SSO) for NetBox Cloud. Set up your Identity Provider, configure entity IDs, assertion URLs, and enable secure authentication for your users.

Curated catalog of device types across hundreds of vendors, browsable and importable from NetBox Cloud

NetBox Validation overview - policy-based validation for NetBox data, configs, and infrastructure graphs

Understand how permissions work for the NetBox Cloud API

Managed MCP server that connects AI agents and copilots to the NetBox Labs platform on NetBox Cloud

Pre-built starter and compliance framework policy packs

This document provides information about NetBox Cloud connectivity, including required ports and network architecture for integrating your infrastructure with NetBox Cloud.

You can secure access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to Prefix Lists, which can then be applied to NetBox instances to control which source IPs your instances will accept connections from.

Read-only REST API serving NetBox data from an independent cache with sub-50ms latency

Policy design and scaling recommendations for large deployments

High-performance bulk data API for NetBox with 5,000-25,000 rows/sec throughput

To safely and easily upgrade your NetBox Cloud instance without worrying about any plugin compatibility issues, follow the steps outlined below:

Intent, config, and graph validation engines

These connectivity options are no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture.

Pre-change validation, continuous compliance, and finding management workflows

Data integrity and security is a primary focus at NetBox Labs, and with our robust NetBox database backup features, you can rest assured that your data remains secure and easily recoverable. Scheduled backups take place automatically and all backups are encrypted at rest and in transit to offsite storage. From within the NetBox Labs Console, you can easily access and manage the backups of your NetBox Cloud database, and are able to perform the following actions:

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox administrators to extend the NetBox data model without writing a line of code.

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox Discovery is an advanced network discovery and observability solution designed to simplify documenting your network and help detect network drift. It extends NetBox by providing automated network and device discovery capabilities through the orb-agent, a lightweight and scalable discovery component.

This guide will help you set up and start using NetBox Discovery to ingest network data into NetBox. The setup process varies depending on your NetBox deployment type.

This guide will help you set up and start using NetBox Discovery to ingest network data into NetBox. The setup process varies depending on your NetBox deployment type.

This guide will help you set up and start using NetBox Discovery to ingest network data into NetBox. The setup process varies depending on your NetBox deployment type.

This guide will help you set up and start using NetBox Discovery to ingest network data into NetBox. The setup process varies depending on your NetBox deployment type.

NetBox Discovery is an advanced network discovery and observability solution designed to simplify documenting your network and help detect network drift. It extends NetBox by providing automated network and device discovery capabilities through the orb-agent, a lightweight and scalable discovery component.

NetBox Discovery is an advanced network discovery and observability solution designed to simplify documenting your network and help detect network drift. It extends NetBox by providing automated network and device discovery capabilities through the orb-agent, a lightweight and scalable discovery component.

NetBox Discovery is an advanced network discovery and observability solution designed to simplify documenting your network and help detect network drift. It extends NetBox by providing automated network and device discovery capabilities through the orb-agent, a lightweight and scalable discovery component.

Overview

NetBox Enterprise provides a simplified installation and upgrade process for self-hosted NetBox deployments. Includes advanced features, integrations, and professional support not available in the community edition.

Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.

<!-- HELM_HIDDEN

This guide covers backup procedures for Embedded Cluster deployments. For Helm deployments, see Helm Backups.

Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.

Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.

Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.

Place the following in configuration overrides python section

You should be able to follow these instructions for installing NetBox Enterprise in most environments.

Step-by-step guide for installing NetBox Enterprise Embedded Cluster

Step-by-step guide for installing NetBox Enterprise Embedded Cluster

You should be able to follow these instructions for installing NetBox Enterprise in most environments.

Step-by-step guide for installing NetBox Enterprise Embedded Cluster

Step-by-step guide for installing NetBox Enterprise Embedded Cluster

Self-hosted NetBox distribution for deploying NetBox in your own infrastructure

Self-hosted NetBox distribution for deploying NetBox in your own infrastructure

Self-hosted NetBox distribution with simplified installation, enterprise features, and professional support

Self-hosted NetBox distribution with simplified installation, enterprise features, and professional support

Host system requirements

Host system requirements

Tested Versions

RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

Tested Versions

RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

Ubuntu-specific preparation steps. See the main requirements document for general requirements and special cases.

Ubuntu-specific preparation steps. See the main requirements document for general requirements and special cases.

Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

Required Information

Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setup, see Storage Options.

Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setup, see Storage Options.

Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setup, see Storage Options.

Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setup, see Storage Options.

Multi-Node NetBox Enterprise requires external S3-compatible object storage for shared media files, image uploads, and custom plugin files. This guide covers storage providers, bucket setup, CORS configuration, and troubleshooting.

Multi-Node NetBox Enterprise requires external S3-compatible object storage for shared media files, image uploads, and custom plugin files. This guide covers storage providers, bucket setup, CORS configuration, and troubleshooting.

Multi-Node NetBox Enterprise requires external S3-compatible object storage for shared media files, image uploads, and custom plugin files. This guide covers storage providers, bucket setup, CORS configuration, and troubleshooting.

Multi-Node NetBox Enterprise requires external S3-compatible object storage for shared media files, image uploads, and custom plugin files. This guide covers storage providers, bucket setup, CORS configuration, and troubleshooting.

Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations

Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations

Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations

Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations

Diagnostic procedures and solutions for common NetBox Enterprise issues

Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support

Extend NetBox Enterprise with custom plugins using wheelhouse archives, delivered via PVC or S3 storage

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation

Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise

Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

This guide covers backup procedures for Embedded Cluster deployments. For Helm deployments, see Helm Backups.

Step-by-step guide for installing NetBox Enterprise Embedded Cluster

Self-hosted NetBox distribution for deploying NetBox in your own infrastructure

RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation

Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setup, see Storage Options.

Multi-Node NetBox Enterprise requires external S3-compatible object storage for shared media files, image uploads, and custom plugin files. This guide covers storage providers, bucket setup, CORS configuration, and troubleshooting.

Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations

Configure and use the AI-powered Private Copilot assistant in NetBox Enterprise

Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers

Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise

Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider

tls-and-ingress-accessing-netbox-enterprise\}

NetBox Ansible Collection - Quick Start

Acceptance

Configure and use the AI-powered Private Copilot assistant in NetBox Enterprise

The network discovery backend leverages NMAP to scan networks and discover IP information.

Orb network discovery backend, which is a wrapper over NMAP scanner.

This model serves as a proxy for NetBox's native ObjectChange model.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend.

This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend.

Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers

Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers

Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers

Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers

Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers

The opentelemetry_infinity backend embeds the OpenTelemetry Infinity process inside Orb Agent to run manageable and policy-driven otel-collector-contrib instances. Each Orb policy will spin up a new otelcol-contrib process running the configuration provided by the policy.

Orb agent is a component of the NetBox Discovery solution. It provides network discovery and observability capabilities and is developed by NetBox Labs.

See AGENTS.md for the contributor & agent guide — repo architecture,

This is the canonical guide for both humans and coding agents (Claude Code,

Orb discovery backends collection

Some environments require all outbound traffic to leave the network through a corporate forward proxy. Orb Agent's outbound connection to your Diode target (used to send discovered data to NetBox) honors the standard proxy environment variables, so no extra configuration flags are required.

The pktvisor backend embeds the pktvisord process inside Orb Agent to run deep packet analytics, active probes, and streaming aggregations directly at the edge. Pktvisor policies let you decide which network taps to activate, which analyzers to run, and how the resulting metrics are exported to your observability stack.

This guide is for authors of NetBox plugins who want their models to work correctly within branches.

PO Line Items - NetBox Asset Lifecycle data model reference

Change management policies for NetBox Change Management

Policy rules for NetBox Change Management policies

The portable schema feature allows Custom Object Type (COT) definitions to be exported as

This document provides information about NetBox Cloud connectivity, including required ports and network architecture for integrating your infrastructure with NetBox Cloud.

This document provides information about NetBox Cloud connectivity, including required ports and network architecture for integrating your infrastructure with NetBox Cloud.

This document provides information about NetBox Cloud connectivity, including required ports and network architecture for integrating your infrastructure with NetBox Cloud.

You can secure access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to Prefix Lists, which can then be applied to NetBox instances to control which source IPs your instances will accept connections from.

You can secure access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to Prefix Lists, which can then be applied to NetBox instances to control which source IPs your instances will accept connections from.

You can secure access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to Prefix Lists, which can then be applied to NetBox instances to control which source IPs your instances will accept connections from.

You can secure access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to Prefix Lists, which can then be applied to NetBox instances to control which source IPs your instances will accept connections from.

Table of Contents

Table of Contents

The Proxmox VE integration is currently experimental and is not yet available for customer preview. Contact product@netboxlabs.com if you would like to be notified when this is available to preview.

This document provides answers to commonly asked questions about the NetBox Proxmox VE integration.

Proxmox VE to NetBox Object Mapping

Traffic Originating From NetBox Cloud

Traffic Originating From NetBox Cloud

Traffic Originating From NetBox Cloud

Traffic Originating From NetBox Cloud

Traffic Originating From NetBox Cloud

Purchase Orders - NetBox Asset Lifecycle data model reference

Purchasing - NetBox Asset Lifecycle feature guide

Python API client library for NetBox.

This guide walks through the basics of using pynetbox to interact with NetBox.

Nbl Custom Legacy Worker

Nbl Custom Worker

This page outlines the steps to prepare and publish a new pynetbox release. The package version is derived from the git tag at release time by setuptoolsscm, so the source tree does not carry a hardcoded version in setup.py.

Release notes for NetBox Labs CMDB Integration v2.0.0.

Release notes for NetBox Labs CMDB Integration v2.0.0.

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Version 7.8.0 (June 18, 2026)

0.5.3

This page documents the classes that wrap responses returned by NetBox: Record (a single object) and RecordSet (a lazy collection of records).

The NetBox Custom Objects plugin exposes full CRUD operations through the standard NetBox REST API, rooted at /api/plugins/custom-objects/. The root of the API lists endpoints for Custom Object Types, Custom Object Type Fields, the linked-objects helper, and a dynamically generated endpoint for each Custom Object Type you have defined:

Once a branch has been merged, it is generally no longer needed and can no longer be activated. However, occasionally you may find it necessary to undo the changes from a branch (due to an error or some other undesired state). This can be done by reverting the branch. Only merged branches can be reverted.

Review model for NetBox Change Management workflow

Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise

Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise

Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise

Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise

Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise

Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider

Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider

Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider

Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider

Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider

Reporting a Vulnerability

Reporting a Vulnerability

Reporting a Vulnerability

Overview and versioned documentation for the NetBox ServiceNow integration (v2.0.0).

Overview and versioned documentation for the NetBox ServiceNow integration (v2.0.0).

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Shipment Line Items - NetBox Asset Lifecycle data model reference

Shipments - NetBox Asset Lifecycle feature guide

Shipments - NetBox Asset Lifecycle data model reference

The SNMP discovery backend leverages SNMP (Simple Network Management Protocol) to connect to network devices and collect network information.

The SNMP discovery backend uses an intelligent six-tier priority system to automatically determine interface types. This system provides zero-configuration support for common network equipment while allowing fine-grained customization through user-defined patterns.

This page lists the vendors with bundled device model coverage for the SNMP discovery backend.

Orb snmp discovery backend, which is a wrapper over NMAP scanner.

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Spare Items - NetBox Asset Lifecycle data model reference

Spares Management - NetBox Asset Lifecycle feature guide

Spares Pools - NetBox Asset Lifecycle data model reference

The device discovery backend supports advanced SSH scenarios through NAPALM's sshconfigfile optional argument. This guide covers connecting to network devices through jumphost/bastion servers, custom ProxyCommand configurations, and VRF-aware SSH connections.

Status Transition Rules - NetBox Asset Lifecycle data model reference

Status Transitions - NetBox Asset Lifecycle feature guide

Syncing a Branch

Data model, tables, synchronization behavior, and logging details for v2.0.0.

Data model, tables, synchronization behavior, and logging details for v2.0.0.

NetBox Enterprise Installs

NetBox Enterprise Installs

NetBox Enterprise Installs

NetBox Enterprise Installs

NetBox Enterprise Installs

NetBox Enterprise Installs

To safely and easily upgrade your NetBox Cloud instance without worrying about any plugin compatibility issues, follow the steps outlined below:

To safely and easily upgrade your NetBox Cloud instance without worrying about any plugin compatibility issues, follow the steps outlined below:

To safely and easily upgrade your NetBox Cloud instance without worrying about any plugin compatibility issues, follow the steps outlined below:

To safely and easily upgrade your NetBox Cloud instance without worrying about any plugin compatibility issues, follow the steps outlined below:

Special upgrade instructions when migrating from v1.x

Special upgrade instructions when migrating from v1.x

ServiceNow navigation, parameters, and operational guidance for v2.0.0.

ServiceNow navigation, parameters, and operational guidance for v2.0.0.

NetBox Docker is not officially supported by NetBox Labs. This page is intended as a minimal guide to getting branching working on NetBox Docker. For additional configuration options, please consult the NetBox Docker documentation.

As of version 0.4.0, Custom Objects is compatible with NetBox Branching, but not yet fully supported. Users can safely run both plugins together, but there are some caveats to be aware of. See below for how each Custom Objects model interacts with NetBox Branching.

As of version 0.4.0 Custom Objects is compatible with NetBox Branching, but not fully supported. This means that users can safely use both plugins together, but there are some caveats to be aware of. See below to learn how each of the Custom Objects models interacts with NetBox Branching.

This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion operations.

NetBox Asset Lifecycle release notes and changelog

Diagnostic procedures and solutions for common NetBox Enterprise issues

Extend NetBox Enterprise with custom plugins using wheelhouse archives, delivered via PVC or S3 storage

Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise

The Orb Agent can integrate with HashiCorp Vault to securely manage sensitive information such as passwords and API keys. This feature allows you to reference secrets stored in Vault directly in your policy configurations without hardcoding sensitive values.

Vendor Accounts - NetBox Asset Lifecycle data model reference

Vendors - NetBox Asset Lifecycle data model reference

This page documents the special methods available on Virtualization models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint reference.

Synchronize VMware vCenter virtual infrastructure into NetBox Discovery. Automatically imports datacenters, clusters, virtual machines, and resource management data for unified visibility.

This document provides answers to commonly asked questions about the NetBox VMware vCenter integration.

VMware vCenter to NetBox Object Mapping

In many cases where cloud connectivity options seem necessary, NetBox Cloud offers features that can address your needs without additional setup. In the majority of cases Internet Delivery (Single Region) is the most appropriate connectivity option, but there are some general recommendations depending on your use case:

In many cases where cloud connectivity options seem necessary, NetBox Cloud offers features that can address your needs without additional setup. In the majority of cases Internet Delivery (Single Region) is the most appropriate connectivity option, but there are some general recommendations depending on your use case:

In many cases where cloud connectivity options seem necessary, NetBox Cloud offers features that can address your needs without additional setup. In the majority of cases Internet Delivery (Single Region) is the most appropriate connectivity option, but there are some general recommendations depending on your use case:

In many cases where cloud connectivity options seem necessary, NetBox Cloud offers features that can address your needs without additional setup. In the majority of cases Internet Delivery (Single Region) is the most appropriate connectivity option, but there are some general recommendations depending on your use case:

Orb worker backend - allow running custom Backend implementations

The worker backend allows to run custom implementation as part of Orb Agent.

Within the NetBox Labs Console you can access the backups of your NetBox Cloud database, and are able to perform the following actions:

Within the NetBox Labs Console you can access the backups of your NetBox Cloud database, and are able to perform the following actions:

Within the NetBox Labs Console you can access the backups of your NetBox Cloud database, and are able to perform the following actions:

Within the NetBox Labs Console you can access the backups of your NetBox Cloud database, and are able to perform the following actions: