https://github.com/jsenecal/netbox-cable-labels

Plugin for netbox that allows the automatic generation of labels based on a user defined template
https://github.com/jsenecal/netbox-cable-labels

netbox netbox-plugin python3

Last synced: 2 months ago
JSON representation

Plugin for netbox that allows the automatic generation of labels based on a user defined template

• Host: GitHub
• URL: https://github.com/jsenecal/netbox-cable-labels
• Owner: jsenecal
• License: other
• Created: 2022-09-21T14:36:24.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-25T22:05:16.000Z (over 1 year ago)
• Last Synced: 2024-10-11T17:42:31.460Z (3 months ago)
• Topics: netbox, netbox-plugin, python3
• Language: Python
• Homepage:
• Size: 27.3 KB
• Stars: 38
• Watchers: 6
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).

While this is still in development and not yet on pypi you can install with pip:

```bash

pip install git+https://github.com/jsenecal/netbox-cable-labels

```

or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):

```bash

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 :

```python

PLUGINS = [

    'netbox_cable_labels'

]

```

## Configuring

Setup PLUGINS_CONFIG with the following:

```python

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

```