Skip to main content

438 docs tagged with "Enterprise"

Documentation specific to NetBox Enterprise deployments and features

View all tags

Agent Configuration File (agent.yaml)

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.

Air-Gapped Appliance

Deploy NetBox Enterprise as a pre-built VM appliance for air-gapped environments with no internet connectivity

Air-Gapped Appliance

Deploy NetBox Enterprise as a pre-built VM appliance for air-gapped environments with no internet connectivity

Architecture

Component topology, operator reconciliation flow, and data flow diagrams

Backups

Velero backup and restore for NetBox Enterprise Helm deployments

Branch Events

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.

Branches

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.

Branching Plugin

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.

Built-in Plugins in NetBox Enterprise

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.

Built-in Plugins in NetBox Enterprise (v1.10)

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.

Change Diffs

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.

Change Log

Release notes and changelog for NetBox Change Management

Circuits

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

Cisco ACI Integration

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

Cisco Catalyst Center Integration

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.

Comments

Comment model for NetBox Change Management reviews

Complete Deployment Guide

End-to-end production deployment walkthrough covering all components — CRDs, operator, PostgreSQL, Redis, Diode, TLS, monitoring, and backups

Configuration Parameters

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:

Core

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

Core Classes

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

Creating a Branch

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.

Custom Objects Plugin

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//.

Custom Plugins

Install custom NetBox plugins in Helm deployments using wheelhouse archives via media directory, PVC, or S3

CyberArk Secrets Manager (beta)

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.

DCIM

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

Delinea Secret Server Secrets Manager (beta)

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.

Development

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.

Device Discovery

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

Device Discovery - Interface Type Matching

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.

Device Discovery — Supported Platforms

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.

Diode

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.

Diode SDK Go

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

Diode SDK Python

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

Doppler Secrets Manager

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

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

Environment-Driven Configuration

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.

Event Rules

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.

Event Streams

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

Event Streams

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

Event Streams (v1.12)

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

Example Manifests

Ready-to-use NetBoxEnterprise resource manifests for Helm deployments

Example Manifests

Ready-to-use NetBoxEnterprise resource manifests for Helm deployments

Exceptions

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.

Extensions

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.

External Database

Step-by-step guide to connecting NetBox Enterprise to an external PostgreSQL database

Getting Started

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

Getting Started with NetBox Assurance (v1.12)

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.

Getting Started with NetBox Assurance (v1.13)

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.

Getting Started with NetBox Assurance (v1.13)

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.

Git

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

gNMI Discovery

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.

gnmi-discovery

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.

Infoblox NIOS Integration

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

Ingress & TLS

Configure ingress controllers, TLS certificates, and custom CA chains

Installing Custom NetBox Plugins

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.

Installing Custom NetBox Plugins (v1.10)

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.

IPAM

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

Jira Assets Integration

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

Known issues

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

Known issues

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

Known Issues

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

LDAP Authentication

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

LDAP Authentication

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

LDAP Authentication

Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP

Linux Root-Level Changes

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 /.

Linux Root-Level Changes

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

Linux Root-Level Changes

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

Linux Root-Level Changes

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

Linux Root-Level Changes (v1.10)

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 /.

Local

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

Maintenance Mode

Safely take NetBox offline for database operations, backups, and repairs

Microsoft DHCP Integration

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.

Microsoft DNS Integration

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.

Migrating to 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 to 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 to 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 to 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 to 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 to NetBox Enterprise (v1.10)

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 to S3-Compatible Storage

NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external S3-compatible object storage. This guide explains how to migrate from local storage to S3-compatible storage.

Migrating to S3-Compatible Storage

NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external S3-compatible object storage. This guide explains how to migrate from local storage to S3-compatible storage.

Migrating to S3-Compatible Storage

NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external S3-compatible object storage. This guide explains how to migrate from local storage to S3-compatible storage.

Migrating to S3-Compatible Storage (v1.13)

NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external S3-compatible object storage. This guide explains how to migrate from local storage to S3-compatible storage.

Monitoring

Configure Prometheus metrics, ServiceMonitor, and health check endpoints

