Skip to content

cruse1977/netbox-floorplan-plugin

 
 

Repository files navigation

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
  • NOTE: Background Images have been disabled.

Compatibility

NetBox Version Plugin Version
3.5 >= 0.3.2
3.6 >= 0.3.2
>4.0.2 0.4.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

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

See NetBox Documentation for details

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.

About

NetBox Floorplan plugin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 36.8%
  • JavaScript 35.0%
  • HTML 28.2%