This document describes all new features and changes in Nautobot 1.0, a divergent fork of NetBox 2.10. For the launch of Nautobot 1.0 and for the purpose of this document, all “new” features or “changes” are referring to the features and changes comparing Nautobot 1.0 coming from NetBox 2.10. All future release notes will only refer to features and changes relative to prior releases of Nautobot.
Users migrating from NetBox to Nautobot should also refer to the "Migrating from NetBox" documentation as well.
Configuration Context Association to Device Types¶
Config contexts can now be associated to (filtered by) Device Types, in addition to all other previously supported associations.
Custom Fields on All Models¶
Custom fields allow user-defined fields, or attributes, on specific data models such as sites or devices. Historically, custom fields have been supported only on “primary” models (Site, Device, Rack, Virtual Machine, etc.) but not on “organizational” models (Region, Device Platform, Rack Group, etc.) or on “device component” models like interfaces. As of Nautobot 1.0, custom fields are now supported on every model, including interfaces.
Once created the name or data type of the custom field cannot be modified. Choices for custom fields are now stored as discrete database objects. Choices that are in active use cannot be deleted.
A new "Status" model has been added, allowing users to define additional permitted values for the "status" field on any or all of the models that have such a field (Cable, Circuit, Device, IPAddress, PowerFeed, Prefix, Rack, Site, VirtualMachine, VLAN). The default sets of statuses permitted for each model remain the same as in NetBox 2.10, but you are now free to define additional status values as suit your needs and workflows.
One example application for custom statuses would be in defining additional values to apply to a Device as part of an automation workflow, with statuses such as
rebooting to reflect the progress of each device through the workflow, allowing automation to identify the appropriate next action to take for each status.
Data Validation Plugin API¶
Data quality assurance in Nautobot becomes easier with the new data validation plugin API. This makes it possible to codify organizational standards. Using a data validation plugin, an organization can ensure all data stored in Nautobot meets its specific standards, such as enforcing device naming standards, ensuring certain prefixes are never used, asserting that VLANs always have a name, requiring interfaces to always have a description, etc. The ability to ensure a high quality of data becomes much more streamlined; error-prone, manual process becomes automated; and there is no more need to actively run reports to check data quality.
Detail Views for more Models¶
Detailed view pages are now provided for models including ClusterGroup, ClusterType, DeviceRole, Manufacturer, Platform, and RackRole.
Docker-Based Development Environment¶
In addition to the previously available virtual-environment-based developer workflow, Nautobot now additionally supports a development environment based around Docker as an alternative.
Git Integration as a Data Source¶
Git integration offers users an option to integrate into a more traditional NetDevOps pipeline for managing Python modules, Jinja templates, and YAML/JSON data. There are several use cases that have historically required users to either manage Python modules on the filesystem or use Jinja2 templates within the GUI. With this new feature, users can add a Git repository from the UI or REST API, the contents of which will be synchronized into Nautobot immediately and can be later refreshed on-demand. This allows users to more easily update and manage:
- Jobs - store your Python modules that define Jobs (formerly known as Custom Scripts and/or Reports) in a Git repository
- Export Templates - store your Jinja templates used to create an export template in a Git repository
- Config Contexts - store your YAML/JSON data used within a config context in a Git repository
- Arbitrary Files - usable by custom plugins and apps
Not only does this integration and feature simplify management of these features in Nautobot, it offers users the ability to use Git workflows for the management of the jobs, templates, and data ensuring there has been proper review and approval before updating them on the system.
Nautobot now provides an HTTP API endpoint supporting GraphQL. This feature adds a tremendous amount of flexibility in querying data from Nautobot. It offers the ability to query for specific datasets across multiple models in a single query. Historically, if you wanted to retrieve the list of devices, all of their interfaces, and all of their neighbors, this would require numerous REST API calls. GraphQL gives the flexibility to get all the data desired and nothing unnecessary, all in a single API call.
For more details, please refer to the GraphQL website, as well as to the Nautobot GraphQL documentation.
Installable Python Package¶
Nautobot is now installable as a self-contained Python package via
pip install nautobot. Packages are released to PyPI with every Nautobot update.
Nautobot now includes a dedicated administrative CLI command,
Plugin API Enhancements¶
Plugins can now provide custom data validation logic.
Plugins can now include executable Jobs (formerly known as Custom Scripts and Reports) that will automatically be added to the list of available Jobs for a user to execute.
Additional data models defined by a plugin are automatically made available in GraphQL.
Plugins can now define additional Django apps that they require and these dependencies will be automatically enabled when the plugin is activated.
Nautobot now allows and encourages plugins to make use of the generic view classes and page templates provided in
Single Sign-On / Social Authentication Support¶
Nautobot now supports single sign on as an authentication option using OAuth2, OpenID, SAML, and others, using the social-auth-app-django module. For more details please refer to the guide on SSO authentication.
User-Defined, or "custom", relationships allow users to create their own relationships between models in Nautobot to best suit the needs of their specific network design.
For example, a VLAN is mapped to a Site by default. After a VLAN is created today, you then assign that VLAN to an Interface on a Device. This Device should be within the initial mapped Site. However, many networks today have different requirements and relationships for VLANs (and many other models): VLANs may be limited to racks in Layer 3 DC fabrics; VLANs may be mapped to multiple buildings in a campus; they may span sites. Relationships allow you to express these additional requirements and relationships without requiring code changes to Nautobot itself. Other use cases include circuits, ASNs, or IP addressing -- just to name a few -- allowing users to define the exact relationships required for their network.
All of the individual Django apps in NetBox (
ipam, etc.) have been moved into a common
nautobot Python package namespace. The
netbox application namespace has been moved to
nautobot.core. This will require updates when porting NetBox custom scripts and reports to Nautobot jobs, as well as when porting NetBox plugins to Nautobot.
Nautobot is now packaged using Poetry and builds as an installable Python package.
requirements.txt have been replaced with
pyproject.toml. Releases of Nautobot are now published to PyPI, the Python Package Index, and therefore can now be installed using
pip install nautobot.
Installation and Startup¶
Because Nautobot may be installed using
pip, we have replaced
manage.py with a dedicated
nautobot-server CLI command used to adminster the server. It works exactly as
manage.py does, but does not require you to be within the project root directory.
Configuration and Settings¶
Nautobot has done away with the requirement to duplicate or modify files anywhere in the source code. The
configuration.py file has been replaced with a
nautobot_config.py file that may be read from anywhere on your system. It is also much easier to add custom settings or overload nearly any default setting.
To facilitate this, many automatically generated settings have been removed, and replaced with their underlying static configurations. We feel this affords a greater amount of flexibility in deployment patterns, with a tradeoff of slightly more initial configuration.
To make things a little easier, you may generate a new configuration with sane defaults using the
nautobot-server init command! The configuration file defaults to
~/.nautobot/nautobot_config.py but using the
nautobot-server --config argument, you may name or place the file anywhere you choose.
You may also defined a
NAUTOBOT_CONFIG variable to tell Nautobot where to find the file so that you don't need to always pass the
For details see Configuring Nautobot.
Consolidating Custom Scripts and Reports into Jobs¶
Nautobot has consolidated NetBox's "custom scripts" and "reports" into what is now called Jobs.
The job history (results) table on the home page now shows metadata on each job such as the timestamp and the user that executed the job. Additionally, jobs can be defined and executed by the system and by plugins, and when they are, users can see their results in the history too. UI views have been added for viewing the details of a given job result, and the JobResult model now provides standard APIs for Jobs to log their status and results in a consistent way.
Job result history is now retained indefinitely unless intentionally deleted. Historically only the most recent result for each custom script or report was retained and all older records were deleted.
Python modules that define jobs can now be stored in Git and easily added to Nautobot via the UI as documented above in Git Integration as a Data Source.
Custom User Model¶
A new custom model has been created for
User data. This has allowed Nautobot to use a UUID as a primary key for the
User model, and to prepare for future use-cases not support by the default Django model.
This has also meant
UserConfig no longer exists as a separate model.
UserConfig is now a property on the custom
Hiding UI Elements based on Permissions¶
Historically, a user viewing the home page and navigation menu would see a list of all model types and menu items in the system, with a “lock” icon on items that they were not granted access to view in detail.
As an option, administrators can now choose to instead hide un-permitted items altogether from the home page and the navigation menu, providing a simpler interface for limited-access users. The prior behavior remains as the default.
IPAM Network Fields to VARBINARY¶
To enable future support of databases other than PostgreSQL, the network fields inside of IPAM needed to be changed.
inet field types have been replaced with a database agnostic field type. For this purpose
varbinary was chosen because it can safely and efficiently store packed binary integers.
More details about the impact of this and other changes can be found in the Migration documentation.
Navigation Menu Changes¶
The "Other" menu has been renamed to "Extensibility" and many new items have been added to this menu.
Status records have been added to the "Organization" menu.
New Name and Logo¶
"NetBox" has been changed to "Nautobot" throughout the code, UI, and documentation, and Nautobot has a new logo and icon.
User-Defined Custom Links¶
Historically the custom links feature was restricted so that only administrators could define and manage custom links to add to various built-in data views. In Nautobot the management of custom links has been moved into the main user interface, accessible to any user who has been granted appropriate access permissions.
User-Defined Export Templates¶
Historically the custom data export templates feature was restricted such that only administrators could define and edit these templates. In Nautobot this has been moved into the main user interface, accessible to any user who has been granted appropriate access permissions.
Historically the webhooks feature was restricted such that only administrators could define and manage webhooks, HTTP callbacks that are triggered automatically when a specified data model(s) are created, updated, and/or deleted. In Nautobot this has been moved into the main user interface, accessible to any user who has been granted appropriate access permissions.
UUID Primary Database Keys¶
Database keys are now defined as Universally Unique Identifiers (UUIDs) instead of integers, protecting against certain classes of data-traversal attacks.
Nautobot has replaced Gunicorn with uWSGI. In most cases uWSGI is faster, more stable and easier to setup making it ideal to use over Gunicorn. Our recommendation is to use uWSGI in production.
Secrets storage and management has been removed from Nautobot.
The "Related Devices" table has been removed from the detailed Device view.
- #143 - Added "copy" button on hover to
Devicedetail view for name, primary IP addresses, and serial number.
- #183 - Implemented a baseline integration test suite using Selenium
- #505 - Added example of Okta OAuth2 integration to the docs.
- #523 - Added instructions for using LDAP TLS Options to SSO documentation
- #576 -
JobResultdetail views now support custom links and plugin template extensions
- #537 - To mitigate CVE-2021-31542, the minimum supported Django version is now 3.1.12.
- #220 - Added a troubleshooting section to the development guide for issues encountered when using the multi-threaded development server
- #342 - Fixed inconsistent behavior in
Site.time_zoneto emit and accept input as a null field if not set when using API
- #389 - Fixed incorrect TaggedItem base class that caused tag issues on MySQL.
- #421 - Fixed
git: Reference at 'refs/heads/master' does not existby improving error-handling displaying a warning when a user tries to use an empty repo or a branch that does not exist upstream.
- #452 - Fixed
OPTIONSresponse not including the
- #476 - Fixed incorrect handling of /31 and /127 networks in
- #490 - Fixed incorrect VLAN count displayed in VLANGroup detail views.
- #499 - Fixed object's changelog showing incorrect information about its tags on partial (PATCH) updates using API
- #501 - Fixed missing prepopulation of address/prefix value into the form when adding an address or prefix under a parent prefix.
- #508 - Fixed typo in
- #512 - Fixed ServerError when cloning a record with exactly one
Tagapplied to it.
- #513 - Fixed inadvertent omission of "Search" box from ReadTheDocs.
- #528 - Fixed an ordering issue in the
- #530 - Fixed incorrect/confusing docstring in
- #540 - Fixed intermittent CI failures due to DockerHub rate limits.
- #542 - Fixed incorrect documentation for running
- #562 - Fixed inability to use a Git repository to define a
ConfigContextmapped to a specific
- #564 - Fixed incorrect docstring on
- #570 - Fixed inability to import
VLANmodel via Git.
- #583 - Fixed incorrect rejection of various forms when explicitly selecting a
nulloption. (Port of NetBox #5704)
- #418 - Removed unused JQuery-UI component flagged by vulnerability scanner (CVE-2020-7729)
- #14 - Plugins are now officially permitted to use the generic view classes defined in
nautobot.core.views.genericand corresponding base templates defined in
- #162 - Added Invoke tasks
loaddatafor database backup/restoration in the development environment.
- #430 - GraphQL
ip_addressesnow includes an
- #438 - Config contexts can now be assigned to individual DeviceTypes.
- #442 - Added warning when mixing
@extras_features("graphql")with explicitly declared GraphQL types
- #450 - GraphQL
interfacesand similar models now include
- #451 - Added static GraphQL type for VirtualMachine model
- #456 - Added mkdocs-include-markdown-plugin
- #465 - Added Virtual Chassis to the Home Page
- #423 - Clarified reference to
/config_contexts/folder in Git user guide
- #448 -
nautobot-server initno longer provides an option to overwrite the existing configuration files.
- #474 - The
dummy_pluginhas been moved to a new
examplesdirectory in the Git repository and now serves as an example of implementing various plugin features.
- #309 - Fixed erroneous termination display when cables are connected to power feeds.
- #396 - Fixed
ValidationErrornot being raised when Relationship filters are invalid
- #397 - Fixed Git repository sync failure when token contains special characters
- #415 - Fixed incorrect handling of Unicode in view test cases
- #417 - Fixed incorrect link to Docker docs from installation docs
- #428 - Fixed GraphQL error when handling ASNs greater than 2147483647
- #430 - Fixed missing
ContentTypeforeign keys in GraphQL
- #436 - Fixed Redis Cacheops error when using newly generated
- #454 - Fixed inability to create IPv6 addresses via REST API.
- #459 - Fixed issue with Job forms not respecting
- #461 - Fixed
NAUTOBOT_DB_TIMEOUTread as string in default config
- #482 - Fixed
FieldErrorfrom being raised when a
JobResultreferences a model with no
- #486 - Fixed failing Docker builds due to do missing
- #488 - Fix migrations in MySQL by hard-coding the
- #456 - Removed markdown-include
- #242 - Added a production-ready
Dockerfilefor clustered deployment
- #356 - Added a new
nautobot-server startpluginmanagement command to ease plugin development
- #366 - Added GraphQL filter tests for
interfacesqueries and added missing unit tests for
- #362 - Updated sample code in plugin development guide to inherit from
- #15 - Added documentation for plugins using generic models to get change logging using
- #336 - Fixed
nautobot.utilities.api.get_serializer_for_modelto now support the plugins namespace
- #337 - Fixed
nautobot.extras.plugins.api.views.PluginsAPIRootViewno longer creates null entries when
PluginConfigdoes not define a
- #365 - Fixed incorrect field types on GraphQL ID fields
- #382 - Fixed choices returned from
OPTIONSrequests returning mixed use of
- #393 - Fixed creating a
VirtualChassiswith a master device changes the master device's
- #398 - Fixed
VirtualChassisedit view to now show "Update" button vs. "Create"
- #399 - Fixed
nautobot.utilities.utils.get_filterset_for_modelto now support the plugins namespace
- #400 - Fixed the class_path format for Jobs API usage documentation not being clear enough
- #402 - Docs build requirements will now install
markdown-includeversion from PyPI instead of GitHub
- #409 - Fixed misspelling: "Datbase" --> "Database" in
- #290 - Added REST API endpoint for triggering a Git repository sync
- #333 - Relationships now display the name of the related object type as well as the count
- #358 - Updated Python dependencies to their latest patch versions
- #276 - Fixed 500 error when creating Rack Reservation with invalid units
- #277 - Fixed 500 error when editing/updating IPAM Services with invalid ports
- #332 - Fixed UI allowing creation of multiple
- #334 - Fixed missing "Bulk Create" option when creating an IP Address
- #357 - Fixed error when plugins attempted to use
- #359 - Fixed incorrect GraphQL filtering of cables by
- #361 - Fixed duplicate "tags" field when creating a cable connection
- #96 - Implemented user guide documentation for GraphQL
- #97 - Implemented user guide documentation for Git as a Data Source
- #150 - Revised all documentation referencing objects with status fields
- #175 - Revised plugin development guide to use Poetry
- #211 - Travis CI build improvements to simplify entry points and make tests fail faster
- #217 - Replaced JSONB aggregation with custom cross-database implementation that supports PG and MySQL
- #245 - Replaced PG-specific "advisory locks" with cross-database distributed Redis lock
- #252 - Revised and clarified install instructions for CentOS
- #262 - Revised Nautobot upgrade and NetBox migration guides
- #273 - Update to jQuery 3.6.0
- #289 - Updated natural unicode-aware sorting for interface/device names to support MySQL
- #167 - Fix to enable to query
ip_addressesby parent in GraphQL
- #212 - Allow plugins to use built-in buttons
- #232 - Fix to enable inclusion of custom fields in queries in GraphQL
- #233 - Fix to enable filtering by booleans in GraphQL
- #247 - Fix to enable filtering by custom field values in GraphQL
- #260 - Fix cable path tracing by not coercing UUID values to version 4
- #264 - Fix missing parenthesis in datasources example
- #265 - Fix 500 crash in API when posting ports as strings to IPAM services
- #269 - Fix
NoneTypeerror when searching for /31 prefixes
- #272 - Fix invalid f-string in
- #278 - Fix crash when sorting IPAM objects in list view by network address in web UI
- #285 - Refactor GraphQL filter argument generation to emit the correct types for each field
- #286 - Fix
NoneTypeerror when seraching for IPs without a prefix
- #287 - Fix IP addresses not showing in search results
- #288 - Fix display of parent prefixes from IPAddress detail view
- #293 - Allow
DynamicModel[Multiple]ChoiceFieldto work with plugin model
- #300 - Fix
AttributeErrorwhen assigning an IP to a device interface
- #304 - Fix for IPAM network objects
clean()checks not working as intended
- #305 - Fix
Statusrendering to always preserve capitalization of
- #306 - Fix custom relationship display fields for all models
- #307 - Fix the ability to CSV export power connections if connected to a PowerFeed
- #308 - Fix missing template error when viewing a PowerFeed connected to a PowerPort on a Device.
- #318 - Fix
TypeErrorwhen creating any IPAM network object with prefix of /0
- #320 - Fix issue causing model validation to fail on all IPAM network objects
- #324 - Fix unit test execution on MySQL by changing subquery limiting to list slicing
- #325 - Fix to allow relationship associations to be unset in the web UI
- #326 - Fix 404 error when attempting to delete a RelationshipAssociation from the list view
- #373 - Fix missing "Bulk Add IP Addresses" tab
v1.0.0b3 introduces several database changes that are not backwards-compatible with v1.0.0b2 and earlier. There is no direct upgrade path from v1.0.0b2 to v1.0.0b3 - you must create a new database when installing v1.0.0b3!
- #100 - Added detailed documentation of the
- #105 - Added tooltip with detailed information to utilization graph bars.
- #109 - Docker development environment build now automatically installs from any present
- #121 - Added "Data Model Changes" section to the "Migrating from NetBox" documentation
- #141 - Custom Link UI now includes example usage hints
- #227 - Add QFSP+ (64GFC) FiberChannel interface type
- #236 - Add
post_upgradeto developer docs and add
Major backwards-incompatible database changes were included in this beta release that are intended are to pave the way for us to support MySQL as a database backend in a future update. Of those changes, these are the most notable:
- All IPAM objects with network field types (
ipam.Prefix) are no longer hard-coded to use PostgreSQL-only
cidrfield types and are now using a custom implementation leveraging SQL-standard
users.Usermodel has been completely replaced with a custom implementation that no longer requires the use of a secondary database table for storing user configuration.
- Custom Fields have been overhauled for asserting data integrity and improving user experience
- Custom Fields can no longer be renamed or have their type changed after they have been created.
- Choices for Custom Fields are now stored as discrete database objects. Choices that are in active use cannot be deleted.
- #78 - Replaced PostgreSQL-specific IP network/address fields with more generic field types
- #83 - Custom user model added; UserConfig model merged into User model
- #84 - Revised developer documentation for clarity and current workflows
- #98 - Simplify MultipleContentTypeField boilerplate
- #119 - Various documentation improvements
- #120 - Revise development release checklist document for new processes
- #128 - Overview of usage for the
nautobot-netbox-importerplugin could be mistaken for full instructions
- #122 - Improved installation flow for creating nautobot user and virtualenv
- #131 - Replaced PostgreSQL-specific ArrayField with a more generic JSONArrayField
- #137 - Explicitly disallow Custom Field Name Changes
- #142 - Converted various config validation checks into proper Django checks
- #149 - Unify optional settings documentation for
- #159 - Update documentation for external authentication SSO Backend to get a proper install
- #180 - Revised available Invoke tasks for simplicity and maintainability
- #208 - Custom fields model refactor
- #216 - Update install docs to address inconsistent experience w/
- #235 - Update restart docs to include worker
- #241 - Swap
- #124 - Removed incorrect statement from feature request template
- #161 - Removed leftover references in documentation to
- #188 - Remove
CSRF_TRUSTED_ORIGINSfrom core settings
- #189 - Remove all references to
- #26 -
nautobot-server runserverdoes not work using
- #58 - GraphQL Device Query - Role filter issue
- #76 - Cable paths could not be traced through circuits
- #95 - Plugin load errors under Gunicorn
- #127 - SSL error: decryption failed or bad record mac & SSL SYSCALL error: EOF detected
- #132 - Generated
nautobot_config.pydid not include a trailing newline
- #134 - Missing venv activation step in install guide
- #135 - Custom field Selection value name change causes data inconsistency
- #147 - Login failed when BASE_PATH is set
- #153 - Editing an existing user token shows "create" buttons instead of "update"
- #154 - Some tests were failing when run in the development Docker container
- #155 - NAPALM driver string not displayed in Platform detail view
- #166 - Contrib directory is missing (including the apache.conf)
- #168 - Incorrect
AUTHENTICATION_BACKENDSexample in remote authentication documentation
- #170 - GraphQL filtering failure returned all objects instead of none
- #172 - Incorrect whitespace in some HTML template tags
- #181 - Incorrect UI reference in Webhook documentation
- #185 - Possible infinite loop in cable tracing algorithm
- #186 - Example Jobs are not updated for Nautobot
- #201 - Custom Fields cannot filter by name for content_types
- #205 - API Documentation shows numeric id instead of UUID
- #213 - Programming Error Exception Value: relation "social_auth_usersocialauth" does not exist
- #224 - Edit view for IPAM network objects does not emit the current network address value
- #255 - Update docs
edit_urito point to correct path
- #35 - Documentation for troubleshooting Nautobot's interaction with SELinux.
- #47 - Basic user documentation for Relationships feature.
- #48 - Additional unit testing and bug fixes for Relationships feature.
- #99 - Add
- #101 - Complete documentation of
- #107 - Add
- #52 - Disabled Poetry's "parallel installation" feature for CI and development builds.
- #61 - Updated pull request template contents for clarity.
- #74 - Refactor install instructions to be more streamlined and more intuitive.
BASE_STORAGE_DIRconfiguration setting with
NAUTOBOT_ROOT; this new setting also influences the default value of
- #88 - Replace Gunicorn w/ uWSGI
- #89 - Development workflow improvements
- Improve speed of development Docker container rebuilds
django-debug-toolbaris now a development dependency rather than a production dependency for Nautobot.
- #106 - Revise deployment docs to use
$PATHinstead of venv activate
- #108 - Document special workflow for development using containers on remote servers
- #72 - Removed issue template for "Documentation Change"; use "Bug" or "Feature Request" issue templates instead.
- #36 - Broken links to ReadTheDocs pages.
- #41 - Incorrect field name in CustomLink Admin page.
- #42 - Incorrect link to
- #45 - Incorrect button labels when creating/editing an Interface record.
- #43 - Incorrect commands in documentation for adding optional dependencies to
- #51 - Incorrect functioning of "development container" in VSCode integration.
- #57 - Incorrect
- #63 - Incorrect help text for "Destination Label" field when creating/editing Relationship records.
- #64 - Incorrect absolute link to ReadTheDocs page.
- #69 - More incorrect links to ReadTheDocs pages.
- #79 - Incorrect internal documentation link to
- #81 - Unable to change Device rack position after creation.
- #93 - Bug when setting
CACHEOPS_DEFAULTStimeout value to
Initial public beta release.
- Fixed a bug, inherited from NetBox 2.10, in which object permissions were not filtered correctly in the admin interface.
- Fixed a bug, inherited from NetBox 2.10, in which the UI would report an exception if the database contains ChangeLog entries that reference a nonexistent ContentType.