Skip to main content

A NetBox services Plugin for Service Providers

Project description

NetBox Services Plugin

This plugin extends NetBox to manage and relate business services to network resources. It introduces a Service model that allows you to track various service types (such as L2VPN, L3VPN, DIA, Transit, CDN, Voice) and associate them with devices, interfaces, cables, VLANs, prefixes, VRFs, ASNs, route targets, L2VPNs, tunnels, and virtual machines.

Features

  • Add, edit, and delete business services.
  • Relate services to network objects (devices, interfaces, cables, VLANs, prefixes, VRFs, ASNs, route targets, L2VPNs, tunnels, virtual machines).
  • Filter and view services in a table with all relevant fields.
  • Custom forms and views for relating specific network objects to a service.
  • Integrated navigation and changelog support.

Usage

  • Access the plugin from the NetBox navigation menu under "Business Services".
  • Create new services and relate them to network resources.
  • Use the detail view to see all associations for a service.

alt text

Why

Because you might be looking for such a thing.

Tagging is great for simple categorization, but the NetBox Services plugin goes far beyond that by letting you model real business services and their relationships to network resources.

Instead of just tagging a device or prefix as "DIA," you can create a full DIA service—like "NW-123456" from Cogent—and link it to all relevant devices, interfaces, prefixes, VRFs, ASNs, and more.

For example, with a DIA service from Cogent (Service ID: NW-123456), you can:

  • See all devices and interfaces delivering that service.
  • Track the exact IP prefixes, VRFs, and ASNs involved.
  • Relate cables, tunnels, and even virtual machines to the service.
  • View and manage all these relationships in one place, with history and forms tailored to each resource.

This gives you a true service-centric view of your network, making troubleshooting, reporting, and change management much more powerful and organized than simple tagging ever could.

Requirements

  • NetBox 4.x or later
  • Django 4.x or later

Installation

  1. Clone this repository into your NetBox plugins directory. You can also install it on your system / venv / coffee maker with
pip install netbox_services
  1. Add 'netbox_services' to the PLUGINS list in your NetBox configuration.
    PLUGINS = [
        'netbox_services'
    ],
  1. Run migrations: python manage.py migrate netbox_services
  2. Restart NetBox.

License

MIT

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_services-0.0.10.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_services-0.0.10-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file netbox_services-0.0.10.tar.gz.

File metadata

  • Download URL: netbox_services-0.0.10.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for netbox_services-0.0.10.tar.gz
Algorithm Hash digest
SHA256 c5c8db86fbf37629cffabb4f128de270a23c070d0bd485fdc9cf86467d93752a
MD5 a87810ffbdda6177a6d6d3cd8a1eeabe
BLAKE2b-256 554556753f81ac3014bd087f3c54a88e4b1efc5c0f917479b6688b45539b49c8

See more details on using hashes here.

File details

Details for the file netbox_services-0.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_services-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 7f47ffc41dedd6e5f321cd33719801f9d224449ded2d02d93a6d9f69b96d69c1
MD5 940c3cbe8c9f6fbc9d8d021d799f1a82
BLAKE2b-256 733115d638d31cc748073cdaf00690bb68021524a3d621516e64a8b2c2480c03

See more details on using hashes here.

Supported by

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