Skip to main content
netbox spatial lens

Your estate through one lens: world, floor and rack, drawn from NetBox and recoloured by what you need to see

world • site • floor • rack

License NetBox compatibility Python version

Documentation | Compatibility | Configuration | Permissions | Extending | Changelog

A lens does two things to what you point it at: it brings one place into focus, and it filters what you see there. That is what this is for a network. The world map, the floor plan and the rack in 3D are the same estate at three focal lengths, one click apart, and every one of them recolours on demand by whatever you came to find out.

A NetBox plugin. NetBox knows a rack's height, footprint, power feeds and cooling capability. It does not know where the rack stands in the room, and it will not colour a room by any of those values. This draws the room and colours it.

https://github.com/user-attachments/assets/15360e00-abfa-40f1-a338-959fd32c0023

What it does | Getting started | Where the ideas come from | Documentation

What it does

World → site → floor → rack, one click each way. Every drawing has a stat strip above it and a legend that filters it.

The world map

Sites on a globe, sized by rack count and coloured by group, status, tenant or region, with the circuits between them coloured by provider. The two legends and the Sites and Circuits finders narrow the map. It needs WebGL and MapLibre, which loads from a CDN by default or from your own copy; tiles are optional.

A globe with sites in North America and Europe, circuits drawn as great circles across the Atlantic, and two legends naming the site groups and the circuit providers

The site

Every room in the site as a small plan with its own figures, on a tab of NetBox's site page.

The MDF site drawn as four rooms side by side, each with its rack, device, space and power figures above a thumbnail of its real floor plan

The floor

The room in 3D, every rack a cabinet at its real position, rotation and height, coloured by power, cooling, space or role, with the reading rising up its doors and the cable runs arcing over the tops, faint until you hover a rack. Look from the top, at three quarters or from the side, and switch from Cabinets to Devices to see every rack open with its real devices and their front and rear images. Switch to 2D for the plan over a scanned drawing, with zoom. Both views share a sortable rack table. Find racks by name or asset tag, narrow them by tag or custom field, and place them in the layout editor.

A 20.7 by 13.2 metre data hall of 80 cabinets in eight rows of ten, two blocks of four rows either side of a central aisle, their roofs and doors coloured by how full they are, the cable runs resting faint over the room, the two uplinks of rack E05 lit as it is hovered, and its hover card naming what it is cabled to

The same hall of 80 racks in the Devices view: every cabinet open with its real devices, roofs coloured by rack role, and the hover card of one switch naming its rack, type and unit

The hall in the Devices view with "c" in the find box: the ten racks of row C stand out with their devices and every other rack fades, and the hover card of one switch in C08

The rack

The cabinet in 3D, with the real front and rear images of each device type, every cable run through the cable managers, and reserved and free units. Turn it, move it and zoom, or jump to the front, the rear or the side. Devices are coloured by role, status, tenant, cabling or power. Find devices by name or asset tag, and narrow them by tag or custom field. It needs WebGL and Three.js, which loads from a CDN by default or from your own copy.

Rack C04, a 48U cabinet of 49 devices seen from behind and to the side, the switches wearing their real rear panels, the data cables dressed up one cable manager and the power leads up the other, and the two uplinks leaving through the roof, beside the port allocation and cabling panels

On every level

In the rack, click a cable, or a row of the cabling list, to trace it end to end, through patch panels and out to a provider, or along a power chain from socket to feed. On the floor, a cable leaving the room opens the cable, or the circuit it reaches.

Getting started

Install it like any NetBox plugin: pip install netbox-spatial-lens, add netbox_spatial_lens to PLUGINS, and migrate. It also works inside netbox-branching branches.

Your first floor

  1. Draw the room: Spatial Lens > Floors > Add. Give its width and depth, and bind it to a site (one room) or a location (several rooms).
  2. Place the racks: open the floor, choose Edit layout, then drag each rack from the list onto the plan and rotate it. Rack sizes come from NetBox.
  3. Look at it: colour by power, cooling, space or role, and click a rack to open it.

Optional: add a background plan, and set site coordinates for the world map.

For the development stack, the demo database, and the commands that populate it, see docs/development.md.

Where the ideas come from

net3d, NetBox Labs Visual Explorer, netbox-floorplan-plugin and netbox-demo-data
  • net3d: the zoom-through navigation, cable tracing and power chains. Not its architecture, which is a standalone Node app reading the REST API from outside.
  • NetBox Labs Visual Explorer: the geometry model, one queryable row per placement. It has no overlays, which is our reason to exist.
  • netbox-floorplan-plugin: read as a one-shot importer. Its plan is a Fabric.js blob with no coordinate columns, so an overlay over it would be a JSON walk per rack.
  • netbox-demo-data: what everything is tested against.

Documentation

Compatibility Which NetBox versions each release supports
Configuration Every setting, and a site with no internet access
Extending Colouring from another plugin, filtering by custom fields, and the floor layout API
Modules What each module and script holds
Permissions What to grant, and what each page reads
Development The dev stack, the demo database, and the commands that fill it
Gotchas What NetBox and this stack do that is not obvious

Metadata

Release files for netbox-spatial-lens 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for netbox-spatial-lens 0.5.0
File Size Uploaded Provenance Actions
netbox_spatial_lens-0.5.0.tar.gz 241.4 kB With provenance Details for netbox_spatial_lens-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for netbox-spatial-lens 0.5.0
File Interpreter ABI Platform Actions
netbox_spatial_lens-0.5.0-py3-none-any.whl Python 3 none any Details for netbox_spatial_lens-0.5.0-py3-none-any.whl

Total release size: 531.0 kB

Release files / netbox_spatial_lens-0.5.0.tar.gz

Download URL netbox_spatial_lens-0.5.0.tar.gz
Size 241.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8e8821982639ad241e7540b8fe4ce7a7d9b19b6f4d098f1059cfa4a1163c0401
BLAKE2b-256 checksum
How to use checksums
61abe3d42b063dd75d5981232315c22e57d2d034331ce08bfc0e53d8e1883487
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / netbox_spatial_lens-0.5.0-py3-none-any.whl

Download URL netbox_spatial_lens-0.5.0-py3-none-any.whl
Size 289.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b858a6f9e5d04f207082b4a034b436b4a577dde46634dcac7c6b115358ea70ab
BLAKE2b-256 checksum
How to use checksums
083c2993bef2317a23be2f777950cb7f90bca8b499c1697f7ea1419ec1dcc544
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for netbox-spatial-lens 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for netbox_spatial_lens-0.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page