netbox/docs/release-notes/version-4.1.md

NetBox v4.1

v4.1.0 (2024-09-03)

Breaking Changes

• Several filters deprecated in v4.0 have been removed (see #15410).
• The unit size for VirtualMachine.disk and VirtualDisk.size has been changed from 1 gigabyte to 1 megabyte. Existing values will be adjusted automatically during the upgrade process.
• The min_vid and max_vid fields on the VLAN group model have been replaced with vid_ranges, an array of starting and ending VLAN ID pairs.
• The five individual event type fields on the EventRule model have been replaced by a single event_types array field, which lists applicable event types by name.
• All UI views & API endpoints associated with change records have been moved from /extras to /core.
• The validate() method on CustomValidator subclasses now must accept the request argument (deprecated in v4.0 by #14279).

New Features

Circuit Groups (#7025)

Circuits can now be assigned to groups for administrative purposes. Each circuit may be assigned to multiple groups, and each assignment may optionally indicate a priority (primary, secondary, or tertiary).

VLAN Group ID Ranges (#9627)

The VLAN group model has been enhanced to support multiple VLAN ID (VID) ranges, whereas previously it could track only a single beginning and ending VID pair. VID ranges are stored as an array of beginning and ending (inclusive) integer pairs, e.g. 1-100,1000-1999.

Nested Device Modules (#10500)

Module bays can now be added to modules to effect a hierarchical arrangement of submodules within a device. A module installed within a device's module bay may itself have module bays into which child modules may be installed.

Rack Types (#12826)

A new rack type model has been introduced, which functions similarly to device types. Users can now define a common make and model of equipment rack, the attributes of which are automatically populated when creating a new rack of that type. Backward compatibility for racks with individually defined characteristics is fully retained.

Plugins Catalog Integration (#14731)

The NetBox UI now integrates directly with the canonical plugins catalog hosted by NetBox Labs. Users can now explore available plugins and check for newer releases natively within the NetBox user interface.

User Notifications (#15621)

NetBox now includes a user notification system. Users can subscribe to individual objects and be alerted to changes within the web interface. Additionally, event rules can be created to trigger notifications for specific users and/or groups. Plugins can also employ this notification system for their own purposes.

Enhancements

• #7537 - Add a serial number field for virtual machines
• #8198 - Enable uniqueness enforcement for custom field values
• #8984 - Enable filtering of custom script output by log level
• #11969 - Support for tracking airflow on racks and module types
• #14656 - Dynamically render the custom field edit form depending on the selected field type
• #15106 - Add distance and distance_unit fields for wireless links
• #15156 - Add display_url field to all REST API serializers, which links to the corresponding UI view for an object
• #16574 - Add last_synced time to REST API serializer for data sources
• #16580 - Enable plugin views to enforce LOGIN_REQUIRED selectively (remove AUTH_EXEMPT_PATHS)
• #16782 - Enable filtering of selection choices for object and multi-object custom fields
• #16907 - Update user interface styling
• #17051 - Introduce ISOLATED_DEPLOYMENT config parameter for denoting Internet isolation
• #17221 - ObjectEditView now supports HTMX-based object editing
• #17288 - Introduce a configurable limit on the number of aliases within a GraphQL API request
• #17289 - Enforce a standard policy for local passwords by default
• #17318 - Include the assigned provider in nested API representation of circuits

Bug Fixes (From Beta1)

• #17086 - Fix exception when viewing a job with no related object
• #17097 - Record static object representation when calling NotificationGroup.notify()
• #17098 - Prevent automatic deletion of related notifications when deleting an object
• #17159 - Correct file paths in plugin installation instructions
• #17163 - Fix filtering of related services under IP address view
• #17169 - Avoid duplicating catalog listings for installed plugins
• #17301 - Correct styling of the edit & delete buttons for custom script modules
• #17302 - Fix log level filtering support for custom script messages
• #17306 - Correct rounding of reported VLAN group utilization

Plugins

• #15692 - Introduce improved plugin support for background jobs
• #16359 - Enable plugins to embed content in the top navigation bar
• #16726 - Extend PluginTemplateExtension to enable registering multiple models
• #16776 - Add an alerts() method to PluginTemplateExtension for embedding important information on object views
• #16886 - Introduce a mechanism for plugins to register custom event types (for use with user notifications)

Other Changes

• #14692 - Change the atomic unit for virtual disks from 1GB to 1MB
• #14861 - The URL path for UI views concerning virtual disks has been standardized to /virtualization/virtual-disks/
• #15410 - Remove various deprecated query filters
• #15908 - Indicate product edition in release data
• #16388 - Move all change logging resources from extras to core
• #16884 - Remove the ID column from the default table configuration for changelog records
• #16988 - Relocate rack items in navigation menu
• #17143 - The use of legacy "nested" serializer classes has been deprecated

REST API Changes

• The /api/extras/object-changes/ endpoint has moved to /api/core/object-changes/.
• Most object representations now include a read-only display_url field, which links to the object's corresponding UI view.
• Added the following endpoints:
  • /api/circuits/circuit-groups/
  • /api/circuits/circuit-group-assignments/
  • /api/dcim/rack-types/
  • /api/extras/notification-groups/
  • /api/extras/notifications/
  • /api/extras/subscriptions/
• circuits.Circuit
  • Added the assignments field, which lists all group assignments
• core.DataSource
  • Added the read-only last_synced field
• dcim.ModuleBay
  • Added the optional module foreign key field
• dcim.ModuleBayTemplate
  • Added the optional module_type foreign key field
• dcim.ModuleType
  • Added the optional airflow choice field
• dcim.Rack
  • Added the optional rack_type foreign key field
  • Added the optional airflow choice field
• extras.CustomField
  • Added the related_object_filter JSON field for object and multi-object custom fields
  • Added the validation_unique boolean field
• extras.EventRule
  • Removed the type_create, type_update, type_delete, type_job_start, and type_job_end boolean fields
  • Added the event_types array field
• ipam.VLANGroup
  • Removed the min_vid and max_vid fields
  • Added the vid_ranges field, an array of starting & ending VLAN IDs
• virtualization.VirtualMachine
  • Added the optional serial field
• wireless.WirelessLink
  • Added the optional distance and distance_unit fields