v4.0-beta2 - 2024-04-22

Warning

This is a beta release of NetBox intended for testing and evaluation. Do not use this software in production. Also be aware that no upgrade path is provided to future releases.

Tip

Plugin maintainers: Please see the dedicated plugin migration guide for a checklist of changes that may be needed to ensure compatibility with NetBox v4.0.

Breaking Changes

• Support for Python 3.8 and 3.9 has been removed.
• The format for GraphQL query filters has changed. Please see the GraphQL documentation for details and examples.
• The deprecated device_role & device_role_id filters for devices have been removed. (Use role and role_id instead.)
• The obsolete device_role field has been removed from the REST API serializer for devices. (Use role instead.)
• The legacy reports functionality has been dropped. Reports will be automatically converted to custom scripts on upgrade.
• The parent and parent_id filters for locations now return only immediate children of the specified location. (Use ancestor and ancestor_id to return all descendants.)
• The object_type field on the CustomField model has been renamed to related_object_type.
• The utilities.utils module has been removed and its resources reorganized into separate modules organized by function.
• The obsolete NullableCharField class has been removed. (Use Django's stock CharField class with null=True instead.)
• The annotated_date template filter and annotated_now template tag have been removed.

New Features

Complete UI Refresh (#12128)

The NetBox user interface has been completely refreshed and updated. This massive effort entailed:

• Refactoring the base HTML templates
• Moving from Boostrap 5.0 to Bootstrap 5.3
• Adopting the Tabler UI theme
• Replacing slim-select with Tom-Select
• Displaying additional object attributes in dropdown form fields
• Enabling opt-in HTMX-powered navigation (see #14736)
• Widespread cleanup & standardization of UI components

Dynamic REST API Fields (#15087)

The REST API now supports specifying which fields to include in the response data. For example, the response to a request for

GET /api/dcim/sites/?fields=name,status,region,tenant

will include only the four specified fields in the representation of each site. Additionally, the underlying database queries effected by such requests have been optimized to omit fields which are not included in the response, resulting in a substantial performance improvement.

Strawberry GraphQL Engine (#9856)

The GraphQL engine has been changed from using Graphene-Django to Strawberry-Django. Changes include:

• Queryset Optimizer - reduces the number of database queries when querying related tables
• Updated GraphiQL Browser
• The format for GraphQL query filters and lookups has changed. Please see the GraphQL documentation for details and examples.

Advanced Form Rendering Functionality (#14739)

New resources have been introduced to enable advanced form rendering without a need for custom HTML templates. These include:

• FieldSet - Represents a grouping of form fields (replaces the use of lists/tuples)
• InlineFields - Multiple fields rendered on a single row
• TabbedGroups - Fieldsets rendered under navigable tabs within a form
• ObjectAttribute - Renders a read-only representation of a particular object attribute (for reference)

Legacy Admin UI Disabled (#12325)

The legacy admin user interface is now disabled by default, and the few remaining views it provided have been relocated to the primary UI. NetBox deployments which still depend on the legacy admin functionality for plugins can enable it by setting the DJANGO_ADMIN_ENABLED configuration parameter to true.

Enhancements

• #12776 - Introduce the htmx_talble template tag to simplify the rendering of embedded tables
• #12851 - Replace the deprecated Bleach HTML sanitization library with nh3
• #13283 - Display additional context on API-backed dropdown form fields (e.g. object descriptions)
• #13918 - Add facility field to Location model
• #14237 - Automatically clear dependent selection form fields when modifying a parent selection
• #14279 - Make the current request available as context when running custom validators
• #14454 - Include member devices in the REST API representation of virtual chassis
• #14637 - Upgrade to Django 5.0
• #14672 - Add support for Python 3.12
• #14728 - The plugins list view has been moved from the legacy admin UI to the main NetBox UI
• #14729 - All background task views have been moved from the legacy admin UI to the main NetBox UI
• #14736 - Introduce a user preference to enable HTMX-powered navigation
• #14438 - Track individual custom scripts as database objects
• #15131 - Automatically annotate related object counts on REST API querysets
• #15237 - Ensure consistent filtering ability for all model fields by testing for missing/incorrect filters
• #15238 - Include the description field in "brief" REST API serializations
• #15278 - BaseModelSerializer now takes a nested keyword argument allowing it to represent a related object
• #15383 - Standardize filtering logic for the parents of recursively-nested models (parent & ancestor filters)
• #15413 - The global search engine now supports caching of non-field object attributes
• #15490 - Custom validators can now reference related object attributes via dotted paths
• #15547 - Add comments field to CustomField model
• #15712 - Enable image attachments for virtual machines
• #15735 - Display all dates & times in ISO 8601 format consistently
• #15754 - Remove is_staff restriction on admin menu items
• #15764 - Increase maximum value of Device vc_position field

Bug Fixes (from Beta1)

• #15580 - Fix rendering of modals with HTMX navigation enabled
• #15605 - Fix ProgrammingError exception when applying migrations to older databases
• #15613 - Restore the login button/user menu on mobile view
• #15616 - Fix button style for invalid custom links
• #15617 - Fix rack elevation styling under dark mode
• #15619 - Enforce a minimum width for progress bars
• #15636 - Fix filtering of attached images when viewing an object in the UI
• #15637 - Correct nonfunctional links within embedded tables when HTMX enabled
• #15638 - Correct parameter used to retrieve saved filters for a model
• #15641 - Fix adding/removing filters on the advanced object selector widget
• #15652 - Fix the display of error messages after attempting to delete an object
• #15671 - Fix ValueError exception when uploading a custom script
• #15695 - Fix ForeignKeyViolation exception when applying migration users.0006_custom_group_model on older databases
• #15698 - Fix ProgrammingError exception when applying the users.0008_flip_objectpermission_assignments migration to older databases
• #15760 - Permit breaking of long words for wrap within object attribute tables
• #15778 - Fix bulk edit/delete functionality when HT...

v3.7.6 - 2024-04-22

Enhancements

• #14690 - Improve rendering of JSON data in configuration form
• #15427 - Enable compatibility with non-Amazon S3 providers for remote data sources
• #15640 - Add global search support for L2VPN identifiers
• #15644 - Introduce new configuration parameters for enabling HTTP Strict Transport Security (HSTS)

Bug Fixes

• #15541 - Restore ability to modify assigned component template when adding/modifying an inventory item template
• #15582 - Fix permission constraints for synchronization of remote data sources
• #15588 - Correct OpenAPI schema definitions for read-only fields which may return null values
• #15635 - Extend plugin removal instruction to include reindexing the global search cache
• #15654 - Fix AttributeError exception when attempting to save an incomplete tunnel termination
• #15668 - Fix permission required to display virtual disks tab on virtual machine UI view
• #15685 - Allow filtering cables by decimal values using UI filter form
• #15761 - Add missing ike_policy & ike_policy_id filters for IKE proposals
• #15771 - Include id in list of supported fields for all bulk import forms
• #15790 - Fix live preview support for EventRule comments

v3.7.5 - 2024-04-04

Enhancements

• #14707 - Clarify interface designation when creating tunnel terminations
• #15039 - Allow API tokens to be cloned

Bug Fixes

• #14799 - Avoid caching modified reports & scripts
• #15029 - Raise a clean validation error when attempting to make duplicate FHRP group assignments
• #15102 - Fix usage of selector widget for form fields referencing users/groups
• #15435 - Correct permissions name to allow adding a module bay to a device via the UI
• #15502 - Fix KeyError exception when modifying an IP address assigned to a virtual machine
• #15597 - Restore help modal for button_class field on custom link bulk import form
• #15598 - Fix exception when creating a device from a device type with one or more child inventory items
• #15608 - Avoid caching values of null fields in search index
• #15609 - Fix filtering of the providers list by assigned ASN

v4.0-beta1 - 2024-04-03

Warning

This is a beta release of NetBox intended for testing and evaluation. Do not use this software in production. Also be aware that no upgrade path is provided to future releases.

Tip

Plugin maintainers: Please see the dedicated plugin migration guide for a checklist of changes that may be needed to ensure compatibility with NetBox v4.0.

Breaking Changes

• Support for Python 3.8 and 3.9 has been removed.
• The format for GraphQL query filters has changed. Please see the GraphQL documentation for details and examples.
• The deprecated device_role & device_role_id filters for devices have been removed. (Use role and role_id instead.)
• The obsolete device_role field has been removed from the REST API serializer for devices. (Use role instead.)
• The legacy reports functionality has been dropped. Reports will be automatically converted to custom scripts on upgrade.
• The parent and parent_id filters for locations now return only immediate children of the specified location. (Use ancestor and ancestor_id to return all descendants.)
• The object_type field on the CustomField model has been renamed to related_object_type.
• The utilities.utils module has been removed and its resources reorganized into separate modules organized by function.
• The obsolete NullableCharField class has been removed. (Use Django's stock CharField class with null=True instead.)

New Features

Complete UI Refresh (#12128)

The NetBox user interface has been completely refreshed and updated. This massive effort entailed:

• Refactoring the base HTML templates
• Moving from Boostrap 5.0 to Bootstrap 5.3
• Adopting the Tabler UI theme
• Replacing slim-select with Tom-Select
• Displaying additional object attributes in dropdown form fields
• Enabling opt-in HTMX-powered navigation (see #14736)
• Widespread cleanup & standardization of UI components

Dynamic REST API Fields (#15087)

The REST API now supports specifying which fields to include in the response data. For example, the response to a request for

GET /api/dcim/sites/?fields=name,status,region,tenant

will include only the four specified fields in the representation of each site. Additionally, the underlying database queries effected by such requests have been optimized to omit fields which are not included in the response, resulting in a substantial performance improvement.

Strawberry GraphQL Engine (#9856)

The GraphQL engine has been changed from using Graphene-Django to Strawberry-Django. Changes include:

• Queryset Optimizer - reduces the number of database queries when querying related tables
• Updated GraphiQL Browser
• The format for GraphQL query filters and lookups has changed. Please see the GraphQL documentation for details and examples.

Advanced Form Rendering Functionality (#14739)

New resources have been introduced to enable advanced form rendering without a need for custom HTML templates. These include:

• FieldSet - Represents a grouping of form fields (replaces the use of lists/tuples)
• InlineFields - Multiple fields rendered on a single row
• TabbedGroups - Fieldsets rendered under navigable tabs within a form
• ObjectAttribute - Renders a read-only representation of a particular object attribute (for reference)

Legacy Admin UI Disabled (#12325)

The legacy admin user interface is now disabled by default, and the few remaining views it provided have been relocated to the primary UI. NetBox deployments which still depend on the legacy admin functionality for plugins can enable it by setting the DJANGO_ADMIN_ENABLED configuration parameter to true.

Enhancements

• #12776 - Introduce the htmx_talble template tag to simplify the rendering of embedded tables
• #12851 - Replace the deprecated Bleach HTML sanitization library with nh3
• #13283 - Display additional context on API-backed dropdown form fields (e.g. object descriptions)
• #13918 - Add facility field to Location model
• #14237 - Automatically clear dependent selection form fields when modifying a parent selection
• #14279 - Make the current request available as context when running custom validators
• #14454 - Include member devices in the REST API representation of virtual chassis
• #14637 - Upgrade to Django 5.0
• #14672 - Add support for Python 3.12
• #14728 - The plugins list view has been moved from the legacy admin UI to the main NetBox UI
• #14729 - All background task views have been moved from the legacy admin UI to the main NetBox UI
• #14736 - Introduce a user preference to enable HTMX-powered navigation
• #14438 - Track individual custom scripts as database objects
• #15131 - Automatically annotate related object counts on REST API querysets
• #15237 - Ensure consistent filtering ability for all model fields by testing for missing/incorrect filters
• #15238 - Include the description field in "brief" REST API serializations
• #15278 - BaseModelSerializer now takes a nested keyword argument allowing it to represent a related object
• #15383 - Standardize filtering logic for the parents of recursively-nested models (parent & ancestor filters)
• #15413 - The global search engine now supports caching of non-field object attributes
• #15490 - Custom validators can now reference related object attributes via dotted paths

Other Changes

• #10587 - Enable pagination and filtering for custom script logs
• #12325 - The Django admin UI is now disabled by default (set DJANGO_ADMIN_ENABLED to True to enable it)
• #12510 - Dropped support for legacy reports
• #12795 - NetBox now uses custom User and Group models rather than the stock models provided by Django
• #13647 - Squash all database migrations prior to v3.7
• #14092 - Remove backward compatibility for importing plugin resources from extras.plugins (now netbox.plugins)
• #14638 - Drop support for Python 3.8 and 3.9
• #14657 - Remove backward compatibility for old permissions mapping under ActionsMixin
• #14658 - Remove backward compatibility for importing process_webhook() from extras.webhooks_worker (now extras.webhooks.send_webhook())
• #14740 - Remove the obsolete BootstrapMixin form mixin class
• #15042 - The logic for registering models & model features now executes under the ready() method of individual app configs, rather than relying on the class_prepared signal
• #15099 - Remove obsolete device_role and device_role_id filters for devices
• #15100 - Remove obsolete NullableCharField class
• #15154 - The installation documentation been extended to include instructions and an example configuration file for uWSGI as an alternative to gunicorn
• #15193 - Switch to compiled distribution of the psycopg library
• #15277 - Replace references to ContentType without ObjectType proxy model & standardize field names
• #15292 - Remove obsolete device_role attribute from Device model (this field was renamed to role in v3.6)
• #15357 - The object_type field on the CustomField model has been renamed to related_object_type to avoid confusion with its object_types field
• [#15401](https://github.com/netbox-community/netbox/issues/...

v3.7.4 - 2024-03-13

Enhancements

• #14206 - Add additional FibreChannel SFP+ interface types
• #14366 - Enable custom links for config contexts & templates
• #15291 - Add tunnel termination buttons to VM interfaces table
• #15297 - Linkify platform column in device & virtual machine tables

Bug Fixes

• #13722 - Fix range expansion for comma-separated numerical values
• #14832 - Enable querying IP addresses for an FHRP group via GraphQL
• #15220 - Fix validation check when bulk editing the mask length of IP addresses
• #15232 - Permit user with sufficient permissions to assign an inventory item to a device type
• #15241 - Restore missing display field on VirtualDisk serialization in REST API
• #15243 - Correct representation of installed module when listing module bays using REST API brief mode
• #15316 - Fix selection of 3DES encryption for IKE & IPSec proposals
• #15322 - Add description field to YAML export for device & module types
• #15336 - Correct label for recurring scheduled jobs
• #15347 - Fix querying virtual machine contacts via GraphQL
• #15356 - Fix assignment of front & rear images to device types via REST API

v3.7.3 - 2024-02-21

Enhancements

• #14587 - Display a human-friendly name for the OpenID Connect remote auth backend
• #14946 - Remove associate_by_email() from default social auth pipeline
• #14966 - Add PostgreSQL index for object type & ID on CachedValue table to improve performance
• #15177 - Add "last login" time to user display & REST API serializer

Bug Fixes

• #14058 - Limit platform options by manufacturer when editing a device or device type
• #14064 - Resolving parent location should consider assigned site when bulk importing locations
• #14079 - Ensure changes are logged on related objects when deleting an object referenced via a many-to-many relationship (e.g. tags)
• #14405 - Clean up formatting of link peers in bulk CSV export of cable termination objects
• #14689 - Preserve "empty" default values for JSON custom fields
• #14952 - Update existing AutoSyncRecord when changing the data file of an auto-synced object
• #15059 - Correct IP address count link in VM interfaces table
• #15067 - Fix uncaught exception when attempting invalid device bay import
• #15070 - Fix inclusion of config_template field on REST API serializer for virtual machines
• #15084 - Fix "add export template" link under "export" button on object list views
• #15090 - Ensure protection rules are evaluated prior to enqueueing events when deleting an object
• #15091 - Fix designation of the active tab for assigned object when modifying an L2VPN termination
• #15101 - Correct OpenAPI schema for rack elevation REST API endpoint
• #15115 - Fix unhandled exception with invalid permission constraints
• #15126 - group field should be optional when creating VPN tunnel via REST API
• #15127 - Add missing group column to VPN tunnels table
• #15133 - Fix FHRP group representation on assignments REST API endpoint using brief mode
• #15174 - Warn that permission constraints are not supported for reports or scripts
• #15184 - Correct REST API schema definition for front_image & rear_image on DeviceType
• #15185 - Ensure error messages pertaining to related objects are displayed on the bulk import form
• #15192 - Fix exception when viewing current config when no history is present

v3.7.2 - 2024-02-05

Enhancements

• #13729 - Omit sensitive data source parameters from change log data
• #14645 - Limit the number of assigned IP addresses displayed under interfaces list

Bug Fixes

• #14500 - Optimize calculation of available child prefixes & ranges when viewing a prefix
• #14511 - Fix GraphQL support for interfaces connected to provider networks
• #14572 - Correct the number of jobs listed for individual report & script modules
• #14703 - Revert to the default layout when encountering a misconfigured dashboard
• #14755 - Fix validation of choice values & labels when creating a custom field choice set via the REST API
• #14838 - Avoid corrupting JSON data when changing the action type while editing an event rule
• #14839 - Fix form validation error when attempting to terminate a tunnel to a virtual machine interface
• #14840 - Fix NoReverseMatch exception when rendering a custom field which references a user
• #14847 - IKE policy mode may be set inly when IKEv1 is selected
• #14851 - Automatically remove any associated bookmarks when deleting a user
• #14879 - Include custom fields in REST API representation of data sources
• #14885 - Add missing "group" field to VPN tunnel creation form
• #14892 - Fix exception when running report/script via command line due to missing username
• #14920 - Include button to display available status choices when bulk importing virtual device contexts
• #14945 - Fix "select all" button for device type components
• #14947 - Ensure that application & removal of tags is always recorded in an object's change log
• #14962 - Fix config context rendering for VMs assigned directly to a site (rather than via a cluster)
• #14999 - Fix "create & add another" link for interface FHRP group assignment
• #15015 - Pre-populate assigned tenant when allocating next available IP address under prefix view
• #15020 - Automatically update all VMs when changing a cluster's assigned site
• #15025 - The can_add() template filter should accept a model (not an instance)

v3.7.1 - 2024-01-17

Bug Fixes

• #13844 - Use available_at_site filter when filtering VLANs under prefix form
• #14663 - Fix tunnel creation when setting initial termination to a VM interface
• #14706 - Relax one-to-one mapping of tunnel termination to IP address
• #14709 - Fix typo in tunnel termination type choice name
• #14749 - Remove errant translation wrapper from installed_device on DeviceBay
• #14778 - Custom field API serializer should accept null values for all optional fields
• #14791 - Hide available prefixes when searching within a parent prefix
• #14793 - Add missing Diffie-Hellman group 15
• #14816 - Ensure default contact assignment ordering is consistent
• #14817 - Relax required fields for IKE & IPSec models on bulk import
• #14827 - Ensure all matching event rules are processed in response to an event

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