Advanced NetBox Enterprise Helm Deployment
Advanced deployment scenarios, private registries, and automation for NetBox Enterprise Helm
Documentation specific to NetBox Enterprise deployments and features
View all tagsAdvanced deployment scenarios, private registries, and automation for NetBox Enterprise Helm
NetBox Enterprise is designed to harness the power of Kubernetes while minimizing the amount of work the average person needs to manage it.
Branch operations, such as syncing and merging, are tracked as events. This record of events serves as a history for each branch.
A branch represents a divergent state from the main database.
The NetBox branching plugin allows you to create and work with branches in NetBox, similar to version control systems. This enables you to make changes in isolation and merge them back to the main branch when ready.
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.
A change diff summarized all changes to particular NetBox object within a branch. It serves to simplify the process of reviewing changes within a branch, and avoids the need to review successive individual changes which might otherwise prove tedious.
v0.6.0
Release notes and changelog for NetBox Change Management
Change request model for NetBox Change Management workflow
For the list of changelog, please see the repository releases information in GitHub.
Overview
Troubleshooting
Comment reply model for NetBox Change Management reviews
Comment model for NetBox Change Management reviews
exempt_models
Plugin configuration parameters for NetBox Change Management
Setting up Group Mapping for SAML requires the base SAML SSO Setup to be configured and working first.
First, navigate to Branching > Branches to view the list of any existing branches. Click the "Add" button at top right to create a new branch.
Custom sessions can be used to modify the default HTTP behavior. Below are a few examples, most of them from here.
Thanks for your interest in contributing to pynetbox! This introduction covers a few important things to know before you get started.
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 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.
handler: python
Installation Issues
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 get started with development on pynetbox. It covers setting up your development environment and running tests.
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.
You can view an on-demand Webinar Getting Started with Network Test Automation: NetBox + pyATS hosted by NetBox Labs.
This guide will help you set up and start using the Catalyst Center Integration for NetBox.
ServiceNow Integration Overview
NetBox Labs Documentation
Before Starting
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.
handler: python
1. In the Admin Console for NetBox Enterprise, navigate to the Config tab and scroll to the bottom to check Advanced Settings
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 /.
Available Metrics
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.
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 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 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.
Change management support with policy and workflow controls for NetBox
AI-powered assistant for exploring, understanding, and acting on your NetBox data
Learn how to enable and start using NetBox Copilot in your environment
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
1.10.1/1.10.2
Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.
Place the following in configuration overrides python section
NetBox Labs Documentation
NetBox Labs Documentation
NetBox Labs Documentation
NetBox Labs Documentation
NetBox Labs Documentation
Comprehensive installation guides and configuration files for deploying NetBox Enterprise on Kubernetes using Helm
You should be able to follow these instructions for installing NetBox Enterprise in most environments.
Host system requirements
Tested Versions
Ubuntu-specific preparation steps. See the main requirements document for general requirements and special cases.
Required Information
NetBox Ansible Collection - Quick Start
This model serves as a proxy for NetBox's native ObjectChange model.
NetBox Labs Documentation
Change management policies for NetBox Change Management
Policy rules for NetBox Change Management policies
NetBox Labs Documentation
Table of Contents
Python API client library for NetBox.
TL;DR
This document outlines the steps required to prepare and publish a new release of pynetbox.
handler: python
handler: python
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 an otherwise undesired state). This can be done by reverting the branch. Only merged branches can be reverted.
Review model for NetBox Change Management workflow
Reporting a Vulnerability
Reporting a Vulnerability
Device
Syncing a Branch
This document provides a comprehensive mapping of Cisco Catalyst Center object types to their corresponding NetBox object types, based on the integration implementation.
New Tables in ServiceNow
NetBox Enterprise Installs
Distribution and Installation
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.
This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion operations.
Documentation for NetBox Cloud, Enterprise, Discovery & Assurance, and Integrations.