-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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, views, and other resources, but cannot interfere with core components. A NetBox user may opt to install plugins provided by the community or build his or her own.
Plugins are supported on NetBox v2.8 and later.
Anyone is free and welcome to develop a plugin for NetBox. This can be a project that you use internally within your organization, an open source project, or even a commercial product. To get started with a plugin, we suggest first completing the official development tutorial. This will walk you through the process of creating a plugin from scratch. From there, the plugins framework documentation should have everything you need.
- Plugin Development Tutorial (requires NetBox v3.2+)
- Plugins Documentation
Please note that each plugin is its own project and maintained by its respective owner(s). The NetBox core team cannot provide assistance with plugin-specific issues. If you run into a problem installing or using a plugin, please consult the plugin's documentation to determine where to ask for help. (Generally, users will be advised to submit an issue to the plugin's repository on GitHub or elsewhere.)
Below are some of the more popular plugins that have been created for NetBox. This list of course is always growing, so feel free to suggest additions.
- axians-netbox-plugin-pdu - Get PDU information
- ciscodnacnetbox - Cisco DNA Center Integration with NetBox
- netbox-bgp - Document BGP objects
- netbox-plugin-dns - Plugin for managing DNS views, zones, name servers and records
- netbox-nagios - Show Nagios host and service status in NetBox on the device page
- netbox-paloalto - List firewall rules associated with a NetBox object
- netbox-plugin-auth-saml2 - SSO authentication using SAML2
- netbox-plugin-config-officer - Stores configuration diffs and checks templates compliance
- netbox-plugin-interface-sync - Compare and synchronize interfaces between devices and device types
- netbox-qrcode - Generate QR codes
- netbox-software-manager - Manage Cisco IOS & XE software
- netbox-sync - Sync vCenter objects into NetBox
- netbox-topology-views - Draws topology views
- netbox-vault-secrets - Hashicorp Vault integration
- netbox-virtual-circuit-plugin - Supports virtual circuit management
- netbox_capirca_plugin - Manage ACLs and Firewall rules with capirca inside NetBox
- netbox_ipcalculator - Embedded IP calculator
- nextbox-ui-plugin - A topology visualization plugin powered by the NextUI Toolkit
- ntmap - Network topology map using NetBox as a data source
- phonebox_plugin - Manage telephone numbers
- netbox-acls - Manage Access Lists (Builds on the example from the NetBox Plugin Tutorial)
- netbox-otp-plugin - The plugin provides user OTP token verification and OTP device management
(You can also find plugins by searching for the netbox-plugin topic on GitHub.)