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 (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.VLANlinks), 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.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
ServiceCoreTrunkandServiceCoreLinkmodels referenceSegmentobjects from this plugin. Both plugins must be installed and listed inPLUGINS. - netbox-bgp >= 0.20.2 — required from version 5.0.0 onwards.
ServiceIPBGPSessionlinksnetbox_bgp.BGPSessionobjects. Must be installed and listed inPLUGINS. - NetBox 4.7.0 – 4.7.99 (for plugin versions 4.x and 5.x)
cesnet-service-path-pluginmust 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 anImportError. - 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
- Important: Plugin version 3.0.x requires NetBox 4.5.4 due to
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.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| netbox_cesnet_services_plugin-5.2.0.tar.gz | 68.1 kB | Without provenance | Details for netbox_cesnet_services_plugin-5.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| netbox_cesnet_services_plugin-5.2.0-py3-none-any.whl | Python 3 | none | any | Details for netbox_cesnet_services_plugin-5.2.0-py3-none-any.whl |
Total release size: 180.0 kB
Release files / netbox_cesnet_services_plugin-5.2.0.tar.gz
| Download URL | netbox_cesnet_services_plugin-5.2.0.tar.gz |
|---|---|
| Size | 68.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c3c40f94c4c8b2a0a7dfd5828e0402bb4c09112d650a103c3fb1be72689fff0
|
|
BLAKE2b-256 checksum How to use checksums |
c0aac0f46b9ea2edc6e20600a95a2a7afe7514c6d74b1119957c9d88361fa357
|
| 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.2.0-py3-none-any.whl
| Download URL | netbox_cesnet_services_plugin-5.2.0-py3-none-any.whl |
|---|---|
| Size | 111.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d367344bf7b3af7c21075e08bc0a56404008849f394bf8fc7b85a2f411ed5f06
|
|
BLAKE2b-256 checksum How to use checksums |
59b743c96e28cfa7dd00f64881f0cbc117c91bf49f87998d70885deea6f773e8
|
| 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.2.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.