支持虚拟电路管理的Netbox插件
项目描述
NetBox虚拟电路插件
这是一个支持虚拟电路管理的NetBox插件。
定义
虚拟电路是通过路由两个或更多VLAN创建的电路。
每个虚拟电路由名称、数字ID（0-32767）以及上下文标识。每个虚拟电路必须分配以下操作状态之一
- 待配置
- 已配置
- 待删除
- 配置错误
当VLAN分配给虚拟电路时，它不能存在于另一个虚拟电路中，除非先将其删除。
安装
由于插件发布在PyPI上，只需执行
pip install netbox-virtual-circuit-plugin
即可下载和安装。
要启用插件，将插件名称添加到configuration.py中的PLUGINS列表中，如下所示
PLUGINS = ['netbox_virtual_circuit_plugin'] # Note that the name here use underscore, not hyphen.
不要忘记重新启动NetBox以加载新插件。
您可能还需要手动运行Netbox数据库迁移，以创建虚拟电路所需的适当表。
python3 manage.py migrate
有关安装插件的更多信息，请参阅NetBox的文档。
兼容性
以下表格描述了各种NetBox版本与NetBox虚拟电路插件版本的兼容性。
| Netbox 2.8 | NetBox 2.9 | Netbox 2.10 | Netbox 2.11 | Netbox 3.0 | Netbox 3.1 | |
|---|---|---|---|---|---|---|
1.0.x |
✓ | ✗ | ✗ | x | x | x |
1.1.x 至 1.5.x |
✗ | ✓ | ✗ | x | x | x |
1.6.x |
✗ | ✗ | ✓ | x | x | x |
1.7.x |
✗ | ✗ | x | ✓ | x | x |
2.0.0 |
✗ | ✗ | x | ✓ | x | ✓ |
使用
按照上述说明正确安装插件后，用户可以在 NetBox UI 的 插件 导航标签下找到 虚拟电路 部分，该部分已准备好使用，并且需要正确的 管理员 权限。
至于 REST API 的使用场景，有两个端点在以下位置暴露
/api/plugins/virtual-circuit/virtual-circuits/api/plugins/virtual-circuit/vlans
前者用于创建/检索/修改/删除虚拟电路，后者用于分配和管理虚拟电路到 VLAN 的连接。更多详细信息，请参阅 /api/docs，它也符合 Swagger 规范，用于托管可视化文档。
开发
插件本质上是可以独立运行的 Django 应用程序，它们与 NetBox 集成以提供自定义功能。更多信息，请参阅 NetBox 文档。
为了帮助设置开发环境，它包含一个基于 Makefile 的 CLI 辅助工具，包括以下命令
changelog Generate a changelog file from GitHub Issue Tracker
clean Clean up build artifacts
deploy Run a local development deployment of the plugin with NetBox
docker Build a local docker image
github-tag Create and push a tag with the current version
help Print usage information
migrate Run makemigrations in Django and produce a migration file locally
release Package and distribute the current release to PyPI
test Run unit tests
version Print the version
也就是说，用户只需一条命令即可构建并运行本地开发版本的插件
make build && make deploy
应用程序将在几分钟内通过 http://0.0.0.0:8000/ 可用。默认凭证是
- 用户名： admin
- 密码： admin
- API令牌： 0123456789abcdef0123456789abcdef01234567
以下是 UI 的几个截图
贡献
如果您遇到错误，想提问或请求功能，请打开一个新问题，并尽可能提供上下文。所有贡献、问题和反馈都受到欢迎和赞赏。
许可证
NetBox 虚拟电路插件采用 GPLv3 许可。有关更多信息，请参阅 LICENSE。
netbox-virtual-circuit-plugin-2.0.0.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 2bdc985a1bd99371e446cebe971fdc46958c367cb9eec10d6b907cd8f53cff41 |
|
| MD5 | 27744befd3fd4149a569b0bdbd51def2 |
|
| BLAKE2b-256 | b0b425e0d0cbccd4ddaf7c3087ccc0d6bd829477cd445b6233c3ad3c95487b91 |
哈希值 for netbox_virtual_circuit_plugin-2.0.0-py3-none-any.whl
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | edd7c4193dd2a4f1090b35f24b79f82684d3a168080444b341ed1a079dec5d41 |
|
| MD5 | 4024471c098a6f931b3fe6953b7be8aa |
|
| BLAKE2b-256 | f6b369a571a4bb5d69a8368b2fa7fd8f90c0767a9044a2b15d5ca36658650afc |