netbox-security 1.5.0

A Netbox plugin for tracking Security and NAT related objects

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.