Skip to main content

NetBox Plugin Reloader

A NetBox plugin that dynamically reloads plugins without requiring a server restart. This plugin ensures that NetBox properly registers all plugin models and form fields that might have been missed during the initial application startup.

Features

  • Dynamically registers plugin models that were missed during server startup
  • Refreshes custom field form definitions to include newly registered models
  • Refreshes tag form definitions to include newly registered models
  • Prevents duplicate view tab registrations caused by dynamic model plugins
  • Helps solve integration issues between NetBox and other plugins
  • No configuration required - works out of the box

Compatibility Matrix

NetBox Version Plugin Version
4.2.x 0.0.2
4.3.x 4.3.x
4.4.x 4.4.x
4.5.0 - 4.5.3 4.5.0.1
4.5.4+ 4.5.4.x
4.6.x 4.6.x
4.7.x 4.7.x

Version Format: X.X.Y.Z where X.X = NetBox major.minor version (e.g., 4.5), Y = NetBox patch version (e.g., 0), and Z = plugin release increment

Installation

The plugin is available as a Python package on PyPI and can be installed with pip:

pip install netbox-plugin-reloader

To enable the plugin, add it to the PLUGINS list in your configuration.py:

PLUGINS = [
    'other_plugin',
    'another_plugin',
    'netbox_plugin_reloader',  # Always add netbox_plugin_reloader last!
]

After installing the plugin:

  1. Restart NetBox:

    sudo systemctl restart netbox
    
  2. Ensure that netbox-plugin-reloader is included in your local_requirements.txt if you're using the official NetBox installation method.

For more details, see the NetBox Documentation.

Important Note

netbox_plugin_reloader must be the last item in your PLUGINS list! This ensures that it can properly detect and register all models from other plugins that may have been missed during the initial startup process.

How It Works

When NetBox starts, Plugin Reloader:

  1. Scans all enabled plugins for models that aren't properly registered in NetBox's feature registry
  2. Registers any missed models with NetBox's registration system
  3. Deduplicates view registrations (e.g. Journal, Changelog tabs) that may have accumulated due to dynamic model plugins regenerating model classes during startup
  4. Refreshes custom field form definitions to ensure they include all registered models
  5. Refreshes tag form definitions to ensure they include all registered models

This helps resolve issues where plugins might not fully integrate with NetBox due to load order problems without requiring a server restart. The reloader specifically updates custom field choices and tag choices to include newly registered plugin models.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Author

Jan Krupa jan.krupa@cesnet.cz

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_plugin_reloader-4.7.0.1.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_plugin_reloader-4.7.0.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file netbox_plugin_reloader-4.7.0.1.tar.gz.

File metadata

  • Download URL: netbox_plugin_reloader-4.7.0.1.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for netbox_plugin_reloader-4.7.0.1.tar.gz
Algorithm Hash digest
SHA256 71e3a126d0a066b73ccb72cb46fa78d1b72708e9377e8cb6163e9b141dba9377
MD5 27010e6702fcde345d8f8d31ecb403de
BLAKE2b-256 32290ef2788803ead156d7a41e7ecbd322da596704a9f42f58c6fb9e21b9b4b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_plugin_reloader-4.7.0.1.tar.gz:

Publisher: publish.yml on CESNET/netbox-plugin-reloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_plugin_reloader-4.7.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_plugin_reloader-4.7.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e5d4c43cf5e2bfde81c55ab16ecd47d394d8cbaf92889b9e581b633a3b4dfa95
MD5 a4c21a11f3b28858d3ed442b0eeecc43
BLAKE2b-256 78ecf3972d0e6313d5f550292447fb1639b306a1f370af07766f12f2efa0d859

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_plugin_reloader-4.7.0.1-py3-none-any.whl:

Publisher: publish.yml on CESNET/netbox-plugin-reloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.7.0.1 This release

2 files

4.6.0.2

2 files

4.6.0.1

1 file

4.5.4.1

2 files

4.5.0.1

1 file

4.4.0.1

1 file

4.4.0

1 file

4.3.1

1 file

4.3.0

1 file

0.0.2

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page