NetBox Documentation
Initializing search
netbox-community/netbox
NetBox Documentation
netbox-community/netbox
Introduction
Features
Features
Facilities
Devices & Cabling
Power Tracking
IPAM
VLAN Management
L2VPN & Overlay
Circuits
Wireless
Virtualization
VPN Tunnels
Tenancy
Contacts
Search
Context Data
Configuration Rendering
Synchronized Data
Change Logging
Journaling
Event Rules
Notifications
Background Jobs
Auth & Permissions
API & Integration
Customization
Installation & Upgrade
Installation & Upgrade
Installing NetBox
1. PostgreSQL
2. Redis
3. NetBox
4a. Gunicorn
4b. uWSGI
5. HTTP Server
6. LDAP (Optional)
Upgrading NetBox
Getting Started
Getting Started
Planning
Populating Data
Configuration
Configuration
Configuring NetBox
Required Parameters
System
Security
GraphQL API
Remote Authentication
Data & Validation
Default Values
Error Reporting
Plugins
Miscellaneous
Development
Customization
Customization
Custom Fields
Custom Links
Custom Validation
Export Templates
Reports
Custom Scripts
Integrations
Integrations
REST API
GraphQL API
Webhooks
Synchronized Data
Prometheus Metrics
Plugins
Plugins
About Plugins
Installing a Plugin
Removing a Plugin
Developing Plugins
Developing Plugins
Getting Started
Models
Views
Navigation
Templates
Tables
Forms
Filters & Filter Sets
Search
Event Types
Data Backends
REST API
GraphQL API
Background Jobs
Dashboard Widgets
Exceptions
Migrating to v4.0
Administration
Administration
Authentication
Authentication
Overview
Google
Microsoft Entra ID
Okta
Permissions
Error Reporting
Housekeeping
Replicating NetBox
NetBox Shell
Data Model
Data Model
Circuits
Circuits
Circuit
CircuitGroup
CircuitGroupAssignment
Circuit Termination
Circuit Type
Provider
Provider Account
Provider Network
Virtual Circuit
Virtual Circuit Termination
Virtual Circuit Type
Core
Core
DataFile
DataSource
Job
DCIM
DCIM
Cable
ConsolePort
ConsolePortTemplate
ConsoleServerPort
ConsoleServerPortTemplate
Device
DeviceBay
DeviceBayTemplate
DeviceRole
DeviceType
FrontPort
FrontPortTemplate
Interface
InterfaceTemplate
InventoryItem
InventoryItemRole
InventoryItemTemplate
Location
MACAddress
Manufacturer
Module
ModuleBay
ModuleBayTemplate
ModuleType
ModuleTypeProfile
Platform
PowerFeed
PowerOutlet
PowerOutletTemplate
PowerPanel
PowerPort
PowerPortTemplate
Rack
RackReservation
RackRole
RackType
RearPort
RearPortTemplate
Region
Site
SiteGroup
VirtualChassis
VirtualDeviceContext
Extras
Extras
Bookmark
ConfigContext
ConfigTemplate
CustomField
CustomFieldChoiceSet
CustomLink
EventRule
ExportTemplate
ImageAttachment
JournalEntry
Notification
NotificationGroup
SavedFilter
Subscription
TableConfig
Tag
Webhook
IPAM
IPAM
ASN
ASNRange
Aggregate
FHRPGroup
FHRPGroupAssignment
IPAddress
IPRange
Prefix
RIR
Role
RouteTarget
Service
ServiceTemplate
VLAN
VLANGroup
VLANTranslationPolicy
VLANTranslationRule
VRF
Tenancy
Tenancy
Contact
ContactGroup
ContactRole
Tenant
TenantGroup
Virtualization
Virtualization
Cluster
ClusterGroup
ClusterType
VMInterface
VirtualDisk
VirtualMachine
VPN
VPN
IKEPolicy
IKEProposal
IPSecPolicy
IPSecProfile
IPSecProposal
L2VPN
L2VPNTermination
Tunnel
TunnelGroup
TunnelTermination
Wireless
Wireless
WirelessLAN
WirelessLANGroup
WirelessLink
Reference
Reference
Filtering
Conditions
Markdown
Development
Development
Introduction
Getting Started
Style Guide
Models
Adding Models
Extending Models
Signals
Search
Application Registry
User Preferences
Web UI
Internationalization
Translations
Release Checklist
git Cheat Sheet
Release Notes
Release Notes
Summary
Version 4.3
Version 4.2
Version 4.1
Version 4.0
Version 3.7
Version 3.6
Version 3.5
Version 3.4
Version 3.3
Version 3.2
Version 3.1
Version 3.0
Version 2.11
Version 2.10
Version 2.9
Version 2.8
Version 2.7
Version 2.6
Version 2.5
Version 2.4
Version 2.3
Version 2.2
Version 2.1
Version 2.0
404 - Not found