mattieserver
3e5b28f208
* init for v3.1 * added coords + bump version * fix filter + added preselected roles * added draw_default_layout * upgraded packages * fixed edge/node labels * fixed enable_circuit_terminations * added filter for unconnected devices * added ignore_cable_type * fixed old settings using a string instead of array * removed distutils * fixed coords check * added coor saving * added doc img * updated docs * bump version * bump version
102 lines
3.9 KiB
Markdown
102 lines
3.9 KiB
Markdown
# 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
|
|
|
|
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:
|
|
|
|
```no-highlight
|
|
# echo netbox-topology-views >> local_requirements.txt
|
|
```
|
|
|
|
Once installed, the plugin needs to be enabled in your `configuration.py`
|
|
|
|
```python
|
|
# In your configuration.py
|
|
PLUGINS = ["netbox_topology_views"]
|
|
```
|
|
|
|
Then run `python3 manage.py collectstatic --no-input`
|
|
|
|
### Versions
|
|
|
|
| netbox version | netbox-topology-views version |
|
|
| ------------- |-------------|
|
|
| >= 3.1.8 | >= v1.0.0a1 |
|
|
| >= 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" with type "text" and name "coordinates" you will see the same layout every time.
|
|
|
|
The coordinates can then be provided as: "X;Y"
|
|
|
|
## Configure
|
|
|
|
If you want to override the default values configure the `PLUGINS_CONFIG` in your `netbox configuration.py`.
|
|
|
|
Example:
|
|
```
|
|
PLUGINS_CONFIG = {
|
|
'netbox_topology_views': {
|
|
'device_img': ['router','switch', 'firewall'],
|
|
'preselected_device_roles': ['Router', 'Firewall']
|
|
}
|
|
}
|
|
```
|
|
|
|
| Setting | Default value | Description |
|
|
| ------------- |-------------| -----|
|
|
| device_img |['access-switch', 'core-switch', 'firewall', 'router', 'distribution-switch', 'backup', 'storage,wan-network', 'wireless-ap', 'server', 'internal-switch', 'isp-cpe-material', 'non-racked-devices', 'power-units'] | The slug of the device roles that you have a image for. |
|
|
| preselected_device_roles | ['Firewall', 'Router', 'Distribution Switch', 'Core Switch', 'Internal Switch', 'Access Switch', 'Server', 'Storage', 'Backup', 'Wireless AP'] | The full name of the device roles you want to pre select in the global view. Note that this is case sensitive|
|
|
| allow_coordinates_saving | False | (bool) Set to true if you use the custom coordinates fields and want to save the coordinates |
|
|
| ignore_cable_type | ['power outlet', 'power port'] | The cable types that you want to ignore in the views |
|
|
| preselected_tags | '[]' | The name of tags you want to preload |
|
|
| enable_circuit_terminations | False | (bool) Set to true if you want to see circuit terminations in the topology |
|
|
| draw_default_layout | False | (bool) Set to True if you want to load draw the topology on the initial load (when you go to the topology plugin page) |
|
|
|
|
### Custom Images
|
|
|
|
You upload you own custom images to the netbox static dir (`static/netbox_topology_views/img/`).
|
|
These images need to be named after de device role slug and have the .png format/extension.
|
|
If you add your own image you also need to add the slug to the `device_img` setting.
|
|
|
|
## 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
|
|
|
|
### Update
|
|
|
|
Run `pip install netbox-topology-views --upgrade` in your venv.
|
|
|
|
Run `python3 manage.py collectstatic --no-input`
|
|
|
|
|
|
Clear you browser cache.
|
|
|
|
|
|
### Permissions
|
|
|
|
To view `/plugins/topology-views/` 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
|