v3.7.0 - 2023-12-29

Breaking Changes

• The following fields have been removed from the Webhook model: content_types, type_create, type_update, type_delete, type_job_start, type_job_end, enabled, and conditions. Webhooks are now tied to events via event rules. New event rules will be created for any existing webhooks automatically upon upgrade.
• The ui_visibility field on the custom field model has been replaced with two new fields: ui_visible and ui_editable. These new fields will have their values mapped from the original field automatically upon upgrade.
• The FeatureQuery class used internally for querying content types by model feature has been removed. It has been replaced by the new with_feature() manager method on NetBox's proxy model for ContentType (core.models.ContentType).
• The internal ConfigRevision model has moved from extras to core. Configuration history will be retained throughout the upgrade process.
• The L2VPN and L2VPNTermination models have moved from the ipam app to the new vpn app. All object data will be retained, however please note that the relevant API endpoints have likewise moved to /api/vpn/.
• The CustomFieldsMixin, SavedFiltersMixin, and TagsMixin classes have moved from the extras.forms.mixins module to netbox.forms.mixins.

New Features

VPN Tunnels (#9816)

Several new models have been introduced to enable VPN tunnel management. Users can now define tunnels with two or more terminations to represent peer-to-peer or hub-and-spoke topologies. Each termination is made to a virtual interface on a device or virtual machine. Additionally, users can define IKE and IPSec proposals and policies, which can be applied to tunnels to document encryption and authentication strategies.

Event Rules (#14132)

This release introduces event rules, which can be used to send webhooks or execute custom scripts automatically in response to events that occur in NetBox. For example, it's now possible to run a custom script whenever a new site is created with a particular status or tag.

Event rules replace and extend functionality that was previously built into the webhook model. New event rules will be created for any existing webhooks automatically upon upgrade.

Virtual Machine Disks (#8356)

A new VirtualDisk model has been introduced to enable tracking the assignment of discrete virtual disks to virtual machines. The size field has been retained on the VirtualMachine model, and will be populated automatically with the aggregate size of all assigned virtual disks. (Users who opt to eschew the new model may continue using the VirtualMachine size attribute independently as in previous releases.)

Object Protection Rules (#10244)

A new PROTECTION_RULES configuration parameter has been introduced. Similar to how custom validation rules can be used to enforce certain values for object attributes, protection rules guard against the deletion of objects which do not meet specified criteria. This enables an administrator to prevent, for example, the deletion of a site which has a status of "active."

Improved Custom Field Visibility Controls (#13299)

The ui_visible field on the custom field model has been superseded by two new fields, ui_visible and ui_editable, which control how and whether a custom field is displayed when view and editing an object, respectively. Separating these two functions into discrete fields allows more control over how each custom field is presented to users. The values of these fields will be appropriately set automatically during the upgrade process from the value of the original field.

Improved Global Search Results (#14134)

Global search results now include additional context about each object, such as a description, status, and/or related objects. The set of attributes to be displayed is specific to each object type, and is defined by setting display_attrs under the object's SearchIndex class.

Table Column Registration for Plugins (#14173)

Plugins can now register their own custom columns for inclusion on core NetBox tables. For example, a plugin can register a new column on SiteTable using the new register_table_column() utility function, and it will become available for users to select for display.

Data Backend Registration for Plugins (#13381)

Plugins can now register their own data backends for use with synchronized data sources. This enables plugins to introduce new backends in addition to the git, S3, and local path backends provided natively.

Enhancements

• #12135 - Avoid orphaned interfaces by preventing the deletion of interfaces which have children assigned
• #12216 - Add a color field for circuit types
• #13230 - Allow device types to be excluded from consideration when calculating a rack's utilization
• #13334 - Add an error field to the Job model to record any errors associated with its execution
• #13427 - Introduce a mechanism for excluding models from general-purpose lists of object types
• #13690 - Display any dependent objects to be deleted prior to deleting an object via the web UI
• #13794 - Any models with a relationship to Tenant are now included automatically in the list of related objects under the tenant view
• #13808 - Add a /render-config REST API endpoint for virtual machines
• #14035 - Order objects of equivalent weight by value in global search results to improve readability
• #14147 - Avoid recording empty changelog entries via the new CHANGELOG_SKIP_EMPTY_CHANGES config parameter
• #14156 - Enable custom fields for contact assignments
• #14240 - Increase maximum values for custom field minimum & maximum numeric validators
• #14361 - Add a description field for webhooks
• #14365 - Introduce job_start and job_end signals to allow automated plugin actions
• #14434 - Add model-specific termination object filters for cables (e.g. interface_id and consoleport_id)
• #14436 - Add PostgreSQL indexes for all GenericForeignKey fields
• #14579 - Allow users to specify a preferred language for UI translations

Translations

• #14075 - Add Spanish translation
• #14096 - Add French translation
• #14145 - Add Portuguese translation
• #14266 - Add Russian translation

Bug Fixes

• #14432 - Fix hyperlinks for global search result attributes
• #14472 - Fix display of hidden custom fields in object edit forms
• #14499 - Relax requirements for encryption/auth algorithms on IKE & IPSec proposals
• #14550 - Fix changing action type of existing event rule

Other Changes

• #13550 - Optimize the format for declaring view actions under ActionsMixin (backward compatibility has been retained)
• #13645 - Installation of the sentry-sdk Python library is now required only if Sentry reporting is enabled
• #14036...

v3.6.9 - 2023-12-28

Enhancements

• #14631 - All models can be filtered and searched by their description field (where applicable)

Bug Fixes

• #14482 - Fix validation error when attempting to move a primary IP address to a new parent object
• #14620 - Permit setting device type U height to 0 during bulk edit
• #14621 - Fix error when using the device search filter

v3.6.8 - 2023-12-27

Enhancements

• #11039 - List parent prefixes under IP range view
• #14507 - Print new NetBox version when running upgrade script
• #14538 - Add the available_at_site filter for VLANs
• #14596 - Match against description field when searching for devices

Bug Fixes

• #11816 - Correct display of error message when attempting invalid VLAN site & group assignment
• #12731 - Fix custom validation for many-to-many fields
• #13606 - Fix filtering custom multi-choice fields by null
• #13649 - Correct calculation of absolute lengths for zero-length cables
• #13812 - Update status of remote data source when syncing fails via syncdatasource management command
• #13909 - Fix cloning of objects which have a multi-choice custom field
• #14517 - Ensure reservations tab is always displayed under rack view
• #14532 - Device/VM change record should accurately reflect when primary/OOB IP is deleted
• #14549 - Fix association of job results when executing scripts via runscript management command
• #14560 - Do not escape exclamation marks in custom link URLs
• #14575 - Fix display of the tags column under VDC table
• #14613 - Fix display of current configuration parameters in UI

v3.6.7 - 2023-12-15

Enhancements

• #12751 - Designate fields to expand by default for object selector widget
• #14148 - Add tags column to L2VPN terminations column
• #14390 - Add classes parameter to copy_content template tag
• #14467 - Change custom field choice delimiter from comma to colon

Bug Fixes

• #13983 - Fix bulk import support for custom field choices
• #14081 - Ensure accuracy of parent object counters when deleting related objects
• #14249 - Fix server error when authenticating via IP-restricted API tokens using IPv6
• #14392 - Fix bulk operations for plugin models under admin UI
• #14397 - Fix exception on non-JSON request to /available-ips/ API endpoints
• #14401 - Rack starting_unit cannot be zero
• #14432 - Populate custom field default values for components when creating a device
• #14448 - Fix exception when creating a power feed with rack and panel in different sites
• #14505 - Fix the assignment of tags to L2VPN terminations
• #14512 - Remove unneeded annotations from queries when using REST API brief mode
• #14515 - Ensure user config is created automatically for all user accounts
• #14522 - Fix filtering contact assignments by group
• #14533 - Fix quick search under VLAN group VLANs list

v3.7-beta1 - 2023-12-05

⚠️ This is a beta release intended only for testing and evaluation. Do not deploy it in a production environment. No upgrade path to future releases will be provided.

Breaking Changes

• The following fields have been removed from the Webhook model: content_types, type_create, type_update, type_delete, type_job_start, type_job_end, enabled, and conditions. Webhooks are now tied to events via event rules. Existing webhooks will have event rules created automatically upon upgrade.
• The ui_visibility field on the custom field model has been replaced with two new fields: ui_visible and ui_editable. Existing values will be migrated automatically upon upgrade.
• The FeatureQuery class for querying content types by model feature has been removed. Plugins should now use the new with_feature() manager method on NetBox's proxy model for ContentType.
• The ConfigRevision model has been moved from extras to core. Configuration history will be retained throughout the upgrade process.
• The L2VPN and L2VPNTermination models have been moved from the ipam app to the new vpn app. All object data will be retained, however please note that the relevant API endpoints have moved to /api/vpn/.
• The CustomFieldsMixin, SavedFiltersMixin, and TagsMixin classes have moved from the extras.forms.mixins module to netbox.forms.mixins.

New Features

VPN Tunnels (#9816)

Several new models have been introduced to enable VPN tunnel management. Users can now define tunnels with two or more terminations to replicate peer-to-peer or hub-and-spoke topologies. Each termination is made to a virtual interface on a device or VM. Additionally, users can define IKE and IPSec policies which can be applied to tunnels to document encryption and authentication strategies.

Event Rules (#14132)

This release introduces event rules, which can be used to send webhooks or execute custom scripts automatically in response to NetBox events. For example, it's now possible to run a custom script whenever a new site is created with a particular status or tag.

Event rules replace and extend functionality that was previously built into the webhook model. Event rules will be created for any existing webhooks upon upgrade.

Virtual Machine Disks (#8356)

A new VirtualDisk model has been introduced to enable tracking the assignment of discrete virtual disks to virtual machines. The original size field has been retained on the VirtualMachine model, and will be automatically updated with the aggregate size of all assigned virtual disks. (Users who opt to eschew the new model may continue using the VirtualMachine size attribute as before.)

Object Protection Rules (#10244)

A new PROTECTION_RULES configuration parameter is now available. Similar to how custom validation rules can be used to enforce certain values for object attributes, protection rules guard against the deletion of objects which do not meet specified criteria. This enables an administrator to prevent, for example, the deletion of a site which has a status of "active."

Improved Custom Field Visibility Controls (#13299)

The old ui_visible field on the custom field model](https://docs.netbox.dev/en/feature/models/extras/customfield/) has been replaced by two new fields, ui_visible and ui_editable, which control how and whether a custom field is displayed when view and editing an object, respectively. Separating these two functions into discrete fields enables more control over how each custom field is presented to users. The values of these fields will be appropriately set automatically during the upgrade process depending on the value of the original field.

Improved Global Search Results (#14134)

Global search results now include additional context about each object, such as a description, status, and/or related objects. The set of attributes to be displayed is specific to each object type, and is defined by setting display_attrs under the object's SearchIndex class.

Table Column Registration for Plugins (#14173)

Plugins can now register their own custom columns for inclusion on core NetBox tables. For example, a plugin can register a new column on SiteTable using the new register_table_column() utility function, and it will become available for users to select for display.

Data Backend Registration for Plugins (#13381)

Plugins can now register their own data backends for use with synchronized data sources. This enables plugins to introduce new backends in addition to the git, S3, and local path backends provided natively.

Enhancements

• #12135 - Avoid orphaned interfaces by preventing the deletion of interfaces which have children assigned
• #12216 - Add a color field for circuit types
• #13230 - Allow device types to be excluded from consideration when calculating a rack's utilization
• #13334 - Added an error field to the Job model to record any errors associated with its execution
• #13427 - Introduced a mechanism for omitting models from general-purpose lists of object types
• #13690 - Display any dependent objects to be deleted prior to deleting an object via the web UI
• #13794 - Any models with a relationship to Tenant are now included automatically in the list of related objects under the tenant view
• #13808 - Added a /render-config REST API endpoint for virtual machines
• #14035 - Order objects of equivalent weight by value in global search results to improve readability
• #14156 - Enable custom fields for contact assignments
• #14361 - Add a description field for webhooks
• #14365 - Introduced job_start and job_end signals

Other Changes

• #13550 - Optimized the format for declaring view actions under ActionsMixin (backward compatibility has been retained)
• #13645 - Installation of the sentry-sdk Python library is now required only if Sentry reporting is enabled
• #14036 - Move plugin resources from the extras app into netbox (backward compatibility has been retained)
• #14153 - Replace FeatureQuery with new with_feature() method on ContentType manager
• #14311 - Move the L2VPN models from the ipam app to the new vpn app
• #14312 - Move the ConfigRevision model from the extras app to core
• #14326 - Form feature mixin classes have been moved from the extras app to netbox
• #14395 - Moved extras.webhooks_worker.process_webhook() to extras.webhooks.send_webhook() (backward compatibility has been retained)

v3.6.6 - 2023-11-29

Enhancements

• #13735 - Show complete region hierarchy in UI for all relevant objects

Bug Fixes

• #14056 - Record a pre-change snapshot when bulk editing objects via CSV
• #14187 - Raise a validation error when attempting to create a duplicate script or report
• #14199 - Fix jobs list for reports with a custom name
• #14239 - Fix CustomFieldChoiceSet search filter
• #14242 - Enable export templates for contact assignments
• #14299 - Webhook timestamps should be in proper ISO 8601 format
• #14325 - Fix numeric ordering of service ports
• #14339 - Correctly hash local user password when set via REST API
• #14343 - Fix ordering ASN table by ASDOT column
• #14346 - Fix running reports via REST API
• #14349 - Fix custom validation support for remote data sources
• #14363 - Fix bulk editing of interfaces assigned to VM with no cluster

v3.6.5 - 2023-11-09

Enhancements

• #12741 - Add selector widget to platform field on device & virtual machine forms
• #13022 - Introduce support for assigning IP addresses when bulk importing services
• #13587 - Annotate units of measurement on power port table columns
• #13669 - Add bulk import button to contact assignments list view
• #13723 - Add inventory items column to interfaces table
• #13743 - Add site column to power feeds table
• #13936 - Add primary IPv4 and IPv6 filters for virtual machines and VDCs
• #13951 - Add device & virtual machine fields to service filter form
• #14085 - Strip trailing port number from value returned by get_client_ip()
• #14101 - Add greater/less than mask length filters for IP addresses
• #14112 - Add tab listing child items under inventory item view
• #14113 - Add optional parent column to inventory items table
• #14220 - Order available columns alphabetically in table configuration form
• #14221 - Add contact group column on contact assignments table

Bug Fixes

• #14033 - Avoid exception when attempting to connect both ends of a cable to the same object
• #14117 - Check that enough rear port positions have been selected to accommodate the number of front ports being created
• #14166 - Permit user login when maintenance mode is enabled
• #14182 - Ensure the active configuration is restored upon clearing cache
• #14195 - Correct permissions evaluation for ASN range child ASNs view
• #14223 - Disable ordering of jobs by assigned object

v3.6.4 - 2023-10-17

Enhancements

• #12831 - Include circuit description in cable trace SVG image
• #12872 - Introduce the DATA_UPLOAD_MAX_MEMORY_SIZE configuration parameter
• #13950 - Display custom choice field labels rather than values in UI
• #13957 - Add DNS name filter on IP addresses list
• #13962 - Add a copy-to-clipboard button for API tokens
• #13972 - Introduce a filter to find unterminated cables

Bug Fixes

• #11987 - Fix validation of bulk cable updates via bulk import form
• #12328 - Ensure generic foreign key relationships are populated in REST API serializations of objects
• #12336 - Employ PostgreSQL advisory locks to avoid duplicate MPTT tree IDs when bulk creating objects
• #13064 - Fix resetting of checkbox fields triggered by HTMX form re-rendering
• #13440 - Fix support for assigning a tenant when creating "next available" VLANs via the REST API
• #13746 - Fix support for setting custom field values when creating "next available" IP addresses via the REST API
• #13872 - Add CSV delimiter field to file upload tab under bulk object upload views
• #13876 - Fix support for assigning an interface when creating "next available" IP addresses via the REST API
• #13910 - Correct "add device" button link under platform view
• #13944 - Correct serialization of several report attributes in the REST API
• #13966 - Restore "last login" column on users table
• #14013 - Fix device role filter choices under inventory items list filters
• #14023 - Fix exception when bulk disconnecting interfaces connected to the same cable
• #14025 - Fix exception when viewing a script that begins with the same name as another
• #14026 - Optimize the automatic creation of available IP addresses for large prefixes
• #14042 - Fix duplicated child object count decrements when removing objects in bulk

v3.6.3 - 2023-09-26

Enhancements

• #12732 - Add toggle to hide disconnected interfaces under device view

Bug Fixes

• #11079 - Enable tracing cable paths across multiple cables in parallel
• #11901 - Fix IndexError exception when manipulating terminations for existing cables via REST API
• #13506 - Enable creating a config template which references a data file via the REST API
• #13666 - Cleanly handle reports without any test methods defined
• #13839 - Restore original text color for HTML code elements
• #13843 - Fix assignment of VLAN group scope during bulk edit
• #13845 - Fix AttributeError exception when attaching front/rear images to a device type
• #13849 - Fix KeyError exception when deleting an object which references a configured choice value that has been removed
• #13859 - Fix invalid response when searching for custom choice field values returns no matches
• #13864 - Correct default background color for dashboard widget headers
• #13871 - Fix rack filtering for empty location during device bulk import
• #13891 - Allow designating an IP address as primary for device/VM while assigning it to an interface

v3.6.2 - 2023-09-20

Enhancements

• #13245 - Add interface types for QSFP112 and OSFP-RHS
• #13563 - Add support for other delimiting characters when using CSV import

Bug Fixes

• #11209 - Hide available IP/VLAN listing when sorting under a parent prefix or VLAN range
• #11617 - Raise validation error on the presence of an unknown CSV header during bulk import
• #12219 - Fix dashboard widget heading contrast under dark mode
• #12685 - Render Markdown in custom field help text on object edit forms
• #13653 - Tweak color of error text to improve legibility
• #13701 - Correct display of power feed legs under device view
• #13706 - Restore extra filters dropdown on device interfaces list
• #13721 - Filter VLAN choices by selected site (if any) when creating a prefix
• #13727 - Fix exception when viewing rendered config for VM without a role assigned
• #13745 - Optimize counter field migrations for large databases
• #13756 - Fix exception when sorting module bay list by installed module status
• #13757 - Fix RecursionError exception when assigning config context to a device type
• #13767 - Fix support for comments when creating a new service via web UI
• #13782 - Fix tag exclusion support for contact assignments
• #13791 - Preserve whitespace in values when performing bulk rename of objects via web UI
• #13809 - Avoid TypeError exception when editing active configuration with statically defined CUSTOM_VALIDATORS
• #13813 - Fix member count for newly created virtual chassis
• #13818 - Restore missing tags field on L2VPN termination edit form