A Netbox plugin for tracking Security and NAT related objects
Project description
NetBox Security Plugin
Netbox plugin for Security and NAT related objects documentation.
Features
This plugin provides following Models:
- 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 |
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file netbox_security-1.4.4.tar.gz.
File metadata
- Download URL: netbox_security-1.4.4.tar.gz
- Upload date:
- Size: 71.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0b6ad58dea5066ae4ebc5fcc1925b40f795ff0eb625b3cc779aacf0080a7e63
|
|
| MD5 |
aa9e3cd711a2b85a345599e0708ebc20
|
|
| BLAKE2b-256 |
7d6aa89f1b2d200ff2c5e90ca5da0a788d348e5c62f5606333e72a8efa714fd5
|
Provenance
The following attestation bundles were made for netbox_security-1.4.4.tar.gz:
Publisher:
publish.yml on andy-shady-org/netbox-security
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
netbox_security-1.4.4.tar.gz -
Subject digest:
b0b6ad58dea5066ae4ebc5fcc1925b40f795ff0eb625b3cc779aacf0080a7e63 - Sigstore transparency entry: 1079390285
- Sigstore integration time:
-
Permalink:
andy-shady-org/netbox-security@91e6f575345d14e1ee409ec3cad2f3ee16f7003b -
Branch / Tag:
refs/tags/v1.4.4 - Owner: https://github.com/andy-shady-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@91e6f575345d14e1ee409ec3cad2f3ee16f7003b -
Trigger Event:
release
-
Statement type:
File details
Details for the file netbox_security-1.4.4-py3-none-any.whl.
File metadata
- Download URL: netbox_security-1.4.4-py3-none-any.whl
- Upload date:
- Size: 183.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e75f219d60438775e2fbef184e824e8db31d4704ea60dd773fe51e423a83691
|
|
| MD5 |
2e5ad4bbc87da37f176ed88080fc6956
|
|
| BLAKE2b-256 |
b911b407d97f4cd38d8e56067741edb6891a4c91b0e6448a4c2c2d9fb06fa4da
|
Provenance
The following attestation bundles were made for netbox_security-1.4.4-py3-none-any.whl:
Publisher:
publish.yml on andy-shady-org/netbox-security
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
netbox_security-1.4.4-py3-none-any.whl -
Subject digest:
3e75f219d60438775e2fbef184e824e8db31d4704ea60dd773fe51e423a83691 - Sigstore transparency entry: 1079390323
- Sigstore integration time:
-
Permalink:
andy-shady-org/netbox-security@91e6f575345d14e1ee409ec3cad2f3ee16f7003b -
Branch / Tag:
refs/tags/v1.4.4 - Owner: https://github.com/andy-shady-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@91e6f575345d14e1ee409ec3cad2f3ee16f7003b -
Trigger Event:
release
-
Statement type: