NetBox cesnet_services Plugin

NetBox plugin for CESNET services.

• Free software: MIT
• Documentation: https://kani999.github.io/netbox-cesnet-services-plugin/

Features

Enables CESNET services in NetBox:

• BGP connections — tracks BGP peering sessions with last-seen monitoring and status badges
• LLDP Neighbors / LLDP Leafs — stores discovered LLDP adjacencies and leaf relationships
• ServiceCoreTrunk — core trunk between two nodes with linked path segments
• ServiceCoreLink — core link with topology, SAPs, L2 (QinQ encapsulation, LLDP, Flowspec), IS-IS/OSPF routing and IP addresses; belongs to one or more CoreTrunks
• ServiceIP — IP service with SAP attachment, routed/physical device and interface attributes, VLAN encapsulation (dot1q / QinQ S-VLAN & C-VLAN as ipam.VLAN links), IPv4/IPv6 addresses, VRF (null = Global), and routing (static or BGP)

Compatibility

Installing

For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.

Prerequisites

• cesnet-service-path-plugin — required from version 3.0.1 onwards. The ServiceCoreTrunk and ServiceCoreLink models reference Segment objects from this plugin. Both plugins must be installed and listed in PLUGINS.
• NetBox 4.7.0 – 4.7.99 (for plugin version 4.0.x)
  • cesnet-service-path-plugin must be >= 6.3.0
  • For NetBox 4.5.4 – 4.6.99, use plugin version 3.0.x (latest 3.0.5)
• NetBox 4.5.4 – 4.6.99 (for plugin version 3.0.x)
  • Important: Plugin version 3.0.x requires NetBox 4.5.4 due to StrFilterLookup (ships with strawberry-graphql-django >= 0.79.0). Starting the plugin on NetBox 4.5.0–4.5.3 will raise an ImportError.
  • For NetBox 4.5.0–4.5.3, use plugin version 2.0.0
  • For NetBox 4.4.x, use plugin version 1.2.8 or earlier

Installation

You can install with pip:

pip install netbox-cesnet-services-plugin

or by adding to your local_requirements.txt or plugin_requirements.txt (netbox-docker):

# For NetBox 4.7.x
netbox-cesnet-services-plugin==4.0.0

# For NetBox 4.5.4 – 4.6.99
# netbox-cesnet-services-plugin==3.0.5

# For NetBox 4.5.4 – 4.6.99 (previous releases)
# netbox-cesnet-services-plugin==3.0.4
# netbox-cesnet-services-plugin==3.0.3
# netbox-cesnet-services-plugin==3.0.2
# netbox-cesnet-services-plugin==3.0.1

# For NetBox 4.5.4 – 4.6.99 (without new service models)
# netbox-cesnet-services-plugin==3.0.0

# For NetBox 4.5.4 only
# netbox-cesnet-services-plugin==2.1.0

# For NetBox 4.5.0–4.5.3
# netbox-cesnet-services-plugin==2.0.0

# For NetBox 4.4.x (use 1.2.8 or earlier)
# netbox-cesnet-services-plugin==1.2.8

Configuration

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py, or if you use netbox-docker, your /configuration/plugins.py file.

You can optionally set device platforms for filtering choices in LLDPNeighbor form:

PLUGINS = [
    'cesnet_service_path_plugin',   # required by netbox_cesnet_services_plugin >= 3.0.1
    'netbox_cesnet_services_plugin',
]

PLUGINS_CONFIG = {
    "netbox_cesnet_services_plugin": {
        "platforms" : ["ios", "iosxe", "iosxr", "nxos", "nxos_ssh"],
        "bgp_last_seen_warning_days": 2,   # days until last_seen badge turns orange (default: 2)
        "bgp_last_seen_danger_days": 5,    # days until last_seen badge turns red (default: 5)
    },
}

Credits

Based on the NetBox plugin tutorial:

• demo repository
• tutorial

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