Skip to content
Nautobot Documentation
Platform Features
Initializing search
GitHub
Overview
User Guide
Developer Guide
Release Notes
Nautobot Apps
Nautobot Docs Home ↗︎
Nautobot Documentation
GitHub
Overview
User Guide
User Guide
Administration
Administration
Installation
Installation
Prerequisites
Installing System Dependencies
Installing Nautobot
Deploying Nautobot Services
Configuring an HTTP Server
External Authentication (Optional)
Installing and Using Plugins
Nautobot Docker Images
Health Checks
SELinux Troubleshooting
Upgrading
Upgrading
Database Backup
Upgrading Nautobot
Upgrading Nautobot from v1.X to v2.0
Upgrading Nautobot from v1.X to v2.0
Migrating from Region and Site to Location
IPAM Migration Guide
IPAM Migration Guide
What's Changed
Before you Upgrade
After you Upgrade
For Developers
Migration
Migration
Migrating from NetBox
Migrating from PostgreSQL to MySQL
Configuration
Configuration
Required Settings
Optional Settings
Time Zones
External Authentication
External Authentication
LDAP
SSO
Remote Header
Tools
Tools
Nautobot Server
Nautobot Shell
Guides
Guides
Caching
Health Check
Permissions
Prometheus Metrics
Replicating Nautobot
Request Profiling
Django Storages with S3
Task Queues
Feature Guides
Feature Guides
Getting Started
Getting Started
Devices
Location Types and Locations
Platforms
Tenants
Interfaces
VLANS and VLAN Groups
IP Address Management
The Search Bar
Contacts and Teams
Custom Fields
Git as a Data Source
GraphQL
IP Address Merge Tool
Relationships
Software Image Files and Versions
Core Data Model
Core Data Model
Overview
Overview
Introduction
Circuits
Circuits
Circuit
Circuit Termination
Circuit Type
Circuit Provider
Circuit Provider Network
DCIM
DCIM
Location Type
Location
Rack Group
Rack
Manufacturer
Device Family
Platform
Device Type
Device Type
Console Port Template
Console Server Port Template
Device Bay Template
Front Port Template
Interface Template
Power Outlet Template
Power Port Template
Rear Port Template
Device
Device
Console Port
Console Server Port
Device Bay
Front Port
Interface
Inventory Item
Power Port
Power Outlet
Rear Port
Cable
Device Redundancy Group
Interface Redundancy Group
Power Panel
Power Feed
Rack Reservation
Software Image File
Software Version
Virtual Chassis
Controller
Controller Managed Device Group
Extras
Extras
Config Context
Config Context Schema
Contact
Team
IPAM
IPAM
IP Address
Namespace
Prefix
RIR
Route Target
Service
VLAN
VLAN Group
VRF
Tenancy
Tenancy
Tenant
Tenant Group
Virtualization
Virtualization
Cluster
Cluster Group
Cluster Type
Virtual Machine
VM Interface
Platform Functionality
Platform Functionality
Change Logging
Computed Fields
Custom Fields
Custom Links
Dynamic Groups
Export Templates
External Integrations
Git Repositories
GraphQL
GraphQL
GraphQL Queries
Image Attachments
Jobs
Jobs
Job Buttons
Job Hooks
Job Models
Job Scheduling and Approvals
NAPALM
Notes
Relationships
REST API
REST API
Filtering
Authentication
UI Endpoints
Roles
Secrets
Statuses
Tags
Template Filters
Users
Users
Object Permission
Token
Webhooks
Developer Guide
Developer Guide
Jobs Developer Guide
Jobs Developer Guide
Migration Guides
App Developer Guide
App Developer Guide
Setup
NautobotAppConfig
Models
Models
Global Search
GraphQL
Django Admin
Views
Views
NautobotUIViewSet
NautobotUIViewSetRouter
Nautobot Generic Views
URLs
Base Template
Help Documentation
REST API
Advanced
Advanced
Django Generic Views
Notes
View Overrides
Platform Features
Platform Features
Custom Validators
Database Backed Config
Filter Extensions
Git Repository Content
Jinja2 Filters
Jobs
Populating Extensibility Features
Prometheus Metrics
Secrets Providers
Uniquely Identifying a Nautobot Object
UI Extensions
UI Extensions
Banners
Home Page
Links in the Installed Apps View
Navigation
Object Detail & List Views
Testing
Code Reference
Code Reference
nautobot.apps
nautobot.apps.admin
nautobot.apps.api
nautobot.apps.change_logging
nautobot.apps.choices
nautobot.apps.config
nautobot.apps.constants
nautobot.apps.datasources
nautobot.apps.exceptions
nautobot.apps.factory
nautobot.apps.filters
nautobot.apps.forms
nautobot.apps.graphql
nautobot.apps.jobs
nautobot.apps.models
nautobot.apps.querysets
nautobot.apps.secrets
nautobot.apps.tables
nautobot.apps.testing
nautobot.apps.ui
nautobot.apps.urls
nautobot.apps.utils
nautobot.apps.views
Migration Guides
Migration Guides
From Nautobot v1
Dependency Updates
Code Updates
Model Updates
Model Updates
Global
DCIM
Extras
IPAM
Advanced
Advanced
Porting NetBox Plugins to Nautobot
Core Developer Guide
Core Developer Guide
Getting Started
Adding and Updating Nautobot Settings
Advanced Docker Compose Usage
Application Registry
Bootstrap UI
Best Practices
Caching
Controllers
Generic Views
Home Page Panels
Model Development Checklist
Model Features
Natural Keys
Navigation Menu
Page Templates
Role Internals
Style Guide
Testing
User Preferences
Release Checklist
Release Notes
Release Notes
Version 2.2
Version 2.1
Version 2.0
Version 1.6
Version 1.5
Version 1.4
Version 1.3
Version 1.2
Version 1.1
Version 1.0
Nautobot Apps
Nautobot Apps
Network to Code App Docs
Network to Code App Docs
Nautobot ChatOps
Nautobot Circuit Maintenance
Nautobot Data Validation Engine
Nautobot Device LifeCycle Management
Nautobot Device Onboarding
Nautobot Firewall Models
Nautobot Golden Configuration
Nautobot Plugin Nornir
Nautobot Single Source of Truth
Community Apps
Nautobot Docs Home ↗︎
Extending Existing Functionality
¶