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:

  • 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


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.4.4.tar.gz (71.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.4.4-py3-none-any.whl (183.4 kB view details)

Uploaded Python 3

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

Hashes for netbox_security-1.4.4.tar.gz
Algorithm Hash digest
SHA256 b0b6ad58dea5066ae4ebc5fcc1925b40f795ff0eb625b3cc779aacf0080a7e63
MD5 aa9e3cd711a2b85a345599e0708ebc20
BLAKE2b-256 7d6aa89f1b2d200ff2c5e90ca5da0a788d348e5c62f5606333e72a8efa714fd5

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_security-1.4.4.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.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

Hashes for netbox_security-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3e75f219d60438775e2fbef184e824e8db31d4704ea60dd773fe51e423a83691
MD5 2e5ad4bbc87da37f176ed88080fc6956
BLAKE2b-256 b911b407d97f4cd38d8e56067741edb6891a4c91b0e6448a4c2c2d9fb06fa4da

See more details on using hashes here.

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

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