NetBox Assurance (v1.12)

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 (v1.13)

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 (v1.13)

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: Getting Started with NetBox Assurance

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: NetBox Assurance

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: Using the NetBox Assurance UI

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 Assurance: Using the NetBox Assurance UI

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 Assurance: Using the NetBox Assurance UI

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 Assurance: Using the NetBox Assurance UI

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 Branching

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.

NetBox Configuration

Configure NetBox application replicas, workers, resources, and application settings

NetBox Custom Objects

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 Custom Objects

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 Custom Objects

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 Custom Objects

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 (v1.12)

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: NetBox Discovery

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: NetBox Discovery

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: NetBox Discovery

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 Enterprise (v1.12)

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.

NetBox Enterprise Backups

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

NetBox Enterprise Backups

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

NetBox Enterprise Multi-Node Deployment

NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. This provides zero-downtime maintenance, automatic failover, and horizontal scaling.

NetBox Enterprise Multi-Node Deployment

NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. This provides zero-downtime maintenance, automatic failover, and horizontal scaling.

NetBox Enterprise Multi-Node Deployment (v1.13)

NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. This provides zero-downtime maintenance, automatic failover, and horizontal scaling.

NetBox Enterprise Multi-Node Deployment (v1.14)

NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. This provides zero-downtime maintenance, automatic failover, and horizontal scaling.

NetBox Enterprise Storage Installation

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

NetBox Enterprise Storage Installation

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

NetBox Enterprise Storage Installation

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

NetBox Enterprise 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.

NetBox Enterprise 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.

NetBox Enterprise 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.

NetBox Enterprise Storage Options (v1.13)

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.

NetBox Enterprise: Migrating to 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.

NetBox Enterprise: Migrating to S3-Compatible Storage

NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external S3-compatible object storage. This guide explains how to migrate from local storage to S3-compatible storage.

NetBox Enterprise: NetBox Enterprise Multi-Node Deployment

NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. This provides zero-downtime maintenance, automatic failover, and horizontal scaling.

NetBox Enterprise: NetBox Enterprise 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.

Network Discovery

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

network-discovery

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

Object Changes

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

OpenTelemetry Infinity

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 - the NetBox Discovery agent

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

orb-agent

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

Outbound Proxy Support

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.

Pktvisor

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.

Plugin Development Guide

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

Policies

Change management policies for NetBox Change Management

Policy Rules

Policy rules for NetBox Change Management policies

Portable Schema

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

Prerequisites

System requirements, tooling, and access needed before installing NetBox Enterprise

Prerequisites

System requirements, tooling, and access needed before installing NetBox Enterprise

Proxmox VE Integration

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.

Quick Start

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

Quickstart

Get NetBox Enterprise running on Kubernetes in 5 minutes

Quickstart

Get NetBox Enterprise running on Kubernetes in 5 minutes

README

Nbl Custom Legacy Worker

Release Checklist

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

Release notes for NetBox Labs CMDB Integration v2.0.0.

Release notes

Release notes for NetBox Labs CMDB Integration v2.0.0.

Release Notes

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Release Notes

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Release Notes

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Response

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

REST API

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:

Reverting a Branch

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.

Reviews

Review model for NetBox Change Management workflow

SAML Group Mapping

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

SAML Group Mapping

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

SAML Group Mapping

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

SAML Group Mapping (v1.12)

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

SAML Group Mapping (v1.13)

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

SAML Single Sign-On

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

SAML Single Sign-On

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

SAML Single Sign-On

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

Security

RBAC modes, pod security, TLS configuration, and network policies

SNMP Discovery

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

SNMP Discovery - Interface Type Matching

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.

snmp-discovery

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

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.4.012

SSH Configuration and Jumphost Support for Device Discovery

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 & Conditions

NetBoxEnterprise status fields, condition types, and component health reference

Troubleshooting

Common issues, diagnostic commands, and health check reference

Upgrading

Upgrade procedures for the netbox-enterprise Helm chart

User Guide

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

User Guide

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

Using Branching with NetBox Docker

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.

Using NetBox Custom Objects with NetBox Branching

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.

Using NetBox Custom Objects 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.

Using the REST API

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

Vault Secrets Manager

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.

Virtualization

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

VMware vCenter Integration

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

worker

Orb worker backend - allow running custom Backend implementations

Worker

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