# Built-in Plugins in NetBox Enterprise (/docs/enterprise/nbe-ec-built-in-plugins)





NetBox Enterprise includes a curated set of pre-integrated plugins that extend core capabilities without the complexity of manual installation. These plugins are tested, supported, and ready to enable with simple configuration changes.

<Callout type="info" title="Applies to both deployment methods">
  Built-in plugins are available in both **Embedded Cluster** and **Helm** deployments. For Helm, enable plugins via `netboxEnterprise.spec.netbox.config.customPythonConfig` in your values file. See [NetBox Configuration](/enterprise/helm/configuration/netbox) for details.
</Callout>

## Overview [#overview]

Built-in plugins provide enterprise-ready features that would normally require manual wheelhouse management. By pre-integrating popular community plugins, NetBox Enterprise simplifies deployment while ensuring compatibility and support.

**Key Benefits:**

* **Zero Installation**: No wheelhouse creation or dependency management required
* **Pre-tested Compatibility**: All plugins verified against the NetBox Enterprise version
* **Official Support**: Covered under NetBox Enterprise support agreements
* **Instant Availability**: Enable/disable with configuration changes only
* **Automatic Updates**: Plugins updated alongside NetBox Enterprise releases

**Built-in vs Custom Plugins:**

| Feature           | Built-in Plugins          | Custom Plugins               |
| ----------------- | ------------------------- | ---------------------------- |
| **Installation**  | Configuration only        | Wheelhouse creation required |
| **Compatibility** | Pre-tested                | Manual verification needed   |
| **Support**       | Official support included | Community or vendor support  |
| **Updates**       | Automatic with NBE        | Manual wheelhouse rebuild    |
| **Availability**  | Instant                   | Requires upload process      |

**Available Plugins (as of NBE 2.2.1):**

The following plugins are included in the current release. Use the **Config Name** value in your `PLUGINS` list.

| Plugin                             | Config Name                        | Version | Certified |
| ---------------------------------- | ---------------------------------- | ------- | --------- |
| netbox-acls                        | `netbox_acls`                      | 2.0.1   | ☑︎        |
| netbox-bgp                         | `netbox_bgp`                       | 0.18.1  | ☑︎        |
| netbox-documents                   | `netbox_documents`                 | 0.8.2   | ☐         |
| netbox-enterprise-plugin           | `netbox_enterprise_plugin`         | 0.2.7   | ☑︎        |
| netbox-floorplan-plugin            | `netbox_floorplan`                 | 0.9.1   | ☑︎        |
| netbox-healthcheck-plugin          | `netbox_healthcheck_plugin`        | 0.3.0   | ☑︎        |
| netbox-interface-synchronization   | `netbox_interface_synchronization` | 4.5.8   | ☐         |
| netbox-inventory                   | `netbox_inventory`                 | 2.5.1   | ☐         |
| netbox-lifecycle                   | `netbox_lifecycle`                 | 1.1.9   | ☐         |
| netbox-plugin-dns                  | `netbox_dns`                       | 1.5.8   | ☑︎        |
| netbox-qrcode                      | `netbox_qrcode`                    | 0.0.20  | ☑︎        |
| netbox-reorder-rack                | `netbox_reorder_rack`              | 1.1.4   | ☑︎        |
| netbox-secrets                     | `netbox_secrets`                   | 3.0.2   | ☑︎        |
| netbox-topology-views              | `netbox_topology_views`            | 4.5.1   | ☑︎        |
| netbox-turbobulk                   | `netbox_turbobulk`                 | 0.1.8   | ☑︎        |
| netbox-validity                    | `validity`                         | 3.5.2   | ☐         |
| netboxlabs-diode-netbox-plugin     | `netbox_diode_plugin`              | 1.13.0  | ☑︎        |
| netboxlabs-netbox-assurance-plugin | `netbox_assurance_plugin`          | 1.5.4   | ☑︎        |
| netboxlabs-netbox-branching        | `netbox_branching`                 | 1.0.3   | ☑︎        |
| netboxlabs-netbox-changes          | `netbox_changes`                   | 1.0.1   | ☑︎        |
| netboxlabs-netbox-copilot          | `netbox_copilot`                   | 1.33.3  | ☑︎        |
| netboxlabs-netbox-custom-objects   | `netbox_custom_objects`            | 0.5.1   | ☑︎        |
| slurpit\_netbox                    | `slurpit_netbox`                   | 1.3.30  | ☑︎        |

