Skip to main content

Netbox Plugin to support graphical floorplans

Project description

NetBox Floorplan Plugin

Tests

Originally Forked from https://github.com/tbotnz/netbox_floorplan

Demo

demo

Summary

A netbox plugin providing floorplan mapping capability for locations and sites

  • provides graphical ability to draw racks & unracked devices on a floorplan
  • support for metadata such as labels, areas, walls, coloring
  • floorplan object mapped to sites or locations and click through rack/devices
  • keyboard controls supported
  • export to svg

Compatibility

NetBox Version Plugin Version
3.5 >= 0.3.2
3.6 >= 0.3.2
4.0.x 0.4.1
4.1.x 0.5.0
4.2.x 0.6.0
4.3.x 0.7.0
4.4.x 0.8.0

Installing

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

sudo pip install netbox-floorplan-plugin

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

PLUGINS = ['netbox_floorplan']

Enable Migrations:

cd /opt/netbox
sudo ./venv/bin/python3 netbox/manage.py makemigrations netbox_floorplan_plugin
sudo ./venv/bin/python3 netbox/manage.py migrate
sudo ./venv/bin/python3 netbox/manage.py collectstatic

Restart NetBox and add netbox-floorplan-plugin to your local_requirements.txt

See NetBox Documentation for details

[!IMPORTANT] In order for racks to display properly, the rack type of the rack should be specified and a width/height set within the type.

Mentions

Forked from https://github.com/tbotnz/netbox_floorplan

Special thanks to Ziply Fiber network automation team for helping originally helping to conceive this during the NANOG hackathon

Release process

Update netbox_floorplan/version.py with a new version number, create a new Github release with the same number, the pypi publish workflow will run.

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_floorplan_plugin-0.8.0.tar.gz (158.3 kB view details)

Uploaded Source

Built Distribution

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

netbox_floorplan_plugin-0.8.0-py3-none-any.whl (171.5 kB view details)

Uploaded Python 3

File details

Details for the file netbox_floorplan_plugin-0.8.0.tar.gz.

File metadata

  • Download URL: netbox_floorplan_plugin-0.8.0.tar.gz
  • Upload date:
  • Size: 158.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_floorplan_plugin-0.8.0.tar.gz
Algorithm Hash digest
SHA256 b1360552322ec6e4364217252a4f702a9a3ab47c86181f837564d6821ffda9cd
MD5 9a43d95a29d6a020da6d7842389514e7
BLAKE2b-256 8ee6d17b93e42225e1cf9da6515526e7133adde2fb85b16cd79fae5b7148a683

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_floorplan_plugin-0.8.0.tar.gz:

Publisher: pub-pypi.yml on netbox-community/netbox-floorplan-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_floorplan_plugin-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_floorplan_plugin-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 145d5872564c640ee05eacc283470c0d29d3b17bd79a6eb13178155fc98a2d6b
MD5 cb5aeecf220ac9ca7d3231777cfad587
BLAKE2b-256 31e604e74094462bee06c312c8f50885920212e1ca6d8ba8ec4bdd333757524c

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_floorplan_plugin-0.8.0-py3-none-any.whl:

Publisher: pub-pypi.yml on netbox-community/netbox-floorplan-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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