Skip to main content

Interactive floor plan visualization for NetBox sites

Project description

NetBox Map

Python NetBox License PyPI PyPI Downloads

A NetBox plugin for interactive floor plan visualization, site maps, rack utilization, and cable tracing.

Links: Documentation | NetBox Ping | Website | Demo

netbox-map-banner

Features

Floor Plans

  • Canvas-based editor with drag-and-drop tile placement, pan/zoom, and configurable grids
  • 12 tile types -- rack, aisle, wall, column, door, cooling, power, empty, reserved, access point, camera, printer
  • Tile orientation (0/90/180/270°) -- text rotates to match, so narrow vertical tiles stay readable
  • Link tiles to NetBox objects (racks, devices, power panels, power feeds, ports)
  • Background image upload for blueprints or photos
  • PDF export with all visible tiles, labels, and FOV cones

Rack Visualization

  • Utilization heatmap -- color gradient from green (0%) to red (90%+) directly on tiles
  • Expand racks in the sidebar to see all devices sorted by U-position
  • Full rack elevation SVG (front/rear) in the detail panel
  • Search across device names and IPs inside racks

Cable Tracing

  • Full cable trace for devices, rear ports, and front ports
  • Unified traces through patch panels (Server:eth0 → Cable → FrontPort → RearPort → Cable → Switch:Gig1/0/3)
  • "Show on map" buttons to zoom to devices that exist on the floor plan
  • Rack device traces -- expand a rack, click the cable icon on any device

Camera FOV

  • Configurable direction (0-360°), angle (10-360°), and distance (1-50 cells)
  • Live preview of semi-transparent FOV cones on the canvas
  • Toggle all FOV cones on/off

Global Site Map

  • Leaflet.js geographic map with OpenStreetMap tiles
  • Sites, locations, floor plan tiles, and standalone markers on one map
  • Edit mode -- place sites, locations, and markers by clicking the map
  • Drag to reposition, auto-saves coordinates
  • GPS sync -- automatically writes lat/lng to device records when placed on the map
  • Early fiber/cable path support (experimental -- expect breaking changes in future releases)

Settings (Web UI)

  • Configure detail panel fields per object type from the browser
  • Toggle MAC address display, custom fields, GPS sync
  • No file editing or restarts needed

Network Topology

  • Interactive topology view with stencil device cards and interface ports
  • Hierarchical layout, orthogonal cable routing with obstacle avoidance
  • Saved views with position persistence and filters
  • PDF export, cable coloring by type or speed, pass-through collapse

Application Mapping Beta

  • Model applications, deployments to devices/VMs, and inter-app dependencies
  • Application topology view with dependency edges and failure simulation
  • Mixed mode: devices + apps + deployed-on connections on one canvas
  • Templates for bulk application deployment
  • Device/VM detail page integration (Applications tab + panel)

Integration

  • Site detail page panel with floor plan links
  • Device detail page "Map Locations" tab
  • Global search indexing for floor plans, tiles, and markers
  • Change logging on all models
  • REST API with full CRUD, filtering, and search
  • Dark mode support

Screenshots

BAsic_Device_showcase

CAM-FOV_showcasee

MAP_showcase

Rack_showcase

image Screenshot from 2026-03-29 18-10-27 Screenshot from 2026-03-29 15-14-36

Installation

source /opt/netbox/venv/bin/activate
pip install netbox-map

Or from source:

source /opt/netbox/venv/bin/activate
pip install git+https://github.com/DenDanskeMine/netbox-map.git

Add to configuration.py:

PLUGINS = [
    'netbox_map',
]

Apply migrations and restart:

cd /opt/netbox/netbox
python3 manage.py migrate
python3 manage.py collectstatic --no-input
sudo systemctl restart netbox

GPS Sync

When enabled, placing a device on a map automatically writes lat/lng to the device record. Clearing the tile/marker clears the GPS if no other map references remain.

Maps URL Deep-Linking

Point NetBox's built-in Map button to this plugin instead of Google Maps:

  1. Go to Admin > Configuration > Miscellaneous
  2. Set Maps URL to: https://your-netbox-url/plugins/map/sitemap/?q=
  3. Save

Now clicking the Map button on any Site or Device opens the plugin's site map centered on that location.

REST API

Endpoint Description
/api/plugins/map/floorplans/ Floor plan CRUD
/api/plugins/map/floorplan-tiles/ Tile CRUD
/api/plugins/map/tile-port-assignments/ Tile port assignments
/api/plugins/map/location-coordinates/ Location GPS coordinates
/api/plugins/map/map-markers/ Map marker CRUD
/api/plugins/map/cable-paths/ Fiber/cable paths
/api/plugins/map/custom-marker-types/ Custom marker types
/api/plugins/map/map-settings/ Plugin settings (singleton)
/api/plugins/map/topology-saved-views/ Topology saved views
/api/plugins/map/applications/ Application CRUD
/api/plugins/map/application-groups/ Application groups
/api/plugins/map/application-templates/ Application templates
/api/plugins/map/application-deployments/ App-to-host deployments
/api/plugins/map/application-dependencies/ App dependency edges

All endpoints support filtering, pagination, and brief mode.

Compatibility

netbox-map NetBox Python
0.10.x 4.5+ 3.12+
0.9.x 4.5+ 3.12+
0.8.x 4.5+ 3.12+
≤ 0.7.x 4.5+ 3.12+

Dependencies

  • No additional Python packages required (only NetBox itself)

Development

git clone https://github.com/DenDanskeMine/netbox-map.git
cd netbox-map
pip install -e .

License

Apache License 2.0 -- see LICENSE.

Support

Open an issue on GitHub.

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_map-0.10.2.tar.gz (549.5 kB view details)

Uploaded Source

Built Distribution

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

netbox_map-0.10.2-py3-none-any.whl (595.7 kB view details)

Uploaded Python 3

File details

Details for the file netbox_map-0.10.2.tar.gz.

File metadata

  • Download URL: netbox_map-0.10.2.tar.gz
  • Upload date:
  • Size: 549.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for netbox_map-0.10.2.tar.gz
Algorithm Hash digest
SHA256 915c16348ea0c959e5b1fb8dc809c414a5e73af92cfb9b3ec6fab9b9e79c49a5
MD5 8d18608685b342480879c882f23c5391
BLAKE2b-256 9bb422d5c91776d794754b930f354d226db437e6b653222d15ed619110614679

See more details on using hashes here.

File details

Details for the file netbox_map-0.10.2-py3-none-any.whl.

File metadata

  • Download URL: netbox_map-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 595.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for netbox_map-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 72960d23b32c0a7c9a876c0047e6f4748e85c47960bc63868d7af9279553f448
MD5 dd3e3b22f8544ae6b9ded8c7d8d3b7ae
BLAKE2b-256 7231ccbc475f56099d9ad572523ac3fdf61fc6650f5921b927a422556991a4fb

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