NetBox Security Plugin
Netbox plugin for Security and NAT related objects documentation.
Features
This plugin provides following Models:
- CustomPrefix
- Addresses
- Address Sets
- Address Lists
- Security Zones
- Security Zone Policies
- NAT Pools
- NAT Pool Members
- NAT Rule-sets
- NAT Rules
- Firewall Filters
- Firewall Filter Rules
- Firewall Policers
Compatibility
| NetBox Version | NetBox Security Version |
|---|---|
| NetBox 4.2 | >= 1.0.2 |
| NetBox 4.3 | >= 1.1.0 |
| NetBox 4.4 | >= 1.3.0 |
| NetBox 4.5 | >= 1.4.0 |
| NetBox 4.6 | >= 1.5.0 |
| NetBox 4.7 | >= 1.6.0 |
Installation
The plugin is available as a Python package in pypi and can be installed with pip
pip install netbox-security
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
PLUGINS = ['netbox_security']
Restart NetBox and add netbox-security to your local_requirements.txt
Perform database migrations:
cd /opt/netbox
source venv/bin/activate
python ./netbox/manage.py migrate netbox_security
python ./netbox/manage.py reindex netbox_security
Full documentation on using plugins with NetBox: Using Plugins - NetBox Documentation
Configuration
The following options are available:
virtual_ext_page: String (default left) Virtual Machine related objects table position. The following values are available:
left, right, full_width. Set empty value for disable.interface_ext_page: String (default full_width) Interface related objects table position. The following values are available:
left, right, full_width. Set empty value for disable.address_ext_page: String (default right) Address/Address Set related objects table position. The following values are available:
left, right, full_width. Set empty value for disable.top_level_menu: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.assignments_menu: Boolean (default False) Display assignments within the plugin menu. The following values are available: True, False.
Contribute
Contributions are always welcome! Please see the Contribution Guidelines
Documentation
For further information, please refer to the full documentation: Using NetBox Security
Credits
- Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.
- Thanks to Dan Sheppard for the abstracted field generation stuff which I also used.
- Thanks to Kris Beevers and Mark Coleman at Netbox Labs for encouragement and engagement.
1 maintainer
Release files for netbox-security 1.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| netbox_security-1.6.2.tar.gz | 87.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| netbox_security-1.6.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 297.3 kB
Release files / netbox_security-1.6.2.tar.gz
| Download URL | netbox_security-1.6.2.tar.gz |
|---|---|
| Size | 87.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a993b7e2ba182e75a556e8db48ac6353c0af6b60a63346f4aa793d7c57d41fc5
|
|
BLAKE2b-256 checksum How to use checksums |
4470e4ec3636e990fbbe354954cf856a052198ac4476d6ae0f65d03ee90c741d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / netbox_security-1.6.2-py3-none-any.whl
| Download URL | netbox_security-1.6.2-py3-none-any.whl |
|---|---|
| Size | 210.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbe4323eeb664cb5556856be0daa6fe0218176a446628b89bc9acd55896aae6d
|
|
BLAKE2b-256 checksum How to use checksums |
f051b606fc75e00a947f7571e77716cbf0e399e0e6379e43a4b8a96d65e7e162
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency log
