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 user and is not intended to be modified by any code outside of NetBox core.
AWS Direct Connect (Single Region)
AWS Direct Connect is available via hosted connections from BT, Equinix Fabric, MegaPort, Optus, PCCW, Zayo etc. VLAN hand-off is with BGP and Single or Dual Direct Connect services are available. Customer IP space (/24 or /25) is assigned for the VPC, as this is required to host load balancers and proxies within the dedicated customer Account/VPC. Internally we will allocate a /27 per availability zone for each of the 3 availability zones.
Background Jobs
NetBox includes the ability to execute certain functions as background tasks. These include:
Cisco Catalyst Center NetBox Integration - Technical Information
Cisco Catalyst Center to NetBox Object Mapping
Cisco Catalyst Center Integration
Overview
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 register their own dashboard widgets to complement those already available natively.
Data & Validation Parameters
CUSTOM_VALIDATORS
Error Reporting
Sentry
Error Reporting Settings
SENTRY_DSN
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 the EventType class. This can be done anywhere within the plugin. An example is provided below.
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 example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating an event for device objects and designating a webhook to be transmitted. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver.
Exceptions
The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios.
Filters & Filter Sets
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 parent region or group, status, facility ID, and so on. The same filter set is used consistently for a model whether the request is made via the UI or REST API. (Note that the GraphQL API uses a separate filter class.) NetBox employs the django-filters2 library to define filter sets.
Getting Started with the Cisco Catalyst Center Integration for NetBox
This guide will help you set up and start using the Catalyst Center Integration for NetBox.
Getting Started with the Juniper Mist Integration for NetBox
This guide will help you set up and start using the Juniper Mist Integration for NetBox.
Getting Started with the VMware vCenter Integration for NetBox
This guide will help you set up and start using the VMware vCenter Integration for NetBox.
Index
The NetBox ServiceNow Integration provides API and CMDB integration capabilities between ServiceNow and NetBox instances. This application enables bidirectional synchronization of infrastructure data, allowing organizations to maintain consistent configuration management data across both platforms.
Juniper Mist Integration
Overview
Juniper Mist Integration - FAQ and Troubleshooting
This document provides answers to commonly asked questions about the NetBox Juniper Mist integration.
Juniper Mist NetBox Integration - Technical Information
This document provides a comprehensive mapping of Juniper Mist object types to their corresponding NetBox object types, based on the integration implementation.
NetBox Cloud Features
Features and capabilities exclusive to NetBox Cloud
NetBox Cloud SAML Configuration Guide
Overview
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 generating a notification:
Plugin Parameters
PLUGINS
Plugins
Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can introduce their own models and views, but cannot interfere with existing components. A NetBox user may opt to install plugins provided by the community or build his or her own.
Remote Authentication Settings
The configuration parameters listed here control remote authentication for NetBox. Note that REMOTEAUTHENABLED must be True in order for these settings to take effect.
Search
Global Search
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. Plugin authors can extend these templates to minimize the work needed to create custom templates while ensuring that the content they produce matches NetBox's layout and style. These templates are all written in the Django Template Language (DTL).
User Interface
Light & Dark Mode
Virtualization
Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just like physical objects, providing a seamless integration between physical and virtual networks.
VMware vCenter Integration
Overview