Skip to main content

A Netbox plugin that supports Virtual Circuit

Project description

NetBox Virtual Circuit Plugin

A plugin for NetBox that supports Virtual Circuit management.

Definitions

A Virtual Circuit is a circuit created by routing two or more VLANs together.

Each Virtual Circuit is identified by a name, a numeric ID (0-32767), along with a context. Each Virtual Circuit must be assigned one of the following operational statuses:

  • Pending Configuration
  • Configured
  • Pending Deletion
  • Configuration Error

When a VLAN is assigned to a Virtual Circuit, it can not exist in another Virtual Circuit without first being removed.

Installing

pip install netbox-virtual-circuit-plugin

Using

Once the plugin is installed correctly as guided here, one can find the Virtual Circuit section under Plugins navigation tab via NetBox UI that is ready to use with correct admin permission.

As for REST API use cases, the 2 group endpoints are exposed at:

  • /api/plugins/virtual-circuit/virtual-circuits
  • /api/plugins/virtual-circuit/vlans

While the former one is for creating/retrieving/modifying/deleting Virtual Circuits, the later one is for assigning and managing Virtual-Circuit-to-VLAN connections. For more information, refer to /api/docs as it also conforms to Swagger Specification for hosted visual documentations.

Developing

Plugins are essentially self-contained Django apps which integrate with NetBox to provide custom functionality. For more information, see NetBox documentation.

Contributing

If you experience a bug, would like to ask a question, or request a feature, open a new issue and provide as much context as possible. All contributions, questions, and feedback are welcomed and appreciated.

License

NetBox Virtual Circuit Plugin is licensed under GPLv3. See LICENSE for more info.

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-virtual-circuit-plugin-0.1.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file netbox-virtual-circuit-plugin-0.1.1.tar.gz.

File metadata

  • Download URL: netbox-virtual-circuit-plugin-0.1.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for netbox-virtual-circuit-plugin-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6e607511d26c959f7374a29d4b90ada4f9175de4f4993c351c8f9b970ed873c1
MD5 27310b545e6fc159b9f79e7440c13f74
BLAKE2b-256 1d4f750f3dcda72fb29f4e5bcb59d446c8d912a80cffd1102f62278b42f24bfb

See more details on using hashes here.

Provenance

File details

Details for the file netbox_virtual_circuit_plugin-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: netbox_virtual_circuit_plugin-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for netbox_virtual_circuit_plugin-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3125197131a171a520ad57b132a273ef30521ba738e006f1d11e28eb42656967
MD5 25350ef6dd8a3a9a6da4de8bacdbc188
BLAKE2b-256 842f8ff58f1298d0b0246ea4d69bcf27f0540563c01880ccf12587f808f04e18

See more details on using hashes here.

Provenance

Supported by

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