Plugin versions are updated with each NetBox Enterprise release. For version history, see the [NetBox Enterprise Release Notes](https://netboxlabs.com/docs/netbox-enterprise/nbe-release-notes/).

## Prerequisites [#prerequisites]

Before enabling built-in plugins, ensure you have:

* **Admin Access**: Access to the NetBox Enterprise Admin Console
* **Configuration Permissions**: Ability to modify NetBox Python Configuration Overrides
* **Plugin Documentation**: Review the specific plugin's documentation for configuration requirements
* **Deployment Window**: Time for NetBox pods to restart (typically 2-5 minutes)

<Callout type="info" title="No Installation Required">
  Unlike custom plugins, built-in plugins do not require wheelhouse creation, dependency management, or file uploads. They are already installed in the NetBox Enterprise container.
</Callout>

## Enabling Built-in Plugins [#enabling-built-in-plugins]

### Step 1: Access Admin Console [#step-1-access-admin-console]

1. Navigate to the **Config** tab in the NetBox Enterprise Admin Console
2. Scroll down and enable **Show Advanced Settings** checkbox:

<img alt="Screenshot: advanced settings" src="__img0" />

### Step 2: Configure Plugins [#step-2-configure-plugins]

In the **NetBox Python Configuration Overrides** field, add your plugin configuration:

**Example: Enable multiple plugins**

```python
PLUGINS = ['netbox_topology_views', 'netbox_bgp', 'netbox_acls']
```

**Example: Enable plugins with configuration**

```python
PLUGINS = ['netbox_topology_views', 'netbox_bgp']

PLUGINS_CONFIG = {
    'netbox_topology_views': {
        'allow_coordinates_saving': True,
        'always_save_coordinates': True
    },
    'netbox_bgp': {
        'device_ext_page': 'right'
    }
}
```

<Callout type="info" title="Configuration Reference">
  Each plugin has specific configuration options. Consult the plugin's documentation on GitHub for available settings:

  * [NetBox Topology Views](https://github.com/netbox-community/netbox-topology-views)
  * [NetBox BGP](https://github.com/netbox-community/netbox-bgp)
  * See [Release Notes](https://netboxlabs.com/docs/netbox-enterprise/nbe-release-notes/) for links to all built-in plugins
</Callout>

### Step 3: Deploy Configuration [#step-3-deploy-configuration]

1. Scroll to the bottom of the Config page
2. Click **Save config**
3. When prompted, click **Go to updated version**
4. Click **Deploy** to apply the configuration changes

The deployment process will:

* Create a new NetBox Enterprise configuration version
* Restart NetBox pods with the updated plugin configuration
* Apply any plugin-specific database migrations
* Return to **Ready** state when complete (typically 2-5 minutes)

### Step 4: Verify Plugin Activation [#step-4-verify-plugin-activation]

Once NetBox Enterprise returns to **Ready** state:

```bash
# Check plugin status in the UI
1. Log in to your NetBox instance
2. Navigate to /plugins/ to see the list of installed plugins
3. Verify your enabled plugins appear in the list
```

**Expected Plugin Indicators:**

* Plugin appears in the Plugins list at `/plugins/`
* Plugin navigation items appear in the NetBox UI navbar
* Plugin-specific pages and features are accessible
* No plugin loading errors in System > Background Jobs

## Best Practices [#best-practices]

### Plugin Selection [#plugin-selection]

* **Review Documentation**: Always review a plugin's documentation before enabling
* **Understand Dependencies**: Check if plugins require specific data models or configurations
* **Test in Development**: Enable plugins in a development environment first
* **Start Minimal**: Enable only plugins you actively need to reduce complexity

### Configuration Management [#configuration-management]

* **Version Control**: Track your `PLUGINS` and `PLUGINS_CONFIG` in version control
* **Document Choices**: Document why specific plugins are enabled and their configurations
* **Review Regularly**: Periodically review enabled plugins and disable unused ones
* **Configuration Validation**: Test configuration changes in staging before production

### Performance Considerations [#performance-considerations]

* **Resource Usage**: Some plugins add database queries or background jobs
* **Monitor Impact**: Monitor system performance after enabling new plugins
* **Disable Unused**: Disable plugins you're not actively using
* **Review Updates**: Check release notes when upgrading NetBox Enterprise for plugin changes

## Troubleshooting [#troubleshooting]

### Plugin Doesn't Appear After Deployment [#plugin-doesnt-appear-after-deployment]

**Check**:

* Deployment completed successfully and shows **Ready** state
* Plugin name is spelled correctly in `PLUGINS` list
* Plugin name matches exactly (case-sensitive)
* No errors in Background Jobs or system logs

**Solutions**:

```bash
# Check NetBox logs for plugin loading errors
kubectl logs -n <namespace> <netbox-pod-name> | grep -i plugin

# Verify configuration was applied
# Log in to NetBox and check Admin > System > Configuration
```

### Plugin Configuration Not Applied [#plugin-configuration-not-applied]

**Check**:

* `PLUGINS_CONFIG` dictionary syntax is correct (proper Python formatting)
* Plugin name in `PLUGINS_CONFIG` matches name in `PLUGINS` list
* Configuration keys match plugin's documented options
* Values use correct data types (strings, booleans, integers)

**Solutions**:

* Review plugin's GitHub repository for correct configuration syntax
* Check Python syntax (commas, quotes, brackets)
* Verify configuration keys match plugin documentation exactly

### Database Migration Errors [#database-migration-errors]

**Problem**: Deployment fails with database migration errors

**Solutions**:

* Check that your NetBox Enterprise version supports the plugin version
* Review [Release Notes](https://netboxlabs.com/docs/netbox-enterprise/nbe-release-notes/) for known issues
* Contact your NetBox Enterprise support representative if migrations fail

### Plugin Causes Performance Issues [#plugin-causes-performance-issues]

**Solutions**:

* Review plugin documentation for performance tuning options
* Check plugin configuration for settings that reduce query load
* Disable the plugin temporarily to confirm it's the cause
* Review plugin's GitHub issues for known performance problems
* Consider alternative plugins or custom solutions

## Additional Resources [#additional-resources]

* [NetBox Enterprise Release Notes](https://netboxlabs.com/docs/netbox-enterprise/nbe-release-notes/) - Current list of built-in plugins
* [Installing Custom Plugins](/enterprise/nbe-ec-custom-plugins/) - Add plugins not included by default
* [NetBox Plugin Configuration](https://netboxlabs.com/docs/netbox/en/stable/configuration/plugins/) - General plugin configuration guide
* [NetBox Community Plugins](https://github.com/netbox-community/netbox/wiki/Plugins) - Browse available plugins

## Disabling Plugins [#disabling-plugins]

To disable a plugin:

1. Remove the plugin name from the `PLUGINS` list
2. Remove any associated `PLUGINS_CONFIG` entries (optional but recommended)
3. Save and deploy the configuration
4. The plugin will be deactivated after NetBox restarts

<Callout type="warn" title="Database Data Retention">
  Disabling a plugin does not remove its database tables or data. The data remains in the database and will be accessible again if you re-enable the plugin. To completely remove a plugin's data, you would need to manually drop its database tables (not recommended without backup).
</Callout>