A Netbox plugin that supports Virtual Circuit management
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file netbox-virtual-circuit-plugin-0.1.2.tar.gz.
File metadata
- Download URL: netbox-virtual-circuit-plugin-0.1.2.tar.gz
- Upload date:
- Size: 5.8 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9a346e3beddd6c3124eece8e3ccd7a8efcbc030b2725e7790d00f21f35903ae3 |
|
| MD5 | 4e0f2145f6cb9f937c482f9956fae0a0 |
|
| BLAKE2b-256 | 40f79d022387e3533d9024058beb4f0266f9ebd9c418e290ad9c1e353a2157e8 |
Provenance
File details
Details for the file netbox_virtual_circuit_plugin-0.1.2-py3-none-any.whl.
File metadata
- Download URL: netbox_virtual_circuit_plugin-0.1.2-py3-none-any.whl
- Upload date:
- Size: 21.9 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 210a0958a156f7af438808ec171ed8b9c2185d1316ade34dd90ce33550fc61b4 |
|
| MD5 | c16818a6f9169fcbc368cd64c4f87264 |
|
| BLAKE2b-256 | 22210ee4bda0d11a6e452706d9d581f6cf28925e89ecbfc6d0ef0e0ced8ab924 |
