Skip to main content

Provides the ability to record circuit maintenance, maintenance impact and maintenance notifications in Netbox and link them to Providers and Circuits.

Project description

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
  • Track circuit impact from provider maintenance
  • Provides a consolidated view of active, upcoming and historical maintenance events at the provider and circuit level
  • Consolidated notifications (coming soon)
  • Maintenance overlap detection (coming soon)

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.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.

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_circuitmaintenance-0.5.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

netbox_circuitmaintenance-0.5.0-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file netbox_circuitmaintenance-0.5.0.tar.gz.

File metadata

File hashes

Hashes for netbox_circuitmaintenance-0.5.0.tar.gz
Algorithm Hash digest
SHA256 8bca57f9b33b92cb6c2720d4764e55ede67b957c863b1ce01aa178535dd819da
MD5 0764b663f9b01859ef5788354c61702d
BLAKE2b-256 d49e02c67dae2ab46ad2117a0c0eb738f43adfaa68cc596947c8f9f6374387a1

See more details on using hashes here.

File details

Details for the file netbox_circuitmaintenance-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_circuitmaintenance-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a94cded6ea7f6a713decf8cc5f1028306484c7c89dcd8a3f4c6caf60901aef2
MD5 ae50439a89c2deb8d74030b4c043b258
BLAKE2b-256 c0ec249508718c80e121cde9f3a774a865f84601d0b0652c2712c34ae69b7a9e

See more details on using hashes here.

Supported by

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