Home

Netbox Circuit Maintenance Plugin¶

Documentation: https://jasonyates.github.io/netbox-circuitmaintenance/

A NetBox plugin built to track circuit maintenance events, the plugin itself is agnostic in that it is only built to store data surrounding maintenance events and provide an overview of historical, active and upcoming circuit and provider maintenance events. The plugin tracks maintenance events at the provider level and associates impact from each event at the circuit level.

The plugin does not directly provide an automated approach to ingesting provider notifications, instead it extends NetBox's extensive REST API and provides GET/POST/PUT/PATCH methods to manage maintenance events. The plugin is intended to be coupled with an automated parser to handle the parsing of provider notifications and the delivery of the maintenance events to the plugin's REST API. Several example parsers have been documented here.

Features¶

Track provider maintenance events with provider timezone support
Track circuit impact from provider maintenance
Maintenance summary dashboard with stats, timeline and grouped-by-provider views
Maintenance calendar with ICS/iCal subscription feed
Consolidated view of active, upcoming and historical maintenance at the provider and circuit level
Unmatched notification triage queue for automated parser workflows
Full REST API with timezone and nullable notification support

Compatibility¶

This plugin is only supported on NetBox 3.4 or higher, for exact compatibility information, see the table below. | NetBox Version | Plugin Version | |--|--| | 4.4+ | 0.8.0 | | 4.4+ | 0.6.0 | | 4.2+ | 0.5.0 | | 4.0+ | 0.4.2 | | 3.5 | 0.3.0 | | 3.4 | 0.2.2 |

Installing¶

A working installation of Netbox 3.4+ is required - see official documentation.

Package Installation¶

Activate your virtual env and install via pip::

$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-circuitmaintenance

To ensure the Netbox Documents plugin is automatically re-installed during future upgrades, add the package to your local_requirements.txt :

# echo netbox-circuitmaintenance >> local_requirements.txt

Enable the Plugin¶

In the Netbox configuration.py configuration file add or update the PLUGINS parameter, adding netbox_circuitmaintenance:

PLUGINS = [
    'netbox_circuitmaintenance'
]

PLUGINS_CONFIG = {
    "netbox_circuitmaintenance": {},
}

Apply Database Migrations¶

Apply database migrations with Netbox manage.py:

(venv) $ python manage.py migrate

Restart Netbox¶

Restart the Netbox service to apply changes:

sudo systemctl restart netbox

Screenshots¶

Maintenance Event View Circuit Maintenance View Provider Maintenance View

Credits¶

Based on the NetBox plugin tutorial:

This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin project template.