Nautobot Floor Plan

3.0.1 verified Fri May 01 auth: no python

A Nautobot app that provides visual floor plan management for data centers, allowing users to define floor plans, place racks, power feeds, and more. Current version is 3.0.1, supporting Nautobot >=3.0 and Python 3.10–3.13. Release cadence is roughly quarterly with periodic minor and patch releases.

pip install nautobot-floor-plan

Common errors

error ModuleNotFoundError: No module named 'nautobot_floor_plan' ↓

cause The app is not installed or is installed under a different name.

fix

Install the package: pip install nautobot-floor-plan

error nautobot.core.exceptions.AppNotFound: The app 'nautobot_floor_plan' is not installed or is not a valid Nautobot app. ↓

cause Forgot to add 'nautobot_floor_plan' to the PLUGINS list in nautobot_config.py.

fix

Add 'nautobot_floor_plan' to the PLUGINS list in your nautobot_config.py and run 'nautobot-server migrate'.

error django.db.migrations.exceptions.MigrationSchemaMissing: Unable to create the django_migrations table ↓

cause Migrations have not been run after installing the app.

fix

Run: nautobot-server migrate

Warnings

breaking Nautobot 3.0 requires Floor Plan app v3.x. Older versions (v2.x) are incompatible with Nautobot 3.0. ↓

fix Upgrade app to v3.0.0+ when upgrading Nautobot to 3.x.

deprecated Python 3.9 support dropped in v2.9.0 and v3.0.0. ↓

fix Use Python >=3.10.

gotcha The app relies on Nautobot's 'Location' model. Floor plans must be associated with a Location that has a valid floor plan layout; otherwise, the UI may fail silently. ↓

fix Ensure the Location type is set to a type that supports floor plans (e.g., 'Data Center').

Imports

FloorPlan

wrong

from nautobot_floorplan.models import FloorPlan

correct

from nautobot_floor_plan.models import FloorPlan

The package uses underscores: nautobot_floor_plan

FloorPlanTile

wrong

from nautobot_floor_plan.models import FloorPlanTile

correct

from nautobot_floor_plan.models import FloorPlanTile

FloorPlanGrid

wrong

from nautobot_floor_plan.models import FloorPlanGrid

correct

from nautobot_floor_plan.models import FloorPlanGrid

Quickstart

Quick verification that the app is installed and models are importable. Full setup requires Nautobot configuration (add 'nautobot_floor_plan' to PLUGINS in nautobot_config.py) and migrations.

import nautobot_floor_plan
from nautobot_floor_plan.models import FloorPlan

# Quick check: ensure FloorPlan model is importable
print(f'nauotbot_floor_plan version: {nautobot_floor_plan.__version__}')