Advanced Tools and Troubleshooting
NetBox Enterprise is designed to harness the power of Kubernetes while minimizing the amount of work the average person needs to manage it.
Kubernetes deployments, kubectl commands, and container orchestration
View all tagsNetBox Enterprise is designed to harness the power of Kubernetes while minimizing the amount of work the average person needs to manage it.
Custom scripting was introduced to provide a way for users to execute custom logic from within the NetBox UI. Custom scripts enable the user to directly and conveniently manipulate NetBox data in a prescribed fashion. They can be used to accomplish myriad tasks, such as:
The Diode project is currently in Public Preview. Please see NetBox Labs Product and Feature Lifecycle for more details.
reference architecture
Before getting started
This guide will help you set up and start using Diode to ingest data into NetBox.
Complete setup and configuration guide for NetBox Discovery across Cloud, Enterprise, and Community deployments with step-by-step instructions
Setting up a Development Environment
NetBox
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.
IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formation, and much more.
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 /.
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.
ADMINS
Comprehensive overview of the NetBox Cloud Administrative Console interface, features, and sections including deployment, database, and monitoring panels.
Advanced network discovery and observability solution for automated network documentation and drift detection across all NetBox deployments
Overview
1.10.1/1.10.2
Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.
Overview of NetBox Enterprise Helm installation methods and architecture
System requirements and prerequisites for NetBox Enterprise Helm installation
Troubleshooting guide for NetBox Enterprise Helm installation issues
Comprehensive Helm installation guides for NetBox Enterprise
Configuration guide for customizing NetBox Enterprise Helm deployment using values-extra.yaml
You should be able to follow these instructions for installing NetBox Enterprise in most environments.
Kubernetes dependencies
System requirements
Host system requirements
Tested Versions
v2.0.10 (2017-07-14)
v2.2.10 (2018-02-21)
v2.8.9 (2020-08-04)
v3.0.12 (2021-12-06)
v3.3.10 (2022-12-13)
v3.5.9 (2023-08-28)
v4.0.11 (2024-09-03)
v4.1.11 (2025-01-06)
v4.2.9 (2025-04-30)
This section covers operational procedures for NetBox Enterprise.
This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installation, the general approach outlined here works just as well for adding new data to existing NetBox deployments.
Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can introduce their own models and views, but cannot interfere with existing components. A NetBox user may opt to install plugins provided by the community or build his or her own.
Looking to try NetBox Discovery as quickly and easily as possible? The Quickstart Guide on the NetBox Labs blog has you covered! In a few commands you will install and pre-configure everything you need to start experimenting:
ALLOWED_HOSTS
What is a REST API?
BASE_PATH
NetBox Enterprise Installs
Distribution and Installation
Upgrading NetBox to a new version is pretty simple, however users are cautioned to always review the release notes and save a backup of their current deployment prior to beginning an upgrade.
This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here.