netbox-cable-labels
netbox-cable-labels copied to clipboard
Plugin for netbox that allows the automatic generation of labels based on a user defined template
NetBox Auto Cable Label Plugin
Plugin for netbox that allows the automatic generation of the label field content for cables based on a user defined template
- Free software: Apache-2.0
Compatibility
NetBox Version | Plugin Version |
---|---|
3.5 | 0.0.1 |
Installing
For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.
While this is still in development and not yet on pypi you can install with pip:
pip install git+https://github.com/jsenecal/netbox-cable-labels
or by adding to your local_requirements.txt
or plugin_requirements.txt
(netbox-docker):
git+https://github.com/jsenecal/netbox-cable-labels
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py
,
or if you use netbox-docker, your /configuration/plugins.py
file :
PLUGINS = [
'netbox_cable_labels'
]
Configuring
Setup PLUGINS_CONFIG with the following:
PLUGINS_CONFIG = {
"netbox_cable_labels": {"label_template": "Some Jinja2 template string here"},
}
Please note that the cable instance is passed as
cable
to the templating engine.
Default configuration
By default, the plugin copies the cable id
in the label, prefixed with the pound (#) sign.
"#{{cable.pk}}"
Management command
Using manage.py
, you can run the command generate_labels
to automatically generate labels on cables that do not already have one set, based on the configured template.
./manage.py generate_labels