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 hashes)

Uploaded Source

Built Distribution

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