Skip to main content

QR Code generation for netbox objects

Project description

Netbox QR Code Plugin

A NetBox plugin used to 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
0.0.19 4.4.x 4.4.0
0.0.20 4.5.x 4.5.0

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_qrcode-0.0.20.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_qrcode-0.0.20-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file netbox_qrcode-0.0.20.tar.gz.

File metadata

  • Download URL: netbox_qrcode-0.0.20.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_qrcode-0.0.20.tar.gz
Algorithm Hash digest
SHA256 28b60d972dc4a09cd841ba382c12b57f85cd7fabe811913599832303591026e0
MD5 e02cb91043e6192d9c1e62b5173e93cc
BLAKE2b-256 da069e901a59fbe236b2056fe696a9012e8e9e07109601627be4b5ffcea49727

See more details on using hashes here.

File details

Details for the file netbox_qrcode-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: netbox_qrcode-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_qrcode-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 091da12724dd08684cee970304e0e05cfc55dc5f1ae5f7f97529c3f8e0f2f1e2
MD5 c887da60421b12433c4d843a5d09e8ee
BLAKE2b-256 e02e611c64afa4120a0543293384f0d0cc8acbc9e57850c775e849505bd8020b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page