netbox-tunnels2 icon indicating copy to clipboard operation
netbox-tunnels2 copied to clipboard

Netbox Plugin to track IP Tunnels (Netbox 3.4+)

Netbox Tunnels Plugin

This plugin is a fork of jdrew82/netbox-tunnels-plugin and hiddenman/netbox-tunnels-plugin in an effort to support Netbox 3.4+.


In Netbox 3.7, official Tunnel support was added. Please transition to using the build in feature.


Features

This plugin provide following Models:

  • Tunnels
  • Tunnel Types

Compatibility

NetBox Version Plugin Version
NetBox 3.4 0.2.2
NetBox 3.5 0.2.3
NetBox 3.6 0.2.8
NetBox 3.7 > 0.2.9

Installation

You can install this package from Pip

pip install netbox-tunnels2

To install the package from source

git clone https://github.com/robertlynch3/netbox-tunnels2.git
cd netbox-tunnels2
source /path/to/netbox/venv/bin/activate
python3 setup.py develop

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ['netbox_tunnels2']

Apply the migrations with Netbox manage.py:

(venv) $ python manage.py migrate

Restart Netbox to apply the changes:

sudo systemctl restart netbox

See NetBox Documentation for details

Screenshots

Tunnel List Tunnel List

Tunnel Details Tunnel Details

TODO

  • Validate the Public IP addresses belong to the Devices
  • Validate the same inside interface is not used by multiple tunnels