一个用于创建拓扑图的NetBox插件
项目描述
Netbox Topology Views 插件
从NetBox中的设备创建拓扑视图/地图。连接基于您在NetBox中创建的电缆。支持按名称、站点、标签和设备角色进行筛选。
可导出为xml（用于draw.io/diagrams.net）或png。
预览
安装
注意： 对于docker，请参阅： Docker安装
注意： 将 RUN mkdir -p /opt/netbox/netbox/static/netbox_topology_views/img 添加到Dockerfile-Plugins文件中，以创建图像文件夹
该插件作为Python包提供，可以使用pip安装。
在您的虚拟环境中运行 pip install netbox-topology-views。
为了确保NetBox Topology Views插件在未来的升级过程中自动重新安装，在NetBox根目录中创建一个名为 local_requirements.txt 的文件（如果尚未存在），与 requirements.txt 文件一起（在旁边）列出 netbox-topology-views 包
# echo netbox-topology-views >> local_requirements.txt
安装完成后，需要在您的 configuration.py 中启用插件
# In your configuration.py
PLUGINS = ["netbox_topology_views"]
首先运行 source /opt/netbox/venv/bin/activate 进入Python虚拟环境。
然后运行
cd /opt/netbox/netbox
pip3 install netbox-topology-views
python3 manage.py migrate netbox_topology_views
python3 manage.py collectstatic --no-input
版本
| netbox 版本 | netbox-topology-views 版本 |
|---|---|
| >= 4.1.0 | >= v4.1.0 |
| >= 4.0.0 | >= v4.0.0 |
| >= 3.7.0 | >= v3.9.0 |
| >= 3.6.4 | >= v3.8.1 |
| >= 3.6.0 | >= v3.7.X |
| >= 3.5.0 | >= v3.4.X |
| >= 3.4.0 | >= v3.X.X |
| >= 3.3.0 | >= v3.0.0 |
| >= 3.2.0 | >= v1.1.0 |
| >= 3.1.8 | >= v1.0.0 |
| >= 2.11.1 | >= v0.5.3 |
| >= 2.10.0 | >= v0.5.0 |
| < 2.10.0 | =< v0.4.10 |
更新
在您的 venv 中运行 pip install netbox-topology-views --upgrade。
运行 python3 manage.py migrate netbox_topology_views
运行 python3 manage.py collectstatic --no-input
清除您的浏览器缓存。
配置
个人选项
所有个人选项都可以直接在插件中为每个用户分配默认值。默认值可以在过滤页面上被覆盖。
其余选项必须在您的 netbox/configuration.py 的 PLUGINS_CONFIG 部分中进行配置。
示例
PLUGINS_CONFIG = {
'netbox_topology_views': {
'static_image_directory': 'netbox_topology_views/img',
'allow_coordinates_saving': True,
'always_save_coordinates': True
}
}
| 设置 | 默认值 | 描述 |
|---|---|---|
| static_image_directory | netbox_topology_views/img | (str 或 pathlib.Path) 默认情况下，指定图像将从该位置加载。必须在 STATIC_ROOT 内部 |
| allow_coordinates_saving | False | (bool) 如果您想启用保存坐标的能力，则将其设置为 true。 |
| always_save_coordinates | False | (bool) 如果您想启用默认情况下保存坐标的选项，则设置此选项。将 allow_coordinates_saving 设置为 true 是强制性的。 |
自定义字段：坐标
还支持自定义字段。
注意： 自定义字段 "coordinates" 已弃用，并将在未来被移除。请使用坐标组代替。
如果您为 "dcim > device" 和 "Circuits > circuit" 创建了类型为 "text" 且名称为 "coordinates" 的自定义字段 "coordinates"，则每次都会看到相同的布局。建议将此字段设置为 "UI 可见性" "隐藏"，并让插件在后台管理它。
坐标以 "X;Y" 的形式存储。
请阅读 "配置" 章节，以将
allow_coordinates_saving选项设置为 True。您还可以将always_save_coordinates选项设置为 True。
将自定义字段转换为坐标组
请注意，存储在自定义字段 "coordinates" 中的值不会自动转换为坐标组。以下是自己执行此转换的实用方法：
- 导航到 "拓扑" > "过滤器"。
- 选择 "显示未连接" 和 "显示电缆"。
- 保留所有其他过滤设置不变。我们希望显示所有条目！
- 点击 "搜索" 并等待结果显示
- 选择所有节点。这可以通过按住 Shift 键并用鼠标左键拖动一个框架围绕所有图标来完成。
- 将选择稍微向一侧拖动。这会导致所有设备的坐标都存储在 "default" 组中。
提示： 点击图标后不要等待太久再拖动。如果在开始拖动之前按住鼠标按钮时间过长，选择将被重置。
- 存储值可能需要一些时间，具体取决于设备的数量。请耐心等待并检查 "坐标" 以确保一切已存储。
- 现在可以安全地删除自定义字段。
自定义图像
要更改与设备关联的图像，请使用 Images 页面 - 它允许将设备角色与在 NetBox 静态目录（由插件配置 static_image_directory 指定，默认为 netbox_topology_views/img）中找到的图像进行映射。您还可以上传自己的自定义图像到那里 - 如果图像的名称与设备角色的短名称相同，则这些图像将自动用于设备（如果设置中已指定了其他图像，则除外）。
使用
在导航栏中转到插件标签页，点击拓扑或转到 $NETBOX_URL/plugins/netbox_topology_views/ 以查看您的拓扑
选择拓扑视图的选项
- 坐标组
- 选择坐标组。这些组允许设备根据组显示在不同的位置，从而为相同的拓扑提供不同的表示。如果未选择任何内容，则自动设置组 "默认"。
- 保存坐标
- 保存拓扑视图中设备的坐标。
- 显示未连接的
- 显示没有连接或未显示连接的设备。此选项依赖于其他参数，如 '显示电缆' 和 '显示逻辑连接'。
- 显示电缆
- 显示通过一根或多根电缆连接的接口、前后端口等之间的连接。这些连接以电缆的颜色显示为实线。
- 显示逻辑连接
- 在拓扑视图中显示接口之间的逻辑连接（在NetBox中称为接口连接）。
- 显示冗余电缆和逻辑连接
- 即使电缆直接连接，也会显示逻辑连接（除电缆外）。禁用此选项可防止冗余显示。此选项仅在启用 '显示逻辑连接' 时才有效。
- 显示邻居
- 自动将邻居添加到过滤结果集中。如果勾选了 '显示电缆'，则将添加链路对等方；如果勾选了 '显示逻辑连接'，则将添加远端终结点。
- 显示电路终结
- 在拓扑视图中显示以电路终结结束的连接。这些连接以蓝色虚线显示。
- 显示电源馈线
- 显示电源插座和电源端口之间的连接。这些连接以电缆的颜色显示为实线。此选项依赖于 '显示电缆'。
- 显示无线链接
- 显示无线连接。这些连接以蓝色虚线显示。
坐标和坐标组
Netbox 拓扑视图存储设备的位置。为了允许拓扑的不同表示，支持坐标组。
请阅读 "配置" 章节，以将
allow_coordinates_saving选项设置为 True。您还可以将always_save_coordinates选项设置为 True。
转到菜单中的 "坐标组" 并创建您想要的任意多个组。您可以在稍后过滤器窗格中选择一个组，以根据此组显示图标位置（请参阅 "使用" 章节）。如果您不需要此功能，也可以省略创建组。Netbox 拓扑视图会自动为您创建一个名为 "默认" 的组，并将所有坐标存储在此组中，即使您在过滤器中没有选择组。
默认情况下，使用物理引擎计算设备的坐标。一旦将设备图标拖到另一个位置，其位置就会被保存，并且会被物理引擎排除在计算之外。所有保存的坐标都可以在 "坐标" 菜单项下查看和编辑。
注意：在编写本文档时，无法存储电路终结、电源面板和电源馈线的位置，因为这些不是设备。
权限
要查看 /plugins/netbox_topology-views/topology，您需要以下权限
- dcim | device | can view device
- dcim | site | can view site
- extras | tag | can view tag
- dcim | device role | can view device role
在移动图标时保存 Coordinates
- netbox_topology_views | coordinate | change
查看 /plugins/netbox_topology-views/images
- dcim | 站点 | 查看
- dcim | 设备角色 | 查看
- dcim | 设备角色 | 添加
- dcim | 设备角色 | 修改
查看 /plugins/netbox_topology-views/individualoptions
- netbox_topology_views | 单独选项 | 修改
根据您的需求设置 坐标组
- netbox_topology_views | 坐标组 | 查看/添加/修改/删除
根据您的需求设置 坐标
- netbox_topology_views | 坐标 | 查看/添加/修改/删除
根据您的需求设置 电源馈电坐标
- netbox_topology_views | 电源馈电坐标 | 查看/添加/修改/删除
根据您的需求设置 电源面板坐标
- netbox_topology_views | 电源面板坐标 | 查看/添加/修改/删除
根据您的需求设置 回路坐标
- netbox_topology_views | 回路坐标 | 查看/添加/修改/删除
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。