Skip to main content

A Netbox plugin for tracking Security and NAT related objects

Project description

NetBox Security Plugin

Netbox plugin for Security and NAT related objects documentation.

PyPi Stars Badge Forks Badge Issues Badge Pull Requests Badge GitHub contributors License Badge Code Style Black Downloads Downloads/Week Downloads/Month

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

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


Download files

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

Source Distribution

netbox_security-1.5.7.tar.gz (84.6 kB view details)

Uploaded Source

Built Distribution

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

netbox_security-1.5.7-py3-none-any.whl (206.2 kB view details)

Uploaded Python 3

File details

Details for the file netbox_security-1.5.7.tar.gz.

File metadata

  • Download URL: netbox_security-1.5.7.tar.gz
  • Upload date:
  • Size: 84.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_security-1.5.7.tar.gz
Algorithm Hash digest
SHA256 2f6b47191a714311d99e0b099b254d13d86a390b2b5ff69aef5e1eeef9eb03fb
MD5 f168f4154bc51f5233474459caa72a7c
BLAKE2b-256 ba65c1936a603d81d07a2ae3bb6146572370eb1628101a142083925ce7c60e65

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_security-1.5.7.tar.gz:

Publisher: publish.yml on andy-shady-org/netbox-security

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_security-1.5.7-py3-none-any.whl.

File metadata

  • Download URL: netbox_security-1.5.7-py3-none-any.whl
  • Upload date:
  • Size: 206.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_security-1.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 afa2867c342d2b4bcd98711b1b60b305e2111e0a81f8b20b7fcc544040514add
MD5 ff9585d5905d22ea10e69b475d9aa4a3
BLAKE2b-256 bbc72b01ba62b0c2b7e6419d4249d74a971f83def1e2b29258da85fd0026b4c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_security-1.5.7-py3-none-any.whl:

Publisher: publish.yml on andy-shady-org/netbox-security

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page