NetBox BGP 插件使用教程

NetBox BGP 插件使用教程

netbox-bgpNetBox plugin for BGP related objects documentation项目地址:https://gitcode.com/gh_mirrors/ne/netbox-bgp

1. 项目的目录结构及介绍

NetBox BGP 插件的目录结构如下：

netbox-bgp/
├── docs/
│   └── img/
├── netbox_bgp/
│   ├── migrations/
│   ├── templates/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── forms.py
│   ├── models.py
│   ├── urls.py
│   └── views.py
├── .gitignore
├── CODEOWNERS
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
└── setup.py

目录结构介绍：

• docs/: 包含项目的文档和图片资源。
• netbox_bgp/: 插件的主要代码目录。
  • migrations/: 数据库迁移文件。
  • templates/: HTML 模板文件。
  • __init__.py: 包初始化文件。
  • admin.py: Django 管理界面配置。
  • apps.py: 应用配置。
  • forms.py: 表单定义。
  • models.py: 数据模型定义。
  • urls.py: URL 路由配置。
  • views.py: 视图函数定义。
• .gitignore: Git 忽略文件配置。
• CODEOWNERS: 代码所有者配置。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• Makefile: 构建脚本。
• README.md: 项目说明文档。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

NetBox BGP 插件的启动文件主要是 setup.py 和 apps.py。

setup.py

setup.py 文件用于定义项目的元数据和依赖关系，以便通过 pip 安装插件。

from setuptools import find_packages, setup

setup(
    name='netbox-bgp',
    version='0.13.2',
    description='NetBox plugin for BGP related objects documentation',
    url='https://github.com/k01ek/netbox-bgp',
    author='Nikolay Yuzefovich',
    license='Apache 2.0',
    install_requires=[],
    packages=find_packages(),
    include_package_data=True,
    zip_safe=False,
)

apps.py

apps.py 文件用于配置 Django 应用。

from django.apps import AppConfig

class NetboxBgpConfig(AppConfig):
    name = 'netbox_bgp'

3. 项目的配置文件介绍

NetBox BGP 插件的配置文件主要是 configuration.py，需要在 NetBox 的配置文件中进行配置。

configuration.py

在 NetBox 的配置文件中添加以下配置：

PLUGINS = ['netbox_bgp']

此外，还可以配置插件的一些选项：

PLUGINS_CONFIG = {
    'netbox_bgp': {
        'device_ext_page': 'right',  # 设备相关 BGP 会话表的位置
        'top_level_menu': False,     # 是否启用顶级导航菜单
    }
}

配置选项介绍：

• device_ext_page: 设备相关 BGP 会话表的位置，可选值为 left、right、full_width 或空值（禁用）。
• top_level_menu: 是否启用顶级导航菜单，布尔值，默认为 False。

以上是 NetBox BGP 插件的基本使用教程，希望对您有所帮助。

netbox-bgpNetBox plugin for BGP related objects documentation项目地址:https://gitcode.com/gh_mirrors/ne/netbox-bgp