Skip to content

netbox-community/netbox-qrcode

Repository files navigation

Netbox QR Code Plugin

Netbox plugin for generate QR codes for objects: Device, Module, Cable, Powerfeed, Powerpanel, Location

This plugin depends on qrcode and Pillow python library

Downloads Downloads Downloads

Compatibility

Plugin Version NetBox Version Tested on
0.0.11 3.7.x 3.7.x
0.0.14 4.0.x 4.0.11
0.0.15 4.1.x 4.1.6
0.0.17 4.2.x 4.2.4
0.0.18 4.3.x 4.3.1

Installation

If Netbox was installed according to the standard installation instructions. It may be necessary to activate the virtual environment.

source /opt/netbox/venv/bin/activate

The plugin is available as a Python package in pypi and can be installed with pip

pip install netbox-qrcode

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ['netbox_qrcode']

Restart NetBox and add netbox-qrcode to your local_requirements.txt

Configuration

Label Design

Extensive label customisation is possible, it's also possible to include different labels for each object type, for example 2 labels for the Device view.

For advice on configuration please see the two links below:

Cable QR Code

Printing

Setting the label printer

If the print does not look like the preview in the Netbox, first try to get a perfect print using Word. As many printer settings also have an influence on the print result. Borderless printing is possible if the printer (e.g. thermal transfer printer) supports this.

ShowImage

Here is an example of what needs to be considered to print borderless from a Word document. Go to: Example Zebra ZM400 300dpi label printer and a label 56x32mm. >>

Setting Browser Print Settings

When you press the “Print” button, there are some print properties that are added by the browser. However, these interfere with the print result. They should therefore be deactivated.

Firefox:
Parameter Value
Orientation Portrait
Paper size User defined
Margins none
Scale Fit to page width or 100%
Options --> Print headers and footers disable
Options --> Print backgrounds disable
Chrome:

Chrome can alter settings between printing and the print preview, therefore the below settings are recomended

Parameter Value
Layout Portrait
Paper size empty !!!
Pages per sheet 1
Margins none
Scale Default or 100%
Options --> PBackground grafics disable

Image

Contributing

Issues and pull requests are welcomed.

Screenshots

Device QR code with text label Device QR Code

Rack QR code Rack QR Code

Cable QR code Cable QR Code