v4.0.2 - 2024-05-14

Important

This release includes an important security fix for NetBox v4.0.0 and v4.0.1, and is a strongly recommended update for all users. Details of the vulnerability are published in a GitHub security advisory.

Enhancements

• #15119 - Add cluster & cluster group UI filter fields for VLAN groups
• #16090 - Include current NetBox version when an unsupported plugin is detected
• #16096 - Introduce the ENABLE_TRANSLATION configuration parameter
• #16107 - Change the default value for LOGIN_REQUIRED to True
• #16127 - Add integration point for unsupported settings

Bug Fixes

• #16077 - Fix display of parameter values when viewing configuration revisions
• #16078 - Fix integer filters mistakenly marked as required for GraphQL API
• #16101 - Fix initial loading of pagination widget for dynamic object tables
• #16123 - Fix custom script execution via REST API
• #16124 - Fix GraphQL API support for querying virtual machine interfaces

v4.0.1 - 2024-05-09

Important

This release contains a security vulnerability which is fixed in v4.0.2. For this reason, v4.0.2 is a strongly recommended update for all users. Details of the vulnerability are published in a GitHub security advisory.

Enhancements

• #15148 - Add copy-to-clipboard button for config context data
• #15328 - Add a virtual machines UI tab for host devices
• #15451 - Add 2.5 and 5 Gbps backplane Ethernet interface types
• #16010 - Enable Prometheus middleware only if metrics are enabled

Bug Fixes

• #15968 - Avoid resizing quick search field to display clear button
• #15973 - Fix AttributeError exception when modifying cable termination type
• #15977 - Hide all admin menu items for non-authenticated users
• #15982 - Restore the "assign IP" tab for assigning existing IP addresses to interfaces
• #15992 - Fix AttributeError exception when Sentry integration is enabled
• #15995 - Permit nullable fields referenced by unique constraints to be omitted from REST API requests
• #15999 - Fix layout of login form labels for certain languages
• #16003 - Enable cache busting for setmode.js asset to avoid breaking dark mode support on upgrade
• #16011 - Fix site tenant assignment by PK via REST API
• #16020 - Include Python version in system UI view
• #16022 - Fix database migration failure when encountering a script module which no longer exists on disk
• #16025 - Fix execution of scripts via the runscript management command
• #16031 - Render Markdown content in script log messages
• #16051 - Translate "empty" text for object tables
• #16061 - Omit hidden fields from display within event rule edit form

v4.0.0 - 2024-05-06

Important

This release contains a security vulnerability which is fixed in v4.0.2. For this reason, v4.0.2 is a strongly recommended update for all users. Details of the vulnerability are published in a GitHub security advisory.

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_table 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
• #15915 - Provide a comprehensive system status view with export functionality

Bug Fixes (from Beta2)

• #15630 - Ensure consistent toggling between light & dark UI modes
• #15802 - Improve hyperlink color contrast in dark mode
• #15809 - Fix GraphQL union support for nullable fields
• #15815 - Convert dashboard widgets referencing old user/group models
• #15826 - Update EXEMPT_EXCLUDE_MODELS to reference new user & group models
• #15831 - Fix LDAP group mirroring
• #15838 - Fix AttributeError exception when rendering custom date fields
• #15852 - Update total results count when filtering object lists
• #15853 - Correct background color for cable trace SVG images in dark mode
• #15855 - Fix AttributeError exception when creating an event rule tied to a custom script
• #15944 - Fix styling of paginator when displayed above an object list

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 Us...

v3.7.8 - 2024-05-06

Enhancements

• #12127 - Enable adding new cables directly from navigation menu

Bug Fixes

• #15877 - Account for virtual chassis membership when assigning related interfaces via bulk edit
• #15917 - Fix pagination through search results within dropdown fields
• #15925 - Fix SVG rendering of cable traces to circuit terminations
• #15948 - Fix cable trace SVG generation for cables with multiple terminations at both ends
• #15960 - Replace CSV export formatting for several many-to-many fields
• #15961 - Fix secret toggle button for IKE policies

v3.7.7 - 2024-05-01

Enhancements

• #15428 - Show usage counts for associated objects on config template list
• #15812 - Add Date & DateTime variable types for custom scripts
• #15894 - Cache the generated API schema definition for shorter loading times

Bug Fixes

• #11460 - Fix AttributeError exception when editing a cable with only one end terminated
• #13712 - Fix row highlighting for device interface list display
• #13806 - Fix "mark" button tooltip on button activation for device interface list display
• #13922 - Fix SVG drawing error on multiple termination trace with multiple devices
• #14241 - Fix random interface swap when performing cable trace with multiple termination
• #14852 - Fix NoReverseMatch exception when viewing an event rule which references a deleted custom script
• #15524 - Fix rounding error when reporting IP range utilization
• #15548 - Ignore many-to-many mappings when checking dependencies of an object being deleted
• #15845 - Avoid extraneous database queries when fetching assigned IP addresses via REST API
• #15872 - BANNER_MAINTENANCE content should permit custom HTML
• #15891 - Ensure deterministic ordering for scripts & reports
• #15896 - Fix retention of default value when editing a custom JSON field
• #15899 - Fix exception when enabling the tags column on the L2VPN terminations table

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