An NetBox plugin to create Topology maps
Project description
Netbox Topology Views Plugin
Create topology views/maps from your devices in netbox. The connections are based on the cables you created in netbox. Support to filter on name, site, tag and device role.
Preview
Install
NOTE: For docker please see: Docker install
The plugin is available as a Python package and can be installed with pip.
Run pip install netbox-topology-views in your virtual env.
To ensure NetBox Topology Views plugin is automatically re-installed during future upgrades, create a file named local_requirements.txt (if not already existing) in the NetBox root directory (alongside requirements.txt) and list the netbox-topology-views package:
# echo netbox-topology-views >> local_requirements.txt
Once installed, the plugin needs to be enabled in your configuration.py
# In your configuration.py
PLUGINS = ["netbox_topology_views"]
First run source /opt/netbox/venv/bin/activate to enter the Python virtual environment.
Then run
cd /opt/netbox/netbox
pip3 install netbox-topology-views
python3 manage.py migrate netbox_topology_views
python3 manage.py collectstatic --no-input
Versions
| netbox version | netbox-topology-views version |
|---|---|
| >= 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 |
Custom field: coordinates
There is also support for custom fields.
If you create a custom field "coordinates" for "dcim > device" and "Circuits > circuit" with type "text" and name "coordinates" you will see the same layout every time. It is recommended to set this field to "UI visibility" "Hidden" and let the plugin manage it in the background.
The coordinates are stored as: "X;Y".
Please read the "Configure" chapter to set the allow_coordinates_saving option to True.
You might also set the always_save_coordinates option to True.
Configure
All individual options can be assigned a default value per user directly in the plugin. The default value can be overridden on the filter page.
The remaining options must be configured in the PLUGINS_CONFIG section of your netbox/configuration.py.
Example:
PLUGINS_CONFIG = {
'netbox_topology_views': {
'static_image_directory': 'netbox_topology_views/img',
'allow_coordinates_saving': True,
'always_save_coordinates': True
}
}
| Setting | Default value | Description |
|---|---|---|
| static_image_directory | netbox_topology_views/img | (str or pathlib.Path) Specifies the location that images will be loaded from by default. Must be within STATIC_ROOT |
| allow_coordinates_saving | False | (bool) Set to true if you use the custom coordinates fields and want to save the coordinates |
| always_save_coordinates | False | (bool) Set if you want to enable the option to save coordinates by default |
Custom Images
To change image with associated device use the Images page - it allows to map a device role with an image found in the netbox static directory (defined by the plugin config static_image_directory which defaults to netbox_topology_views/img). You can also upload you own custom images to there - these images will automatically be used for a device (if it does not already have a specified image in the settings) if their name is the device role slug.
Use
Go to the plugins tab in the navbar and click topology or go to $NETBOX_URL/plugins/netbox_topology_views/ to view your topologies
Select your options for the topology view:
- Save Coordinates
- Save the coordinates of devices in the topology view.
- Show Unconnected
- Show devices that have no connections or for which no connection is displayed. This option depends on other parameters like 'Show Cables' and 'Show Logical Connections'.
- Show Cables
- Show connections between interfaces, front / rear ports, etc., that are connected with one or more cables. These connections are displayed as solid lines in the color of the cable.
- Show Logical Connections
- Show logical connections between interfaces (referred to as Interface Connections in NetBox) in the topology view. Where the path between interfaces includes multiple cables (e.g., via patch panels), only the end interface connections are shown, not the intermediate front / rear port connections, etc. This is similar to what was referred to as 'end-to-end' connections in previous versions. These connections are displayed as yellow dotted lines.
- Show redundant Cable and Locigal Connection
- Shows a logical connection (in addition to a cable), even if a cable is directly connected. Leaving this option disabled prevents that redundant display. This option only has an effect if 'Show Logical Connections' is activated.
- Show Neighbors
- Adds neighbors to the filter result set automatically. Link peers will be added if 'Show Cables' is ticked, far-end terminations will be added if 'Show Logical Connections' is ticked.
- Show Circuit Terminations
- Show connections which end at a circuit termination in the topology view. These connections are displayed as blue dashed lines.
- Show Power Feeds
- Displays connections between power outlets and power ports. These connections are displayed as solid lines in the color of the cable. This option depends on 'Show Cables'.
- Show Wireless Links
- Displays wireless connections. These connections are displayed as blue dotted lines.
Update
Run pip install netbox-topology-views --upgrade in your venv.
Run python3 manage.py migrate netbox_topology_views
Run python3 manage.py collectstatic --no-input
Clear you browser cache.
Permissions
To view /plugins/netbox_topology-views/topology you need the following permissions:
- dcim | device | can view device
- dcim | site | can view site
- extras | tag | can view tag
- dcim | device role | can view device role
To view /plugins/netbox_topology-views/image:
- dcim | site | view
- dcim | device role | view
- dcim | device role | add
- dcim | device role | change
To view /plugins/netbox_topology-views/individualoptions:
- netbox topology views | individualoptions | change
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-topology-views-3.5.0.tar.gz.
File metadata
- Download URL: netbox-topology-views-3.5.0.tar.gz
- Upload date:
- Size: 194.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 479036cd677ba30872068828bc868c3e38c46f85a25ad226d037deb1cd9543e5 |
|
| MD5 | 07a0f218311ca579c11efa6dc4eacb78 |
|
| BLAKE2b-256 | af786d3be46ea84a3f8da8f8d5be3a8a5b5c1b868182a1b1ac69192adfb83e3e |
File details
Details for the file netbox_topology_views-3.5.0-py3-none-any.whl.
File metadata
- Download URL: netbox_topology_views-3.5.0-py3-none-any.whl
- Upload date:
- Size: 252.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | db89348acc9777c1ef7b0348e3ae2205734439c5c861e2fdf939378ad9c19ec0 |
|
| MD5 | c9c3cd01f816d7401efd0f3ee8f24a06 |
|
| BLAKE2b-256 | 3217839ea44f61613e6106ed0ef93470d326ecdb0170f7031c70a6335128c822 |
