# Docs - NetBox Asset Lifecycle - [NetBox Asset Lifecycle](/docs/asset-lifecycle): NetBox Asset Lifecycle is a NetBox plugin that tracks the full procurement lifecycle for network and IT equipment - from planning through purchasing, shippin... - [Releases](/docs/asset-lifecycle/releases): Migrations have been reinitialized from scratch for this release. Upgrading from any v0.2.x release is not supported. Prior releases were intended for evalua... - Features - [Features](/docs/asset-lifecycle/features): NetBox Asset Lifecycle bridges the gap between NetBox's inventory model and the real-world process of acquiring equipment. It lets infrastructure teams drive... - [Bills of Materials](/docs/asset-lifecycle/features/bills-of-materials): A Bill of Materials (BOM) captures everything that needs to be acquired for a project - every device, module, rack, and cable, with quantities. It is the bri... - [Purchasing](/docs/asset-lifecycle/features/purchasing): Once a BOM has been approved, the next step is to place orders with one or more vendors. The Purchasing area of the plugin records who you buy from, what you... - [Shipments](/docs/asset-lifecycle/features/shipments): A shipment records the physical delivery of equipment against a purchase order. The Shipments area of the plugin tracks who is delivering each consignment, h... - [Spares Management](/docs/asset-lifecycle/features/spares): Most organisations keep some equipment in reserve - boxed switches in a storeroom, transceivers in a parts cabinet, cables on a shelf. The Spares Management ... - [Status Transitions](/docs/asset-lifecycle/features/status-transitions): Every BOM, purchase order, and shipment in the plugin has a status that indicates where it sits in its lifecycle. Status transition rules govern which change... - Models - [Models](/docs/asset-lifecycle/models): Models documentation - [Assets](/docs/asset-lifecycle/models/asset): An asset is a junction between a BOM and an individual NetBox object (a rack, device, module, or cable) gathered by the BOM's scope rules. The set of assets ... - [Bills of Materials](/docs/asset-lifecycle/models/bom): A bill of materials (BOM) lists all equipment required to implement an installation. Each BOM is composed of multiple line items, where each line item record... - [BOM Line Items](/docs/asset-lifecycle/models/bomlineitem): A BOM line item represents a unique item on a BOM and the quantity required. Each line item references a specific type - a rack type, device type, module typ... - [BOM Scope Rules](/docs/asset-lifecycle/models/bomscoperule): A BOM scope rule filters objects in NetBox to determine which should be included in (or excluded from) the scope of a BOM. Each rule references one or more o... - [Cable Types](/docs/asset-lifecycle/models/cabletype): A cable type captures a unique combination of cable medium, profile, and end connectors, providing a canonical reference for cables modeled in NetBox. NetBox... - [Couriers](/docs/asset-lifecycle/models/courier): A courier is a shipping provider responsible for delivering equipment ordered from a vendor. Each shipment is associated with exactly one courier. A courier ... - [Courier Accounts](/docs/asset-lifecycle/models/courieraccount): A courier account represents a specific billing account held with a courier. An organization may maintain multiple accounts with a single courier; each shipm... - [PO Line Items](/docs/asset-lifecycle/models/polineitem): A purchase order line item records the quantity and price of a particular BOM line item on a purchase order. Each BOM line item may appear at most once on a ... - [Purchase Orders](/docs/asset-lifecycle/models/purchaseorder): A purchase order records equipment ordered from a vendor to fulfill the requirements of a BOM. A single BOM may be fulfilled by one or more purchase orders -... - [Shipments](/docs/asset-lifecycle/models/shipment): A shipment records the delivery of equipment against a purchase order. Each shipment is dispatched by a single courier and may include any number of line ite... - [Shipment Line Items](/docs/asset-lifecycle/models/shipmentlineitem): A shipment line item records the quantity of a particular BOM line item included in a shipment. Each shipment line item tracks both the quantity sent by the ... - [Spare Items](/docs/asset-lifecycle/models/spareitem): A spare item represents one or more units of a specific type and variant assigned to a spares pool. Items in a pool can be drawn upon to fulfill assets witho... - [Spare Item Allocations](/docs/asset-lifecycle/models/spareitemallocation): A spare item allocation defines the minimum and/or maximum quantity of a specific item type and variant that a spares pool is expected to hold. Allocations a... - [Spares Pools](/docs/asset-lifecycle/models/sparespool): A spares pool is a collection of spare equipment held in reserve at a specific site or location. Each pool groups related spare items for a particular storag... - [Status Transition Rules](/docs/asset-lifecycle/models/statustransitionrule): A status transition rule permits a specific change of status for a supported object type. The plugin consults these rules when the status of a BOM, purchase ... - [Vendors](/docs/asset-lifecycle/models/vendor): A vendor is a supplier from which equipment is purchased. Each purchase order is associated with exactly one vendor. A vendor may have any number of accounts... - [Vendor Accounts](/docs/asset-lifecycle/models/vendoraccount): A vendor account represents a specific billing account held with a vendor. An organization may maintain multiple accounts with a single vendor (for example, ... - NetBox Asset Lifecycle - [NetBox Asset Lifecycle](/docs/asset-lifecycle/v0.1): NetBox Asset Lifecycle is a NetBox plugin that tracks the full procurement lifecycle for network and IT equipment - from planning through purchasing, shippin... - [v0.1](/docs/asset-lifecycle/v0.1/releases) - Features - [Features](/docs/asset-lifecycle/v0.1/features): NetBox Asset Lifecycle bridges the gap between NetBox's inventory model and the real-world process of acquiring equipment. It lets infrastructure teams drive... - [Bills of Materials](/docs/asset-lifecycle/v0.1/features/bills-of-materials): A Bill of Materials (BOM) captures everything that needs to be acquired for a project - every device, module, rack, and cable, with quantities. It is the bri... - [Purchasing](/docs/asset-lifecycle/v0.1/features/purchasing): Once a BOM has been approved, the next step is to place orders with one or more vendors. The Purchasing area of the plugin records who you buy from, what you... - [Shipments](/docs/asset-lifecycle/v0.1/features/shipments): A shipment records the physical delivery of equipment against a purchase order. The Shipments area of the plugin tracks who is delivering each consignment, h... - [Spares Management](/docs/asset-lifecycle/v0.1/features/spares): Most organisations keep some equipment in reserve - boxed switches in a storeroom, transceivers in a parts cabinet, cables on a shelf. The Spares Management ... - [Status Transitions](/docs/asset-lifecycle/v0.1/features/status-transitions): Every BOM, purchase order, and shipment in the plugin has a status that indicates where it sits in its lifecycle. Status transition rules govern which change... - Models - [Models](/docs/asset-lifecycle/v0.1/models): Models documentation - [Bills of Materials](/docs/asset-lifecycle/v0.1/models/bom): A bill of materials (BOM) lists all equipment required to implement an installation. Each BOM is composed of multiple line items, where each line item record... - [BOM Line Items](/docs/asset-lifecycle/v0.1/models/bomlineitem): A BOM line item represents a unique item on a BOM and the quantity required. Each line item references a specific type - a rack type, device type, module typ... - [BOM Objects](/docs/asset-lifecycle/v0.1/models/bomobject): A BOM object is a junction between a BOM and an individual NetBox object (a rack, device, module, or cable) gathered by the BOM's scope rules. The set of BOM... - [BOM Scope Rules](/docs/asset-lifecycle/v0.1/models/bomscoperule): A BOM scope rule filters objects in NetBox to determine which should be included in (or excluded from) the scope of a BOM. Each rule references one or more o... - [Cable Types](/docs/asset-lifecycle/v0.1/models/cabletype): A cable type captures a unique combination of cable medium and profile, providing a canonical reference for cables modeled in NetBox. NetBox does not ship a ... - [Couriers](/docs/asset-lifecycle/v0.1/models/courier): A courier is a shipping provider responsible for delivering equipment ordered from a vendor. Each shipment is associated with exactly one courier. A courier ... - [Courier Accounts](/docs/asset-lifecycle/v0.1/models/courieraccount): A courier account represents a specific billing account held with a courier. An organization may maintain multiple accounts with a single courier; each shipm... - [PO Line Items](/docs/asset-lifecycle/v0.1/models/polineitem): A purchase order line item records the quantity and price of a particular BOM line item on a purchase order. Each BOM line item may appear at most once on a ... - [Purchase Orders](/docs/asset-lifecycle/v0.1/models/purchaseorder): A purchase order records equipment ordered from a vendor to fulfill the requirements of a BOM. A single BOM may be fulfilled by one or more purchase orders -... - [Shipments](/docs/asset-lifecycle/v0.1/models/shipment): A shipment records the delivery of equipment against a purchase order. Each shipment is dispatched by a single courier and may include any number of line ite... - [Shipment Line Items](/docs/asset-lifecycle/v0.1/models/shipmentlineitem): A shipment line item records the quantity of a particular BOM line item included in a shipment. Each shipment line item tracks both the quantity sent by the ... - [Spare Items](/docs/asset-lifecycle/v0.1/models/spareitem): A spare item represents one or more units of a specific type and variant assigned to a spares pool. Items in a pool can be drawn upon to fulfill BOM objects ... - [Spares Pools](/docs/asset-lifecycle/v0.1/models/sparespool): A spares pool is a collection of spare equipment held in reserve at a specific site or location. Each pool groups related spare items for a particular storag... - [Status Transition Rules](/docs/asset-lifecycle/v0.1/models/statustransitionrule): A status transition rule permits a specific change of status for a supported object type. The plugin consults these rules when the status of a BOM, purchase ... - [Vendors](/docs/asset-lifecycle/v0.1/models/vendor): A vendor is a supplier from which equipment is purchased. Each purchase order is associated with exactly one vendor. A vendor may have any number of accounts... - [Vendor Accounts](/docs/asset-lifecycle/v0.1/models/vendoraccount): A vendor account represents a specific billing account held with a vendor. An organization may maintain multiple accounts with a single vendor (for example, ... - NetBox Asset Lifecycle - [NetBox Asset Lifecycle](/docs/asset-lifecycle/v0.2): NetBox Asset Lifecycle is a NetBox plugin that tracks the full procurement lifecycle for network and IT equipment - from planning through purchasing, shippin... - [Releases](/docs/asset-lifecycle/v0.2/releases) - Features - [Features](/docs/asset-lifecycle/v0.2/features): NetBox Asset Lifecycle bridges the gap between NetBox's inventory model and the real-world process of acquiring equipment. It lets infrastructure teams drive... - [Bills of Materials](/docs/asset-lifecycle/v0.2/features/bills-of-materials): A Bill of Materials (BOM) captures everything that needs to be acquired for a project - every device, module, rack, and cable, with quantities. It is the bri... - [Purchasing](/docs/asset-lifecycle/v0.2/features/purchasing): Once a BOM has been approved, the next step is to place orders with one or more vendors. The Purchasing area of the plugin records who you buy from, what you... - [Shipments](/docs/asset-lifecycle/v0.2/features/shipments): A shipment records the physical delivery of equipment against a purchase order. The Shipments area of the plugin tracks who is delivering each consignment, h... - [Spares Management](/docs/asset-lifecycle/v0.2/features/spares): Most organisations keep some equipment in reserve - boxed switches in a storeroom, transceivers in a parts cabinet, cables on a shelf. The Spares Management ... - [Status Transitions](/docs/asset-lifecycle/v0.2/features/status-transitions): Every BOM, purchase order, and shipment in the plugin has a status that indicates where it sits in its lifecycle. Status transition rules govern which change... - Models - [Models](/docs/asset-lifecycle/v0.2/models): Models documentation - [Bills of Materials](/docs/asset-lifecycle/v0.2/models/bom): A bill of materials (BOM) lists all equipment required to implement an installation. Each BOM is composed of multiple line items, where each line item record... - [BOM Line Items](/docs/asset-lifecycle/v0.2/models/bomlineitem): A BOM line item represents a unique item on a BOM and the quantity required. Each line item references a specific type - a rack type, device type, module typ... - [BOM Objects](/docs/asset-lifecycle/v0.2/models/bomobject): A BOM object is a junction between a BOM and an individual NetBox object (a rack, device, module, or cable) gathered by the BOM's scope rules. The set of BOM... - [BOM Scope Rules](/docs/asset-lifecycle/v0.2/models/bomscoperule): A BOM scope rule filters objects in NetBox to determine which should be included in (or excluded from) the scope of a BOM. Each rule references one or more o... - [Cable Types](/docs/asset-lifecycle/v0.2/models/cabletype): A cable type captures a unique combination of cable medium and profile, providing a canonical reference for cables modeled in NetBox. NetBox does not ship a ... - [Couriers](/docs/asset-lifecycle/v0.2/models/courier): A courier is a shipping provider responsible for delivering equipment ordered from a vendor. Each shipment is associated with exactly one courier. A courier ... - [Courier Accounts](/docs/asset-lifecycle/v0.2/models/courieraccount): A courier account represents a specific billing account held with a courier. An organization may maintain multiple accounts with a single courier; each shipm... - [PO Line Items](/docs/asset-lifecycle/v0.2/models/polineitem): A purchase order line item records the quantity and price of a particular BOM line item on a purchase order. Each BOM line item may appear at most once on a ... - [Purchase Orders](/docs/asset-lifecycle/v0.2/models/purchaseorder): A purchase order records equipment ordered from a vendor to fulfill the requirements of a BOM. A single BOM may be fulfilled by one or more purchase orders -... - [Shipments](/docs/asset-lifecycle/v0.2/models/shipment): A shipment records the delivery of equipment against a purchase order. Each shipment is dispatched by a single courier and may include any number of line ite... - [Shipment Line Items](/docs/asset-lifecycle/v0.2/models/shipmentlineitem): A shipment line item records the quantity of a particular BOM line item included in a shipment. Each shipment line item tracks both the quantity sent by the ... - [Spare Items](/docs/asset-lifecycle/v0.2/models/spareitem): A spare item represents one or more units of a specific type and variant assigned to a spares pool. Items in a pool can be drawn upon to fulfill BOM objects ... - [Spares Pools](/docs/asset-lifecycle/v0.2/models/sparespool): A spares pool is a collection of spare equipment held in reserve at a specific site or location. Each pool groups related spare items for a particular storag... - [Status Transition Rules](/docs/asset-lifecycle/v0.2/models/statustransitionrule): A status transition rule permits a specific change of status for a supported object type. The plugin consults these rules when the status of a BOM, purchase ... - [Vendors](/docs/asset-lifecycle/v0.2/models/vendor): A vendor is a supplier from which equipment is purchased. Each purchase order is associated with exactly one vendor. A vendor may have any number of accounts... - [Vendor Accounts](/docs/asset-lifecycle/v0.2/models/vendoraccount): A vendor account represents a specific billing account held with a vendor. An organization may maintain multiple accounts with a single vendor (for example, ... - Workflows - [Workflows](/docs/asset-lifecycle/v0.2/workflows): Workflows documentation - [Working with BOMs](/docs/asset-lifecycle/v0.2/workflows/bills-of-materials): The recommended workflow for creating bills of materials is to first populate the intended design in NetBox, and then employ scope rules to select the releva... - [Installing Objects](/docs/asset-lifecycle/v0.2/workflows/installation): An object associated with a bill of materials (BOM) can be marked as installed from a shipment or spares pool. - [Working with Purchase Orders](/docs/asset-lifecycle/v0.2/workflows/purchase-orders): One or more purchase orders can be generated from each approved BOM. - [Working with Shipments](/docs/asset-lifecycle/v0.2/workflows/shipments): Once a PO has been submitted for provisioning, you can start tracking shipments from the vendor. This will typically occur when a vendor advises you of a shi... - [Spares Management](/docs/asset-lifecycle/v0.2/workflows/spares-management): 1. Navigate to Asset Lifecycle > Spares Pools > Add. 2. Enter a unique name and select the site at which the pool is or will be located. 3. Assign a location... - Workflows - [Workflows](/docs/asset-lifecycle/workflows): Workflows documentation - [Working with BOMs](/docs/asset-lifecycle/workflows/bills-of-materials): A bill of materials (BOM) represents a collection of products (devices, modules, cables, etc.) to be ordered for installation. - [Installing Objects](/docs/asset-lifecycle/workflows/installation): Objects in NetBox can be recorded as having been sourced via a particular PO/shipment or from a spares pool. Note that this supported only for objects which ... - [Working with Purchase Orders](/docs/asset-lifecycle/workflows/purchase-orders): Purchase orders represent a collection of products to be ordered from a vendor, generated from a bill of materials. - [Working with Shipments](/docs/asset-lifecycle/workflows/shipments): Once a PO has been ordered, you can start tracking shipments from the vendor. This will typically occur when a vendor advises you of a shipment pertaining to... - [Spares Management](/docs/asset-lifecycle/workflows/spares-management): Equipment that is kept on standby for potential future use is managed by defining spares pools. - NetBox Assurance - [NetBox Assurance](/docs/assurance): NetBox Assurance automatically detects operational drift between your intended network design (documented in NetBox) and your actual network infrastructure. ... - [Getting Started with NetBox Assurance](/docs/assurance/getting-started): This guide will help you set up, configure, and start using NetBox Assurance to maintain accurate network documentation and proactive drift detection. Follow... - [Using the NetBox Assurance UI](/docs/assurance/using-the-ui): The NetBox Assurance plugin provides a comprehensive web interface within NetBox for monitoring network drift, viewing deviation reports, and managing remedi... - NetBox Branching - [NetBox Branching](/docs/branching): If you're familiar with git or similar version control systems, the concept of branching should be familiar. Essentially, this plugin allows you to make copi... - [NetBox Branching Best Practices](/docs/branching/best-practices): This document describes the underlying architecture and best practices for using NetBox Branching effectively. - [Change Log](/docs/branching/changelog): The main change for this version is a set of performance enhancements targeting branch provisioning. For large data sets we have seen up to a 4x reduction in... - [Configuration Parameters](/docs/branching/configuration): This page documents the configuration parameters specific to the NetBox Branching plugin. They are set under the netboxbranching key of NetBox's PLUGINSCONFI... - [Event Rules](/docs/branching/event-rules): When addbranchcontext is configured in NetBox's EVENTSPIPELINE (see Configuration), branch context is available throughout event rule processing. This applie... - [Using Branching with NetBox Docker](/docs/branching/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 additio... - [Plugin Development Guide](/docs/branching/plugin-development): This guide is for authors of NetBox plugins who want their models to work correctly within branches. - [Using the REST API](/docs/branching/rest-api): This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion opera... - Models - [Models](/docs/branching/models): Models documentation - [Branches](/docs/branching/models/branch): 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 ... - [Branch Events](/docs/branching/models/branchevent): Branch lifecycle operations (provisioning, syncing, merging, etc.) are recorded as branch events. The list of events associated with a branch serves as its o... - [Change Diffs](/docs/branching/models/changediff): 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... - [Object Changes](/docs/branching/models/objectchange): This model serves as a proxy for NetBox's native ObjectChange model. - Using Branches - [Using Branches](/docs/branching/using-branches): Using Branches documentation - [Creating a Branch](/docs/branching/using-branches/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. - [Reverting a Branch](/docs/branching/using-branches/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 c... - [Syncing & Merging Changes](/docs/branching/using-branches/syncing-merging): Synchronizing a branch replicates all recent changes from main into the branch. These changes can be reviewed under the Changes Behind tab of the branch view. - NetBox Branching - [NetBox Branching](/docs/branching/v0.6): If you're familiar with git or similar version control systems, the concept of branching should be familiar. Essentially, this plugin allows you to make copi... - [Change Log](/docs/branching/v0.6/changelog) - [Configuration Parameters](/docs/branching/v0.6/configuration): Default: [] (empty list) - [Using the REST API](/docs/branching/v0.6/rest-api): This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion opera... - Media - [Media](/docs/branching/v0.6/media): Media documentation - Screenshots - [Screenshots](/docs/branching/v0.6/media/screenshots): Screenshots documentation - Models - [Models](/docs/branching/v0.6/models): Models documentation - [Branches](/docs/branching/v0.6/models/branch): A branch represents a divergent state from the main database. - [Branch Events](/docs/branching/v0.6/models/branchevent): Branch operations, such as syncing and merging, are tracked as events. This record of events serves as a history for each branch. - [Change Diffs](/docs/branching/v0.6/models/changediff): 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... - [Object Changes](/docs/branching/v0.6/models/objectchange): This model serves as a proxy for NetBox's native ObjectChange model. - Using Branches - [Using Branches](/docs/branching/v0.6/using-branches): Using Branches documentation - [Creating a Branch](/docs/branching/v0.6/using-branches/creating-a-branch): 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. - [Reverting a Branch](/docs/branching/v0.6/using-branches/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 ... - [Syncing & Merging Changes](/docs/branching/v0.6/using-branches/syncing-merging): Synchronizing a branch replicates all recent changes from main into the branch. These changes can be reviewed under the "Changes Behind" tab under the branch... - NetBox Branching - [NetBox Branching](/docs/branching/v0.7): If you're familiar with git or similar version control systems, the concept of branching should be familiar. Essentially, this plugin allows you to make copi... - [NetBox Branching Best Practices](/docs/branching/v0.7/best-practices): This guidance applies to NetBox Branching version 0.7.3 and previous versions. - [Change Log](/docs/branching/v0.7/changelog) - [Configuration Parameters](/docs/branching/v0.7/configuration): Default: [] (empty list) - [Using Branching with NetBox Docker](/docs/branching/v0.7/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 additio... - [Using the REST API](/docs/branching/v0.7/rest-api): This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion opera... - Media - [Media](/docs/branching/v0.7/media): Media documentation - Screenshots - [Screenshots](/docs/branching/v0.7/media/screenshots): Screenshots documentation - Models - [Models](/docs/branching/v0.7/models): Models documentation - [Branches](/docs/branching/v0.7/models/branch): A branch represents a divergent state from the main database. - [Branch Events](/docs/branching/v0.7/models/branchevent): Branch operations, such as syncing and merging, are tracked as events. This record of events serves as a history for each branch. - [Change Diffs](/docs/branching/v0.7/models/changediff): 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... - [Object Changes](/docs/branching/v0.7/models/objectchange): This model serves as a proxy for NetBox's native ObjectChange model. - Using Branches - [Using Branches](/docs/branching/v0.7/using-branches): Using Branches documentation - [Creating a Branch](/docs/branching/v0.7/using-branches/creating-a-branch): 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. - [Reverting a Branch](/docs/branching/v0.7/using-branches/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 ... - [Syncing & Merging Changes](/docs/branching/v0.7/using-branches/syncing-merging): Synchronizing a branch replicates all recent changes from main into the branch. These changes can be reviewed under the "Changes Behind" tab under the branch... - NetBox Branching - [NetBox Branching](/docs/branching/v0.8): If you're familiar with git or similar version control systems, the concept of branching should be familiar. Essentially, this plugin allows you to make copi... - [NetBox Branching Best Practices](/docs/branching/v0.8/best-practices): This document was last updated for NetBox Branching version 0.8.0. - [Change Log](/docs/branching/v0.8/changelog) - [Configuration Parameters](/docs/branching/v0.8/configuration): Default: [] (empty list) - [Using Branching with NetBox Docker](/docs/branching/v0.8/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 additio... - [Using the REST API](/docs/branching/v0.8/rest-api): This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion opera... - Media - [Media](/docs/branching/v0.8/media): Media documentation - Screenshots - [Screenshots](/docs/branching/v0.8/media/screenshots): Screenshots documentation - Models - [Models](/docs/branching/v0.8/models): Models documentation - [Branches](/docs/branching/v0.8/models/branch): A branch represents a divergent state from the main database. - [Branch Events](/docs/branching/v0.8/models/branchevent): Branch operations, such as syncing and merging, are tracked as events. This record of events serves as a history for each branch. - [Change Diffs](/docs/branching/v0.8/models/changediff): 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... - [Object Changes](/docs/branching/v0.8/models/objectchange): This model serves as a proxy for NetBox's native ObjectChange model. - Using Branches - [Using Branches](/docs/branching/v0.8/using-branches): Using Branches documentation - [Creating a Branch](/docs/branching/v0.8/using-branches/creating-a-branch): 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. - [Reverting a Branch](/docs/branching/v0.8/using-branches/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 ... - [Syncing & Merging Changes](/docs/branching/v0.8/using-branches/syncing-merging): Synchronizing a branch replicates all recent changes from main into the branch. These changes can be reviewed under the "Changes Behind" tab under the branch... - NetBox Branching - [NetBox Branching](/docs/branching/v0.9): If you're familiar with git or similar version control systems, the concept of branching should be familiar. Essentially, this plugin allows you to make copi... - [NetBox Branching Best Practices](/docs/branching/v0.9/best-practices): This document was last updated for NetBox Branching version 0.8.0. - [Change Log](/docs/branching/v0.9/changelog) - [Configuration Parameters](/docs/branching/v0.9/configuration): To include branch context in event rule processing, add the plugin's addbranchcontext function to NetBox's EVENTSPIPELINE setting before extras.events.proces... - [Event Rules](/docs/branching/v0.9/event-rules): When addbranchcontext is configured in NetBox's EVENTSPIPELINE (see configuration), branch context is available throughout event rule processing. This applie... - [Using Branching with NetBox Docker](/docs/branching/v0.9/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 additio... - [Plugin Development Guide](/docs/branching/v0.9/plugin-development): This guide is for authors of NetBox plugins who want their models to work correctly within branches. - [Using the REST API](/docs/branching/v0.9/rest-api): This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion opera... - Media - [Media](/docs/branching/v0.9/media): Media documentation - Screenshots - [Screenshots](/docs/branching/v0.9/media/screenshots): Screenshots documentation - Models - [Models](/docs/branching/v0.9/models): Models documentation - [Branches](/docs/branching/v0.9/models/branch): A branch represents a divergent state from the main database. - [Branch Events](/docs/branching/v0.9/models/branchevent): Branch operations, such as syncing and merging, are tracked as events. This record of events serves as a history for each branch. - [Change Diffs](/docs/branching/v0.9/models/changediff): 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... - [Object Changes](/docs/branching/v0.9/models/objectchange): This model serves as a proxy for NetBox's native ObjectChange model. - Using Branches - [Using Branches](/docs/branching/v0.9/using-branches): Using Branches documentation - [Creating a Branch](/docs/branching/v0.9/using-branches/creating-a-branch): 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. - [Reverting a Branch](/docs/branching/v0.9/using-branches/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 ... - [Syncing & Merging Changes](/docs/branching/v0.9/using-branches/syncing-merging): Synchronizing a branch replicates all recent changes from main into the branch. These changes can be reviewed under the "Changes Behind" tab under the branch... - NetBox Branching - [NetBox Branching](/docs/branching/v1.0): If you're familiar with git or similar version control systems, the concept of branching should be familiar. Essentially, this plugin allows you to make copi... - [NetBox Branching Best Practices](/docs/branching/v1.0/best-practices): This document describes the underlying architecture and best practices for using NetBox Branching effectively. - [Change Log](/docs/branching/v1.0/changelog) - [Configuration Parameters](/docs/branching/v1.0/configuration): This page documents the configuration parameters specific to the NetBox Branching plugin. They are set under the netboxbranching key of NetBox's PLUGINSCONFI... - [Event Rules](/docs/branching/v1.0/event-rules): When addbranchcontext is configured in NetBox's EVENTSPIPELINE (see Configuration), branch context is available throughout event rule processing. This applie... - [Using Branching with NetBox Docker](/docs/branching/v1.0/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 additio... - [Plugin Development Guide](/docs/branching/v1.0/plugin-development): This guide is for authors of NetBox plugins who want their models to work correctly within branches. - [Using the REST API](/docs/branching/v1.0/rest-api): This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion opera... - Media - [Media](/docs/branching/v1.0/media): Media documentation - Screenshots - [Screenshots](/docs/branching/v1.0/media/screenshots): Screenshots documentation - Models - [Models](/docs/branching/v1.0/models): Models documentation - [Branches](/docs/branching/v1.0/models/branch): 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 ... - [Branch Events](/docs/branching/v1.0/models/branchevent): Branch lifecycle operations (provisioning, syncing, merging, etc.) are recorded as branch events. The list of events associated with a branch serves as its o... - [Change Diffs](/docs/branching/v1.0/models/changediff): 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... - [Object Changes](/docs/branching/v1.0/models/objectchange): This model serves as a proxy for NetBox's native ObjectChange model. - Using Branches - [Using Branches](/docs/branching/v1.0/using-branches): Using Branches documentation - [Creating a Branch](/docs/branching/v1.0/using-branches/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. - [Reverting a Branch](/docs/branching/v1.0/using-branches/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 c... - [Syncing & Merging Changes](/docs/branching/v1.0/using-branches/syncing-merging): Synchronizing a branch replicates all recent changes from main into the branch. These changes can be reviewed under the Changes Behind tab of the branch view. - NetBox Changes - [NetBox Change Management](/docs/changes): This plugin adds change management support to NetBox. Leveraging the netbox-branching plugin, it implements policy and workflow controls to ensure proposed c... - [Administration Guide](/docs/changes/admin-guide): This guide covers setting up and managing change management for NetBox administrators. For a general overview of the change management workflow, see the Intr... - [Change Log](/docs/changes/changelog) - [Configuration Parameters](/docs/changes/configuration): The following plugin configuration parameters are available. These are set under PLUGINSCONFIG in your NetBox configuration.py: - [End-User Guide](/docs/changes/end-user-guide): This guide is for the two roles that take part in day-to-day change management: requesters, who stage changes in a branch and ask for review, and reviewers, ... - [Event Rules](/docs/changes/event-rules): The plugin registers custom event types that can be used with NetBox's event rules to trigger webhooks, scripts, or other actions in response to change manag... - [Integration Guide](/docs/changes/integration-guide): This guide covers how to integrate NetBox change management with external systems using webhooks, scripts, and the REST API. For a general overview of the ch... - [REST API](/docs/changes/rest-api): The plugin exposes a REST API under /api/plugins/changes/. All endpoints follow standard NetBox REST API conventions for filtering, pagination, and authentic... - Models - [Models](/docs/changes/models): Models documentation - [Change Requests](/docs/changes/models/changerequest): A change request is submitted to request approval of proposed changes in a branch before it can be merged. All rules of the assigned change policy must be me... - [Comments](/docs/changes/models/comment): As part of the review process, users can leave comments on change requests to ask questions or suggest changes. Each comment may start a thread of replies an... - [Comment Replies](/docs/changes/models/commentreply): Each comment on a change request starts a new discussion thread to which users can reply. This helps keep the discussion around a change request organized. - [Policies](/docs/changes/models/policy): A policy defines the conditions that must be met for a change request to be merged. Each policy defines one or more rules which assert these conditions. All ... - [Policy Rules](/docs/changes/models/policyrule): Each policy contains one or more rules which assert certain conditions that must be met for the policy to be met. For example, you might define a policy that... - [Reviews](/docs/changes/models/review): Reviews are submitted to approve, reject, or comment on a change request. The users eligible to review a particular change request are determined by its assi... - NetBox Change Management - [NetBox Change Management](/docs/changes/v0.4): This plugin adds change management support to NetBox. Leveraging the netbox-branching plugin, it implements policy and workflow controls to ensure proposed c... - [Change Log](/docs/changes/v0.4/changelog) - [Configuration Parameters](/docs/changes/v0.4/configuration): The following plugin configuration parameters are available. - Media - [Media](/docs/changes/v0.4/media): Media documentation - Models - [Models](/docs/changes/v0.4/models): Models documentation - [Change Requests](/docs/changes/v0.4/models/changerequest): A change request is submitted to request approval of proposed changes in a branch before it can be merged. All rules of the assigned change policy must be me... - [Comments](/docs/changes/v0.4/models/comment): As part of the review process, users can leave comments on change requests to ask question or suggest changes. Each comment may start a thread of replies and... - [Comment Replies](/docs/changes/v0.4/models/commentreply): Each comment on a change request starts a new discussion thread to which users can reply. This helps keep the discussion around a change request organized. - [Policies](/docs/changes/v0.4/models/policy): A policy defines the conditions that must be met for a change request to be merged. Each policy defines one or more rules which assert these conditions. All ... - [Policy Rules](/docs/changes/v0.4/models/policyrule): Each policy contains one or more rules which assert certain conditions that must be met for the policy to be met. For example, you might define a policy that... - [Reviews](/docs/changes/v0.4/models/review): Reviews are submitted to approve, reject, or comment on a change request. The users eligible to review a particular change request are determined by its assi... - NetBox Change Management - [NetBox Change Management](/docs/changes/v1.0): This plugin adds change management support to NetBox. Leveraging the netbox-branching plugin, it implements policy and workflow controls to ensure proposed c... - [Administration Guide](/docs/changes/v1.0/admin-guide): This guide covers setting up and managing change management for NetBox administrators. For a general overview of the change management workflow, see the Intr... - [Change Log](/docs/changes/v1.0/changelog) - [Configuration Parameters](/docs/changes/v1.0/configuration): The following plugin configuration parameters are available. These are set under PLUGINSCONFIG in your NetBox configuration.py: - [End-User Guide](/docs/changes/v1.0/end-user-guide): This guide is for the two roles that take part in day-to-day change management: requesters, who stage changes in a branch and ask for review, and reviewers, ... - [Event Rules](/docs/changes/v1.0/event-rules): The plugin registers custom event types that can be used with NetBox's event rules to trigger webhooks, scripts, or other actions in response to change manag... - [Integration Guide](/docs/changes/v1.0/integration-guide): This guide covers how to integrate NetBox change management with external systems using webhooks, scripts, and the REST API. For a general overview of the ch... - [REST API](/docs/changes/v1.0/rest-api): The plugin exposes a REST API under /api/plugins/changes/. All endpoints follow standard NetBox REST API conventions for filtering, pagination, and authentic... - Media - [Media](/docs/changes/v1.0/media): Media documentation - Models - [Models](/docs/changes/v1.0/models): Models documentation - [Change Requests](/docs/changes/v1.0/models/changerequest): A change request is submitted to request approval of proposed changes in a branch before it can be merged. All rules of the assigned change policy must be me... - [Comments](/docs/changes/v1.0/models/comment): As part of the review process, users can leave comments on change requests to ask questions or suggest changes. Each comment may start a thread of replies an... - [Comment Replies](/docs/changes/v1.0/models/commentreply): Each comment on a change request starts a new discussion thread to which users can reply. This helps keep the discussion around a change request organized. - [Policies](/docs/changes/v1.0/models/policy): A policy defines the conditions that must be met for a change request to be merged. Each policy defines one or more rules which assert these conditions. All ... - [Policy Rules](/docs/changes/v1.0/models/policyrule): Each policy contains one or more rules which assert certain conditions that must be met for the policy to be met. For example, you might define a policy that... - [Reviews](/docs/changes/v1.0/models/review): Reviews are submitted to approve, reject, or comment on a change request. The users eligible to review a particular change request are determined by its assi... - NetBox Cloud - [NetBox Cloud Documentation](/docs/cloud): Welcome to NetBox Cloud - the fully-managed SaaS version of NetBox that eliminates infrastructure complexity while providing enterprise-grade network documen... - Console administration - [Microsoft Entra ID Setup (formerly Azure Active Directory)](/docs/cloud/console-administration/azure-ad-sso-setup): This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Entra ID (formerly Azure Active Directory) as an authentic... - [Group Mapping For Microsoft Entra ID Single Sign-On (SSO)](/docs/cloud/console-administration/azure-group-mapping): 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 fe... - [NetBox Cloud Console Access](/docs/cloud/console-administration/console-access): You should already have access to the NetBox Labs Console when you sign up for NetBox Cloud. - [Console Administration](/docs/cloud/console-administration/console-administration): This guide covers administrative tasks for the NetBox Labs Console, including managing administrator accounts and console settings. - [NetBox Cloud Free Plan Features](/docs/cloud/console-administration/free-plan-features): 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 ... - [Add a New User to Free Plan](/docs/cloud/console-administration/free-plan-new-user): 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 C... - [NetBox Cloud Hostnames](/docs/cloud/console-administration/managing-hostnames): 1. From within the NetBox Labs Console click on Settings and then navigate to the Hostnames tab. - [NetBox Cloud Plugins](/docs/cloud/console-administration/netbox-cloud-plugins): From within the NetBox Labs Console, you can view installed Plugins for a specific NetBox instance in addition to their Scope and Version. - [Group Mapping For Okta Single Sign-On (SSO)](/docs/cloud/console-administration/okta-group-mapping): 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... - [Okta SSO Setup](/docs/cloud/console-administration/okta-sso-setup): This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend. - [Prefix Lists](/docs/cloud/console-administration/prefix-lists): 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 instanc... - [Public IP Addressing](/docs/cloud/console-administration/public-ip-addressing): The Public IP addresses that outbound traffic from your NetBox Cloud instance (eg. webhooks) will be seen to be originating from are listed below. This will ... - [Configuring SAML Group Mapping in NetBox Cloud](/docs/cloud/console-administration/saml-group-map): NetBox Cloud supports SAML-based authentication, including group mappings to enforce role-based access control. For group mapping, you will need to provide y... - [NetBox Cloud SAML Configuration Guide](/docs/cloud/console-administration/saml-sso-setup): 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. - [Upgrading NetBox Cloud](/docs/cloud/console-administration/upgrading-nbc): To safely and easily upgrade your NetBox Cloud instance without worrying about any plugin compatibility issues, follow the steps outlined below: - [Working with NetBox Cloud Database Backups](/docs/cloud/console-administration/working_with_database_backups): 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 remai... - Cloud API - [Cloud API](/docs/cloud/cloud-api): Programmatic access to NetBox Cloud platform operations via API keys - [API Keys](/docs/cloud/cloud-api/api-keys): Create and manage API keys for authenticating with the NetBox Cloud API - [API Reference - Backups](/docs/cloud/cloud-api/api-reference-backups): Use the NetBox Cloud API to request, retrieve, and restore backups - [Authentication](/docs/cloud/cloud-api/authentication): Authenticate requests to the NetBox Cloud API using API keys - [Permissions](/docs/cloud/cloud-api/permissions): Understand how permissions work for the NetBox Cloud API - NetBox Cloud Features - [NetBox Cloud Features](/docs/cloud/features): Features and capabilities exclusive to NetBox Cloud - [Event Streams](/docs/cloud/features/event-streams): Real-time event streaming from NetBox Cloud to AWS SNS and Azure Service Bus - [Replica Cache](/docs/cloud/features/replica-cache): Read-only REST API serving NetBox data from an independent cache - Cloud connectivity - [AWS Direct Connect (Multi-Region)](/docs/cloud/cloud-connectivity/aws-direct-connect-multi-region): This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture. - [AWS Direct Connect (Single Region)](/docs/cloud/cloud-connectivity/aws-direct-connect): This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture. - [AWS Private Link (Single Region)](/docs/cloud/cloud-connectivity/aws-private-link): This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture. - [Cloud Connectivity Frequently Asked Questions](/docs/cloud/cloud-connectivity/cloud-connectivity-faq): These connectivity options are no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture. - [Internet Delivery (Single Region)](/docs/cloud/cloud-connectivity/internet-delivery): Internet Delivery (Single Region) is the standard product offering for NetBox Cloud. It comes with extensive security features (see below) and is suitable fo... - [IPSEC VPN Tunnels (Single Region)](/docs/cloud/cloud-connectivity/ipsec-vpn-tunnels): This connectivity option is no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture. - [AWS Multi Region Failover](/docs/cloud/cloud-connectivity/multi-region-failover): 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 Connectivity Architecture Diagram (Mermaid)](/docs/cloud/cloud-connectivity/netbox-connectivity-diagram): This is the accurate, 100% validated connectivity architecture diagram for NetBox Cloud. - [Ports and Connectivity Architecture](/docs/cloud/cloud-connectivity/ports-and-connectivity-architecture): This document provides information about NetBox Cloud connectivity, including required ports and network architecture for integrating your infrastructure wit... - [Which Cloud Connectivity Option is Right for Me?](/docs/cloud/cloud-connectivity/which-connectivity-option): These connectivity options are no longer offered to new customers. For current connectivity information, see Ports and Connectivity Architecture. - Instance management - [Migrating to NetBox Cloud](/docs/cloud/instance-management/migrating-to-netbox-cloud): Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward process. Since NetBox Cloud is built... - NetBox Copilot - [NetBox Copilot](/docs/copilot): NetBox Copilot is an AI-powered assistant that embeds directly into your NetBox interface. It lets you interact with your network and infrastructure data usi... - [NetBox Copilot Quickstart Guide](/docs/copilot/quickstart): Get NetBox Copilot up and running in your NetBox instance in just a few minutes. - [NetBox Copilot Usage Guide](/docs/copilot/usage-guide): A guide to using NetBox Copilot effectively, including capabilities, best practices, troubleshooting, and frequently asked questions. - [Privacy & Security](/docs/copilot/privacy-security): NetBox Copilot is designed with security and privacy as core principles. This page explains how we collect, use, and protect your data. - NetBox Custom Objects - [NetBox Custom Objects](/docs/custom-objects): This documentation covers: - [Using NetBox Custom Objects with NetBox Branching](/docs/custom-objects/branching): When using Custom Objects together with NetBox Branching, the following minimum versions are required: - [Custom Object Field Attributes](/docs/custom-objects/field-attributes): The following attributes are available when creating or editing a Custom Object Type Field. - [GraphQL API](/docs/custom-objects/graphql): The NetBox Custom Objects plugin exposes custom objects through NetBox's GraphQL API at the standard /graphql/ endpoint, alongside NetBox's built-in models. ... - [Installation and Configuration](/docs/custom-objects/installation): Add the Python package to NetBox's running environment: - [Portable Schema](/docs/custom-objects/portable-schema): The portable schema feature allows Custom Object Type (COT) definitions to be exported as structured JSON documents, versioned in source control, and applied... - [Releases](/docs/custom-objects/releases): Custom Object Types and their instances now participate fully in NetBox branching workflows. COT schema changes (adding/removing fields, modifying field defi... - [REST API](/docs/custom-objects/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 A... - NetBox Custom Objects - [NetBox Custom Objects](/docs/custom-objects/v0.3): For additional documentation on the REST API, go here. - [Api](/docs/custom-objects/v0.3/api): The NetBox Custom Objects plugin provides CRUD operations through the standard NetBox API, with endpoints located at: /api/plugins/custom-objects/ - NetBox Custom Objects - [NetBox Custom Objects](/docs/custom-objects/v0.4): If you hit any problems please check the existing issues before creating a new one. If you're unsure, start a discussion. - [Api](/docs/custom-objects/v0.4/api): The NetBox Custom Objects plugin provides CRUD operations through the standard NetBox API, with endpoints located at: /api/plugins/custom-objects/ - [Using NetBox Custom Objects with NetBox Branching](/docs/custom-objects/v0.4/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, ... - [Changelog](/docs/custom-objects/v0.4/changelog): Custom Objects now has limited compatibility with NetBox Branching. Please see the documentation for more details. - [Configuration Parameters](/docs/custom-objects/v0.4/configuration): The maximum number of Custom Object Types that may be created. - NetBox Custom Objects - [NetBox Custom Objects](/docs/custom-objects/v0.5): This documentation covers: - [Using NetBox Custom Objects with NetBox Branching](/docs/custom-objects/v0.5/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 a... - [Custom Object Field Attributes](/docs/custom-objects/v0.5/field-attributes): The following attributes are available when creating or editing a Custom Object Type Field. - [Installation and Configuration](/docs/custom-objects/v0.5/installation): Add the Python package to NetBox's running environment: - [Portable Schema](/docs/custom-objects/v0.5/portable-schema): The portable schema feature allows Custom Object Type (COT) definitions to be exported as structured JSON documents, versioned in source control, and applied... - [Releases](/docs/custom-objects/v0.5/releases): Polymorphic Object and MultiObject fields now support a relatedname that exposes a working reverse accessor on the target model instance (e.g. site.coinstanc... - [REST API](/docs/custom-objects/v0.5/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 A... - Diode - [Diode](/docs/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 so... - [Getting Started with Diode](/docs/diode/getting-started): This guide will help you set up and start using Diode to ingest data into NetBox. - [Protocol Documentation](/docs/diode/diode-proto) - Protobuf - [Protobuf](/docs/diode/protobuf): Protobuf documentation - [Protocol Documentation](/docs/diode/protobuf/diode-proto) - [Metrics](/docs/diode/metrics): Diode's telemetry implementation supports multiple configuration methods and exporters. - Observability - [Observability](/docs/diode/observability): Observability documentation - [Metrics](/docs/diode/observability/metrics): Diode's telemetry implementation supports multiple configuration methods and exporters. - [NetBox Limited Use License 1.0](/docs/diode/license): In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses. - NetBox Discovery - [NetBox Discovery](/docs/discovery): NetBox Discovery is an advanced network discovery and observability solution designed to simplify documenting your network and help detect network drift. It ... - [Get Started with NetBox Discovery](/docs/discovery/getting-started): 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 deploy... - Discovery Agent - [Discovery Agent](/docs/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. - [Configuration Samples](/docs/discovery/agent/config_samples): Here is a collection of configuration samples supported by orb agent - Advanced Config - [Advanced Config](/docs/discovery/agent/advanced_config): Advanced Config documentation - [Environment-Driven Configuration](/docs/discovery/agent/advanced_config/env_config): 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... - [Outbound Proxy Support](/docs/discovery/agent/advanced_config/outbound_proxy): Some environments require all outbound traffic to leave the network through a corporate forward proxy. Orb Agent's outbound connection to your Diode target (... - Backends - [Backends](/docs/discovery/agent/backends): Backends documentation - [gNMI Discovery](/docs/discovery/agent/backends/gnmi_discovery): The gNMI discovery backend is an event-driven network discovery service that maintains long-lived gNMI subscriptions and ingests device, interface, and hardw... - [Network Discovery](/docs/discovery/agent/backends/network_discovery): The network discovery backend leverages NMAP to scan networks and discover IP information. - [OpenTelemetry Infinity](/docs/discovery/agent/backends/opentelemetry_infinity): The opentelemetryinfinity backend embeds the OpenTelemetry Infinity process inside Orb Agent to run manageable and policy-driven otel-collector-contrib insta... - [Pktvisor](/docs/discovery/agent/backends/pktvisor): The pktvisor backend embeds the pktvisord process inside Orb Agent to run deep packet analytics, active probes, and streaming aggregations directly at the ed... - [Worker](/docs/discovery/agent/backends/worker): The worker backend allows to run custom implementation as part of Orb Agent. - Device Discovery - [Device Discovery](/docs/discovery/agent/backends/device_discovery): The device discovery backend leverages NAPALM to connect to network devices and collect network information. - [Device Discovery - Interface Type Matching](/docs/discovery/agent/backends/device_discovery/interface): The device discovery backend uses an intelligent five-tier priority system to automatically determine interface types. This system provides zero-configuratio... - [SSH Configuration and Jumphost Support for Device Discovery](/docs/discovery/agent/backends/device_discovery/ssh): The device discovery backend supports advanced SSH scenarios through NAPALM's sshconfigfile optional argument. This guide covers connecting to network device... - [Device Discovery - Supported Platforms](/docs/discovery/agent/backends/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) ... - SNMP Discovery - [SNMP Discovery](/docs/discovery/agent/backends/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](/docs/discovery/agent/backends/snmp_discovery/interface): The SNMP discovery backend uses an intelligent six-tier priority system to automatically determine interface types. This system provides zero-configuration s... - [SNMP Discovery - Supported Platforms](/docs/discovery/agent/backends/snmp_discovery/supported_platforms): This page lists the vendors with bundled device model coverage for the SNMP discovery backend. - Configs - [Configs](/docs/discovery/agent/configs): Configs documentation - [Agent Configuration File (agent.yaml)](/docs/discovery/agent/configs/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, whi... - [Git](/docs/discovery/agent/configs/git): The Git configuration manager outlines a policy management system where an agent fetches policies from a Git repository. - [Local](/docs/discovery/agent/configs/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. - Secretsmgr - [Secretsmgr](/docs/discovery/agent/secretsmgr): Secretsmgr documentation - [CyberArk Secrets Manager (beta)](/docs/discovery/agent/secretsmgr/cyberark): The Orb Agent can integrate with CyberArk Privileged Access Manager (PAM) via the Central Credential Provider (CCP) to retrieve secrets at runtime. This feat... - [Delinea Secret Server Secrets Manager (beta)](/docs/discovery/agent/secretsmgr/delinea): The Orb Agent can integrate with Delinea Secret Server (both Secret Server Cloud and on-prem / Platform) to securely manage sensitive information such as pas... - [Doppler Secrets Manager](/docs/discovery/agent/secretsmgr/doppler): The Orb Agent can integrate with Doppler to securely manage sensitive information such as passwords and API keys. This feature allows you to reference secret... - [Vault Secrets Manager](/docs/discovery/agent/secretsmgr/vault): The Orb Agent can integrate with HashiCorp Vault to securely manage sensitive information such as passwords and API keys. This feature allows you to referenc... - NetBox Enterprise - [NetBox Enterprise Overview](/docs/enterprise): Self-hosted NetBox distribution for deploying NetBox in your own infrastructure - Embedded cluster - [NetBox Enterprise Installation](/docs/enterprise/embedded-cluster/nbe-ec-installation): Step-by-step guide for installing NetBox Enterprise Embedded Cluster - [Linux Root-Level Changes](/docs/enterprise/embedded-cluster/nbe-ec-linux-changes): Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/embedded-cluster/nbe-ec-requirements-rhel): RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/embedded-cluster/nbe-ec-requirements-ubuntu): Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise System Requirements](/docs/enterprise/embedded-cluster/nbe-ec-requirements): Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations - [High Availability](/docs/enterprise/embedded-cluster/nbe-ha-requirements): What high availability is in NetBox Enterprise, what it requires, and how a multi-node cluster behaves on node or availability-zone loss - [Migrating to NetBox Enterprise](/docs/enterprise/embedded-cluster/nbe-migrating): 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 pla... - [NetBox Enterprise Multi-Node Deployment](/docs/enterprise/embedded-cluster/nbe-multi-node): NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. Thi... - [NetBox Enterprise Storage Installation](/docs/enterprise/embedded-cluster/nbe-storage-installation): Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setu... - [Migrating to S3-Compatible Storage](/docs/enterprise/embedded-cluster/nbe-storage-migration): NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external... - [NetBox Enterprise Storage Options](/docs/enterprise/embedded-cluster/nbe-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... - [Topology-Aware Node Labels](/docs/enterprise/embedded-cluster/nbe-topology-labels): Tag Embedded Cluster nodes with topology labels (topology.kubernetes.io/zone) to enable zone-aware pod spreading and storage replication - Helm - Api - [NetBoxEnterprise CRD](/docs/enterprise/helm/api/netboxenterprise): Complete field reference for the NetBoxEnterprise custom resource definition - [Status & Conditions](/docs/enterprise/helm/api/status-conditions): NetBoxEnterprise status fields, condition types, and component health reference - Configuration - [Diode Configuration](/docs/enterprise/helm/configuration/diode): Configure the Diode data ingestion pipeline for NetBox Enterprise - [Helm Values Reference](/docs/enterprise/helm/configuration/helm-values): Complete reference for all nbe-operator values.yaml fields - [Ingress & TLS](/docs/enterprise/helm/configuration/ingress-tls): Configure routing, gateway and ingress controllers, TLS certificates, and custom CA chains - [Monitoring](/docs/enterprise/helm/configuration/monitoring): Configure Prometheus metrics, ServiceMonitor, and health check endpoints - [NetBox Configuration](/docs/enterprise/helm/configuration/netbox): Configure NetBox application replicas, workers, resources, and application settings - [PostgreSQL Configuration](/docs/enterprise/helm/configuration/postgresql): Configure internal PGO-managed or external PostgreSQL for NetBox Enterprise - [Redis Configuration](/docs/enterprise/helm/configuration/redis): Configure internal operator-managed or external Redis for NetBox Enterprise - Guides - [Architecture](/docs/enterprise/helm/guides/architecture): Component topology, operator reconciliation flow, and data flow diagrams - [Backups](/docs/enterprise/helm/guides/backups): Velero backup and restore for NetBox Enterprise Helm deployments - [Complete Deployment Guide](/docs/enterprise/helm/guides/complete-deployment): End-to-end production deployment walkthrough covering all components such as CRDs, operator, PostgreSQL, Redis, Diode, TLS, monitoring, and backups - [Custom Plugins](/docs/enterprise/helm/guides/custom-plugins): Install custom NetBox plugins in Helm deployments using wheelhouse archives via media directory, PVC, or S3 - [External Database](/docs/enterprise/helm/guides/external-database): Step-by-step guide to connecting NetBox Enterprise to an external PostgreSQL database - [Maintenance Mode](/docs/enterprise/helm/guides/maintenance-mode): Safely take NetBox offline for database operations, backups, and repairs - [Private Registry](/docs/enterprise/helm/guides/private-registry): Pull NetBox Enterprise images from your own private or proxy registry instead of the NetBox Labs proxy - [Security](/docs/enterprise/helm/guides/security): RBAC modes, pod security, TLS configuration, and network policies - [Troubleshooting](/docs/enterprise/helm/guides/troubleshooting): Common issues, diagnostic commands, and health check reference - Installation - [Example Manifests](/docs/enterprise/helm/installation/examples): Ready-to-use NetBoxEnterprise resource manifests for Helm deployments - [Prerequisites](/docs/enterprise/helm/installation/prerequisites): System requirements, tooling, and access needed before installing NetBox Enterprise - [Quickstart](/docs/enterprise/helm/installation/quickstart): Get NetBox Enterprise running on Kubernetes in 5 minutes - [Standard Installation](/docs/enterprise/helm/installation/standard-install): Full NetBox Enterprise installation with custom values and production settings - [Upgrading](/docs/enterprise/helm/installation/upgrading): Upgrade procedures for the netbox-enterprise Helm chart - [Air-Gapped Appliance](/docs/enterprise/nbe-airgap-appliance): Deploy NetBox Enterprise as a pre-built VM appliance for air-gapped environments with no internet connectivity - [Microsoft Entra ID Group Mapping](/docs/enterprise/nbe-azure-group-mapping): Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise - [Microsoft Entra ID Single Sign-On](/docs/enterprise/nbe-azure-sso): Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise - [NetBox Enterprise Backups](/docs/enterprise/nbe-backups): This guide covers backup procedures for Embedded Cluster deployments. For Helm deployments, see Helm Backups. - [NetBox Private Copilot](/docs/enterprise/nbe-copilot): Configure and use the AI-powered Private Copilot assistant in NetBox Enterprise - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/nbe-ec-built-in-plugins): Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support - [Installing Custom NetBox Plugins](/docs/enterprise/nbe-ec-custom-plugins): Extend NetBox Enterprise with custom plugins using wheelhouse archives, delivered via PVC or S3 storage - [LDAP Authentication](/docs/enterprise/nbe-ldap): Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP - [OpenID Connect (OIDC) Single Sign-On](/docs/enterprise/nbe-oidc-sso): Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers - [NetBox Enterprise Release Notes](/docs/enterprise/nbe-release-notes): NetBox Enterprise 2.2.1 is a patch release. It corrects the host ports the bundled Traefik gateway binds on Embedded Cluster, updates the bundled assurance p... - [SAML Group Mapping](/docs/enterprise/nbe-saml-group-map): Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise - [SAML Single Sign-On](/docs/enterprise/nbe-saml): Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider - [TLS and Gateway: Accessing NetBox Enterprise](/docs/enterprise/nbe-tls-ingress): The NetBox Enterprise installation provides its own gateway controller (Traefik, serving the Kubernetes Gateway API) on ports 80 and 443. No additional confi... - [Advanced Tools and Troubleshooting](/docs/enterprise/nbe-troubleshooting): Diagnostic procedures and solutions for common NetBox Enterprise issues - [TurboBulk](/docs/enterprise/nbe-turbobulk): High-performance bulk data API for NetBox Enterprise with 5,000-25,000 rows/sec throughput - NetBox Enterprise v1.10 - [NetBox Enterprise v1.10](/docs/enterprise/v1.10): Documentation archive for NetBox Enterprise v1.10 - Enterprise features - [NetBox Enterprise Entra ID Group Mapping](/docs/enterprise/v1.10/enterprise-features/nbe-azure-group-mapping): Place the following in configuration overrides python section - [Microsoft Entra ID Setup (formerly Azure Active Directory)](/docs/enterprise/v1.10/enterprise-features/nbe-azure-sso): This guide explains how to configure single sign-on (SSO) support for NetBox Enterprise using Microsoft Entra ID (formerly Azure Active Directory) as an auth... - [NetBox Enterprise Backups](/docs/enterprise/v1.10/enterprise-features/nbe-backups): Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis. - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/v1.10/enterprise-features/nbe-ec-built-in-plugins): NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity... - [Installing Custom NetBox Plugins](/docs/enterprise/v1.10/enterprise-features/nbe-ec-custom-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 plu... - [NetBox Enterprise Installation](/docs/enterprise/v1.10/enterprise-features/nbe-ec-installation): You should be able to follow these instructions for installing NetBox Enterprise in most environments. - [Linux Root-Level Changes](/docs/enterprise/v1.10/enterprise-features/nbe-ec-linux-changes): This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to dire... - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/v1.10/enterprise-features/nbe-ec-requirements-rhel): This guide was used on fresh installs of the following versions of RHEL: - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/v1.10/enterprise-features/nbe-ec-requirements-ubuntu): Ubuntu-specific preparation steps. See the main requirements document for general requirements and special cases. - [NetBox Enterprise Requirements](/docs/enterprise/v1.10/enterprise-features/nbe-ec-requirements): The following are the recommended system requirements for a production deployment of NetBox Enterprise running two replicas. For larger environments with mor... - [LDAP Configuration for NetBox Enterprise](/docs/enterprise/v1.10/enterprise-features/nbe-ldap): 1. In the Admin Console for NetBox Enterprise, navigate to the Config tab and scroll to the bottom to check Advanced Settings 2. Apply the following into Net... - [Migrating to NetBox Enterprise](/docs/enterprise/v1.10/enterprise-features/nbe-migrating): 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 pla... - [NetBox Enterprise](/docs/enterprise/v1.10/enterprise-features/nbe-overview): NetBox Enterprise is a distribution of NetBox built by NetBox Labs for organizations deploying NetBox in their own infrastructure. NetBox Enterprise users ga... - [NetBox Enterprise 1.x Release Notes](/docs/enterprise/v1.10/enterprise-features/nbe-release-notes): This release contains a few small fixes to handle upgrades from much older releases, plus support for toggling whether to auto-apply in Diode. - [Configuring SAML Group Mapping in NetBox Enterprise](/docs/enterprise/v1.10/enterprise-features/nbe-saml-group-map): Setting up Group Mapping for SAML requires the base SAML SSO Setup to be configured and working first. - [NetBox Enterprise SAML Configuration Guide](/docs/enterprise/v1.10/enterprise-features/nbe-saml) - [TLS and Ingress: Accessing NetBox Enterprise](/docs/enterprise/v1.10/enterprise-features/nbe-tls-ingress): The NetBox Enterprise installation provides its own ingress controller. No additional configuration is required to reach NetBox on HTTP and HTTPS. - [Advanced Tools and Troubleshooting](/docs/enterprise/v1.10/enterprise-features/nbe-troubleshooting): NetBox Enterprise is designed to harness the power of Kubernetes while minimizing the amount of work the average person needs to manage it. However, sometime... - NetBox Enterprise Features - [NetBox Enterprise Features](/docs/enterprise/v1.10/features): Features and capabilities exclusive to NetBox Enterprise - NetBox Enterprise v1.12 - [NetBox Enterprise v1.12](/docs/enterprise/v1.12): Documentation archive for NetBox Enterprise v1.12 - Enterprise features - [Microsoft Entra ID Group Mapping](/docs/enterprise/v1.12/enterprise-features/nbe-azure-group-mapping): Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise - [Microsoft Entra ID Single Sign-On](/docs/enterprise/v1.12/enterprise-features/nbe-azure-sso): Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise - [NetBox Enterprise Backups](/docs/enterprise/v1.12/enterprise-features/nbe-backups): Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis. - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/v1.12/enterprise-features/nbe-ec-built-in-plugins): NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity... - [Installing Custom NetBox Plugins](/docs/enterprise/v1.12/enterprise-features/nbe-ec-custom-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 plu... - [NetBox Enterprise Installation](/docs/enterprise/v1.12/enterprise-features/nbe-ec-installation): You should be able to follow these instructions for installing NetBox Enterprise in most environments. - [Linux Root-Level Changes](/docs/enterprise/v1.12/enterprise-features/nbe-ec-linux-changes): This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to dire... - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/v1.12/enterprise-features/nbe-ec-requirements-rhel): This guide was used on fresh installs of the following versions of RHEL: - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/v1.12/enterprise-features/nbe-ec-requirements-ubuntu): Ubuntu-specific preparation steps. See the main requirements document for general requirements and special cases. - [NetBox Enterprise Requirements](/docs/enterprise/v1.12/enterprise-features/nbe-ec-requirements): The following are the recommended system requirements for a production deployment of NetBox Enterprise running two replicas. For larger environments with mor... - [LDAP Authentication](/docs/enterprise/v1.12/enterprise-features/nbe-ldap): Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP - [Migrating to NetBox Enterprise](/docs/enterprise/v1.12/enterprise-features/nbe-migrating): 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 pla... - [OpenID Connect (OIDC) Single Sign-On](/docs/enterprise/v1.12/enterprise-features/nbe-oidc-sso): Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers - [NetBox Enterprise](/docs/enterprise/v1.12/enterprise-features/nbe-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. - [NetBox Enterprise Release Notes](/docs/enterprise/v1.12/enterprise-features/nbe-release-notes): This is a small update over 1.12.3, containing a few security and plugin updates. - [SAML Group Mapping](/docs/enterprise/v1.12/enterprise-features/nbe-saml-group-map): Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise - [SAML Single Sign-On](/docs/enterprise/v1.12/enterprise-features/nbe-saml): Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider - [TLS and Ingress: Accessing NetBox Enterprise](/docs/enterprise/v1.12/enterprise-features/nbe-tls-ingress): The NetBox Enterprise installation provides its own ingress controller. No additional configuration is required to reach NetBox on HTTP and HTTPS. - [Advanced Tools and Troubleshooting](/docs/enterprise/v1.12/enterprise-features/nbe-troubleshooting): Diagnostic procedures and solutions for common NetBox Enterprise issues - NetBox Enterprise Features - [NetBox Enterprise Features](/docs/enterprise/v1.12/features): Features and capabilities exclusive to NetBox Enterprise - NetBox Enterprise v1.13 - [NetBox Enterprise v1.13](/docs/enterprise/v1.13): Documentation archive for NetBox Enterprise v1.13 - Enterprise features - [Microsoft Entra ID Group Mapping](/docs/enterprise/v1.13/enterprise-features/nbe-azure-group-mapping): Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise - [Microsoft Entra ID Single Sign-On](/docs/enterprise/v1.13/enterprise-features/nbe-azure-sso): Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise - [NetBox Enterprise Backups](/docs/enterprise/v1.13/enterprise-features/nbe-backups): Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis. - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/v1.13/enterprise-features/nbe-ec-built-in-plugins): Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support - [Installing Custom NetBox Plugins](/docs/enterprise/v1.13/enterprise-features/nbe-ec-custom-plugins): Extend NetBox Enterprise with custom plugins using wheelhouse archives for standalone and multi-node/HA deployments - [NetBox Enterprise Installation](/docs/enterprise/v1.13/enterprise-features/nbe-ec-installation): Step-by-step guide for installing NetBox Enterprise Embedded Cluster - [Linux Root-Level Changes](/docs/enterprise/v1.13/enterprise-features/nbe-ec-linux-changes): Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/v1.13/enterprise-features/nbe-ec-requirements-rhel): RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/v1.13/enterprise-features/nbe-ec-requirements-ubuntu): Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise System Requirements](/docs/enterprise/v1.13/enterprise-features/nbe-ec-requirements): Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations - [LDAP Authentication](/docs/enterprise/v1.13/enterprise-features/nbe-ldap): Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP - [Migrating to NetBox Enterprise](/docs/enterprise/v1.13/enterprise-features/nbe-migrating): 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 pla... - [NetBox Enterprise Multi-Node Deployment](/docs/enterprise/v1.13/enterprise-features/nbe-multi-node): NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. Thi... - [OpenID Connect (OIDC) Single Sign-On](/docs/enterprise/v1.13/enterprise-features/nbe-oidc-sso): Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers - [NetBox Enterprise Overview](/docs/enterprise/v1.13/enterprise-features/nbe-overview): Self-hosted NetBox distribution with simplified installation, enterprise features, and professional support - [NetBox Enterprise Release Notes](/docs/enterprise/v1.13/enterprise-features/nbe-release-notes): A small bug fix release to address an nginx image issue. - [SAML Group Mapping](/docs/enterprise/v1.13/enterprise-features/nbe-saml-group-map): Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise - [SAML Single Sign-On](/docs/enterprise/v1.13/enterprise-features/nbe-saml): Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider - [NetBox Enterprise Storage Installation](/docs/enterprise/v1.13/enterprise-features/nbe-storage-installation): Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setu... - [Migrating to S3-Compatible Storage](/docs/enterprise/v1.13/enterprise-features/nbe-storage-migration): NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external... - [NetBox Enterprise Storage Options](/docs/enterprise/v1.13/enterprise-features/nbe-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... - [TLS and Ingress: Accessing NetBox Enterprise](/docs/enterprise/v1.13/enterprise-features/nbe-tls-ingress): The NetBox Enterprise installation provides its own ingress controller. No additional configuration is required to reach NetBox on HTTP and HTTPS. - [Advanced Tools and Troubleshooting](/docs/enterprise/v1.13/enterprise-features/nbe-troubleshooting): Diagnostic procedures and solutions for common NetBox Enterprise issues - NetBox Enterprise v1.14 - [NetBox Enterprise v1.14](/docs/enterprise/v1.14): Documentation archive for NetBox Enterprise v1.14 - Enterprise features - [Microsoft Entra ID Group Mapping](/docs/enterprise/v1.14/enterprise-features/nbe-azure-group-mapping): Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise - [Microsoft Entra ID Single Sign-On](/docs/enterprise/v1.14/enterprise-features/nbe-azure-sso): Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise - [NetBox Enterprise Backups](/docs/enterprise/v1.14/enterprise-features/nbe-backups): Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis. - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/v1.14/enterprise-features/nbe-ec-built-in-plugins): Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support - [Installing Custom NetBox Plugins](/docs/enterprise/v1.14/enterprise-features/nbe-ec-custom-plugins): Extend NetBox Enterprise with custom plugins using wheelhouse archives for standalone and multi-node/HA deployments - [NetBox Enterprise Installation](/docs/enterprise/v1.14/enterprise-features/nbe-ec-installation): Step-by-step guide for installing NetBox Enterprise Embedded Cluster - [Linux Root-Level Changes](/docs/enterprise/v1.14/enterprise-features/nbe-ec-linux-changes): Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/v1.14/enterprise-features/nbe-ec-requirements-rhel): RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/v1.14/enterprise-features/nbe-ec-requirements-ubuntu): Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise System Requirements](/docs/enterprise/v1.14/enterprise-features/nbe-ec-requirements): Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations - [LDAP Authentication](/docs/enterprise/v1.14/enterprise-features/nbe-ldap): Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP - [Migrating to NetBox Enterprise](/docs/enterprise/v1.14/enterprise-features/nbe-migrating): 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 pla... - [NetBox Enterprise Multi-Node Deployment](/docs/enterprise/v1.14/enterprise-features/nbe-multi-node): NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. Thi... - [OpenID Connect (OIDC) Single Sign-On](/docs/enterprise/v1.14/enterprise-features/nbe-oidc-sso): Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers - [NetBox Enterprise Overview](/docs/enterprise/v1.14/enterprise-features/nbe-overview): Self-hosted NetBox distribution with simplified installation, enterprise features, and professional support - [NetBox Enterprise Release Notes](/docs/enterprise/v1.14/enterprise-features/nbe-release-notes): This is a minor bug fix release addressing Redis configuration and certificate handling issues. - [SAML Group Mapping](/docs/enterprise/v1.14/enterprise-features/nbe-saml-group-map): Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise - [SAML Single Sign-On](/docs/enterprise/v1.14/enterprise-features/nbe-saml): Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider - [NetBox Enterprise Storage Installation](/docs/enterprise/v1.14/enterprise-features/nbe-storage-installation): Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setu... - [Migrating to S3-Compatible Storage](/docs/enterprise/v1.14/enterprise-features/nbe-storage-migration): NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external... - [NetBox Enterprise Storage Options](/docs/enterprise/v1.14/enterprise-features/nbe-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... - [TLS and Ingress: Accessing NetBox Enterprise](/docs/enterprise/v1.14/enterprise-features/nbe-tls-ingress): The NetBox Enterprise installation provides its own ingress controller. No additional configuration is required to reach NetBox on HTTP and HTTPS. - [Advanced Tools and Troubleshooting](/docs/enterprise/v1.14/enterprise-features/nbe-troubleshooting): Diagnostic procedures and solutions for common NetBox Enterprise issues - NetBox Enterprise v2.0 - [NetBox Enterprise v2.0](/docs/enterprise/v2.0): Documentation archive for NetBox Enterprise v2.0 - Enterprise features - [Air-Gapped Appliance](/docs/enterprise/v2.0/enterprise-features/nbe-airgap-appliance): Deploy NetBox Enterprise as a pre-built VM appliance for air-gapped environments with no internet connectivity - [Microsoft Entra ID Group Mapping](/docs/enterprise/v2.0/enterprise-features/nbe-azure-group-mapping): Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise - [Microsoft Entra ID Single Sign-On](/docs/enterprise/v2.0/enterprise-features/nbe-azure-sso): Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise - [NetBox Enterprise Backups](/docs/enterprise/v2.0/enterprise-features/nbe-backups): Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis. - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/v2.0/enterprise-features/nbe-ec-built-in-plugins): Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support - [Installing Custom NetBox Plugins](/docs/enterprise/v2.0/enterprise-features/nbe-ec-custom-plugins): Extend NetBox Enterprise with custom plugins using wheelhouse archives, delivered via PVC or S3 storage - [NetBox Enterprise Installation](/docs/enterprise/v2.0/enterprise-features/nbe-ec-installation): Step-by-step guide for installing NetBox Enterprise Embedded Cluster - [Linux Root-Level Changes](/docs/enterprise/v2.0/enterprise-features/nbe-ec-linux-changes): Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/v2.0/enterprise-features/nbe-ec-requirements-rhel): RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/v2.0/enterprise-features/nbe-ec-requirements-ubuntu): Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise System Requirements](/docs/enterprise/v2.0/enterprise-features/nbe-ec-requirements): Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations - [LDAP Authentication](/docs/enterprise/v2.0/enterprise-features/nbe-ldap): Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP - [Migrating to NetBox Enterprise](/docs/enterprise/v2.0/enterprise-features/nbe-migrating): 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 pla... - [NetBox Enterprise Multi-Node Deployment](/docs/enterprise/v2.0/enterprise-features/nbe-multi-node): NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. Thi... - [OpenID Connect (OIDC) Single Sign-On](/docs/enterprise/v2.0/enterprise-features/nbe-oidc-sso): Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers - [NetBox Enterprise Overview](/docs/enterprise/v2.0/enterprise-features/nbe-overview): Self-hosted NetBox distribution for deploying NetBox in your own infrastructure - [NetBox Enterprise Release Notes](/docs/enterprise/v2.0/enterprise-features/nbe-release-notes): NetBox Enterprise 2.0.0 introduces a new declarative Kubernetes operator with intelligent resource orchestration, significant architectural improvements, enh... - [SAML Group Mapping](/docs/enterprise/v2.0/enterprise-features/nbe-saml-group-map): Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise - [SAML Single Sign-On](/docs/enterprise/v2.0/enterprise-features/nbe-saml): Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider - [NetBox Enterprise Storage Installation](/docs/enterprise/v2.0/enterprise-features/nbe-storage-installation): Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setu... - [Migrating to S3-Compatible Storage](/docs/enterprise/v2.0/enterprise-features/nbe-storage-migration): NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external... - [NetBox Enterprise Storage Options](/docs/enterprise/v2.0/enterprise-features/nbe-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... - [TLS and Ingress: Accessing NetBox Enterprise](/docs/enterprise/v2.0/enterprise-features/nbe-tls-ingress): The NetBox Enterprise installation provides its own ingress controller. No additional configuration is required to reach NetBox on HTTP and HTTPS. - [Advanced Tools and Troubleshooting](/docs/enterprise/v2.0/enterprise-features/nbe-troubleshooting): Diagnostic procedures and solutions for common NetBox Enterprise issues - Helm - Installation - [Example Manifests](/docs/enterprise/v2.0/helm/installation/examples): Ready-to-use NetBoxEnterprise resource manifests for Helm deployments - [Prerequisites](/docs/enterprise/v2.0/helm/installation/prerequisites): System requirements, tooling, and access needed before installing NetBox Enterprise - [Quickstart](/docs/enterprise/v2.0/helm/installation/quickstart): Get NetBox Enterprise running on Kubernetes in 5 minutes - [Standard Installation](/docs/enterprise/v2.0/helm/installation/standard-install): Full NetBox Enterprise installation with custom values and production settings - NetBox Enterprise v2.1 - [NetBox Enterprise Overview](/docs/enterprise/v2.1): Self-hosted NetBox distribution for deploying NetBox in your own infrastructure - Embedded cluster - [NetBox Enterprise Installation](/docs/enterprise/v2.1/embedded-cluster/nbe-ec-installation): Step-by-step guide for installing NetBox Enterprise Embedded Cluster - [Linux Root-Level Changes](/docs/enterprise/v2.1/embedded-cluster/nbe-ec-linux-changes): Reference guide for system-level changes made by NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Red Hat Enterprise Linux (RHEL)](/docs/enterprise/v2.1/embedded-cluster/nbe-ec-requirements-rhel): RHEL-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise Requirements for Ubuntu](/docs/enterprise/v2.1/embedded-cluster/nbe-ec-requirements-ubuntu): Ubuntu-specific system preparation steps for NetBox Enterprise Embedded Cluster installation - [NetBox Enterprise System Requirements](/docs/enterprise/v2.1/embedded-cluster/nbe-ec-requirements): Hardware, software, and network requirements for NetBox Enterprise Embedded Cluster installations - [Migrating to NetBox Enterprise](/docs/enterprise/v2.1/embedded-cluster/nbe-migrating): 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 pla... - [NetBox Enterprise Multi-Node Deployment](/docs/enterprise/v2.1/embedded-cluster/nbe-multi-node): NetBox Enterprise Multi-Node enables high-availability (HA) deployments by distributing NetBox across multiple servers in an active-active configuration. Thi... - [NetBox Enterprise Storage Installation](/docs/enterprise/v2.1/embedded-cluster/nbe-storage-installation): Configure S3-compatible storage during NetBox Enterprise installation. For existing installations, see Storage Migration. For storage providers and CORS setu... - [Migrating to S3-Compatible Storage](/docs/enterprise/v2.1/embedded-cluster/nbe-storage-migration): NetBox Enterprise can store media files (uploaded images, device type images, custom scripts, and attachments) in either local filesystem storage or external... - [NetBox Enterprise Storage Options](/docs/enterprise/v2.1/embedded-cluster/nbe-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... - Helm - Api - [NetBoxEnterprise CRD](/docs/enterprise/v2.1/helm/api/netboxenterprise): Complete field reference for the NetBoxEnterprise custom resource definition - [Status & Conditions](/docs/enterprise/v2.1/helm/api/status-conditions): NetBoxEnterprise status fields, condition types, and component health reference - Configuration - [Diode Configuration](/docs/enterprise/v2.1/helm/configuration/diode): Configure the Diode data ingestion pipeline for NetBox Enterprise - [Helm Values Reference](/docs/enterprise/v2.1/helm/configuration/helm-values): Complete reference for all nbe-operator values.yaml fields - [Ingress & TLS](/docs/enterprise/v2.1/helm/configuration/ingress-tls): Configure ingress controllers, TLS certificates, and custom CA chains - [Monitoring](/docs/enterprise/v2.1/helm/configuration/monitoring): Configure Prometheus metrics, ServiceMonitor, and health check endpoints - [NetBox Configuration](/docs/enterprise/v2.1/helm/configuration/netbox): Configure NetBox application replicas, workers, resources, and application settings - [PostgreSQL Configuration](/docs/enterprise/v2.1/helm/configuration/postgresql): Configure internal PGO-managed or external PostgreSQL for NetBox Enterprise - [Redis Configuration](/docs/enterprise/v2.1/helm/configuration/redis): Configure internal operator-managed or external Redis for NetBox Enterprise - Guides - [Architecture](/docs/enterprise/v2.1/helm/guides/architecture): Component topology, operator reconciliation flow, and data flow diagrams - [Backups](/docs/enterprise/v2.1/helm/guides/backups): Velero backup and restore for NetBox Enterprise Helm deployments - [Complete Deployment Guide](/docs/enterprise/v2.1/helm/guides/complete-deployment): End-to-end production deployment walkthrough covering all components — CRDs, operator, PostgreSQL, Redis, Diode, TLS, monitoring, and backups - [Custom Plugins](/docs/enterprise/v2.1/helm/guides/custom-plugins): Install custom NetBox plugins in Helm deployments using wheelhouse archives via media directory, PVC, or S3 - [External Database](/docs/enterprise/v2.1/helm/guides/external-database): Step-by-step guide to connecting NetBox Enterprise to an external PostgreSQL database - [Maintenance Mode](/docs/enterprise/v2.1/helm/guides/maintenance-mode): Safely take NetBox offline for database operations, backups, and repairs - [Security](/docs/enterprise/v2.1/helm/guides/security): RBAC modes, pod security, TLS configuration, and network policies - [Troubleshooting](/docs/enterprise/v2.1/helm/guides/troubleshooting): Common issues, diagnostic commands, and health check reference - Installation - [Example Manifests](/docs/enterprise/v2.1/helm/installation/examples): Ready-to-use NetBoxEnterprise resource manifests for Helm deployments - [Prerequisites](/docs/enterprise/v2.1/helm/installation/prerequisites): System requirements, tooling, and access needed before installing NetBox Enterprise - [Quickstart](/docs/enterprise/v2.1/helm/installation/quickstart): Get NetBox Enterprise running on Kubernetes in 5 minutes - [Standard Installation](/docs/enterprise/v2.1/helm/installation/standard-install): Full NetBox Enterprise installation with custom values and production settings - [Upgrading](/docs/enterprise/v2.1/helm/installation/upgrading): Upgrade procedures for the netbox-enterprise Helm chart - [Air-Gapped Appliance](/docs/enterprise/v2.1/nbe-airgap-appliance): Deploy NetBox Enterprise as a pre-built VM appliance for air-gapped environments with no internet connectivity - [Microsoft Entra ID Group Mapping](/docs/enterprise/v2.1/nbe-azure-group-mapping): Configure automatic permission assignment based on Microsoft Entra ID group membership in NetBox Enterprise - [Microsoft Entra ID Single Sign-On](/docs/enterprise/v2.1/nbe-azure-sso): Configure Microsoft Entra ID (formerly Azure Active Directory) authentication for NetBox Enterprise - [NetBox Enterprise Backups](/docs/enterprise/v2.1/nbe-backups): This guide covers backup procedures for Embedded Cluster deployments. For Helm deployments, see Helm Backups. - [NetBox Private Copilot](/docs/enterprise/v2.1/nbe-copilot): Configure and use the AI-powered Private Copilot assistant in NetBox Enterprise - [Built-in Plugins in NetBox Enterprise](/docs/enterprise/v2.1/nbe-ec-built-in-plugins): Pre-integrated NetBox plugins with zero installation complexity, providing enterprise-ready features and official support - [Installing Custom NetBox Plugins](/docs/enterprise/v2.1/nbe-ec-custom-plugins): Extend NetBox Enterprise with custom plugins using wheelhouse archives, delivered via PVC or S3 storage - [LDAP Authentication](/docs/enterprise/v2.1/nbe-ldap): Configure LDAP authentication for NetBox Enterprise with Active Directory or OpenLDAP - [OpenID Connect (OIDC) Single Sign-On](/docs/enterprise/v2.1/nbe-oidc-sso): Configure OpenID Connect authentication for NetBox Enterprise with Microsoft Entra ID, Okta, or generic OIDC providers - [NetBox Enterprise Release Notes](/docs/enterprise/v2.1/nbe-release-notes): NetBox Enterprise 2.1.2 bumps NetBox to 4.5.10 and Copilot to 1.33.0, adds Redis tuning knobs on the CRD, configurable Diode reconciler rate limits and repli... - [SAML Group Mapping](/docs/enterprise/v2.1/nbe-saml-group-map): Configure automatic permission assignment based on SAML identity provider group membership in NetBox Enterprise - [SAML Single Sign-On](/docs/enterprise/v2.1/nbe-saml): Configure SAML 2.0 authentication for NetBox Enterprise with any SAML-compliant identity provider - [TLS and Ingress: Accessing NetBox Enterprise](/docs/enterprise/v2.1/nbe-tls-ingress): The NetBox Enterprise installation provides its own ingress controller. No additional configuration is required to reach NetBox on HTTP and HTTPS. - [Advanced Tools and Troubleshooting](/docs/enterprise/v2.1/nbe-troubleshooting): Diagnostic procedures and solutions for common NetBox Enterprise issues - Discovery Integrations - [Discovery Integrations](/docs/integrations): Discover and synchronize infrastructure data into NetBox from your network platforms and controllers. - Cisco ACI - [Cisco ACI Integration](/docs/integrations/cisco-aci): Automatically discover and synchronize Cisco ACI fabric inventory - devices, interfaces, VRFs, prefixes, VLANs, and IP addresses - into NetBox via the Diode SDK. - [Getting Started](/docs/integrations/cisco-aci/getting-started): This guide walks you through setting up the Cisco ACI Integration for NetBox. - [Technical Information](/docs/integrations/cisco-aci/cisco-aci-tech-info): This page describes how ACI object types are mapped to NetBox objects by the integration. - [FAQ & Troubleshooting](/docs/integrations/cisco-aci/cisco-aci-faq): 1. Authentication errors: - Cisco Catalyst Center - [Cisco Catalyst Center Integration](/docs/integrations/cisco-catalyst-center): 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. - [Getting Started](/docs/integrations/cisco-catalyst-center/getting-started): This guide will help you set up and start using the Catalyst Center Integration for NetBox. - [Technical Information](/docs/integrations/cisco-catalyst-center/cisco-catalyst-center-tech-info): Authentication: POST to \{CCCHOST\}/dna/system/api/v1/auth/token with username/password; token used in X-Auth-Token for subsequent requests. - [FAQ & Troubleshooting](/docs/integrations/cisco-catalyst-center/cisco-catalyst-center-faq): 1. Authentication Errors: - Cisco Meraki - [Cisco Meraki Integration](/docs/integrations/cisco-meraki): The NetBox Cisco Meraki integration provides comprehensive synchronization of Cisco Meraki cloud-managed infrastructure data into NetBox, enabling organizati... - [Getting Started](/docs/integrations/cisco-meraki/getting-started): This guide will help you set up and start using the Cisco Meraki Integration for NetBox. - [Technical Information](/docs/integrations/cisco-meraki/cisco-meraki-tech-info): Multiple networks can map to the same site; the first network (by name) supplies site-level fields and template binding. - [FAQ & Troubleshooting](/docs/integrations/cisco-meraki/cisco-meraki-faq): This document provides answers to commonly asked questions about the NetBox Cisco Meraki integration. - HPE Aruba Mist - [HPE Juniper Networking Mist Integration](/docs/integrations/hpe-mist): The NetBox HPE Juniper Networking Mist integration helps organisations maintain a single pane of glass view of their Mist-managed infrastructure alongside th... - [Getting Started](/docs/integrations/hpe-mist/getting-started): This guide will help you set up and start using the HPE Juniper Networking Mist Integration for NetBox. - [Technical Information](/docs/integrations/hpe-mist/hpe-mist-tech-info): Cipher uses Mist auth.pairwise list (e.g. wpa2-ccmp, wpa2-tkip, wpa3). - [FAQ & Troubleshooting](/docs/integrations/hpe-mist/hpe-mist-faq): This document provides answers to commonly asked questions about the NetBox HPE Juniper Networking Mist integration. - Infoblox NIOS - [Infoblox NIOS Integration](/docs/integrations/infoblox-nios): Discover and synchronize Infoblox NIOS IPAM, DHCP, and VLAN data into NetBox, including networks, IP addresses, VLANs, VLAN groups, and DHCP ranges. - [Getting Started](/docs/integrations/infoblox-nios/getting-started): This guide will help you set up and start using the Infoblox NIOS Integration for NetBox. - [Technical Information](/docs/integrations/infoblox-nios/infoblox-nios-tech-info): All objects (prefixes, IP addresses) are tagged with their network view for easy filtering. - [FAQ & Troubleshooting](/docs/integrations/infoblox-nios/infoblox-nios-faq): This document provides answers to commonly asked questions about the NetBox Infoblox NIOS integration. - Lightyear - [Lightyear Integration](/docs/integrations/lightyear): The NetBox Lightyear integration automatically synchronizes your circuit inventory from Lightyear.ai into NetBox, eliminating manual data entry and ensuring ... - [Getting Started](/docs/integrations/lightyear/getting-started): This guide will help you set up and start using the Lightyear Integration for NetBox. - [Technical Information](/docs/integrations/lightyear/lightyear-tech-info): This document covers the Lightyear to NetBox object mappings, API details, and configuration reference for the integration. - [FAQ & Troubleshooting](/docs/integrations/lightyear/lightyear-faq): This document provides answers to commonly asked questions about the NetBox Lightyear integration. - Microsoft DHCP - [Microsoft DHCP Integration](/docs/integrations/ms-dhcp): 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. - [Getting Started](/docs/integrations/ms-dhcp/getting-started): This guide covers how to set up and run the Microsoft DHCP Integration for NetBox. - [Technical Information](/docs/integrations/ms-dhcp/ms-dhcp-tech-info): When a reservation and a lease exist for the same IP address, the reservation always takes precedence. The IP address is ingested with status reserved using ... - [FAQ & Troubleshooting](/docs/integrations/ms-dhcp/ms-dhcp-faq): This document provides answers to commonly asked questions about the NetBox Microsoft DHCP integration. - Microsoft DNS - [Microsoft DNS Integration](/docs/integrations/ms-dns): Synchronize DNS records from Microsoft Windows Server DNS into NetBox. Ingests A and AAAA records from forward-lookup zones and PTR records from reverse-lookup zones as IP addresses on your Windows DNS servers. - [Getting Started](/docs/integrations/ms-dns/getting-started): This guide covers how to set up and run the Microsoft DNS Integration for NetBox. - [Technical Information](/docs/integrations/ms-dns/ms-dns-tech-info): Microsoft DNS to NetBox object and field mappings: A, AAAA, and PTR records to IP addresses, zone-to-tenant mapping, custom fields, and tags. - [FAQ & Troubleshooting](/docs/integrations/ms-dns/ms-dns-faq): This document provides answers to commonly asked questions about the NetBox Microsoft DNS integration. - Proxmox VE - [Proxmox VE Integration](/docs/integrations/proxmox-ve): Discover and synchronize Proxmox VE infrastructure into NetBox, including hypervisor nodes, virtual machines, LXC containers, networking, and storage. - [Getting Started](/docs/integrations/proxmox-ve/getting-started): This guide will help you set up and start using the Proxmox VE Integration for NetBox. - [Technical Information](/docs/integrations/proxmox-ve/proxmox-ve-tech-info): For QEMU VMs with the guest agent installed and running, the guest agent OS info takes precedence over the ostype map. The guest agent provides a more specif... - [FAQ & Troubleshooting](/docs/integrations/proxmox-ve/proxmox-ve-faq): This document provides answers to commonly asked questions about the NetBox Proxmox VE integration. - VMware vCenter - [VMware vCenter Integration](/docs/integrations/vmware-vcenter): Synchronize VMware vCenter virtual infrastructure into NetBox Discovery. Automatically imports datacenters, clusters, virtual machines, and resource management data for unified visibility. - [Getting Started](/docs/integrations/vmware-vcenter/getting-started): This guide will help you set up and start using the VMware vCenter Integration for NetBox. - [Technical Information](/docs/integrations/vmware-vcenter/vmware-vcenter-tech-info): Standalone hosts (ComputeResource but not ClusterComputeResource) are grouped into a synthetic cluster per datacenter: name \{datacenter}-StandaloneHostsClus... - [FAQ & Troubleshooting](/docs/integrations/vmware-vcenter/vmware-vcenter-faq): This document provides answers to commonly asked questions about the NetBox VMware vCenter integration. - Jira Assets Integration - [Jira Assets Integration](/docs/jira-assets): Synchronize NetBox inventory into Jira Service Management Assets - devices, sites, virtual machines, plugin objects, and custom fields - via a one-way Docker sync container. - [Getting Started](/docs/jira-assets/getting-started): Pull the sync container, configure credentials, validate schema compatibility, and run NetBox-to-Jira Assets synchronization. - [Technical Information](/docs/jira-assets/jira-assets-tech-info): Object mappings, schema design, configuration parameters, and sync behavior for the NetBox-to-Jira Assets integration. - [FAQ & Troubleshooting](/docs/jira-assets/jira-assets-faq): Frequently asked questions and troubleshooting guidance for the Jira Assets integration. - Learn - [Learning paths](/docs/learn): Guided paths from your first NetBox install to governed, AI-ready automation. - [Platform documentation map](/docs/learn/platform): Find the right documentation for each NetBox Labs platform capability - Model, See, Act, Govern. - NetBox Data Exchange - [NetBox Data Exchange](/docs/ndx): NetBox Data Exchange (NDX) is a curated catalog of tens of thousands of infrastructure device types across hundreds of vendors, browsable and importable dire... - NetBox - [The Premier Network Source of Truth](/docs/netbox): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/features): Features documentation - [Facilities](/docs/netbox/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/features/virtualization): Virtual machines, clusters, and standalone hypervisors can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assig... - [Tunnels](/docs/netbox/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Resource Ownership](/docs/netbox/features/resource-ownership): Most objects in NetBox can be assigned an owner. An owner is a set of users and/or groups who are responsible for the administration of associated objects. F... - [Tenancy](/docs/netbox/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey assignment or dependenc... - [Contacts](/docs/netbox/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/features/event-rules): NetBox includes the ability to automatically perform certain functions in response to internal events. These include: - [User Preferences](/docs/netbox/features/user-preferences): NetBox stores per‑user options that control aspects of the web interface and data display. Preferences persist across sessions and can be managed under User ... - [Notifications](/docs/netbox/features/notifications): NetBox includes a system for generating user notifications, which can be marked as read or deleted by individual users. There are two built-in mechanisms for... - [Background Jobs](/docs/netbox/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/installation): Check out the NetBox Cloud Free Plan! Skip the installation process and grab your own NetBox Cloud instance, preconfigured and ready to go in minutes. Comple... - [PostgreSQL Database Installation](/docs/netbox/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/installation/2-redis) - [NetBox Installation](/docs/netbox/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/configuration/security): Default: ('file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp') - [GraphQL API Parameters](/docs/netbox/configuration/graphql-api): Designates the default version of the GraphQL API served by /graphql/. To access a specific version, append the version number to the URL, e.g. /graphql/v2/. - [Remote Authentication Settings](/docs/netbox/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be True in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/configuration/error-reporting): A dictionary mapping keyword arguments to values, to be passed to sentrysdk.init(). See the Sentry Python SDK documentation for more information on supported... - [Plugin Parameters](/docs/netbox/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/configuration/development): This setting enables debugging and displays a debugging toolbar in the user interface. Debugging should be enabled only during development or troubleshooting. - Customization - [Customization](/docs/netbox/customization): Customization documentation - [Custom Fields](/docs/netbox/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/customization/custom-scripts): 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 ... - Best Practices - [Best Practices](/docs/netbox/best-practices): Best Practices documentation - [Modeling Pluggable Transceivers](/docs/netbox/best-practices/modeling-pluggable-transceivers): Many network devices utilize field-swappable small-form factor pluggable transceivers (SFPs) to enable changing the physical media type of a fixed interface.... - [Performance Handbook](/docs/netbox/best-practices/performance-handbook): The purpose of this handbook is to help users and administrators use NetBox efficiently. It contains assorted recommendations and best practices compiled ove... - Integrations - [Integrations](/docs/netbox/integrations): Integrations documentation - [REST API Overview](/docs/netbox/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [UI Components](/docs/netbox/plugins/development/ui-components): All UI components described here were introduced in NetBox v4.6. Be sure to set the minimum NetBox version to 4.6.0 for your plugin before incorporating any ... - [Navigation](/docs/netbox/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/plugins/development/forms): NetBox provides several base form classes for use by plugins. Additional form classes are also available for other standard base model classes (PrimaryModel,... - [Filters & Filter Sets](/docs/netbox/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Event Types](/docs/netbox/plugins/development/event-types): Plugins can register their own custom event types for use with NetBox event rules. This is accomplished by calling the register() method on an instance of th... - [Custom Model Actions](/docs/netbox/plugins/development/permissions): Plugins can register custom permission actions for their models. These actions appear as checkboxes in the ObjectPermission form alongside the standard view/... - [Data Backends](/docs/netbox/plugins/development/data-backends) - [Webhooks](/docs/netbox/plugins/development/webhooks): NetBox supports the configuration of outbound webhooks which can be triggered by custom event rules. By default, a webhook's payload will contain a serialize... - [User Interface](/docs/netbox/plugins/development/user-interface): The NetBox user interface supports toggling between light and dark versions of the theme. If needed, a plugin can determine the currently active color theme ... - [REST API](/docs/netbox/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Jobs](/docs/netbox/plugins/development/background-jobs): NetBox plugins can defer certain operations by enqueuing background jobs, which are executed asynchronously by background workers. This is helpful for decoup... - [Dashboard Widgets](/docs/netbox/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Exceptions](/docs/netbox/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. - [Google](/docs/netbox/administration/authentication/google): This guide explains how to configure single sign-on (SSO) support for NetBox using Google OAuth2 as an authentication backend. - [Microsoft Entra ID](/docs/netbox/administration/authentication/microsoft-entra-id): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Entra ID as an authentication backend. - [Okta](/docs/netbox/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Management Commands](/docs/netbox/administration/management-commands): In addition to Django's built-in management commands, NetBox provides several commands of its own. These are run using manage.py: - [Replicating NetBox](/docs/netbox/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/models): Models documentation - Circuits - [Circuits](/docs/netbox/models/circuits): Circuits documentation - [Circuits](/docs/netbox/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Groups](/docs/netbox/models/circuits/circuitgroup): A unique human-friendly name. - [Circuit Group Assignments](/docs/netbox/models/circuits/circuitgroupassignment): Circuits can be assigned to circuit groups for correlation purposes. For instance, three circuits, each belonging to a different provider, may each be assign... - [Circuit Terminations](/docs/netbox/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - [Virtual Circuits](/docs/netbox/models/circuits/virtualcircuit): A virtual circuit can connect two or more interfaces atop a set of decoupled physical connections. For example, it's very common to form a virtual connection... - [Virtual Circuit Terminations](/docs/netbox/models/circuits/virtualcircuittermination): This model represents the connection of a virtual interface to a virtual circuit. - [Virtual Circuit Types](/docs/netbox/models/circuits/virtualcircuittype): Like physical circuits, virtual circuits are classified by functional type. These types are completely customizable, and can help categorize circuits by func... - Core - [Core](/docs/netbox/models/core): Core documentation - [Data Files](/docs/netbox/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/models/core/job): The Job model is used to schedule and record the execution of background tasks. - [Object Changes](/docs/netbox/models/core/objectchange): An object change is a record of a single create, update, or delete operation against an object whose model supports change logging. Object changes form a com... - [Object Types](/docs/netbox/models/core/objecttype): An object type identifies a NetBox model by its app label and model name (e.g. dcim.device). Object types are used wherever NetBox needs to refer to a model ... - DCIM - [Dcim](/docs/netbox/models/dcim): Dcim documentation - [Cables](/docs/netbox/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Cable Bundles](/docs/netbox/models/dcim/cablebundle): A cable bundle is a logical grouping of individual cables. Bundles are useful for organizing cables that share a common purpose, route, or physical grouping ... - [Console Ports](/docs/netbox/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/models/dcim/inventoryitem): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Roles](/docs/netbox/models/dcim/inventoryitemrole): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Templates](/docs/netbox/models/dcim/inventoryitemtemplate): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Locations](/docs/netbox/models/dcim/location): The parent site to which this location belongs. - [MAC Addresses](/docs/netbox/models/dcim/macaddress): A MAC address object in NetBox represents a single Ethernet link-layer address as reported by or assigned to a network interface. MAC addresses can be assign... - [Manufacturers](/docs/netbox/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Module Type Profiles](/docs/netbox/models/dcim/moduletypeprofile): Each module type may optionally be assigned a profile according to its classification. A profile can extend module types with user-configured attributes - fo... - [Platforms](/docs/netbox/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Groups](/docs/netbox/models/dcim/rackgroup): Racks can optionally be assigned to rack groups to reflect their physical placement. Rack groups provide a secondary means of categorization alongside locati... - [Rack Reservations](/docs/netbox/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rack Types](/docs/netbox/models/dcim/racktype): A rack type defines the physical characteristics of a particular model of rack. - [Rear Ports](/docs/netbox/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/models/extras): Extras documentation - [Bookmarks](/docs/netbox/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Configuration Contexts](/docs/netbox/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Config Context Profiles](/docs/netbox/models/extras/configcontextprofile): Profiles can be used to organize configuration contexts and to enforce a desired structure for their data. The latter is achieved by defining a JSON schema t... - [Configuration Templates](/docs/netbox/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Notification](/docs/netbox/models/extras/notification): A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notificatio... - [Notification Group](/docs/netbox/models/extras/notificationgroup): A set of NetBox users and/or groups of users identified as recipients for certain notifications. - [Saved Filters](/docs/netbox/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Subscription](/docs/netbox/models/extras/subscription): A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object. - [Table Configs](/docs/netbox/models/extras/tableconfig): This object represents the saved configuration of an object table in NetBox. Table configs can be crafted, saved, and shared among users to apply specific vi... - [Tags](/docs/netbox/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/models/ipam): Ipam documentation - [ASNs](/docs/netbox/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the Border Gateway Protocol (BGP) to identify which autonomous system a particular prefix i... - [ASN Ranges](/docs/netbox/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Application Services](/docs/netbox/models/ipam/service): An application service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to re... - [Application Service Templates](/docs/netbox/models/ipam/servicetemplate): Application service templates can be used to instantiate application services on devices and virtual machines. - [VLANs](/docs/netbox/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [VLAN Translation Policies](/docs/netbox/models/ipam/vlantranslationpolicy): VLAN translation is a feature that consists of VLAN translation policies and VLAN translation rules. Many rules can belong to a policy, and each rule defines... - [VLAN Translation Rules](/docs/netbox/models/ipam/vlantranslationrule): A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy. - [Virtual Routing and Forwarding (VRF)](/docs/netbox/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Users - [Users](/docs/netbox/models/users): Users documentation - [Groups](/docs/netbox/models/users/group): A group is a collection of users which share a common set of permissions. Assigning object permissions to a group, rather than to individual users, simplifie... - [Object Permissions](/docs/netbox/models/users/objectpermission): An object permission grants the ability to perform one or more actions (e.g. view, add, change, delete) against a defined set of object types, and may be res... - [Owner](/docs/netbox/models/users/owner): An owner is a set of users and/or groups who are responsible for the administration of certain resources within NetBox. The users and groups assigned to an o... - [Owner Groups](/docs/netbox/models/users/ownergroup): Groups are used to correlate and organize owners. The assignment of an owner to a group has no bearing on the relationship of owned objects to their owners; ... - [Tokens](/docs/netbox/models/users/token): A token is a secret credential associated with a user which authenticates requests to NetBox's REST and GraphQL APIs. A user may hold multiple tokens; each c... - [Users](/docs/netbox/models/users/user): A user represents an individual account in NetBox. Users authenticate to access the application, and may be granted permissions either directly or through th... - Virtualization - [Virtualization](/docs/netbox/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster or directly on a device. Each VM must be assigned to at least one of: a ... - [Virtual Machine Types](/docs/netbox/models/virtualization/virtualmachinetype): A virtual machine type defines a reusable classification and default configuration for virtual machines. - VPN - [Vpn](/docs/netbox/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/models/vpn/ikepolicy): An Internet Key Exchange (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/reference): Reference documentation - [REST API Filtering](/docs/netbox/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. ruff is used for linting (with certain exceptions). - [NetBox Models](/docs/netbox/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of releases: - [Building the Package](/docs/netbox/development/building-the-package): NetBox package artifacts (a wheel and a source distribution) can be built and verified locally. During the v4.6.x preview period, published artifacts are for... - [git Cheat Sheet](/docs/netbox/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.6](/docs/netbox/release-notes/version-4.6): A new VirtualMachineType model has been introduced to enable categorization of virtual machines by instance type, analogous to how DeviceType categorizes phy... - [NetBox v4.5](/docs/netbox/release-notes/version-4.5): Most object list filters within the UI have been extended to include optional lookup modifiers to support more complex queries. For instance, filters for num... - [NetBox v4.4](/docs/netbox/release-notes/version-4.4): Most bulk operations, such as the import, modification, or deletion of objects can now be executed as a background job. This frees the user to continue worki... - [NetBox v4.3](/docs/netbox/release-notes/version-4.3): The fix for bug #18900 now raises explicit exceptions when API endpoints attempt to paginate unordered querysets. Plugin maintainers should review their API ... - [NetBox v4.2](/docs/netbox/release-notes/version-4.2): MAC addresses are now managed as independent objects, rather than attributes on device and VM interfaces. NetBox now supports the assignment of multiple MAC ... - [NetBox v4.1](/docs/netbox/release-notes/version-4.1): This release contains a regression which breaks change logging. Please use release v4.1.10 instead. - [NetBox v4.0](/docs/netbox/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - NetBox v3.7 - [The Premier Network Source of Truth](/docs/netbox/v3.7): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v3.7/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v3.7/features): Features documentation - [Facilities](/docs/netbox/v3.7/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v3.7/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v3.7/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v3.7/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v3.7/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v3.7/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v3.7/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v3.7/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v3.7/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v3.7/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Tenancy](/docs/netbox/v3.7/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey ownership or dependency... - [Contacts](/docs/netbox/v3.7/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v3.7/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v3.7/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v3.7/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v3.7/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v3.7/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v3.7/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v3.7/features/event-rules): NetBox includes the ability to execute certain functions in response to internal object changes. These include: - [Background Jobs](/docs/netbox/v3.7/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v3.7/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v3.7/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v3.7/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v3.7/installation): The instructions below are for installing NetBox as a standalone, self-hosted application. For a Cloud-delivered solution, check out NetBox Cloud by NetBox L... - [PostgreSQL Database Installation](/docs/netbox/v3.7/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v3.7/installation/2-redis) - [NetBox Installation](/docs/netbox/v3.7/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v3.7/installation/4-gunicorn): Like most Django applications, NetBox runs as a WSGI application behind an HTTP server. This documentation shows how to install and configure gunicorn (which... - [HTTP Server Setup](/docs/netbox/v3.7/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v3.7/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v3.7/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v3.7/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v3.7/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v3.7/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v3.7/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v3.7/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v3.7/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v3.7/configuration/security): If disabled, the values of API tokens will not be displayed after each token's initial creation. A user must record the value of a token prior to its creatio... - [Remote Authentication Settings](/docs/netbox/v3.7/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be true in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v3.7/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v3.7/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v3.7/configuration/error-reporting): Defines a Sentry data source name (DSN) for automated error reporting. SENTRYENABLED must be True for this parameter to take effect. For example: - [Plugin Parameters](/docs/netbox/v3.7/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Date & Time Parameters](/docs/netbox/v3.7/configuration/date-time): The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. ... - [Miscellaneous Parameters](/docs/netbox/v3.7/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v3.7/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v3.7/customization): Customization documentation - [Custom Fields](/docs/netbox/v3.7/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v3.7/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v3.7/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v3.7/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v3.7/customization/reports): A NetBox report is a mechanism for validating the integrity of data within NetBox. Running a report allows the user to verify that the objects defined within... - [Custom Scripts](/docs/netbox/v3.7/customization/custom-scripts): 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 ... - Integrations - [Integrations](/docs/netbox/v3.7/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v3.7/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v3.7/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by the Graphene library and Graphene-Django. - [Webhooks](/docs/netbox/v3.7/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v3.7/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v3.7/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v3.7/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v3.7/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v3.7/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v3.7/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v3.7/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v3.7/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [Navigation](/docs/netbox/v3.7/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v3.7/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v3.7/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v3.7/plugins/development/forms): NetBox provides several base form classes for use by plugins. - [Filters & Filter Sets](/docs/netbox/v3.7/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v3.7/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Data Backends](/docs/netbox/v3.7/plugins/development/data-backends) - [REST API](/docs/netbox/v3.7/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v3.7/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Tasks](/docs/netbox/v3.7/plugins/development/background-tasks): NetBox supports the queuing of tasks that need to be performed in the background, decoupled from the request-response cycle, using the Python RQ library. Thr... - [Dashboard Widgets](/docs/netbox/v3.7/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Staged Changes](/docs/netbox/v3.7/plugins/development/staged-changes): This feature is still under active development and considered experimental in nature. Its use in production is strongly discouraged at this time. - [Exceptions](/docs/netbox/v3.7/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - Administration - [Administration](/docs/netbox/v3.7/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v3.7/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v3.7/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with ... - [Microsoft Azure AD](/docs/netbox/v3.7/administration/authentication/microsoft-azure-ad): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Azure Active Directory (AD) as an authentication backend. - [Okta](/docs/netbox/v3.7/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v3.7/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v3.7/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Housekeeping](/docs/netbox/v3.7/administration/housekeeping): NetBox includes a housekeeping management command that should be run nightly. This command handles: - [Replicating NetBox](/docs/netbox/v3.7/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v3.7/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v3.7/models): Models documentation - Circuits - [Circuits](/docs/netbox/v3.7/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v3.7/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Terminations](/docs/netbox/v3.7/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v3.7/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v3.7/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v3.7/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v3.7/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - Core - [Core](/docs/netbox/v3.7/models/core): Core documentation - [Data Files](/docs/netbox/v3.7/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v3.7/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v3.7/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v3.7/models/dcim): Dcim documentation - [Cables](/docs/netbox/v3.7/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v3.7/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v3.7/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v3.7/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v3.7/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v3.7/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v3.7/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v3.7/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v3.7/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v3.7/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v3.7/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v3.7/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v3.7/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v3.7/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v3.7/models/dcim/inventoryitem): Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily f... - [Inventory Item Roles](/docs/netbox/v3.7/models/dcim/inventoryitemrole): Inventory items can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for power supplies, fans,... - [Inventory Item Templates](/docs/netbox/v3.7/models/dcim/inventoryitemtemplate): A template for an inventory item that will be automatically created when instantiating a new device. All attributes of this object will be copied to the new ... - [Locations](/docs/netbox/v3.7/models/dcim/location): The parent site to which this location belongs. - [Manufacturers](/docs/netbox/v3.7/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v3.7/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v3.7/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v3.7/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v3.7/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Platforms](/docs/netbox/v3.7/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v3.7/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v3.7/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v3.7/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v3.7/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v3.7/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v3.7/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v3.7/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v3.7/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v3.7/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rear Ports](/docs/netbox/v3.7/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v3.7/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v3.7/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v3.7/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v3.7/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v3.7/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v3.7/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v3.7/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v3.7/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Branches](/docs/netbox/v3.7/models/extras/branch): A branch is a collection of related staged changes that have been prepared for merging into the active database. A branch can be merged by executing its comm... - [Configuration Contexts](/docs/netbox/v3.7/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Configuration Templates](/docs/netbox/v3.7/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v3.7/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v3.7/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v3.7/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v3.7/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v3.7/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v3.7/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v3.7/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Saved Filters](/docs/netbox/v3.7/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Staged Changes](/docs/netbox/v3.7/models/extras/stagedchange): A staged change represents the creation of a new object or the modification or deletion of an existing object to be performed at some future point. Each chan... - [Tags](/docs/netbox/v3.7/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v3.7/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v3.7/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v3.7/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the BGP protocol to identify which autonomous system a particular prefix is originating and... - [ASN Ranges](/docs/netbox/v3.7/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v3.7/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v3.7/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v3.7/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v3.7/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v3.7/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v3.7/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v3.7/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v3.7/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v3.7/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Services](/docs/netbox/v3.7/models/ipam/service): A service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to represent an HT... - [Service Templates](/docs/netbox/v3.7/models/ipam/servicetemplate): Service templates can be used to instantiate services on devices and virtual machines. - [VLANs](/docs/netbox/v3.7/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v3.7/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v3.7/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v3.7/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v3.7/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v3.7/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v3.7/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v3.7/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v3.7/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Virtualization - [Virtualization](/docs/netbox/v3.7/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v3.7/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v3.7/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v3.7/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v3.7/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v3.7/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v3.7/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v3.7/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v3.7/models/vpn/ikepolicy): An Internet Key Exhcnage (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v3.7/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v3.7/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v3.7/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v3.7/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v3.7/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v3.7/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v3.7/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v3.7/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v3.7/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v3.7/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v3.7/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v3.7/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v3.7/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v3.7/reference): Reference documentation - [REST API Filtering](/docs/netbox/v3.7/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v3.7/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v3.7/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v3.7/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v3.7/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v3.7/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. Pycodestyle is used to validate code formatting, ignoring certain violations. - [NetBox Models](/docs/netbox/v3.7/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v3.7/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v3.7/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v3.7/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v3.7/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v3.7/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v3.7/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v3.7/development/web-ui): The NetBox UI is built on languages and frameworks: - [Internationalization](/docs/netbox/v3.7/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v3.7/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v3.7/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of release: - [git Cheat Sheet](/docs/netbox/v3.7/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v3.7/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v3.7](/docs/netbox/v3.7/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v3.7/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v3.7/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v3.7/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v3.7/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v3.7/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v3.7/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v3.7/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v3.7/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v3.7/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v3.7/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v3.7/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v3.7/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v3.7/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v3.7/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v3.7/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v3.7/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v3.7/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v3.7/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v3.7/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v3.7/media): Media documentation - Authentication - [Authentication](/docs/netbox/v3.7/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v3.7/media/development): Development documentation - Installation - [Installation](/docs/netbox/v3.7/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v3.7/media/misc): Misc documentation - Models - [Models](/docs/netbox/v3.7/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v3.7/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v3.7/media/screenshots): Screenshots documentation - NetBox v4.0 - [The Premier Network Source of Truth](/docs/netbox/v4.0): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v4.0/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v4.0/features): Features documentation - [Facilities](/docs/netbox/v4.0/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v4.0/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v4.0/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v4.0/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v4.0/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v4.0/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v4.0/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v4.0/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v4.0/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v4.0/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Tenancy](/docs/netbox/v4.0/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey ownership or dependency... - [Contacts](/docs/netbox/v4.0/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v4.0/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v4.0/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v4.0/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v4.0/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v4.0/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v4.0/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v4.0/features/event-rules): NetBox includes the ability to execute certain functions in response to internal object changes. These include: - [Background Jobs](/docs/netbox/v4.0/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v4.0/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v4.0/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v4.0/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v4.0/installation): The instructions below are for installing NetBox as a standalone, self-hosted application. For a Cloud-delivered solution, check out NetBox Cloud by NetBox L... - [PostgreSQL Database Installation](/docs/netbox/v4.0/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v4.0/installation/2-redis) - [NetBox Installation](/docs/netbox/v4.0/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v4.0/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/v4.0/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/v4.0/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v4.0/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v4.0/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v4.0/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v4.0/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v4.0/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v4.0/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v4.0/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v4.0/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v4.0/configuration/security): If disabled, the values of API tokens will not be displayed after each token's initial creation. A user must record the value of a token prior to its creatio... - [Remote Authentication Settings](/docs/netbox/v4.0/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be true in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v4.0/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v4.0/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v4.0/configuration/error-reporting): Defines a Sentry data source name (DSN) for automated error reporting. SENTRYENABLED must be True for this parameter to take effect. For example: - [Plugin Parameters](/docs/netbox/v4.0/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/v4.0/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v4.0/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v4.0/customization): Customization documentation - [Custom Fields](/docs/netbox/v4.0/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v4.0/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v4.0/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v4.0/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v4.0/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/v4.0/customization/custom-scripts): 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 ... - Integrations - [Integrations](/docs/netbox/v4.0/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v4.0/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v4.0/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/v4.0/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v4.0/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v4.0/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v4.0/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v4.0/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v4.0/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v4.0/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v4.0/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v4.0/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [Navigation](/docs/netbox/v4.0/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v4.0/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v4.0/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v4.0/plugins/development/forms): NetBox provides several base form classes for use by plugins. - [Filters & Filter Sets](/docs/netbox/v4.0/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v4.0/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Data Backends](/docs/netbox/v4.0/plugins/development/data-backends) - [REST API](/docs/netbox/v4.0/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v4.0/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Tasks](/docs/netbox/v4.0/plugins/development/background-tasks): NetBox supports the queuing of tasks that need to be performed in the background, decoupled from the request-response cycle, using the Python RQ library. Thr... - [Dashboard Widgets](/docs/netbox/v4.0/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Staged Changes](/docs/netbox/v4.0/plugins/development/staged-changes): This feature is still under active development and considered experimental in nature. Its use in production is strongly discouraged at this time. - [Exceptions](/docs/netbox/v4.0/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/v4.0/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/v4.0/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v4.0/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v4.0/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with ... - [Microsoft Azure AD](/docs/netbox/v4.0/administration/authentication/microsoft-azure-ad): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Azure Active Directory (AD) as an authentication backend. - [Okta](/docs/netbox/v4.0/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v4.0/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v4.0/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Housekeeping](/docs/netbox/v4.0/administration/housekeeping): NetBox includes a housekeeping management command that should be run nightly. This command handles: - [Replicating NetBox](/docs/netbox/v4.0/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v4.0/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v4.0/models): Models documentation - Circuits - [Circuits](/docs/netbox/v4.0/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v4.0/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Terminations](/docs/netbox/v4.0/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v4.0/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v4.0/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v4.0/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v4.0/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - Core - [Core](/docs/netbox/v4.0/models/core): Core documentation - [Data Files](/docs/netbox/v4.0/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v4.0/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v4.0/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v4.0/models/dcim): Dcim documentation - [Cables](/docs/netbox/v4.0/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v4.0/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v4.0/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v4.0/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v4.0/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v4.0/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v4.0/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v4.0/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v4.0/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v4.0/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v4.0/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v4.0/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v4.0/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v4.0/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v4.0/models/dcim/inventoryitem): Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily f... - [Inventory Item Roles](/docs/netbox/v4.0/models/dcim/inventoryitemrole): Inventory items can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for power supplies, fans,... - [Inventory Item Templates](/docs/netbox/v4.0/models/dcim/inventoryitemtemplate): A template for an inventory item that will be automatically created when instantiating a new device. All attributes of this object will be copied to the new ... - [Locations](/docs/netbox/v4.0/models/dcim/location): The parent site to which this location belongs. - [Manufacturers](/docs/netbox/v4.0/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v4.0/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v4.0/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v4.0/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v4.0/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Platforms](/docs/netbox/v4.0/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v4.0/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v4.0/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v4.0/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v4.0/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v4.0/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v4.0/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v4.0/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v4.0/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v4.0/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rear Ports](/docs/netbox/v4.0/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v4.0/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v4.0/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v4.0/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v4.0/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v4.0/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v4.0/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v4.0/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v4.0/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Branches](/docs/netbox/v4.0/models/extras/branch): A branch is a collection of related staged changes that have been prepared for merging into the active database. A branch can be merged by executing its comm... - [Configuration Contexts](/docs/netbox/v4.0/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Configuration Templates](/docs/netbox/v4.0/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v4.0/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v4.0/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v4.0/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v4.0/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v4.0/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v4.0/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v4.0/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Saved Filters](/docs/netbox/v4.0/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Staged Changes](/docs/netbox/v4.0/models/extras/stagedchange): A staged change represents the creation of a new object or the modification or deletion of an existing object to be performed at some future point. Each chan... - [Tags](/docs/netbox/v4.0/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v4.0/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v4.0/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v4.0/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the BGP protocol to identify which autonomous system a particular prefix is originating and... - [ASN Ranges](/docs/netbox/v4.0/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v4.0/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v4.0/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v4.0/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v4.0/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v4.0/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v4.0/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v4.0/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v4.0/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v4.0/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Services](/docs/netbox/v4.0/models/ipam/service): A service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to represent an HT... - [Service Templates](/docs/netbox/v4.0/models/ipam/servicetemplate): Service templates can be used to instantiate services on devices and virtual machines. - [VLANs](/docs/netbox/v4.0/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v4.0/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v4.0/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v4.0/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v4.0/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v4.0/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v4.0/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v4.0/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v4.0/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Virtualization - [Virtualization](/docs/netbox/v4.0/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v4.0/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v4.0/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v4.0/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v4.0/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v4.0/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v4.0/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v4.0/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v4.0/models/vpn/ikepolicy): An Internet Key Exhcnage (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v4.0/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v4.0/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v4.0/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v4.0/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v4.0/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v4.0/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v4.0/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v4.0/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v4.0/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v4.0/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v4.0/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v4.0/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v4.0/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v4.0/reference): Reference documentation - [REST API Filtering](/docs/netbox/v4.0/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v4.0/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v4.0/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v4.0/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v4.0/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v4.0/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. Pycodestyle is used to validate code formatting, ignoring certain violations. - [NetBox Models](/docs/netbox/v4.0/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v4.0/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v4.0/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v4.0/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v4.0/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v4.0/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v4.0/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v4.0/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/v4.0/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v4.0/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v4.0/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of release: - [git Cheat Sheet](/docs/netbox/v4.0/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v4.0/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.0](/docs/netbox/v4.0/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/v4.0/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v4.0/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v4.0/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v4.0/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v4.0/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v4.0/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v4.0/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v4.0/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v4.0/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v4.0/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v4.0/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v4.0/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v4.0/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v4.0/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v4.0/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v4.0/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v4.0/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v4.0/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v4.0/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v4.0/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v4.0/media): Media documentation - Authentication - [Authentication](/docs/netbox/v4.0/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v4.0/media/development): Development documentation - Installation - [Installation](/docs/netbox/v4.0/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v4.0/media/misc): Misc documentation - Models - [Models](/docs/netbox/v4.0/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v4.0/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v4.0/media/screenshots): Screenshots documentation - NetBox v4.1 - [The Premier Network Source of Truth](/docs/netbox/v4.1): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v4.1/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v4.1/features): Features documentation - [Facilities](/docs/netbox/v4.1/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v4.1/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v4.1/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v4.1/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v4.1/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v4.1/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v4.1/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v4.1/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v4.1/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v4.1/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Tenancy](/docs/netbox/v4.1/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey ownership or dependency... - [Contacts](/docs/netbox/v4.1/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v4.1/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v4.1/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v4.1/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v4.1/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v4.1/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v4.1/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v4.1/features/event-rules): NetBox includes the ability to automatically perform certain functions in response to internal events. These include: - [Notifications](/docs/netbox/v4.1/features/notifications): NetBox includes a system for generating user notifications, which can be marked as read or deleted by individual users. There are two built-in mechanisms for... - [Background Jobs](/docs/netbox/v4.1/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v4.1/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v4.1/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v4.1/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v4.1/installation): The instructions below are for installing NetBox as a standalone, self-hosted application. For a Cloud-delivered solution, check out NetBox Cloud by NetBox L... - [PostgreSQL Database Installation](/docs/netbox/v4.1/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v4.1/installation/2-redis) - [NetBox Installation](/docs/netbox/v4.1/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v4.1/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/v4.1/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/v4.1/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v4.1/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v4.1/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v4.1/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v4.1/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v4.1/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v4.1/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v4.1/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v4.1/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v4.1/configuration/security): If disabled, the values of API tokens will not be displayed after each token's initial creation. A user must record the value of a token prior to its creatio... - [GraphQL API Parameters](/docs/netbox/v4.1/configuration/graphql-api): Setting this to False will disable the GraphQL API. - [Remote Authentication Settings](/docs/netbox/v4.1/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be true in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v4.1/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v4.1/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v4.1/configuration/error-reporting): Defines a Sentry data source name (DSN) for automated error reporting. SENTRYENABLED must be True for this parameter to take effect. For example: - [Plugin Parameters](/docs/netbox/v4.1/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/v4.1/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v4.1/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v4.1/customization): Customization documentation - [Custom Fields](/docs/netbox/v4.1/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v4.1/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v4.1/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v4.1/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v4.1/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/v4.1/customization/custom-scripts): 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 ... - Integrations - [Integrations](/docs/netbox/v4.1/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v4.1/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v4.1/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/v4.1/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v4.1/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v4.1/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v4.1/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v4.1/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v4.1/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v4.1/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v4.1/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v4.1/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [Navigation](/docs/netbox/v4.1/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v4.1/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v4.1/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v4.1/plugins/development/forms): NetBox provides several base form classes for use by plugins. - [Filters & Filter Sets](/docs/netbox/v4.1/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v4.1/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Event Types](/docs/netbox/v4.1/plugins/development/event-types): Plugins can register their own custom event types for use with NetBox event rules. This is accomplished by calling the register() method on an instance of th... - [Data Backends](/docs/netbox/v4.1/plugins/development/data-backends) - [REST API](/docs/netbox/v4.1/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v4.1/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Jobs](/docs/netbox/v4.1/plugins/development/background-jobs): NetBox plugins can defer certain operations by enqueuing background jobs, which are executed asynchronously by background workers. This is helpful for decoup... - [Dashboard Widgets](/docs/netbox/v4.1/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Staged Changes](/docs/netbox/v4.1/plugins/development/staged-changes): This feature is still under active development and considered experimental in nature. Its use in production is strongly discouraged at this time. - [Exceptions](/docs/netbox/v4.1/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/v4.1/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/v4.1/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v4.1/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v4.1/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with ... - [Google](/docs/netbox/v4.1/administration/authentication/google): This guide explains how to configure single sign-on (SSO) support for NetBox using Google OAuth2 as an authentication backend. - [Microsoft Entra ID](/docs/netbox/v4.1/administration/authentication/microsoft-entra-id): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Entra ID as an authentication backend. - [Okta](/docs/netbox/v4.1/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v4.1/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v4.1/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Housekeeping](/docs/netbox/v4.1/administration/housekeeping): NetBox includes a housekeeping management command that should be run nightly. This command handles: - [Replicating NetBox](/docs/netbox/v4.1/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v4.1/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v4.1/models): Models documentation - Circuits - [Circuits](/docs/netbox/v4.1/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v4.1/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Groups](/docs/netbox/v4.1/models/circuits/circuitgroup): A unique human-friendly name. - [Circuit Group Assignments](/docs/netbox/v4.1/models/circuits/circuitgroupassignment): Circuits can be assigned to circuit groups for correlation purposes. For instance, three circuits, each belonging to a different provider, may each be assign... - [Circuit Terminations](/docs/netbox/v4.1/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v4.1/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v4.1/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v4.1/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v4.1/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - Core - [Core](/docs/netbox/v4.1/models/core): Core documentation - [Data Files](/docs/netbox/v4.1/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v4.1/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v4.1/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v4.1/models/dcim): Dcim documentation - [Cables](/docs/netbox/v4.1/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v4.1/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v4.1/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v4.1/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v4.1/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v4.1/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v4.1/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v4.1/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v4.1/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v4.1/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v4.1/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v4.1/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v4.1/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v4.1/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v4.1/models/dcim/inventoryitem): Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily f... - [Inventory Item Roles](/docs/netbox/v4.1/models/dcim/inventoryitemrole): Inventory items can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for power supplies, fans,... - [Inventory Item Templates](/docs/netbox/v4.1/models/dcim/inventoryitemtemplate): A template for an inventory item that will be automatically created when instantiating a new device. All attributes of this object will be copied to the new ... - [Locations](/docs/netbox/v4.1/models/dcim/location): The parent site to which this location belongs. - [Manufacturers](/docs/netbox/v4.1/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v4.1/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v4.1/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v4.1/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v4.1/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Platforms](/docs/netbox/v4.1/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v4.1/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v4.1/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v4.1/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v4.1/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v4.1/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v4.1/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v4.1/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v4.1/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v4.1/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rack Types](/docs/netbox/v4.1/models/dcim/racktype): A rack type defines the physical characteristics of a particular model of rack. - [Rear Ports](/docs/netbox/v4.1/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v4.1/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v4.1/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v4.1/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v4.1/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v4.1/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v4.1/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v4.1/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v4.1/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Branches](/docs/netbox/v4.1/models/extras/branch): A branch is a collection of related staged changes that have been prepared for merging into the active database. A branch can be merged by executing its comm... - [Configuration Contexts](/docs/netbox/v4.1/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Configuration Templates](/docs/netbox/v4.1/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v4.1/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v4.1/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v4.1/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v4.1/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v4.1/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v4.1/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v4.1/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Notification](/docs/netbox/v4.1/models/extras/notification): A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notificatio... - [Notification Group](/docs/netbox/v4.1/models/extras/notificationgroup): A set of NetBox users and/or groups of users identified as recipients for certain notifications. - [Saved Filters](/docs/netbox/v4.1/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Staged Changes](/docs/netbox/v4.1/models/extras/stagedchange): A staged change represents the creation of a new object or the modification or deletion of an existing object to be performed at some future point. Each chan... - [Subscription](/docs/netbox/v4.1/models/extras/subscription): A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object. - [Tags](/docs/netbox/v4.1/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v4.1/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v4.1/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v4.1/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the Border Gateway Protocol (BGP) to identify which autonomous system a particular prefix i... - [ASN Ranges](/docs/netbox/v4.1/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v4.1/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v4.1/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v4.1/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v4.1/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v4.1/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v4.1/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v4.1/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v4.1/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v4.1/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Services](/docs/netbox/v4.1/models/ipam/service): A service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to represent an HT... - [Service Templates](/docs/netbox/v4.1/models/ipam/servicetemplate): Service templates can be used to instantiate services on devices and virtual machines. - [VLANs](/docs/netbox/v4.1/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v4.1/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v4.1/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v4.1/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v4.1/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v4.1/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v4.1/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v4.1/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v4.1/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Virtualization - [Virtualization](/docs/netbox/v4.1/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v4.1/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v4.1/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v4.1/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v4.1/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v4.1/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v4.1/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v4.1/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v4.1/models/vpn/ikepolicy): An Internet Key Exchange (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v4.1/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v4.1/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v4.1/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v4.1/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v4.1/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v4.1/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v4.1/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v4.1/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v4.1/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v4.1/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v4.1/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v4.1/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v4.1/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v4.1/reference): Reference documentation - [REST API Filtering](/docs/netbox/v4.1/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v4.1/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v4.1/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v4.1/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v4.1/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v4.1/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. ruff is used for linting (with certain exceptions). - [NetBox Models](/docs/netbox/v4.1/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v4.1/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v4.1/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v4.1/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v4.1/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v4.1/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v4.1/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v4.1/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/v4.1/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v4.1/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v4.1/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of release: - [git Cheat Sheet](/docs/netbox/v4.1/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v4.1/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.1](/docs/netbox/v4.1/release-notes/version-4.1): This release contains a regression which breaks change logging. Please use release v4.1.10 instead. - [NetBox v4.0](/docs/netbox/v4.1/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/v4.1/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v4.1/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v4.1/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v4.1/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v4.1/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v4.1/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v4.1/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v4.1/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v4.1/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v4.1/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v4.1/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v4.1/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v4.1/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v4.1/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v4.1/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v4.1/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v4.1/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v4.1/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v4.1/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v4.1/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v4.1/media): Media documentation - Authentication - [Authentication](/docs/netbox/v4.1/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v4.1/media/development): Development documentation - Installation - [Installation](/docs/netbox/v4.1/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v4.1/media/misc): Misc documentation - Models - [Models](/docs/netbox/v4.1/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v4.1/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v4.1/media/screenshots): Screenshots documentation - NetBox v4.2 - [The Premier Network Source of Truth](/docs/netbox/v4.2): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v4.2/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v4.2/features): Features documentation - [Facilities](/docs/netbox/v4.2/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v4.2/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v4.2/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v4.2/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v4.2/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v4.2/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v4.2/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v4.2/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v4.2/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v4.2/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Tenancy](/docs/netbox/v4.2/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey ownership or dependency... - [Contacts](/docs/netbox/v4.2/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v4.2/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v4.2/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v4.2/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v4.2/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v4.2/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v4.2/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v4.2/features/event-rules): NetBox includes the ability to automatically perform certain functions in response to internal events. These include: - [Notifications](/docs/netbox/v4.2/features/notifications): NetBox includes a system for generating user notifications, which can be marked as read or deleted by individual users. There are two built-in mechanisms for... - [Background Jobs](/docs/netbox/v4.2/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v4.2/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v4.2/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v4.2/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v4.2/installation): The instructions below are for installing NetBox as a standalone, self-hosted application. For a Cloud-delivered solution, check out NetBox Cloud by NetBox L... - [PostgreSQL Database Installation](/docs/netbox/v4.2/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v4.2/installation/2-redis) - [NetBox Installation](/docs/netbox/v4.2/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v4.2/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/v4.2/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/v4.2/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v4.2/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v4.2/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v4.2/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v4.2/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v4.2/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v4.2/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v4.2/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v4.2/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v4.2/configuration/security): If disabled, the values of API tokens will not be displayed after each token's initial creation. A user must record the value of a token prior to its creatio... - [GraphQL API Parameters](/docs/netbox/v4.2/configuration/graphql-api): Setting this to False will disable the GraphQL API. - [Remote Authentication Settings](/docs/netbox/v4.2/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be true in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v4.2/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v4.2/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v4.2/configuration/error-reporting): Defines a Sentry data source name (DSN) for automated error reporting. SENTRYENABLED must be True for this parameter to take effect. For example: - [Plugin Parameters](/docs/netbox/v4.2/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/v4.2/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v4.2/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v4.2/customization): Customization documentation - [Custom Fields](/docs/netbox/v4.2/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v4.2/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v4.2/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v4.2/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v4.2/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/v4.2/customization/custom-scripts): 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 ... - Integrations - [Integrations](/docs/netbox/v4.2/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v4.2/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v4.2/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/v4.2/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v4.2/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v4.2/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v4.2/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v4.2/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v4.2/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v4.2/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v4.2/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v4.2/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [Navigation](/docs/netbox/v4.2/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v4.2/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v4.2/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v4.2/plugins/development/forms): NetBox provides several base form classes for use by plugins. - [Filters & Filter Sets](/docs/netbox/v4.2/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v4.2/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Event Types](/docs/netbox/v4.2/plugins/development/event-types): Plugins can register their own custom event types for use with NetBox event rules. This is accomplished by calling the register() method on an instance of th... - [Data Backends](/docs/netbox/v4.2/plugins/development/data-backends) - [REST API](/docs/netbox/v4.2/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v4.2/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Jobs](/docs/netbox/v4.2/plugins/development/background-jobs): NetBox plugins can defer certain operations by enqueuing background jobs, which are executed asynchronously by background workers. This is helpful for decoup... - [Dashboard Widgets](/docs/netbox/v4.2/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Staged Changes](/docs/netbox/v4.2/plugins/development/staged-changes): This feature has been deprecated in NetBox v4.2 and will be removed in a future release. Please consider using the netbox-branching plugin, which provides mu... - [Exceptions](/docs/netbox/v4.2/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/v4.2/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/v4.2/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v4.2/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v4.2/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with ... - [Google](/docs/netbox/v4.2/administration/authentication/google): This guide explains how to configure single sign-on (SSO) support for NetBox using Google OAuth2 as an authentication backend. - [Microsoft Entra ID](/docs/netbox/v4.2/administration/authentication/microsoft-entra-id): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Entra ID as an authentication backend. - [Okta](/docs/netbox/v4.2/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v4.2/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v4.2/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Housekeeping](/docs/netbox/v4.2/administration/housekeeping): NetBox includes a housekeeping management command that should be run nightly. This command handles: - [Replicating NetBox](/docs/netbox/v4.2/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v4.2/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v4.2/models): Models documentation - Circuits - [Circuits](/docs/netbox/v4.2/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v4.2/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Groups](/docs/netbox/v4.2/models/circuits/circuitgroup): A unique human-friendly name. - [Circuit Group Assignments](/docs/netbox/v4.2/models/circuits/circuitgroupassignment): Circuits can be assigned to circuit groups for correlation purposes. For instance, three circuits, each belonging to a different provider, may each be assign... - [Circuit Terminations](/docs/netbox/v4.2/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v4.2/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v4.2/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v4.2/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v4.2/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - [Virtual Circuits](/docs/netbox/v4.2/models/circuits/virtualcircuit): A virtual circuit can connect two or more interfaces atop a set of decoupled physical connections. For example, it's very common to form a virtual connection... - [Virtual Circuit Terminations](/docs/netbox/v4.2/models/circuits/virtualcircuittermination): This model represents the connection of a virtual interface to a virtual circuit. - [Virtual Circuit Types](/docs/netbox/v4.2/models/circuits/virtualcircuittype): Like physical circuits, virtual circuits are classified by functional type. These types are completely customizable, and can help categorize circuits by func... - Core - [Core](/docs/netbox/v4.2/models/core): Core documentation - [Data Files](/docs/netbox/v4.2/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v4.2/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v4.2/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v4.2/models/dcim): Dcim documentation - [Cables](/docs/netbox/v4.2/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v4.2/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v4.2/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v4.2/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v4.2/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v4.2/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v4.2/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v4.2/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v4.2/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v4.2/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v4.2/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v4.2/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v4.2/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v4.2/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v4.2/models/dcim/inventoryitem): Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily f... - [Inventory Item Roles](/docs/netbox/v4.2/models/dcim/inventoryitemrole): Inventory items can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for power supplies, fans,... - [Inventory Item Templates](/docs/netbox/v4.2/models/dcim/inventoryitemtemplate): A template for an inventory item that will be automatically created when instantiating a new device. All attributes of this object will be copied to the new ... - [Locations](/docs/netbox/v4.2/models/dcim/location): The parent site to which this location belongs. - [MAC Addresses](/docs/netbox/v4.2/models/dcim/macaddress): A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface... - [Manufacturers](/docs/netbox/v4.2/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v4.2/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v4.2/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v4.2/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v4.2/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Platforms](/docs/netbox/v4.2/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v4.2/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v4.2/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v4.2/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v4.2/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v4.2/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v4.2/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v4.2/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v4.2/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v4.2/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rack Types](/docs/netbox/v4.2/models/dcim/racktype): A rack type defines the physical characteristics of a particular model of rack. - [Rear Ports](/docs/netbox/v4.2/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v4.2/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v4.2/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v4.2/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v4.2/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v4.2/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v4.2/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v4.2/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v4.2/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Branches](/docs/netbox/v4.2/models/extras/branch): This feature has been deprecated in NetBox v4.2 and will be removed in a future release. Please consider using the netbox-branching plugin, which provides mu... - [Configuration Contexts](/docs/netbox/v4.2/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Configuration Templates](/docs/netbox/v4.2/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v4.2/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v4.2/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v4.2/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v4.2/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v4.2/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v4.2/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v4.2/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Notification](/docs/netbox/v4.2/models/extras/notification): A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notificatio... - [Notification Group](/docs/netbox/v4.2/models/extras/notificationgroup): A set of NetBox users and/or groups of users identified as recipients for certain notifications. - [Saved Filters](/docs/netbox/v4.2/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Staged Changes](/docs/netbox/v4.2/models/extras/stagedchange): This feature has been deprecated in NetBox v4.2 and will be removed in a future release. Please consider using the netbox-branching plugin, which provides mu... - [Subscription](/docs/netbox/v4.2/models/extras/subscription): A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object. - [Tags](/docs/netbox/v4.2/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v4.2/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v4.2/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v4.2/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the Border Gateway Protocol (BGP) to identify which autonomous system a particular prefix i... - [ASN Ranges](/docs/netbox/v4.2/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v4.2/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v4.2/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v4.2/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v4.2/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v4.2/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v4.2/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v4.2/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v4.2/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v4.2/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Services](/docs/netbox/v4.2/models/ipam/service): A service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to represent an HT... - [Service Templates](/docs/netbox/v4.2/models/ipam/servicetemplate): Service templates can be used to instantiate services on devices and virtual machines. - [VLANs](/docs/netbox/v4.2/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v4.2/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [VLAN Translation Policies](/docs/netbox/v4.2/models/ipam/vlantranslationpolicy): VLAN translation is a feature that consists of VLAN translation policies and VLAN translation rules. Many rules can belong to a policy, and each rule defines... - [VLAN Translation Rules](/docs/netbox/v4.2/models/ipam/vlantranslationrule): A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy. - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v4.2/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v4.2/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v4.2/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v4.2/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v4.2/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v4.2/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v4.2/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Virtualization - [Virtualization](/docs/netbox/v4.2/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v4.2/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v4.2/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v4.2/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v4.2/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v4.2/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v4.2/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v4.2/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v4.2/models/vpn/ikepolicy): An Internet Key Exchange (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v4.2/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v4.2/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v4.2/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v4.2/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v4.2/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v4.2/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v4.2/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v4.2/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v4.2/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v4.2/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v4.2/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v4.2/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v4.2/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v4.2/reference): Reference documentation - [REST API Filtering](/docs/netbox/v4.2/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v4.2/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v4.2/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v4.2/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v4.2/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v4.2/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. ruff is used for linting (with certain exceptions). - [NetBox Models](/docs/netbox/v4.2/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v4.2/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v4.2/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v4.2/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v4.2/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v4.2/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v4.2/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v4.2/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/v4.2/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v4.2/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v4.2/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of releases: - [git Cheat Sheet](/docs/netbox/v4.2/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v4.2/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.2](/docs/netbox/v4.2/release-notes/version-4.2): MAC addresses are now managed as independent objects, rather than attributes on device and VM interfaces. NetBox now supports the assignment of multiple MAC ... - [NetBox v4.1](/docs/netbox/v4.2/release-notes/version-4.1): This release contains a regression which breaks change logging. Please use release v4.1.10 instead. - [NetBox v4.0](/docs/netbox/v4.2/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/v4.2/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v4.2/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v4.2/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v4.2/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v4.2/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v4.2/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v4.2/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v4.2/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v4.2/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v4.2/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v4.2/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v4.2/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v4.2/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v4.2/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v4.2/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v4.2/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v4.2/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v4.2/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v4.2/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v4.2/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v4.2/media): Media documentation - Authentication - [Authentication](/docs/netbox/v4.2/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v4.2/media/development): Development documentation - Installation - [Installation](/docs/netbox/v4.2/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v4.2/media/misc): Misc documentation - Models - [Models](/docs/netbox/v4.2/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v4.2/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v4.2/media/screenshots): Screenshots documentation - NetBox v4.3 - [The Premier Network Source of Truth](/docs/netbox/v4.3): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v4.3/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v4.3/features): Features documentation - [Facilities](/docs/netbox/v4.3/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v4.3/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v4.3/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v4.3/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v4.3/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v4.3/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v4.3/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v4.3/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v4.3/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v4.3/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Tenancy](/docs/netbox/v4.3/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey ownership or dependency... - [Contacts](/docs/netbox/v4.3/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v4.3/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v4.3/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v4.3/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v4.3/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v4.3/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v4.3/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v4.3/features/event-rules): NetBox includes the ability to automatically perform certain functions in response to internal events. These include: - [Notifications](/docs/netbox/v4.3/features/notifications): NetBox includes a system for generating user notifications, which can be marked as read or deleted by individual users. There are two built-in mechanisms for... - [Background Jobs](/docs/netbox/v4.3/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v4.3/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v4.3/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v4.3/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v4.3/installation): Check out the NetBox Cloud Free Plan! Skip the installation process and grab your own NetBox Cloud instance, preconfigured and ready to go in minutes. Comple... - [PostgreSQL Database Installation](/docs/netbox/v4.3/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v4.3/installation/2-redis) - [NetBox Installation](/docs/netbox/v4.3/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v4.3/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/v4.3/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/v4.3/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v4.3/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v4.3/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v4.3/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v4.3/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v4.3/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v4.3/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v4.3/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v4.3/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v4.3/configuration/security): The default value of this parameter changed from True to False in NetBox v4.3.0. - [GraphQL API Parameters](/docs/netbox/v4.3/configuration/graphql-api): Setting this to False will disable the GraphQL API. - [Remote Authentication Settings](/docs/netbox/v4.3/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be True in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v4.3/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v4.3/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v4.3/configuration/error-reporting): Defines a Sentry data source name (DSN) for automated error reporting. SENTRYENABLED must be True for this parameter to take effect. For example: - [Plugin Parameters](/docs/netbox/v4.3/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/v4.3/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v4.3/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v4.3/customization): Customization documentation - [Custom Fields](/docs/netbox/v4.3/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v4.3/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v4.3/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v4.3/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v4.3/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/v4.3/customization/custom-scripts): 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 ... - Integrations - [Integrations](/docs/netbox/v4.3/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v4.3/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v4.3/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/v4.3/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v4.3/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v4.3/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v4.3/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v4.3/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v4.3/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v4.3/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v4.3/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v4.3/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [Navigation](/docs/netbox/v4.3/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v4.3/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v4.3/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v4.3/plugins/development/forms): NetBox provides several base form classes for use by plugins. - [Filters & Filter Sets](/docs/netbox/v4.3/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v4.3/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Event Types](/docs/netbox/v4.3/plugins/development/event-types): Plugins can register their own custom event types for use with NetBox event rules. This is accomplished by calling the register() method on an instance of th... - [Data Backends](/docs/netbox/v4.3/plugins/development/data-backends) - [REST API](/docs/netbox/v4.3/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v4.3/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Jobs](/docs/netbox/v4.3/plugins/development/background-jobs): NetBox plugins can defer certain operations by enqueuing background jobs, which are executed asynchronously by background workers. This is helpful for decoup... - [Dashboard Widgets](/docs/netbox/v4.3/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Exceptions](/docs/netbox/v4.3/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/v4.3/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/v4.3/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v4.3/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v4.3/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with ... - [Google](/docs/netbox/v4.3/administration/authentication/google): This guide explains how to configure single sign-on (SSO) support for NetBox using Google OAuth2 as an authentication backend. - [Microsoft Entra ID](/docs/netbox/v4.3/administration/authentication/microsoft-entra-id): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Entra ID as an authentication backend. - [Okta](/docs/netbox/v4.3/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v4.3/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v4.3/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Housekeeping](/docs/netbox/v4.3/administration/housekeeping): NetBox includes a housekeeping management command that should be run nightly. This command handles: - [Replicating NetBox](/docs/netbox/v4.3/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v4.3/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v4.3/models): Models documentation - Circuits - [Circuits](/docs/netbox/v4.3/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v4.3/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Groups](/docs/netbox/v4.3/models/circuits/circuitgroup): A unique human-friendly name. - [Circuit Group Assignments](/docs/netbox/v4.3/models/circuits/circuitgroupassignment): Circuits can be assigned to circuit groups for correlation purposes. For instance, three circuits, each belonging to a different provider, may each be assign... - [Circuit Terminations](/docs/netbox/v4.3/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v4.3/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v4.3/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v4.3/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v4.3/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - [Virtual Circuits](/docs/netbox/v4.3/models/circuits/virtualcircuit): A virtual circuit can connect two or more interfaces atop a set of decoupled physical connections. For example, it's very common to form a virtual connection... - [Virtual Circuit Terminations](/docs/netbox/v4.3/models/circuits/virtualcircuittermination): This model represents the connection of a virtual interface to a virtual circuit. - [Virtual Circuit Types](/docs/netbox/v4.3/models/circuits/virtualcircuittype): Like physical circuits, virtual circuits are classified by functional type. These types are completely customizable, and can help categorize circuits by func... - Core - [Core](/docs/netbox/v4.3/models/core): Core documentation - [Data Files](/docs/netbox/v4.3/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v4.3/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v4.3/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v4.3/models/dcim): Dcim documentation - [Cables](/docs/netbox/v4.3/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v4.3/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v4.3/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v4.3/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v4.3/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v4.3/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v4.3/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v4.3/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v4.3/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v4.3/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v4.3/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v4.3/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v4.3/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v4.3/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v4.3/models/dcim/inventoryitem): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Roles](/docs/netbox/v4.3/models/dcim/inventoryitemrole): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Templates](/docs/netbox/v4.3/models/dcim/inventoryitemtemplate): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Locations](/docs/netbox/v4.3/models/dcim/location): The parent site to which this location belongs. - [MAC Addresses](/docs/netbox/v4.3/models/dcim/macaddress): A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface... - [Manufacturers](/docs/netbox/v4.3/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v4.3/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v4.3/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v4.3/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v4.3/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Module Type Profiles](/docs/netbox/v4.3/models/dcim/moduletypeprofile): Each module type may optionally be assigned a profile according to its classification. A profile can extend module types with user-configured attributes. For... - [Platforms](/docs/netbox/v4.3/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v4.3/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v4.3/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v4.3/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v4.3/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v4.3/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v4.3/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v4.3/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v4.3/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v4.3/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rack Types](/docs/netbox/v4.3/models/dcim/racktype): A rack type defines the physical characteristics of a particular model of rack. - [Rear Ports](/docs/netbox/v4.3/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v4.3/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v4.3/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v4.3/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v4.3/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v4.3/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v4.3/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v4.3/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v4.3/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Configuration Contexts](/docs/netbox/v4.3/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Configuration Templates](/docs/netbox/v4.3/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v4.3/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v4.3/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v4.3/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v4.3/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v4.3/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v4.3/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v4.3/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Notification](/docs/netbox/v4.3/models/extras/notification): A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notificatio... - [Notification Group](/docs/netbox/v4.3/models/extras/notificationgroup): A set of NetBox users and/or groups of users identified as recipients for certain notifications. - [Saved Filters](/docs/netbox/v4.3/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Subscription](/docs/netbox/v4.3/models/extras/subscription): A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object. - [Table Configs](/docs/netbox/v4.3/models/extras/tableconfig): This object represents the saved configuration of an object table in NetBox. Table configs can be crafted, saved, and shared among users to apply specific vi... - [Tags](/docs/netbox/v4.3/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v4.3/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v4.3/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v4.3/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the Border Gateway Protocol (BGP) to identify which autonomous system a particular prefix i... - [ASN Ranges](/docs/netbox/v4.3/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v4.3/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v4.3/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v4.3/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v4.3/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v4.3/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v4.3/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v4.3/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v4.3/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v4.3/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Services](/docs/netbox/v4.3/models/ipam/service): A service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to represent an HT... - [Service Templates](/docs/netbox/v4.3/models/ipam/servicetemplate): Service templates can be used to instantiate services on devices and virtual machines. - [VLANs](/docs/netbox/v4.3/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v4.3/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [VLAN Translation Policies](/docs/netbox/v4.3/models/ipam/vlantranslationpolicy): VLAN translation is a feature that consists of VLAN translation policies and VLAN translation rules. Many rules can belong to a policy, and each rule defines... - [VLAN Translation Rules](/docs/netbox/v4.3/models/ipam/vlantranslationrule): A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy. - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v4.3/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v4.3/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v4.3/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v4.3/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v4.3/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v4.3/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v4.3/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Virtualization - [Virtualization](/docs/netbox/v4.3/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v4.3/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v4.3/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v4.3/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v4.3/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v4.3/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v4.3/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v4.3/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v4.3/models/vpn/ikepolicy): An Internet Key Exchange (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v4.3/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v4.3/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v4.3/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v4.3/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v4.3/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v4.3/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v4.3/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v4.3/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v4.3/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v4.3/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v4.3/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v4.3/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v4.3/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v4.3/reference): Reference documentation - [REST API Filtering](/docs/netbox/v4.3/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v4.3/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v4.3/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v4.3/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v4.3/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v4.3/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. ruff is used for linting (with certain exceptions). - [NetBox Models](/docs/netbox/v4.3/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v4.3/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v4.3/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v4.3/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v4.3/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v4.3/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v4.3/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v4.3/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/v4.3/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v4.3/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v4.3/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of releases: - [git Cheat Sheet](/docs/netbox/v4.3/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v4.3/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.3](/docs/netbox/v4.3/release-notes/version-4.3): The fix for bug #18900 now raises explicit exceptions when API endpoints attempt to paginate unordered querysets. Plugin maintainers should review their API ... - [NetBox v4.2](/docs/netbox/v4.3/release-notes/version-4.2): MAC addresses are now managed as independent objects, rather than attributes on device and VM interfaces. NetBox now supports the assignment of multiple MAC ... - [NetBox v4.1](/docs/netbox/v4.3/release-notes/version-4.1): This release contains a regression which breaks change logging. Please use release v4.1.10 instead. - [NetBox v4.0](/docs/netbox/v4.3/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/v4.3/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v4.3/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v4.3/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v4.3/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v4.3/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v4.3/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v4.3/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v4.3/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v4.3/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v4.3/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v4.3/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v4.3/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v4.3/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v4.3/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v4.3/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v4.3/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v4.3/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v4.3/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v4.3/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v4.3/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v4.3/media): Media documentation - Authentication - [Authentication](/docs/netbox/v4.3/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v4.3/media/development): Development documentation - Installation - [Installation](/docs/netbox/v4.3/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v4.3/media/misc): Misc documentation - Models - [Models](/docs/netbox/v4.3/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v4.3/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v4.3/media/screenshots): Screenshots documentation - NetBox v4.4 - [The Premier Network Source of Truth](/docs/netbox/v4.4): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v4.4/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v4.4/features): Features documentation - [Facilities](/docs/netbox/v4.4/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v4.4/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v4.4/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v4.4/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v4.4/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v4.4/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v4.4/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v4.4/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v4.4/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v4.4/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Tenancy](/docs/netbox/v4.4/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey ownership or dependency... - [Contacts](/docs/netbox/v4.4/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v4.4/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v4.4/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v4.4/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v4.4/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v4.4/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v4.4/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v4.4/features/event-rules): NetBox includes the ability to automatically perform certain functions in response to internal events. These include: - [User Preferences](/docs/netbox/v4.4/features/user-preferences): NetBox stores per‑user options that control aspects of the web interface and data display. Preferences persist across sessions and can be managed under User ... - [Notifications](/docs/netbox/v4.4/features/notifications): NetBox includes a system for generating user notifications, which can be marked as read or deleted by individual users. There are two built-in mechanisms for... - [Background Jobs](/docs/netbox/v4.4/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v4.4/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v4.4/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v4.4/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v4.4/installation): Check out the NetBox Cloud Free Plan! Skip the installation process and grab your own NetBox Cloud instance, preconfigured and ready to go in minutes. Comple... - [PostgreSQL Database Installation](/docs/netbox/v4.4/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v4.4/installation/2-redis) - [NetBox Installation](/docs/netbox/v4.4/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v4.4/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/v4.4/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/v4.4/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v4.4/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v4.4/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v4.4/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v4.4/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v4.4/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v4.4/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v4.4/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v4.4/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v4.4/configuration/security): The default value of this parameter changed from True to False in NetBox v4.3.0. - [GraphQL API Parameters](/docs/netbox/v4.4/configuration/graphql-api): Setting this to False will disable the GraphQL API. - [Remote Authentication Settings](/docs/netbox/v4.4/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be True in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v4.4/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v4.4/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v4.4/configuration/error-reporting): A dictionary mapping keyword arguments to values, to be passed to sentrysdk.init(). See the Sentry Python SDK documentation for more information on supported... - [Plugin Parameters](/docs/netbox/v4.4/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/v4.4/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v4.4/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v4.4/customization): Customization documentation - [Custom Fields](/docs/netbox/v4.4/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v4.4/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v4.4/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v4.4/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v4.4/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/v4.4/customization/custom-scripts): 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 ... - Best Practices - [Best Practices](/docs/netbox/v4.4/best-practices): Best Practices documentation - [Modeling Pluggable Transceivers](/docs/netbox/v4.4/best-practices/modeling-pluggable-transceivers): Many network devices utilize field-swappable small-form factor pluggable transceivers (SFPs) to enable changing the physical media type of a fixed interface.... - [Performance Handbook](/docs/netbox/v4.4/best-practices/performance-handbook): The purpose of this handbook is to help users and administrators use NetBox efficiently. It contains assorted recommendations and best practices compiled ove... - Integrations - [Integrations](/docs/netbox/v4.4/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v4.4/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v4.4/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/v4.4/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v4.4/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v4.4/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v4.4/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v4.4/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v4.4/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v4.4/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v4.4/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v4.4/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [Navigation](/docs/netbox/v4.4/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v4.4/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v4.4/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v4.4/plugins/development/forms): NetBox provides several base form classes for use by plugins. - [Filters & Filter Sets](/docs/netbox/v4.4/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v4.4/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Event Types](/docs/netbox/v4.4/plugins/development/event-types): Plugins can register their own custom event types for use with NetBox event rules. This is accomplished by calling the register() method on an instance of th... - [Data Backends](/docs/netbox/v4.4/plugins/development/data-backends) - [Webhooks](/docs/netbox/v4.4/plugins/development/webhooks): NetBox supports the configuration of outbound webhooks which can be triggered by custom event rules. By default, a webhook's payload will contain a serialize... - [User Interface](/docs/netbox/v4.4/plugins/development/user-interface): The NetBox user interface supports toggling between light and dark versions of the theme. If needed, a plugin can determine the currently active color theme ... - [REST API](/docs/netbox/v4.4/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v4.4/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Jobs](/docs/netbox/v4.4/plugins/development/background-jobs): NetBox plugins can defer certain operations by enqueuing background jobs, which are executed asynchronously by background workers. This is helpful for decoup... - [Dashboard Widgets](/docs/netbox/v4.4/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Exceptions](/docs/netbox/v4.4/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/v4.4/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/v4.4/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v4.4/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v4.4/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with ... - [Google](/docs/netbox/v4.4/administration/authentication/google): This guide explains how to configure single sign-on (SSO) support for NetBox using Google OAuth2 as an authentication backend. - [Microsoft Entra ID](/docs/netbox/v4.4/administration/authentication/microsoft-entra-id): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Entra ID as an authentication backend. - [Okta](/docs/netbox/v4.4/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v4.4/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v4.4/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Replicating NetBox](/docs/netbox/v4.4/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v4.4/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v4.4/models): Models documentation - Circuits - [Circuits](/docs/netbox/v4.4/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v4.4/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Groups](/docs/netbox/v4.4/models/circuits/circuitgroup): A unique human-friendly name. - [Circuit Group Assignments](/docs/netbox/v4.4/models/circuits/circuitgroupassignment): Circuits can be assigned to circuit groups for correlation purposes. For instance, three circuits, each belonging to a different provider, may each be assign... - [Circuit Terminations](/docs/netbox/v4.4/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v4.4/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v4.4/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v4.4/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v4.4/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - [Virtual Circuits](/docs/netbox/v4.4/models/circuits/virtualcircuit): A virtual circuit can connect two or more interfaces atop a set of decoupled physical connections. For example, it's very common to form a virtual connection... - [Virtual Circuit Terminations](/docs/netbox/v4.4/models/circuits/virtualcircuittermination): This model represents the connection of a virtual interface to a virtual circuit. - [Virtual Circuit Types](/docs/netbox/v4.4/models/circuits/virtualcircuittype): Like physical circuits, virtual circuits are classified by functional type. These types are completely customizable, and can help categorize circuits by func... - Core - [Core](/docs/netbox/v4.4/models/core): Core documentation - [Data Files](/docs/netbox/v4.4/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v4.4/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v4.4/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v4.4/models/dcim): Dcim documentation - [Cables](/docs/netbox/v4.4/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v4.4/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v4.4/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v4.4/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v4.4/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v4.4/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v4.4/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v4.4/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v4.4/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v4.4/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v4.4/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v4.4/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v4.4/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v4.4/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v4.4/models/dcim/inventoryitem): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Roles](/docs/netbox/v4.4/models/dcim/inventoryitemrole): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Templates](/docs/netbox/v4.4/models/dcim/inventoryitemtemplate): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Locations](/docs/netbox/v4.4/models/dcim/location): The parent site to which this location belongs. - [MAC Addresses](/docs/netbox/v4.4/models/dcim/macaddress): A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface... - [Manufacturers](/docs/netbox/v4.4/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v4.4/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v4.4/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v4.4/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v4.4/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Module Type Profiles](/docs/netbox/v4.4/models/dcim/moduletypeprofile): Each module type may optionally be assigned a profile according to its classification. A profile can extend module types with user-configured attributes. For... - [Platforms](/docs/netbox/v4.4/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v4.4/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v4.4/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v4.4/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v4.4/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v4.4/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v4.4/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v4.4/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v4.4/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v4.4/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rack Types](/docs/netbox/v4.4/models/dcim/racktype): A rack type defines the physical characteristics of a particular model of rack. - [Rear Ports](/docs/netbox/v4.4/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v4.4/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v4.4/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v4.4/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v4.4/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v4.4/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v4.4/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v4.4/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v4.4/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Configuration Contexts](/docs/netbox/v4.4/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Config Context Profiles](/docs/netbox/v4.4/models/extras/configcontextprofile): Profiles can be used to organize configuration contexts and to enforce a desired structure for their data. The later is achieved by defining a JSON schema to... - [Configuration Templates](/docs/netbox/v4.4/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v4.4/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v4.4/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v4.4/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v4.4/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v4.4/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v4.4/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v4.4/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Notification](/docs/netbox/v4.4/models/extras/notification): A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notificatio... - [Notification Group](/docs/netbox/v4.4/models/extras/notificationgroup): A set of NetBox users and/or groups of users identified as recipients for certain notifications. - [Saved Filters](/docs/netbox/v4.4/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Subscription](/docs/netbox/v4.4/models/extras/subscription): A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object. - [Table Configs](/docs/netbox/v4.4/models/extras/tableconfig): This object represents the saved configuration of an object table in NetBox. Table configs can be crafted, saved, and shared among users to apply specific vi... - [Tags](/docs/netbox/v4.4/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v4.4/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v4.4/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v4.4/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the Border Gateway Protocol (BGP) to identify which autonomous system a particular prefix i... - [ASN Ranges](/docs/netbox/v4.4/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v4.4/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v4.4/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v4.4/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v4.4/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v4.4/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v4.4/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v4.4/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v4.4/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v4.4/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Application Services](/docs/netbox/v4.4/models/ipam/service): An application service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to re... - [Application Service Templates](/docs/netbox/v4.4/models/ipam/servicetemplate): Application service templates can be used to instantiate application services on devices and virtual machines. - [VLANs](/docs/netbox/v4.4/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v4.4/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [VLAN Translation Policies](/docs/netbox/v4.4/models/ipam/vlantranslationpolicy): VLAN translation is a feature that consists of VLAN translation policies and VLAN translation rules. Many rules can belong to a policy, and each rule defines... - [VLAN Translation Rules](/docs/netbox/v4.4/models/ipam/vlantranslationrule): A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy. - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v4.4/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v4.4/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v4.4/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v4.4/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v4.4/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v4.4/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v4.4/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Virtualization - [Virtualization](/docs/netbox/v4.4/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v4.4/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v4.4/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v4.4/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v4.4/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v4.4/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v4.4/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v4.4/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v4.4/models/vpn/ikepolicy): An Internet Key Exchange (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v4.4/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v4.4/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v4.4/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v4.4/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v4.4/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v4.4/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v4.4/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v4.4/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v4.4/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v4.4/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v4.4/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v4.4/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v4.4/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v4.4/reference): Reference documentation - [REST API Filtering](/docs/netbox/v4.4/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v4.4/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v4.4/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v4.4/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v4.4/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v4.4/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. ruff is used for linting (with certain exceptions). - [NetBox Models](/docs/netbox/v4.4/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v4.4/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v4.4/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v4.4/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v4.4/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v4.4/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v4.4/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v4.4/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/v4.4/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v4.4/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v4.4/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of releases: - [git Cheat Sheet](/docs/netbox/v4.4/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v4.4/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.4](/docs/netbox/v4.4/release-notes/version-4.4): Most bulk operations, such as the import, modification, or deletion of objects can now be executed as a background job. This frees the user to continue worki... - [NetBox v4.3](/docs/netbox/v4.4/release-notes/version-4.3): The fix for bug #18900 now raises explicit exceptions when API endpoints attempt to paginate unordered querysets. Plugin maintainers should review their API ... - [NetBox v4.2](/docs/netbox/v4.4/release-notes/version-4.2): MAC addresses are now managed as independent objects, rather than attributes on device and VM interfaces. NetBox now supports the assignment of multiple MAC ... - [NetBox v4.1](/docs/netbox/v4.4/release-notes/version-4.1): This release contains a regression which breaks change logging. Please use release v4.1.10 instead. - [NetBox v4.0](/docs/netbox/v4.4/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/v4.4/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v4.4/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v4.4/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v4.4/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v4.4/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v4.4/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v4.4/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v4.4/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v4.4/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v4.4/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v4.4/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v4.4/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v4.4/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v4.4/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v4.4/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v4.4/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v4.4/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v4.4/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v4.4/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v4.4/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v4.4/media): Media documentation - Authentication - [Authentication](/docs/netbox/v4.4/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v4.4/media/development): Development documentation - Installation - [Installation](/docs/netbox/v4.4/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v4.4/media/misc): Misc documentation - Models - [Models](/docs/netbox/v4.4/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v4.4/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v4.4/media/screenshots): Screenshots documentation - NetBox v4.5 - [The Premier Network Source of Truth](/docs/netbox/v4.5): NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and dat... - [Introduction to NetBox](/docs/netbox/v4.5/introduction): NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effo... - Features - [Features](/docs/netbox/v4.5/features): Features documentation - [Facilities](/docs/netbox/v4.5/features/facilities): From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of se... - [Devices & Cabling](/docs/netbox/v4.5/features/devices-cabling): At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of phys... - [Power Tracking](/docs/netbox/v4.5/features/power-tracking): As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power d... - [IP Address Management](/docs/netbox/v4.5/features/ipam): IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formati... - [VLAN Management](/docs/netbox/v4.5/features/vlan-management): Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q a... - [L2VPN & Overlay](/docs/netbox/v4.5/features/l2vpn-overlay): L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay asset... - [Circuits](/docs/netbox/v4.5/features/circuits): NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in ... - [Wireless](/docs/netbox/v4.5/features/wireless): Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. - [Virtualization](/docs/netbox/v4.5/features/virtualization): Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just... - [Tunnels](/docs/netbox/v4.5/features/vpn-tunnels): NetBox can model private tunnels formed among virtual termination points across your network. Typical tunnel implementations include GRE, IP-in-IP, and IPSec... - [Resource Ownership](/docs/netbox/v4.5/features/resource-ownership): Most objects in NetBox can be assigned an owner. An owner is a set of users and/or groups who are responsible for the administration of associated objects. F... - [Tenancy](/docs/netbox/v4.5/features/tenancy): Most core objects within NetBox's data model support tenancy. This is the association of an object with a particular tenant to convey assignment or dependenc... - [Contacts](/docs/netbox/v4.5/features/contacts): Much like tenancy, contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a res... - [Search](/docs/netbox/v4.5/features/search): NetBox includes a powerful global search engine, providing a single convenient interface to search across its complex data model. Relevant fields on each mod... - [Context Data](/docs/netbox/v4.5/features/context-data): Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virt... - [Configuration Rendering](/docs/netbox/v4.5/features/configuration-rendering): One of the critical aspects of operating a network is ensuring that every network node is configured correctly. By leveraging configuration templates and con... - [Synchronized Data](/docs/netbox/v4.5/features/synchronized-data): Several models in NetBox support the automatic synchronization of local data from a designated remote source. For example, configuration templates defined in... - [Change Logging](/docs/netbox/v4.5/features/change-logging): Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the datab... - [Journaling](/docs/netbox/v4.5/features/journaling): All primary and organizational models in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintaine... - [Event Rules](/docs/netbox/v4.5/features/event-rules): NetBox includes the ability to automatically perform certain functions in response to internal events. These include: - [User Preferences](/docs/netbox/v4.5/features/user-preferences): NetBox stores per‑user options that control aspects of the web interface and data display. Preferences persist across sessions and can be managed under User ... - [Notifications](/docs/netbox/v4.5/features/notifications): NetBox includes a system for generating user notifications, which can be marked as read or deleted by individual users. There are two built-in mechanisms for... - [Background Jobs](/docs/netbox/v4.5/features/background-jobs): NetBox includes the ability to execute certain functions as background tasks. These include: - [Authentication & Permissions](/docs/netbox/v4.5/features/authentication-permissions): NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permission... - [API & Integration](/docs/netbox/v4.5/features/api-integration): NetBox includes a slew of features which enable integration with other tools and resources powering your network. - [Customization](/docs/netbox/v4.5/features/customization): While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built wit... - Installation & Upgrade - [Installation](/docs/netbox/v4.5/installation): Check out the NetBox Cloud Free Plan! Skip the installation process and grab your own NetBox Cloud instance, preconfigured and ready to go in minutes. Comple... - [PostgreSQL Database Installation](/docs/netbox/v4.5/installation/1-postgresql): This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to t... - [Redis Installation](/docs/netbox/v4.5/installation/2-redis) - [NetBox Installation](/docs/netbox/v4.5/installation/3-netbox): This section of the documentation discusses installing and configuring the NetBox application itself. - [Gunicorn](/docs/netbox/v4.5/installation/4a-gunicorn): This page provides instructions for setting up the gunicorn WSGI server. If you plan to use uWSGI instead, go here. - [uWSGI](/docs/netbox/v4.5/installation/4b-uwsgi): This page provides instructions for setting up the uWSGI WSGI server. If you plan to use gunicorn instead, go here. - [HTTP Server Setup](/docs/netbox/v4.5/installation/5-http-server): This documentation provides example configurations for both nginx and Apache, though any HTTP server which supports WSGI should be compatible. - [LDAP Configuration](/docs/netbox/v4.5/installation/6-ldap): This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event o... - [Upgrading to a New NetBox Release](/docs/netbox/v4.5/installation/upgrading): 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 deploym... - Getting Started - [Getting Started](/docs/netbox/v4.5/getting-started): Getting Started documentation - [Planning Your Move](/docs/netbox/v4.5/getting-started/planning): This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installat... - [Populating Data](/docs/netbox/v4.5/getting-started/populating-data): This section covers the mechanisms which are available to populate data in NetBox. - Configuration - [NetBox Configuration](/docs/netbox/v4.5/configuration): NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences,... - [Required Configuration Settings](/docs/netbox/v4.5/configuration/required-parameters): This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as th... - [System Parameters](/docs/netbox/v4.5/configuration/system): The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - [Security & Authentication Parameters](/docs/netbox/v4.5/configuration/security): Default: ('file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp') - [GraphQL API Parameters](/docs/netbox/v4.5/configuration/graphql-api): Designates the default version of the GraphQL API served by /graphql/. To access a specific version, append the version number to the URL, e.g. /graphql/v2/. - [Remote Authentication Settings](/docs/netbox/v4.5/configuration/remote-authentication): The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be True in order for these settings to ta... - [Data & Validation Parameters](/docs/netbox/v4.5/configuration/data-validation): This is a mapping of models to custom validators that have been defined locally to enforce custom validation logic. An example is provided below: - [Default Value Parameters](/docs/netbox/v4.5/configuration/default-values): This parameter controls the content and layout of user's default dashboard. Once the dashboard has been created, the user is free to customize it as they ple... - [Error Reporting Settings](/docs/netbox/v4.5/configuration/error-reporting): A dictionary mapping keyword arguments to values, to be passed to sentrysdk.init(). See the Sentry Python SDK documentation for more information on supported... - [Plugin Parameters](/docs/netbox/v4.5/configuration/plugins): A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here. - [Miscellaneous Parameters](/docs/netbox/v4.5/configuration/miscellaneous): NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - [Development Parameters](/docs/netbox/v4.5/configuration/development): This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only clients which access NetBox from a rec... - Customization - [Customization](/docs/netbox/v4.5/customization): Customization documentation - [Custom Fields](/docs/netbox/v4.5/customization/custom-fields): Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, site... - [Custom Links](/docs/netbox/v4.5/customization/custom-links): Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related reco... - [Custom Validation](/docs/netbox/v4.5/customization/custom-validation): NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper fo... - [Export Templates](/docs/netbox/v4.5/customization/export-templates): NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Temp... - [NetBox Reports](/docs/netbox/v4.5/customization/reports): Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with custom scripts. While backward compatibility has been maintai... - [Custom Scripts](/docs/netbox/v4.5/customization/custom-scripts): 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 ... - Best Practices - [Best Practices](/docs/netbox/v4.5/best-practices): Best Practices documentation - [Modeling Pluggable Transceivers](/docs/netbox/v4.5/best-practices/modeling-pluggable-transceivers): Many network devices utilize field-swappable small-form factor pluggable transceivers (SFPs) to enable changing the physical media type of a fixed interface.... - [Performance Handbook](/docs/netbox/v4.5/best-practices/performance-handbook): The purpose of this handbook is to help users and administrators use NetBox efficiently. It contains assorted recommendations and best practices compiled ove... - Integrations - [Integrations](/docs/netbox/v4.5/integrations): Integrations documentation - [REST API Overview](/docs/netbox/v4.5/integrations/rest-api): REST stands for representational state transfer. It's a particular type of API which employs HTTP requests and JavaScript Object Notation (JSON) to facilitat... - [GraphQL API Overview](/docs/netbox/v4.5/integrations/graphql-api): NetBox provides a read-only GraphQL API to complement its REST API. This API is powered by Strawberry Django. - [Webhooks](/docs/netbox/v4.5/integrations/webhooks): NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the ... - [Synchronized Data](/docs/netbox/v4.5/integrations/synchronized-data): Some NetBox models support automatic synchronization of certain attributes from remote data sources, such as a git repository hosted on GitHub or GitLab. Dat... - [Prometheus Metrics](/docs/netbox/v4.5/integrations/prometheus-metrics): NetBox supports optionally exposing native Prometheus metrics from the application. Prometheus is a popular time series metric platform used for monitoring. - Plugins - [Plugins](/docs/netbox/v4.5/plugins): Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can intr... - [Installing a Plugin](/docs/netbox/v4.5/plugins/installation): The instructions below detail the general process for installing and configuring a NetBox plugin. However, each plugin is different and may require additiona... - [Removing a Plugin](/docs/netbox/v4.5/plugins/removal): The instructions below detail the general process for removing a NetBox plugin. However, each plugin is different and may require additional tasks or modific... - Developing Plugins - [Plugins Development](/docs/netbox/v4.5/plugins/development): Just getting started with plugins? Check out our NetBox Plugin Tutorial on GitHub! This in-depth guide will walk you through the process of creating an entir... - [Database Models](/docs/netbox/v4.5/plugins/development/models): If your plugin introduces a new type of object in NetBox, you'll probably want to create a Django model for it. A model is essentially a Python representatio... - [Views](/docs/netbox/v4.5/plugins/development/views): If your plugin will provide its own page or pages within the NetBox web UI, you'll need to define views. A view is a piece of business logic which performs a... - [UI Components](/docs/netbox/v4.5/plugins/development/ui-components): All UI components described here were introduced in NetBox v4.5. Be sure to set the minimum NetBox version to 4.5.0 for your plugin before incorporating any ... - [Navigation](/docs/netbox/v4.5/plugins/development/navigation): A plugin can register its own submenu as part of NetBox's navigation menu. This is done by defining a variable named menu in navigation.py, pointing to an in... - [Templates](/docs/netbox/v4.5/plugins/development/templates): Templates are used to render HTML content generated from a set of context data. NetBox provides a set of built-in templates suitable for use in plugin views.... - [Tables](/docs/netbox/v4.5/plugins/development/tables): NetBox employs the django-tables2 library for rendering dynamic object tables. These tables display lists of objects, and can be sorted and filtered by vario... - [Forms](/docs/netbox/v4.5/plugins/development/forms): NetBox provides several base form classes for use by plugins. Additional form classes are also available for other standard base model classes (PrimaryModel,... - [Filters & Filter Sets](/docs/netbox/v4.5/plugins/development/filtersets): Filter sets define the mechanisms available for filtering or searching through a set of objects in NetBox. For instance, sites can be filtered by their paren... - [Search](/docs/netbox/v4.5/plugins/development/search): Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named search.py, which... - [Event Types](/docs/netbox/v4.5/plugins/development/event-types): Plugins can register their own custom event types for use with NetBox event rules. This is accomplished by calling the register() method on an instance of th... - [Data Backends](/docs/netbox/v4.5/plugins/development/data-backends) - [Webhooks](/docs/netbox/v4.5/plugins/development/webhooks): NetBox supports the configuration of outbound webhooks which can be triggered by custom event rules. By default, a webhook's payload will contain a serialize... - [User Interface](/docs/netbox/v4.5/plugins/development/user-interface): The NetBox user interface supports toggling between light and dark versions of the theme. If needed, a plugin can determine the currently active color theme ... - [REST API](/docs/netbox/v4.5/plugins/development/rest-api): Plugins can declare custom endpoints on NetBox's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that i... - [GraphQL API](/docs/netbox/v4.5/plugins/development/graphql-api): A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it... - [Background Jobs](/docs/netbox/v4.5/plugins/development/background-jobs): NetBox plugins can defer certain operations by enqueuing background jobs, which are executed asynchronously by background workers. This is helpful for decoup... - [Dashboard Widgets](/docs/netbox/v4.5/plugins/development/dashboard-widgets): Each NetBox user can customize his or her personal dashboard by adding and removing widgets and by manipulating the size and position of each. Plugins can re... - [Exceptions](/docs/netbox/v4.5/plugins/development/exceptions): The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. - [Migrating Your Plugin to NetBox v4.0](/docs/netbox/v4.5/plugins/development/migration-v4): This document serves as a handbook for maintainers of plugins that were written prior to the release of NetBox v4.0. It serves to capture all the changes rec... - Administration - [Administration](/docs/netbox/v4.5/administration): Administration documentation - Authentication - [Authentication](/docs/netbox/v4.5/administration/authentication): Authentication documentation - [Authentication](/docs/netbox/v4.5/administration/authentication/overview): Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. - [Google](/docs/netbox/v4.5/administration/authentication/google): This guide explains how to configure single sign-on (SSO) support for NetBox using Google OAuth2 as an authentication backend. - [Microsoft Entra ID](/docs/netbox/v4.5/administration/authentication/microsoft-entra-id): This guide explains how to configure single sign-on (SSO) support for NetBox using Microsoft Entra ID as an authentication backend. - [Okta](/docs/netbox/v4.5/administration/authentication/okta): This guide explains how to configure single sign-on (SSO) support for NetBox using Okta as an authentication backend. - [Object-Based Permissions](/docs/netbox/v4.5/administration/permissions): NetBox employs a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator... - [Error Reporting](/docs/netbox/v4.5/administration/error-reporting): NetBox supports native integration with Sentry for automatic error reporting. To enable this functionality, set SENTRYENABLED to True and define your unique ... - [Replicating NetBox](/docs/netbox/v4.5/administration/replicating-netbox): NetBox employs a PostgreSQL database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the pgdump an... - [The NetBox Python Shell](/docs/netbox/v4.5/administration/netbox-shell): NetBox includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following... - Models - [Models](/docs/netbox/v4.5/models): Models documentation - Circuits - [Circuits](/docs/netbox/v4.5/models/circuits): Circuits documentation - [Circuits](/docs/netbox/v4.5/models/circuits/circuit): A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet ... - [Circuit Groups](/docs/netbox/v4.5/models/circuits/circuitgroup): A unique human-friendly name. - [Circuit Group Assignments](/docs/netbox/v4.5/models/circuits/circuitgroupassignment): Circuits can be assigned to circuit groups for correlation purposes. For instance, three circuits, each belonging to a different provider, may each be assign... - [Circuit Terminations](/docs/netbox/v4.5/models/circuits/circuittermination): Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or ... - [Circuit Types](/docs/netbox/v4.5/models/circuits/circuittype): A unique human-friendly name. - [Providers](/docs/netbox/v4.5/models/circuits/provider): A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which... - [Provider Accounts](/docs/netbox/v4.5/models/circuits/provideraccount): This model can be used to represent individual accounts associated with a provider. - [Provider Networks](/docs/netbox/v4.5/models/circuits/providernetwork): This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it m... - [Virtual Circuits](/docs/netbox/v4.5/models/circuits/virtualcircuit): A virtual circuit can connect two or more interfaces atop a set of decoupled physical connections. For example, it's very common to form a virtual connection... - [Virtual Circuit Terminations](/docs/netbox/v4.5/models/circuits/virtualcircuittermination): This model represents the connection of a virtual interface to a virtual circuit. - [Virtual Circuit Types](/docs/netbox/v4.5/models/circuits/virtualcircuittype): Like physical circuits, virtual circuits are classified by functional type. These types are completely customizable, and can help categorize circuits by func... - Core - [Core](/docs/netbox/v4.5/models/core): Core documentation - [Data Files](/docs/netbox/v4.5/models/core/datafile): A data file object is the representation in NetBox's database of some file belonging to a remote data source. Data files are synchronized automatically, and ... - [Data Sources](/docs/netbox/v4.5/models/core/datasource): A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized t... - [Jobs](/docs/netbox/v4.5/models/core/job): The Job model is used to schedule and record the execution of background tasks. - DCIM - [Dcim](/docs/netbox/v4.5/models/dcim): Dcim documentation - [Cables](/docs/netbox/v4.5/models/dcim/cable): All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoin... - [Console Ports](/docs/netbox/v4.5/models/dcim/consoleport): A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the... - [Console Port Templates](/docs/netbox/v4.5/models/dcim/consoleporttemplate): A template for a console port that will be created on all instantiations of the parent device type. See the console port documentation for more detail. - [Console Server Ports](/docs/netbox/v4.5/models/dcim/consoleserverport): A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band a... - [Console Server Port Templates](/docs/netbox/v4.5/models/dcim/consoleserverporttemplate): A template for a console server port that will be created on all instantiations of the parent device type. See the console server port documentation for more... - [Devices](/docs/netbox/v4.5/models/dcim/device): Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth o... - [Device Bays](/docs/netbox/v4.5/models/dcim/devicebay): Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four indi... - [Device Bay Templates](/docs/netbox/v4.5/models/dcim/devicebaytemplate): A template for a device bay that will be created on all instantiations of the parent device type. See the device bay documentation for more detail. - [Device Roles](/docs/netbox/v4.5/models/dcim/devicerole): Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution s... - [Device Types](/docs/netbox/v4.5/models/dcim/devicetype): A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack... - [Front Ports](/docs/netbox/v4.5/models/dcim/frontport): Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face o... - [Front Port Templates](/docs/netbox/v4.5/models/dcim/frontporttemplate): A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the front port documentation for mo... - [Interfaces](/docs/netbox/v4.5/models/dcim/interface): Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but oth... - [Interface Templates](/docs/netbox/v4.5/models/dcim/interfacetemplate): A template for a network interface that will be created on all instantiations of the parent device type. See the interface documentation for more detail. - [Inventory Items](/docs/netbox/v4.5/models/dcim/inventoryitem): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Roles](/docs/netbox/v4.5/models/dcim/inventoryitemrole): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Inventory Item Templates](/docs/netbox/v4.5/models/dcim/inventoryitemtemplate): Beginning in NetBox v4.3, the use of inventory items has been deprecated. They are planned for removal in a future NetBox release. Users are strongly encoura... - [Locations](/docs/netbox/v4.5/models/dcim/location): The parent site to which this location belongs. - [MAC Addresses](/docs/netbox/v4.5/models/dcim/macaddress): A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface... - [Manufacturers](/docs/netbox/v4.5/models/dcim/manufacturer): A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may... - [Modules](/docs/netbox/v4.5/models/dcim/module): A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-base... - [Module Bays](/docs/netbox/v4.5/models/dcim/modulebay): Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switc... - [Module Bay Templates](/docs/netbox/v4.5/models/dcim/modulebaytemplate): A template for a module bay that will be created on all instantiations of the parent device type. See the module bay documentation for more detail. - [Module Types](/docs/netbox/v4.5/models/dcim/moduletype): A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. ... - [Module Type Profiles](/docs/netbox/v4.5/models/dcim/moduletypeprofile): Each module type may optionally be assigned a profile according to its classification. A profile can extend module types with user-configured attributes. For... - [Platforms](/docs/netbox/v4.5/models/dcim/platform): A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between diff... - [Power Feed](/docs/netbox/v4.5/models/dcim/powerfeed): A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet... - [Power Outlets](/docs/netbox/v4.5/models/dcim/poweroutlet): Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assig... - [Power Outlet Templates](/docs/netbox/v4.5/models/dcim/poweroutlettemplate): A template for a power outlet that will be created on all instantiations of the parent device type. See the power outlet documentation for more detail. - [Power Panel](/docs/netbox/v4.5/models/dcim/powerpanel): A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one pow... - [Power Ports](/docs/netbox/v4.5/models/dcim/powerport): A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply inter... - [Power Port Templates](/docs/netbox/v4.5/models/dcim/powerporttemplate): A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail. - [Racks](/docs/netbox/v4.5/models/dcim/rack): The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may option... - [Rack Reservations](/docs/netbox/v4.5/models/dcim/rackreservation): Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reser... - [Rack Roles](/docs/netbox/v4.5/models/dcim/rackrole): Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house co... - [Rack Types](/docs/netbox/v4.5/models/dcim/racktype): A rack type defines the physical characteristics of a particular model of rack. - [Rear Ports](/docs/netbox/v4.5/models/dcim/rearport): Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its... - [Rear Port Templates](/docs/netbox/v4.5/models/dcim/rearporttemplate): A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the rear port documentation for more... - [Regions](/docs/netbox/v4.5/models/dcim/region): The parent region, if any. - [Sites](/docs/netbox/v4.5/models/dcim/site): How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a buildi... - [Site Groups](/docs/netbox/v4.5/models/dcim/sitegroup): Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify... - [Virtual Chassis](/docs/netbox/v4.5/models/dcim/virtualchassis): A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and con... - [Virtual Device Context](/docs/netbox/v4.5/models/dcim/virtualdevicecontext): A virtual device context (VDC) represents a logical partition within a physical device, to which interfaces from the parent device can be allocated. Each VDC... - Extras - [Extras](/docs/netbox/v4.5/models/extras): Extras documentation - [Bookmarks](/docs/netbox/v4.5/models/extras/bookmark): A user can bookmark individual objects for convenient access. Bookmarks are listed under a user's profile and can be displayed using a dashboard widget. - [Configuration Contexts](/docs/netbox/v4.5/models/extras/configcontext): Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be a... - [Config Context Profiles](/docs/netbox/v4.5/models/extras/configcontextprofile): Profiles can be used to organize configuration contexts and to enforce a desired structure for their data. The later is achieved by defining a JSON schema to... - [Configuration Templates](/docs/netbox/v4.5/models/extras/configtemplate): Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated wit... - [Custom Fields](/docs/netbox/v4.5/models/extras/customfield): NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the custom fields documentation for more info... - [Custom Field Choice Sets](/docs/netbox/v4.5/models/extras/customfieldchoiceset): Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are ... - [Custom Links](/docs/netbox/v4.5/models/extras/customlink): Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a m... - [EventRule](/docs/netbox/v4.5/models/extras/eventrule): An event rule is a mechanism for automatically taking an action (such as running a script or sending a webhook) in response to an event in NetBox. For exampl... - [Export Templates](/docs/netbox/v4.5/models/extras/exporttemplate): Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring s... - [Image Attachments](/docs/netbox/v4.5/models/extras/imageattachment): Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. - [Journal Entries](/docs/netbox/v4.5/models/extras/journalentry): Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in... - [Notification](/docs/netbox/v4.5/models/extras/notification): A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notificatio... - [Notification Group](/docs/netbox/v4.5/models/extras/notificationgroup): A set of NetBox users and/or groups of users identified as recipients for certain notifications. - [Saved Filters](/docs/netbox/v4.5/models/extras/savedfilter): When filtering lists of objects in NetBox, users can save applied filters for future use. This is handy for complex filter strategies involving multiple disc... - [Subscription](/docs/netbox/v4.5/models/extras/subscription): A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object. - [Table Configs](/docs/netbox/v4.5/models/extras/tableconfig): This object represents the saved configuration of an object table in NetBox. Table configs can be crafted, saved, and shared among users to apply specific vi... - [Tags](/docs/netbox/v4.5/models/extras/tag): Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the ... - [Webhooks](/docs/netbox/v4.5/models/extras/webhook): A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system wh... - IPAM - [Ipam](/docs/netbox/v4.5/models/ipam): Ipam documentation - [ASNs](/docs/netbox/v4.5/models/ipam/asn): An Autonomous System Number (ASN) is a numeric identifier used in the Border Gateway Protocol (BGP) to identify which autonomous system a particular prefix i... - [ASN Ranges](/docs/netbox/v4.5/models/ipam/asnrange): Ranges can be defined to group AS numbers numerically and to facilitate their automatic provisioning. Each range must be assigned to a RIR. - [Aggregates](/docs/netbox/v4.5/models/ipam/aggregate): IP addressing is by nature hierarchical. The first few levels of the IPv4 hierarchy, for example, look like this: - [FHRP Group](/docs/netbox/v4.5/models/ipam/fhrpgroup): A first-hop redundancy protocol (FHRP) enables multiple physical interfaces to present a virtual IP address (VIP) in a redundant manner. Examples of such pro... - [FHRP Group Assignments](/docs/netbox/v4.5/models/ipam/fhrpgroupassignment): Member device and VM interfaces can be assigned to FHRP groups to indicate their participation in maintaining a common virtual IP address (VIP). For instance... - [IP Addresses](/docs/netbox/v4.5/models/ipam/ipaddress): An IP address object in NetBox comprises a single host address (either IPv4 or IPv6) and its subnet mask, and represents an IP address as configured on a net... - [IP Ranges](/docs/netbox/v4.5/models/ipam/iprange): This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.... - [Prefixes](/docs/netbox/v4.5/models/ipam/prefix): A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: Al... - [Regional Internet Registries (RIRs)](/docs/netbox/v4.5/models/ipam/rir): Users can create whatever RIRs they like, but each aggregate must be assigned to one RIR. For example, suppose your organization has been allocated 104.131.0... - [Prefix/VLAN Roles](/docs/netbox/v4.5/models/ipam/role): A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the sa... - [Route Targets](/docs/netbox/v4.5/models/ipam/routetarget): A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can b... - [Application Services](/docs/netbox/v4.5/models/ipam/service): An application service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to re... - [Application Service Templates](/docs/netbox/v4.5/models/ipam/servicetemplate): Application service templates can be used to instantiate application services on devices and virtual machines. - [VLANs](/docs/netbox/v4.5/models/ipam/vlan): A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged in... - [VLAN Groups](/docs/netbox/v4.5/models/ipam/vlangroup): VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster grou... - [VLAN Translation Policies](/docs/netbox/v4.5/models/ipam/vlantranslationpolicy): VLAN translation is a feature that consists of VLAN translation policies and VLAN translation rules. Many rules can belong to a policy, and each rule defines... - [VLAN Translation Rules](/docs/netbox/v4.5/models/ipam/vlantranslationrule): A VLAN translation rule represents a one-to-one mapping of a local VLAN ID (VID) to a remote VID. Many rules can belong to a single policy. - [Virtual Routing and Forwarding (VRF)](/docs/netbox/v4.5/models/ipam/vrf): A VRF object in NetBox represents a Virtual Routing and Forwarding (VRF) domain. Each VRF is essentially an independent routing table. VRFs are commonly used... - Tenancy - [Tenancy](/docs/netbox/v4.5/models/tenancy): Tenancy documentation - [Contacts](/docs/netbox/v4.5/models/tenancy/contact): A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one o... - [Contact Groups](/docs/netbox/v4.5/models/tenancy/contactgroup): The parent contact group (if any). - [Contact Roles](/docs/netbox/v4.5/models/tenancy/contactrole): A unique human-friendly name. - [Tenants](/docs/netbox/v4.5/models/tenancy/tenant): A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or inter... - [Tenant Groups](/docs/netbox/v4.5/models/tenancy/tenantgroup): Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of in... - Users - [Users](/docs/netbox/v4.5/models/users): Users documentation - [Owner](/docs/netbox/v4.5/models/users/owner): An owner is a set of users and/or groups who are responsible for the administration of certain resources within NetBox. The users and groups assigned to an o... - [Owner Groups](/docs/netbox/v4.5/models/users/ownergroup): Groups are used to correlate and organize owners. The assignment of an owner to a group has no bearing on the relationship of owned objects to their owners. - Virtualization - [Virtualization](/docs/netbox/v4.5/models/virtualization): Virtualization documentation - [Clusters](/docs/netbox/v4.5/models/virtualization/cluster): A cluster is a logical grouping of physical resources within which virtual machines run. Physical devices may be associated with clusters as hosts. This allo... - [Cluster Groups](/docs/netbox/v4.5/models/virtualization/clustergroup): Cluster groups may be created for the purpose of organizing clusters. The arrangement of clusters into groups is optional. - [Cluster Types](/docs/netbox/v4.5/models/virtualization/clustertype): A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a l... - [Vminterface](/docs/netbox/v4.5/models/virtualization/vminterface): The virtual machine to which this interface is assigned. - [Virtual Disks](/docs/netbox/v4.5/models/virtualization/virtualdisk): A virtual disk is used to model discrete virtual hard disks assigned to virtual machines. - [Virtual Machines](/docs/netbox/v4.5/models/virtualization/virtualmachine): A virtual machine (VM) represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally b... - VPN - [Vpn](/docs/netbox/v4.5/models/vpn): Vpn documentation - [IKE Policies](/docs/netbox/v4.5/models/vpn/ikepolicy): An Internet Key Exchange (IKE) policy defines an IKE version, mode, and set of proposals to be used in IKE negotiation. These policies are referenced by IPSe... - [IKE Proposals](/docs/netbox/v4.5/models/vpn/ikeproposal): An Internet Key Exhcnage (IKE) proposal defines a set of parameters used to establish a secure bidirectional connection across an untrusted medium, such as t... - [IPSec Policy](/docs/netbox/v4.5/models/vpn/ipsecpolicy): An IPSec policy defines a set of proposals to be used in the formation of IPSec tunnels. A perfect forward secrecy (PFS) group may optionally also be defined... - [IPSec Profile](/docs/netbox/v4.5/models/vpn/ipsecprofile): An IPSec profile defines an IKE policy, IPSec policy, and IPSec mode used for establishing an IPSec tunnel. - [IPSec Proposal](/docs/netbox/v4.5/models/vpn/ipsecproposal): An IPSec proposal defines a set of parameters used in negotiating security associations for IPSec tunnels. IPSec proposals defined in NetBox can be reference... - [L2VPN](/docs/netbox/v4.5/models/vpn/l2vpn): A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by a... - [L2VPN Termination](/docs/netbox/v4.5/models/vpn/l2vpntermination): A L2VPN termination is the attachment of an L2VPN to an interface or VLAN. Note that the L2VPNs of the following types may have only two terminations assigne... - [Tunnels](/docs/netbox/v4.5/models/vpn/tunnel): A tunnel represents a private virtual connection established among two or more endpoints across a shared infrastructure by employing protocol encapsulation. ... - [Tunnel Group](/docs/netbox/v4.5/models/vpn/tunnelgroup): A unique human-friendly name. - [Tunnel Terminations](/docs/netbox/v4.5/models/vpn/tunneltermination): A tunnel termination connects a device or virtual machine interface to a tunnel. The tunnel must be created before any terminations may be added. - Wireless - [Wireless](/docs/netbox/v4.5/models/wireless): Wireless documentation - [Wireless LANs](/docs/netbox/v4.5/models/wireless/wirelesslan): A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless interfaces can ... - [Wireless LAN Groups](/docs/netbox/v4.5/models/wireless/wirelesslangroup): Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, ea... - [Wireless Links](/docs/netbox/v4.5/models/wireless/wirelesslink): A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associatio... - Reference - [Reference](/docs/netbox/v4.5/reference): Reference documentation - [REST API Filtering](/docs/netbox/v4.5/reference/filtering): The objects returned by an API list endpoint can be filtered by attaching one or more query parameters to the request URL. For example, GET /api/dcim/sites/?... - [Conditions](/docs/netbox/v4.5/reference/conditions): Conditions are NetBox's mechanism for evaluating whether a set data meets a prescribed set of conditions. It allows the author to convey simple logic by decl... - [Markdown](/docs/netbox/v4.5/reference/markdown): NetBox supports Markdown rendering for certain text fields. Some common examples are provided below. For a complete Markdown reference, please see Markdowngu... - Development - [NetBox Development](/docs/netbox/v4.5/development): Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started. - [Getting Started](/docs/netbox/v4.5/development/getting-started): Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a fe... - [Style Guide](/docs/netbox/v4.5/development/style-guide): NetBox generally follows the Django style guide, which is itself based on PEP 8. ruff is used for linting (with certain exceptions). - [NetBox Models](/docs/netbox/v4.5/development/models): A NetBox model represents a discrete object type such as a device or IP address. Per Django convention, each model is defined as a Python class and has its o... - [Adding Models](/docs/netbox/v4.5/development/adding-models): Models within each app are stored in either models.py or within a submodule under the models/ directory. When creating a model, be sure to subclass the appro... - [Extending Models](/docs/netbox/v4.5/development/extending-models): Below is a list of tasks to consider when adding a new field to a core model. - [Signals](/docs/netbox/v4.5/development/signals): In addition to Django's built-in signals, NetBox defines some of its own, listed below. - [Search](/docs/netbox/v4.5/development/search): NetBox v3.4 introduced a new global search mechanism, which employs the extras.CachedValue model to store discrete field values from many models in a single ... - [Application Registry](/docs/netbox/v4.5/development/application-registry): The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the u... - [User Preferences](/docs/netbox/v4.5/development/user-preferences): The users.UserConfig model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user prefere... - [Web UI Development](/docs/netbox/v4.5/development/web-ui): Most static resources for the NetBox UI are housed within the netbox/project-static/ directory. - [Internationalization](/docs/netbox/v4.5/development/internationalization): Beginning with NetBox v4.0, NetBox will leverage Django's automatic translation to support languages other than English. This page details the areas of the p... - [Translations](/docs/netbox/v4.5/development/translations): NetBox coordinates all translation work using the Transifex platform. Signing up for a Transifex account is free. - [Release Checklist](/docs/netbox/v4.5/development/release-checklist): This documentation describes the process of packaging and publishing a new NetBox release. There are three types of releases: - [git Cheat Sheet](/docs/netbox/v4.5/development/git-cheat-sheet): This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the too... - Release Notes - [Release Notes](/docs/netbox/v4.5/release-notes): NetBox releases are numbered as major, minor, and patch releases. For example, version 3.1.0 is a minor release, and v3.1.5 is a patch release. Briefly, thes... - [NetBox v4.5](/docs/netbox/v4.5/release-notes/version-4.5): Most object list filters within the UI have been extended to include optional lookup modifiers to support more complex queries. For instance, filters for num... - [NetBox v4.4](/docs/netbox/v4.5/release-notes/version-4.4): Most bulk operations, such as the import, modification, or deletion of objects can now be executed as a background job. This frees the user to continue worki... - [NetBox v4.3](/docs/netbox/v4.5/release-notes/version-4.3): The fix for bug #18900 now raises explicit exceptions when API endpoints attempt to paginate unordered querysets. Plugin maintainers should review their API ... - [NetBox v4.2](/docs/netbox/v4.5/release-notes/version-4.2): MAC addresses are now managed as independent objects, rather than attributes on device and VM interfaces. NetBox now supports the assignment of multiple MAC ... - [NetBox v4.1](/docs/netbox/v4.5/release-notes/version-4.1): This release contains a regression which breaks change logging. Please use release v4.1.10 instead. - [NetBox v4.0](/docs/netbox/v4.5/release-notes/version-4.0): This release includes an important security fix, and is a strongly recommended update for all users. More details will follow. - [NetBox v3.7](/docs/netbox/v4.5/release-notes/version-3.7): If remote authentication is in use with Gunicorn v22.0 or later, it may be necessary to configure Gunicorn's headermap setting to preserve authentication hea... - [NetBox v3.6](/docs/netbox/v4.5/release-notes/version-3.6): Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface: - [NetBox v3.5](/docs/netbox/v4.5/release-notes/version-3.5): The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the info... - [NetBox v3.4](/docs/netbox/v4.5/release-notes/version-3.4): NetBox v3.4 requires PostgreSQL 11 or later. - [NetBox v3.3](/docs/netbox/v4.5/release-notes/version-3.3): When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to in... - [NetBox v3.2](/docs/netbox/v4.5/release-notes/version-3.2): NetBox v3.2 requires Python 3.8 or later. - [NetBox v3.1](/docs/netbox/v4.5/release-notes/version-3.1): NetBox v3.1 requires PostgreSQL 10 or later. - [NetBox v3.0](/docs/netbox/v4.5/release-notes/version-3.0): Upgrading an existing NetBox deployment to version 3.0 must be done from version 2.11.0 or later. If attempting to upgrade a deployment of NetBox v2.10 or ea... - [NetBox v2.11](/docs/netbox/v4.5/release-notes/version-2.11): NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for hist... - [NetBox v2.10](/docs/netbox/v4.5/release-notes/version-2.10): This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF... - [NetBox v2.9](/docs/netbox/v4.5/release-notes/version-2.9): NetBox v2.9 replaces Django's built-in permissions framework with one that supports object-based assignment of permissions using arbitrary constraints. When ... - [NetBox v2.8](/docs/netbox/v4.5/release-notes/version-2.8): In accordance with the fix in #4459, users that are experiencing invalid nested data with regions, rack groups, or tenant groups can perform a one-time opera... - [NetBox v2.7 Release Notes](/docs/netbox/v4.5/release-notes/version-2.7) - [NetBox v2.6 Release Notes](/docs/netbox/v4.5/release-notes/version-2.6): Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perf... - [NetBox v2.5 Release Notes](/docs/netbox/v4.5/release-notes/version-2.5): This release upgrades the Django framework to version 2.2. - [NetBox v2.4 Release Notes](/docs/netbox/v4.5/release-notes/version-2.4): Webhooks enable NetBox to send a representation of an object every time one is created, updated, or deleted. Webhooks are sent from NetBox to external servic... - [NetBox v2.3 Release Notes](/docs/netbox/v4.5/release-notes/version-2.3): A virtual chassis represents a set of physical devices with a shared control plane; for example, a stack of switches managed as a single device. Viewing the ... - [NetBox v2.2 Release Notes](/docs/netbox/v4.5/release-notes/version-2.2): Our second-most popular feature request has arrived! NetBox now supports the creation of virtual machines, which can be assigned virtual interfaces and IP ad... - [NetBox v2.1 Release Notes](/docs/netbox/v4.5/release-notes/version-2.1): The IP address model now supports the assignment of a functional role to help identify special-purpose IPs. These include: - [NetBox v2.0 Release Notes](/docs/netbox/v4.5/release-notes/version-2.0): The maximum number of objects an API consumer can request has been set to 1000 (e.g. ?limit=1000). This limit can be modified by defining MAXPAGESIZE in conf... - Media - [Media](/docs/netbox/v4.5/media): Media documentation - Authentication - [Authentication](/docs/netbox/v4.5/media/authentication): Authentication documentation - Development - [Development](/docs/netbox/v4.5/media/development): Development documentation - Installation - [Installation](/docs/netbox/v4.5/media/installation): Installation documentation - Misc - [Misc](/docs/netbox/v4.5/media/misc): Misc documentation - Models - [Models](/docs/netbox/v4.5/media/models): Models documentation - Release Notes - [Release Notes](/docs/netbox/v4.5/media/release-notes): Release Notes documentation - Screenshots - [Screenshots](/docs/netbox/v4.5/media/screenshots): Screenshots documentation - Platform MCP Server - [Platform MCP Server](/docs/platform-mcp): Managed MCP server connecting AI agents to the NetBox Labs platform - Resources - [Resources](/docs/resources): Maintenance, support, and product lifecycle information for NetBox Labs products. - [Maintenance](/docs/resources/maintenance): NetBox Labs designates the following weekly upgrade windows specifically to upgrade the version of NetBox and NetBox components for NetBox Cloud customers on... - [NetBox Labs Product and Feature Lifecycle](/docs/resources/product_feature_lifecycle): NetBox Labs products and features can go through multiple release stages before becoming generally available. These stages in the release life cycle can pres... - SDKs and Tools - [SDKs and Tools](/docs/sdks): Client libraries and tooling for building and automating against NetBox and the NetBox Labs platform. - pynetbox Documentation - [pynetbox Documentation](/docs/sdks/pynetbox): Python API client library for NetBox. - [Advanced Usage](/docs/sdks/pynetbox/advanced): pynetbox supports multithreaded page fetching for .filter() and .all() queries, which can significantly improve performance when iterating large result sets. - [Core Classes](/docs/sdks/pynetbox/api): This page documents the core classes that form pynetbox's API surface. - [Branching Plugin](/docs/sdks/pynetbox/branching): 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 s... - [Circuits](/docs/sdks/pynetbox/circuits): This page documents the special methods available on Circuits models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint ... - [Core](/docs/sdks/pynetbox/core): This page documents the special methods available on Core models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint refe... - [Custom Objects Plugin](/docs/sdks/pynetbox/custom-objects): 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/plu... - [DCIM](/docs/sdks/pynetbox/dcim): This page documents the special methods available on DCIM models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint refe... - [Endpoint](/docs/sdks/pynetbox/endpoint): Endpoint objects provide CRUD operations for NetBox API endpoints. They are created automatically when you access an attribute on an App instance. - [Exceptions](/docs/sdks/pynetbox/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 leve... - [Extensions](/docs/sdks/pynetbox/extensions): pynetbox's extension framework lets you (or a plugin author) register custom Record subclasses, JSON-field markers, and content-type mappings for NetBox plug... - [Quick Start](/docs/sdks/pynetbox/getting-started): This guide walks through the basics of using pynetbox to interact with NetBox. - [Installation](/docs/sdks/pynetbox/installation) - [IPAM](/docs/sdks/pynetbox/ipam): This page documents the special methods available on IPAM models. Standard CRUD operations follow the patterns described in Quick Start and the Endpoint refe... - [Release Notes](/docs/sdks/pynetbox/release-notes): pynetbox can now be extended to support third-party NetBox plugins without modifying the library. You can register custom record types for a plugin's endpoin... - [Response](/docs/sdks/pynetbox/response): This page documents the classes that wrap responses returned by NetBox: Record (a single object) and RecordSet (a lazy collection of records). - [Virtualization](/docs/sdks/pynetbox/virtualization): This page documents the special methods available on Virtualization models. Standard CRUD operations follow the patterns described in Quick Start and the End... - Development - [Development](/docs/sdks/pynetbox/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. - [Getting Started](/docs/sdks/pynetbox/development/getting-started): This guide walks through setting up a pynetbox development environment and running the test suite. - [Release Checklist](/docs/sdks/pynetbox/development/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,... - Diode Python SDK - [Diode Python SDK](/docs/sdks/diode-sdk-python): Diode SDK Python is a Python library for interacting with the Diode ingestion service utilizing gRPC. - [Entity Examples](/docs/sdks/diode-sdk-python/entity-examples): Source: NetBox v4.6.0 Generated: 2026-07-03 00:59:24Z - Diode Go SDK - [Diode Go SDK](/docs/sdks/diode-sdk-go): Diode SDK Go is a Go library for interacting with the Diode ingestion service utilizing gRPC. - [Entity Examples](/docs/sdks/diode-sdk-go/entity-examples): Source: NetBox v4.6.0 Generated: 2026-07-03 00:59:24Z - **Tools** - [Ansible Collection](/docs/sdks/netbox-ansible-collection): A short guide to getting started with the Ansible Collection for Netbox. - [pyATS](/docs/sdks/pyats): 1. Clone the Git repo and change into the netbox-pyats-webinar directory: - ServiceNow Integration - [ServiceNow Integration](/docs/servicenow): The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectio... - [User Guide](/docs/servicenow/snow-user-guide): NetBox Labs CMDB Integration is a custom application, also known as a scoped application, that resides on a ServiceNow instance. Its main purpose is to facil... - [Installation and Setup](/docs/servicenow/snow-installation): Before you start the installation, ensure the following requirements are met: - [Upgrades and Bug Fixes](/docs/servicenow/snow-upgrading): Upgrades, patches, and hotfixes for the NetBox Labs CMDB Integration application are delivered only through the ServiceNow Store (application identifier xnbl... - [Technical Information](/docs/servicenow/snow-technical-info): The NetBox Labs CMDB Integration application creates several new tables in ServiceNow for staging imported data from NetBox or for other purposes: - [FAQ and Troubleshooting](/docs/servicenow/snow-faq): Each release may have known issues that are documented along with workarounds and resolution plans. - [Known Issues](/docs/servicenow/known-issues): This document lists known issues in the NetBox Labs CMDB Integration application along with workarounds and resolution plans. - [Release Notes](/docs/servicenow/release-notes) - ServiceNow Integration - [ServiceNow Integration](/docs/servicenow/v1.2.6): The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectio... - [FAQ and Troubleshooting](/docs/servicenow/v1.2.6/snow-faq): 1. Verify Basic Connectivity - Check for firewall restrictions between instances - Verify DNS resolution of NetBox hostname - [Installation and Setup](/docs/servicenow/v1.2.6/snow-installation): Before you start the installation, ensure the following requirements are met: - [Technical Information](/docs/servicenow/v1.2.6/snow-technical-info): The NetBox CMDB Integration application creates several new tables in ServiceNow for staging imported data from NetBox or for other purposes: - [Upgrades and Bug Fixes](/docs/servicenow/v1.2.6/snow-upgrading): Upgrades, patches, and hotfixes for the NetBox CMDB Integration application are distributed through XML update sets, which can be obtained from NetBox Labs s... - [User Guide](/docs/servicenow/v1.2.6/snow-user-guide): NetBox CMDB Integration is a custom application, also known as a scoped application, that resides on a ServiceNow instance. Its main purpose is to facilitate... - ServiceNow Integration - [ServiceNow Integration](/docs/servicenow/v1.3.3): The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectio... - [Release Notes](/docs/servicenow/v1.3.3/release-notes): New features: - Better duplication avoidance in CMDB objects with proper IRE rules for the Devices data source - Better duplication avoidance in non-CMDB inc... - [FAQ and Troubleshooting](/docs/servicenow/v1.3.3/snow-faq): 1. Credential Records Not Properly Associated with the API Key - A common mistake during Guided Setup is not saving a record before the step is marked as com... - [Installation and Setup](/docs/servicenow/v1.3.3/snow-installation): Before you start the installation, ensure the following requirements are met: - [Technical Information](/docs/servicenow/v1.3.3/snow-technical-info): The NetBox CMDB Integration application creates several new tables in ServiceNow for staging imported data from NetBox or for other purposes: - [Upgrades and Bug Fixes](/docs/servicenow/v1.3.3/snow-upgrading): Upgrades, patches, and hotfixes for the NetBox CMDB Integration application are distributed through XML update sets, which can be obtained from NetBox Labs s... - [User Guide](/docs/servicenow/v1.3.3/snow-user-guide): NetBox CMDB Integration is a custom application, also known as a scoped application, that resides on a ServiceNow instance. Its main purpose is to facilitate... - ServiceNow Integration - [ServiceNow Integration](/docs/servicenow/v1.3.4): The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectio... - [Release Notes](/docs/servicenow/v1.3.4/release-notes): Fixes: - Includes hotfix-103 - [FAQ and Troubleshooting](/docs/servicenow/v1.3.4/snow-faq): 1. Credential Records Not Properly Associated with the API Key - A common mistake during Guided Setup is not saving a record before the step is marked as com... - [Installation and Setup](/docs/servicenow/v1.3.4/snow-installation): Before you start the installation, ensure the following requirements are met: - [Technical Information](/docs/servicenow/v1.3.4/snow-technical-info): The NetBox CMDB Integration application creates several new tables in ServiceNow for staging imported data from NetBox or for other purposes: - [Upgrades and Bug Fixes](/docs/servicenow/v1.3.4/snow-upgrading): Upgrades, patches, and hotfixes for the NetBox CMDB Integration application are distributed through XML update sets, which can be obtained from NetBox Labs s... - [User Guide](/docs/servicenow/v1.3.4/snow-user-guide): NetBox CMDB Integration is a custom application, also known as a scoped application, that resides on a ServiceNow instance. Its main purpose is to facilitate... - ServiceNow Integration - [ServiceNow Integration](/docs/servicenow/v1.4.012): The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectio... - [Known Issues](/docs/servicenow/v1.4.012/known-issues): This document lists known issues in the NetBox CMDB Integration application along with workarounds and resolution plans. - [Release Notes](/docs/servicenow/v1.4.012/release-notes): New features: - Flexible Tenant Usage Configuration: Added new Tenant Usage setup page allowing administrators to configure how NetBox Tenants should be impo... - [FAQ and Troubleshooting](/docs/servicenow/v1.4.012/snow-faq): Each release may have known issues that are documented along with workarounds and resolution plans. - [Installation and Setup](/docs/servicenow/v1.4.012/snow-installation): Before you start the installation, ensure the following requirements are met: - [Technical Information](/docs/servicenow/v1.4.012/snow-technical-info): The NetBox CMDB Integration application creates several new tables in ServiceNow for staging imported data from NetBox or for other purposes: - [Upgrades and Bug Fixes](/docs/servicenow/v1.4.012/snow-upgrading): Upgrades, patches, and hotfixes for the NetBox CMDB Integration application are distributed through XML update sets, which can be obtained from NetBox Labs s... - [User Guide](/docs/servicenow/v1.4.012/snow-user-guide): NetBox CMDB Integration is a custom application, also known as a scoped application, that resides on a ServiceNow instance. Its main purpose is to facilitate... - Images - [Images](/docs/servicenow/v1.4.012/images): Images documentation - ServiceNow v2.0.0 - [ServiceNow integration](/docs/servicenow/v2.0.0): Overview and versioned documentation for the NetBox ServiceNow integration (v2.0.0). - [Known issues](/docs/servicenow/v2.0.0/known-issues): Known issues, workarounds, and status for v2.0.0. - [Release notes](/docs/servicenow/v2.0.0/release-notes): Release notes for NetBox Labs CMDB Integration v2.0.0. - [FAQ and Troubleshooting](/docs/servicenow/v2.0.0/snow-faq): Common questions, troubleshooting steps, and operational guidance for v2.0.0. - [Installation and Setup](/docs/servicenow/v2.0.0/snow-installation): Install and configure NetBox Labs CMDB Integration v2.0.0 in ServiceNow. - [Technical Information](/docs/servicenow/v2.0.0/snow-technical-info): Data model, tables, synchronization behavior, and logging details for v2.0.0. - [Upgrading NetBox Labs CMDB Integration](/docs/servicenow/v2.0.0/snow-upgrading): Special upgrade instructions when migrating from v1.x - [User Guide](/docs/servicenow/v2.0.0/snow-user-guide): ServiceNow navigation, parameters, and operational guidance for v2.0.0. - Images - [Images](/docs/servicenow/v2.0.0/images): Images documentation - NetBox TurboBulk - [TurboBulk](/docs/turbobulk): TurboBulk is a high-performance bulk data API for NetBox that loads, updates, deletes, and exports tens of thousands of objects per second - orders of magnit... - [TurboBulk Quick Start Guide](/docs/turbobulk/quickstart): Get started with TurboBulk in 5 minutes. - [TurboBulk User Guide](/docs/turbobulk/user-guide): TurboBulk is a high-performance bulk data API for NetBox that achieves massive throughput improvements over the REST API for large-scale data operations. - [TurboBulk API Reference](/docs/turbobulk/api-reference): All API endpoints require authentication via NetBox API token: - [TurboBulk Client](/docs/turbobulk/client): Python client library for the TurboBulk NetBox plugin. - [NetBox Branching Integration](/docs/turbobulk/branching): TurboBulk provides full integration with netbox-branching, enabling branch-aware bulk operations. This allows you to stage large data changes in isolation be... - [TurboBulk Troubleshooting Guide](/docs/turbobulk/troubleshooting): This guide covers common issues, error messages, and solutions when using TurboBulk. - NetBox Validation - [NetBox Validation](/docs/validation): NetBox Validation is your safety net for network changes and the critical guardrail that makes automated and agentic infrastructure management trustworthy. I... - [Getting Started](/docs/validation/getting-started): This tutorial walks you through your first validation -- from installing a policy pack to reviewing compliance scores. You'll have a working validation pipel... - [Core Concepts](/docs/validation/core-concepts): This page covers the mental model for NetBox Validation -- the objects you'll work with and how they relate. - [Policy Pack Library](/docs/validation/policy-packs): NetBox Validation ships with pre-built policy packs that you can install in one click. Starter packs cover common validation scenarios. Compliance framework ... - [Check Reference](/docs/validation/check-reference): All 95 built-in checks organized by engine and category. Each entry includes the check name (used in rule checkname field), description, and configurable par... - [Validation Engines](/docs/validation/engines): NetBox Validation uses three engines that evaluate different aspects of infrastructure compliance. All three produce the same output and feed into the same f... - [API Reference](/docs/validation/api-reference): All validation APIs live under /api/plugins/validation/. Authentication uses a bearer token. - [Scaling Best Practices](/docs/validation/scaling-best-practices): NetBox Validation uses three engines with different scaling characteristics. Understanding how each engine scales helps you design policies, schedule runs, a... - [FAQ](/docs/validation/faq): Execution time depends on your infrastructure size, complexity, and which engines are involved. Intent checks are the fastest -- they query NetBox data direc... - [Workflows](/docs/validation/workflows): This guide covers the main workflows for NetBox Validation -- how to use it in practice for pre-change validation, continuous compliance, targeted runs, and ...