Skip to main content

NetBox cesnet_services Plugin

NetBox plugin for CESNET services.

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
  • ServiceNNI — network-to-network interconnect: trunk from one CESNET node (port or LAG) to a partner network; the tenant (partner) is required. A port or LAG serves at most one Core Trunk / NNI side (available-trunk-ports API lists the free ones)
  • 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 (Static or BGP) with VRF (null = Global), customer prefixes and BGP peer AS; its attachments are ServiceIPEndpoints (Static: exactly one, BGP: 1..N, mixed connection types)
  • ServiceIPEndpoint — one attachment of a ServiceIP: connection type (Direct / Indirect Local / Indirect L2), routed and physical device & interface, VLAN encapsulation (dot1q / QinQ S-VLAN & C-VLAN as ipam.VLAN links), IPv4/IPv6 P2P addresses, static next hops
  • ServiceIPBGPSession — links a netbox-bgp BGPSession (one per address family) to a BGP endpoint and carries the announce-P2P / default-originate / next-hop-self flags

Compatibility

NetBox Version Plugin Version Notes
4.7.0 – 4.7.99 5.3.0 ServiceNNI; trunk port rule (a port / LAG serves one Core Trunk or NNI side) with available-trunk-ports API
4.7.0 – 4.7.99 5.2.0 Related services on Tenant, incl. child tenants via the parent_tenant custom field (tenant_parent_custom_field)
4.7.0 – 4.7.99 5.1.0 Related services (CoreLink / CoreTrunk / ServiceIP) on Device, Interface, Site and ASN detail pages (services_ext_page)
4.7.0 – 4.7.99 5.0.0 Breaking: ServiceIP split into ServiceIP / ServiceIPEndpoint / ServiceIPBGPSession; requires netbox-bgp >= 0.20.2
4.7.0 – 4.7.99 4.0.0 NetBox 4.7 only (django-tables2 3.0: RelatedLinkColumn → Column(linkify=True)); requires cesnet-service-path-plugin >= 6.3.0
4.5.4 – 4.6.99 3.0.5 ServiceIP QinQ VLAN fields converted to ipam.VLAN FKs
4.5.4 – 4.6.99 3.0.4 ServiceIP VRF field (null = Global)
4.5.4 – 4.6.99 3.0.3 ServiceIP routed/physical device & interface fields
4.5.4 – 4.6.99 3.0.2 GraphQL schema fix: DatetimeFilterLookup resolves DuplicatedTypeName error
4.5.4 – 4.6.99 3.0.1 ServiceCoreTrunk, ServiceCoreLink, ServiceIP models + full API/UI/tests
4.5.4 – 4.6.99 3.0.0 NetBox 4.6 support (Django 6.0)
4.5.4+ 2.1.0 last_seen field, bulk ops, status badges
4.5.4+ 2.0.1 GraphQL fix: StrFilterLookup replaces FilterLookup[str]; requires NetBox 4.5.4
4.5.0–4.5.3 2.0.0 Breaking change: Filter system updated, NOT compatible with 4.4.x
4.4.x 1.2.8 Last version compatible with NetBox 4.4.x
4.4.0 1.2.5
4.3.1 1.2.4
4.3.1 1.2.3
4.2.8 1.2.2

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-bgp >= 0.20.2 — required from version 5.0.0 onwards. ServiceIPBGPSession links netbox_bgp.BGPSession objects. Must be installed and listed in PLUGINS.
  • NetBox 4.7.0 – 4.7.99 (for plugin versions 4.x and 5.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_bgp',                   # required by netbox_cesnet_services_plugin >= 5.0.0
    '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:

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

Metadata

Release files for netbox-cesnet-services-plugin 5.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for netbox-cesnet-services-plugin 5.3.0
File Size Uploaded Provenance Actions
netbox_cesnet_services_plugin-5.3.0.tar.gz 76.1 kB Without provenance Details for netbox_cesnet_services_plugin-5.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for netbox-cesnet-services-plugin 5.3.0
File Interpreter ABI Platform Actions
netbox_cesnet_services_plugin-5.3.0-py3-none-any.whl Python 3 none any Details for netbox_cesnet_services_plugin-5.3.0-py3-none-any.whl

Total release size: 203.0 kB

Release files / netbox_cesnet_services_plugin-5.3.0.tar.gz

Download URL netbox_cesnet_services_plugin-5.3.0.tar.gz
Size 76.1 kB
Tags Source
SHA-256 checksum
How to use checksums
737473a0e9fd3eda7a3493239250b160c227fa59b0a3aa8e8a9a0e405ace7ba7
BLAKE2b-256 checksum
How to use checksums
97554029e174dd27f142b7ec99a27d780ef5df57bfd78fbe3c95f8957337f2f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release files / netbox_cesnet_services_plugin-5.3.0-py3-none-any.whl

Download URL netbox_cesnet_services_plugin-5.3.0-py3-none-any.whl
Size 127.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
076457bde487cc2c9a5c9563b86420d5a0f6020fa21f9008a707c2c7e8591a68
BLAKE2b-256 checksum
How to use checksums
78c5b6cef0a36ab940cdf1bbf4b66155345f76e373e7f867c6b2d432ee318a09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Security for netbox-cesnet-services-plugin 5.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.3.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page