v3.6.0 - 2023-08-30

Breaking Changes

• PostgreSQL 11 is no longer supported (dropped in Django 4.2). NetBox v3.6 requires PostgreSQL 12 or later.
• The device_role field on the Device model has been renamed to role. The device_role field has been temporarily retained on the REST API serializer for devices for backward compatibility, but is read-only.
• The choices array field has been removed from the CustomField model. Any defined choices are automatically migrated to CustomFieldChoiceSets, accessible via the new choice_set field on the CustomField model.
• The napalm_driver and napalm_args fields (which were deprecated in v3.5) have been removed from the Platform model.
• The device and device_id filter for interfaces will no longer include interfaces from virtual chassis peers. Two new filters, virtual_chassis_member and virtual_chassis_member_id, have been introduced to match all interfaces belonging to the specified device's virtual chassis (if any).
• Reports and scripts are now returned within a results list when fetched via the REST API, consistent with other models.
• Superusers can no longer retrieve API token keys via the web UI if ALLOW_TOKEN_RETRIEVAL is disabled. (The admin view has been removed per #13044.)

New Features

Relocated Admin UI Views (#12589, #12590, #12591, #13044)

Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface:

• Users
• Groups
• Object permissions
• API tokens
• Configuration revisions

This migration provides a more consistent user experience and unlocks advanced functionality not feasible using Django's built-in views. The admin UI is scheduled for complete removal in NetBox v4.0.

Configurable Default Permissions (#13038)

Administrators now have the option of configuring default permissions for all users globally, regardless of explicit permission or group assignments granted in the database. This is accomplished by defining the DEFAULT_PERMISSIONS configuration parameter. By default, all users are granted permission to manage their own bookmarks and API tokens.

User Bookmarks (#8248)

Users can now bookmark their favorite objects in NetBox. Bookmarks are accessible under each user's personal bookmarks list, and can also be added as a dashboard widget.

Custom Field Choice Sets (#12988)

Selection and multi-select custom fields now employ discrete, reusable choice sets containing the valid options for each field. A choice set may be shared by multiple custom fields. Additionally, each choice within a set can now specify both a raw value and a human-friendly label (see #13241). Pre-existing custom field choices are migrated to choice sets automatically during the upgrade process.

Pre-Defined Location Choices for Custom Fields (#12194)

Users now have the option to employ one of several pre-defined sets of choices when creating a custom field. These include:

• IATA airport codes
• ISO 3166 country codes
• UN/LOCODE location identifiers

When defining a choice set, one of the above can be employed as the base set, with the option to define extra, custom choices as well.

Restrict Tag Usage by Object Type (#11541)

Tags may now be restricted to use with designated object types. Tags that have no specific object types assigned may be used with any object that supports tag assignment.

Enhancements

• #6347 - Cache the number of assigned components for devices and virtual machines
• #8137 - Add a field for designating the out-of-band (OOB) IP address for devices
• #10197 - Cache the number of member devices on each virtual chassis
• #11305 - Add GPS coordinate fields to the device model
• #11478 - Introduce virtual_chassis_member filter for interfaces & restore default behavior for device filter
• #11519 - Add a SQL index for IP address host values to optimize queries
• #11732 - Prevent inadvertent overwriting of object attributes by competing users
• #11936 - Introduce support for tags and custom fields on webhooks
• #12175 - Permit racks to start numbering at values greater than one
• #12210 - Add tenancy assignment for power feeds
• #12461 - Add config template rendering for virtual machines
• #12814 - Expose NetBox models within ConfigTemplate rendering context
• #12882 - Add tag support for contact assignments
• #13037 - Return reports & scripts within a results list when fetched via the REST API
• #13170 - Add rf_role to InterfaceTemplate
• #13269 - Cache the number of assigned component templates for device types

Bug Fixes

• #13513 - Prevent exception when rendering bookmarks widget for anonymous user
• #13599 - Fix errant counter increments when editing device/VM components
• #13605 - Optimize cached counter migrations to avoid excessive memory consumption

Other Changes

• Work has begun on introducing translation and localization support in NetBox. This work is being performed in preparation for release 4.0.
• #6391 - Rename the device_role field on Device to role for consistency with VirtualMachine
• #9077 - Prevent the errant execution of dangerous instance methods in Django templates
• #11766 - Remove obsolete custom ChoiceField and MultipleChoiceField classes
• #12180 - All API endpoints for available objects (e.g. IP addresses) now inherit from a common parent view
• #12237 - Upgrade Django to v4.2
• #12794 - Avoid direct imports of Django's stock user model
• #12320 - Remove obsolete fields napalm_driver and napalm_args from Platform
• #12964 - Drop support for PostgreSQL 11
• #13309 - User account-specific resources have been moved to a new account app for better organization

v3.5.9 - 2023-08-28

Enhancements

• #12489 - Dynamically render location and device lists under site and location views
• #12825 - Display assigned values count per object type under custom field view
• #13313 - Enable filtering IP ranges by containing prefix
• #13415 - Include request object in custom link renderer on tables
• #13536 - Move child VLANs list to a separate tab under VLAN group view
• #13542 - Pass additional HTTP headers through to custom script context
• #13585 - Introduce empty lookup for numeric value filters

Bug Fixes

• #11272 - Fix localization support for device position field
• #13358 - Git backend should send HTTP auth headers only if credentials have been defined
• #13477 - Fix filtering of modified objects after bulk import/update
• #13478 - Fix filtering of export templates by content type under web UI
• #13500 - Fix form validation for bulk update of L2VPN terminations via bulk import form
• #13503 - Fix utilization graph proportions when localization is enabled
• #13507 - Avoid raising exception for invalid content type during global search
• #13516 - Plugin utility functions should be importable from extras.plugins
• #13530 - Ensure script log messages can be serialized as JSON data
• #13543 - Config context tab under device/VM view should not require extras.view_configcontext permission
• #13544 - Ensure reindex command clears all cached values when not in lazy mode
• #13556 - Correct REST API representation of VDC status choice
• #13569 - Fix selection widgets for related interfaces when bulk editing interfaces under device view

v3.6-beta2 - 2023-08-16

⚠️ This is a beta release intended only for testing and evaluation. Do not deploy it in a production environment.

Bug Fixes

• #13351 - Fix missing text due to incorrectly applied translation tags
• #13361 - Extra choices field on custom field choice set form should not be required
• #13363 - Fix API endpoint for custom field choice selector in forms
• #13376 - Restrict add/remove tag fields by model on bulk edit forms
• #13410 - Fix rendering of custom choice fields with large number of choices
• #13433 - User field on API token form should be required
• #13434 - Randomly generate initial keys prior to the creation of new tokens
• #13437 - Display bookmark button only for relevant objects

v3.5.8 - 2023-08-15

Enhancements

• #10030 - Ship a validation schema for the device type library with each release
• #11675 - Add support for specifying import/export route targets during VRF bulk import
• #11922 - Automatically populate any VDC assignments from the parent when adding a child interface via the UI
• #12889 - Add 400GE CFP2 interface type
• #13033 - Add human-friendly speed column to interfaces table
• #13151 - Add "assigned" filter for IP addresses
• #13368 - List installed plugins on the server error report page
• #13442 - Add 200 and 400 Gbps speeds to dropdown choices on interface form

Bug Fixes

• #11578 - Fix schema definition for available IP & VLAN REST API endpoints
• #12639 - Raise validation error for invalid alphanumeric ranges when creating objects
• #12665 - Avoid escaping semicolons when rendering custom links
• #12750 - Automatically delete an AutoSyncRecord when its object is deleted
• #13343 - Fix filtering of circuits under provider network view
• #13369 - Fix job termination status for failed reports
• #13414 - Fix support for "hide-if-unset" custom fields on bulk import forms
• #13446 - Don't disable bulk edit/delete buttons after deselecting "select all" checkbox
• #13451 - Disable table ordering for custom link columns

v3.6-beta1 - 2023-08-02

⚠️ This is a beta release intended only for testing and evaluation. Do not deploy it in a production environment.

Breaking Changes

• PostgreSQL 11 is no longer supported (dropped in Django 4.2). NetBox v3.6 requires PostgreSQL 12 or later.
• The device_role field on the Device model has been renamed to role. The device_role field has been temporarily retained on the REST API serializer for devices for backward compatibility, but is read-only.
• The choices array field has been removed from the CustomField model. Any defined choices are automatically migrated to CustomFieldChoiceSets, accessible via the new choice_set field on the CustomField model.
• The napalm_driver and napalm_args fields (which were deprecated in v3.5) have been removed from the Platform model.

New Features

Relocated Admin Views (#12589, #12590, #12591, #13044)

Management views for the following object types, previously available only under the backend admin interface, have been relocated to the primary user interface:

• Users
• Groups
• Object permissions
• API tokens
• Configuration revisions

This migration provides a more consistent user experience and unlocks advanced functionality not feasible using Django's built-in views. The admin UI is scheduled for complete removal in NetBox v4.0.

Configurable Default Permissions (#13038)

Administrators now have the option of configuring default permissions for all users globally, regardless of explicit permission or group assignments granted in the database. This is accomplished by defining the DEFAULT_PERMISSIONS configuration parameter. By default, all users are granted permission to manage their own bookmarks and API tokens.

User Bookmarks (#8248)

Users can now bookmark their favorite objects in NetBox. Bookmarks are accessible under each user's personal bookmarks list, and can also be added as a dashboard widget.

Custom Field Choice Sets (#12988)

Selection and multi-select custom fields now employ discrete, reusable choice sets containing the valid options for each field. A choice set may be shared by multiple custom fields. Additionally, each choice within a set can now specify both a raw value and a human-friendly label (see #13241). Pre-existing custom field choices are migrated to choice sets automatically during the upgrade process.

Pre-Defined Location Choices for Custom Fields (#12194)

Users now have the option to employ one of several pre-defined sets of choices when creating a custom field. These include:

• IATA airport codes
• ISO 3166 country codes
• UN/LOCODE location identifiers

When defining a choice set, one of the above can be employed as the base set, with the option to define extra, custom choices as well.

Restrict Tag Usage by Object Type (#11541)

Tags may now be restricted to use with designated object types. Tags that have no specific object types assigned may be used with any object that supports tag assignment.

Enhancements

• #6347 - Cache the number of assigned components for devices and virtual machines
• #8137 - Add a field for designating the out-of-band (OOB) IP address for devices
• #10197 - Cache the number of member devices on each virtual chassis
• #11305 - Add GPS coordinate fields to the device model
• #11519 - Add a SQL index for IP address host values to optimize queries
• #11732 - Prevent inadvertent overwriting of object attributes by competing users
• #11936 - Introduce support for tags and custom fields on webhooks
• #12175 - Permit racks to start numbering at values greater than one
• #12210 - Add tenancy assignment for power feeds
• #12882 - Add tag support for contact assignments
• #13170 - Add rf_role to InterfaceTemplate
• #13269 - Cache the number of assigned component templates for device types

Other Changes

• Work has begun on introducing translation and localization support in NetBox. This work is being performed in preparation for release 4.0.
• #6391 - Rename the device_role field on Device to role for consistency with VirtualMachine
• #9077 - Prevent the errant execution of dangerous instance methods in Django templates
• #11766 - Remove obsolete custom ChoiceField and MultipleChoiceField classes
• #12180 - All API endpoints for available objects (e.g. IP addresses) now inherit from a common parent view
• #12237 - Upgrade Django to v4.2
• #12794 - Avoid direct imports of Django's stock user model
• #12320 - Remove obsolete fields napalm_driver and napalm_args from Platform
• #12964 - Drop support for PostgreSQL 11
• #13309 - User account-specific resources have been moved to a new account app for better organization

v3.5.7 - 2023-07-28

Enhancements

• #11803 - Move non-rack devices list to a separate tab under the rack view
• #12625 - Mask sensitive parameters when viewing a configured data source
• #13009 - Add IEC 10609-1 and NBR 14136 power port & outlet types
• #13097 - Implement a faster initial poll for report & script results
• #13234 - Add 100GBASE-X-DSFP and 100GBASE-X-SFPDD interface types

Bug Fixes

• #13051 - Fix Markdown support for table cell alignment
• #13167 - Fix missing script results when fetched via REST API
• #13233 - Remove extraneous VLAN group field from bulk edit form for interfaces
• #13237 - Permit unauthenticated access to content types REST API endpoint when LOGIN_REQUIRED is false
• #13285 - Fix exception when importing device type missing rack unit height value

v3.5.6 - 2023-07-10

Bug Fixes

• #13061 - Fix display of last result for scripts & reports with a custom name defined
• #13096 - Hide scheduling fields for all scripts with scheduling disabled
• #13105 - Fix exception when attempting to allocate next available IP address from prefix marked as utilized
• #13116 - Catch ProgrammingError exception when starting NetBox without pre-populated content types

v3.5.5 - 2023-07-06

Enhancements

• #11738 - Annotate VLAN group utilization
• #12499 - Add "copy to clipboard" buttons in UI for IP addresses
• #12945 - Add 100GE QSFP-DD interface type
• #12955 - Include additional contact details on contact assignments table
• #13065 - Associate contact assignments with their objects in the change log

Bug Fixes

• #11335 - Exclude stale content types when retrieving changelog records
• #12533 - Fix REST API validation of null values for several interface attributes
• #12579 - Fix exception when clicking "create and add another" to add a cable
• #12617 - Populate prechange snapshot on parent object when assigning/removing primary IP address
• #12760 - Avoid rendering partial HTMX responses when restoring browser tabs
• #12842 - Improve handling of exceptions when loading reports
• #12849 - Fix LDAP group permissions assignment for API clients
• #12951 - Display consistent parent information for each termination under cable view
• #12953 - Fix designation of primary IP addresses during interface assignment
• #12960 - Fix OpenAPI schema for various choice fields
• #12961 - Set correct return URL for object contacts tabs
• #12966 - Avoid catching database exceptions when maintenance mode is disabled
• #12975 - Correct URL for VirtualDeviceContext API serializer
• #12977 - Fix URL parameters for object count dashboard widgets
• #12983 - Avoid erroneously clearing many-to-many assignments during bulk edit
• #12989 - Fix bulk import of tags for device & module types
• #13011 - Do not escape commas when rendering custom links
• #13047 - Correct ASN count under ASN ranges list
• #13056 - Add config_template field to device API serializer
• #13092 - Allow nullifying power port max & allocated draw values during bulk edit
• #13100 - Fix ValueError exception when searching for virtual device context for non-numeric values

v3.5.4 - 2023-06-20

Enhancements

• #12828 - Define colors for staged change action choices
• #12847 - Include "add" button on all device & virtual machine component list views
• #12862 - Add menu navigation button to add wireless links directly
• #12865 - Add "add" buttons for reports & scripts to navigation menu

Bug Fixes

• #12474 - Update cable terminations when assigning a location to a new site
• #12622 - Permit the assignment of non-site VLANs to prefixes assigned to a site
• #12682 - Correct OpenAPI schema for connected device API endpoint
• #12687 - Allow the assignment of all /31 IP addresses to interfaces
• #12818 - Fix permissions evaluation when queuing a data sync job
• #12822 - Fix encoding of whitespace in custom link URLs
• #12838 - Correct rounding of rack power utilization values
• #12845 - Fix pagination of objects for related IP addresses table
• #12850 - Fix table configuration modal for the contact assignments list
• #12885 - Permit mounting of devices in rack unit 100
• #12914 - Clear stored ordering from user config when cleared by request

v3.5.3 - 2023-06-02

Enhancements

• #9876 - Improve support for matching tags in conditional rules
• #12015 - Add device type & role filters for device components
• #12470 - Collapse context data by default when viewing a rendered device configuration
• #12562 - Record client IP address when logging authentication failures
• #12597 - Add an option to hide custom fields only if unset
• #12599 - Apply filter parameters to links in object count dashboard widgets

Bug Fixes

• #7503 - Improve rack space validation when creating multiple devices via REST API
• #11539 - Fix exception when applying "empty" filter lookup with invalid value
• #11934 - Prevent reassignment of an IP address designated as primary for its parent object
• #12538 - Redirect user to originating view after editing/deleting an image attachment
• #12627 - Restore hover preview for embedded image attachment tables
• #12694 - Strip leading & trailing whitespace from custom link URL & text
• #12702 - Fix sizing of rear port selection widget on front port template creation form
• #12715 - Use contact assignments table to display the contacts assigned to an object
• #12730 - Fix extraneous contacts listed in object contact assignments view
• #12742 - Object counts dashboard widget should support URL-compatible query filters
• #12762 - Fix GraphiQL UI by reverting graphene-django to earlier version
• #12745 - Escape display text in API-backed selection widgets
• #12779 - Correct arithmetic for converting inches to meters