starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #17350] [MERGED] Release v4.1.0 #15076

New Issue
Closed
opened 2025-12-30 00:19:49 +01:00 by adam · 0 comments
adam commented 2025-12-30 00:19:49 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/17350
Author: @jeremystretch
Created: 9/3/2024
Status: ✅ Merged
Merged: 9/3/2024
Merged by: @jeremystretch

Base: master ← Head: develop

📝 Commits (10+)

📊 Changes

570 files changed (+61541 additions, -44978 deletions)

View changed files

📝 .github/ISSUE_TEMPLATE/bug_report.yaml (+1 -1)
📝 .github/ISSUE_TEMPLATE/feature_request.yaml (+1 -1)
➕ docs/configuration/graphql-api.md (+17 -0)
📝 docs/configuration/index.md (+1 -1)
📝 docs/configuration/miscellaneous.md (+0 -10)
📝 docs/configuration/security.md (+15 -5)
📝 docs/configuration/system.md (+14 -1)
📝 docs/customization/custom-fields.md (+2 -0)
📝 docs/customization/custom-validation.md (+0 -4)
📝 docs/development/adding-models.md (+0 -1)
📝 docs/development/extending-models.md (+1 -1)
📝 docs/development/models.md (+14 -1)
📝 docs/development/release-checklist.md (+4 -14)
📝 docs/features/event-rules.md (+4 -3)
📝 docs/features/facilities.md (+4 -0)
➕ docs/features/notifications.md (+10 -0)
📝 docs/integrations/graphql-api.md (+1 -1)
📝 docs/integrations/rest-api.md (+3 -3)
📝 docs/media/screenshots/cable-trace.png (+0 -0)
📝 docs/media/screenshots/home-dark.png (+0 -0)

...and 80 more files

📄 Description

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

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/17350 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 9/3/2024 **Status:** ✅ Merged **Merged:** 9/3/2024 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `master` ← **Head:** `develop` --- ### 📝 Commits (10+) - [`5016936`](https://github.com/netbox-community/netbox/commit/50169365a9b7007eddf8bb1dd4f419141963fa50) Closes #16359: Add navbar() method to PluginTemplateExtension - [`1952d3e`](https://github.com/netbox-community/netbox/commit/1952d3e63a9e6d9c6dc164ac493988e2fc7ed238) Merge branch 'develop' into feature - [`c6bd714`](https://github.com/netbox-community/netbox/commit/c6bd714a04e1770f689453d1351964ab15f79ee0) Closes #15908: Establish canonical & local sources for release info (#16420) - [`c7176e8`](https://github.com/netbox-community/netbox/commit/c7176e86fc92e0488e08a6e53b840012ae9d7cdd) 15410 removed deprecated filters (#16410) - [`4da5bd6`](https://github.com/netbox-community/netbox/commit/4da5bd6ed1bbfee5f2f76ed53cd41a048edf4fdc) #15908: Update upgrade.sh - [`c1d7696`](https://github.com/netbox-community/netbox/commit/c1d7696b2a0c22c142122d9cb65e5b1c868a08cb) 14692 Convert VM disk size (#16434) - [`c6553c4`](https://github.com/netbox-community/netbox/commit/c6553c45dd1847baef21f2f13bd7ece865293eb9) 7537 add serial number to virtual machines (#16407) - [`853d990`](https://github.com/netbox-community/netbox/commit/853d990c033b638585c95da4ffa0889bb4f9f0ed) Closes #16388: Move change logging resources from `extras` to `core` (#16545) - [`e12edd7`](https://github.com/netbox-community/netbox/commit/e12edd7420937138c9a809ef77a1031014a2f1fa) #16388: Fix migration bug - [`91dcecb`](https://github.com/netbox-community/netbox/commit/91dcecbd077d1af3c886c4d34a45a3c823b3f350) 15106 Add Length Field to Wireless Link (#16528) ### 📊 Changes **570 files changed** (+61541 additions, -44978 deletions) <details> <summary>View changed files</summary> 📝 `.github/ISSUE_TEMPLATE/bug_report.yaml` (+1 -1) 📝 `.github/ISSUE_TEMPLATE/feature_request.yaml` (+1 -1) ➕ `docs/configuration/graphql-api.md` (+17 -0) 📝 `docs/configuration/index.md` (+1 -1) 📝 `docs/configuration/miscellaneous.md` (+0 -10) 📝 `docs/configuration/security.md` (+15 -5) 📝 `docs/configuration/system.md` (+14 -1) 📝 `docs/customization/custom-fields.md` (+2 -0) 📝 `docs/customization/custom-validation.md` (+0 -4) 📝 `docs/development/adding-models.md` (+0 -1) 📝 `docs/development/extending-models.md` (+1 -1) 📝 `docs/development/models.md` (+14 -1) 📝 `docs/development/release-checklist.md` (+4 -14) 📝 `docs/features/event-rules.md` (+4 -3) 📝 `docs/features/facilities.md` (+4 -0) ➕ `docs/features/notifications.md` (+10 -0) 📝 `docs/integrations/graphql-api.md` (+1 -1) 📝 `docs/integrations/rest-api.md` (+3 -3) 📝 `docs/media/screenshots/cable-trace.png` (+0 -0) 📝 `docs/media/screenshots/home-dark.png` (+0 -0) _...and 80 more files_ </details> ### 📄 Description ### Breaking Changes * Several filters deprecated in v4.0 have been removed (see [#15410](https://github.com/netbox-community/netbox/issues/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](https://github.com/netbox-community/netbox/issues/14279/)). ### New Features #### Circuit Groups ([#7025](https://github.com/netbox-community/netbox/issues/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](https://github.com/netbox-community/netbox/issues/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](https://github.com/netbox-community/netbox/issues/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](https://github.com/netbox-community/netbox/issues/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](https://github.com/netbox-community/netbox/issues/14731)) The NetBox UI now integrates directly with the canonical [plugins catalog](https://netboxlabs.com/netbox-plugins/) hosted by [NetBox Labs](https://netboxlabs.com). Users can now explore available plugins and check for newer releases natively within the NetBox user interface. #### User Notifications ([#15621](https://github.com/netbox-community/netbox/issues/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](https://github.com/netbox-community/netbox/issues/7537) - Add a serial number field for virtual machines * [#8198](https://github.com/netbox-community/netbox/issues/8198) - Enable uniqueness enforcement for custom field values * [#8984](https://github.com/netbox-community/netbox/issues/8984) - Enable filtering of custom script output by log level * [#11969](https://github.com/netbox-community/netbox/issues/11969) - Support for tracking airflow on racks and module types * [#14656](https://github.com/netbox-community/netbox/issues/14656) - Dynamically render the custom field edit form depending on the selected field type * [#15106](https://github.com/netbox-community/netbox/issues/15106) - Add `distance` and `distance_unit` fields for wireless links * [#15156](https://github.com/netbox-community/netbox/issues/15156) - Add `display_url` field to all REST API serializers, which links to the corresponding UI view for an object * [#16574](https://github.com/netbox-community/netbox/issues/16574) - Add `last_synced` time to REST API serializer for data sources * [#16580](https://github.com/netbox-community/netbox/issues/16580) - Enable plugin views to enforce `LOGIN_REQUIRED` selectively (remove `AUTH_EXEMPT_PATHS`) * [#16782](https://github.com/netbox-community/netbox/issues/16782) - Enable filtering of selection choices for object and multi-object custom fields * [#16907](https://github.com/netbox-community/netbox/issues/16907) - Update user interface styling * [#17051](https://github.com/netbox-community/netbox/issues/17051) - Introduce `ISOLATED_DEPLOYMENT` config parameter for denoting Internet isolation * [#17221](https://github.com/netbox-community/netbox/issues/17221) - `ObjectEditView` now supports HTMX-based object editing * [#17288](https://github.com/netbox-community/netbox/issues/17288) - Introduce a configurable limit on the number of aliases within a GraphQL API request * [#17289](https://github.com/netbox-community/netbox/issues/17289) - Enforce a standard policy for local passwords by default * [#17318](https://github.com/netbox-community/netbox/issues/17318) - Include the assigned provider in nested API representation of circuits ### Bug Fixes (From Beta1) * [#17086](https://github.com/netbox-community/netbox/issues/17086) - Fix exception when viewing a job with no related object * [#17097](https://github.com/netbox-community/netbox/issues/17097) - Record static object representation when calling `NotificationGroup.notify()` * [#17098](https://github.com/netbox-community/netbox/issues/17098) - Prevent automatic deletion of related notifications when deleting an object * [#17159](https://github.com/netbox-community/netbox/issues/17159) - Correct file paths in plugin installation instructions * [#17163](https://github.com/netbox-community/netbox/issues/17163) - Fix filtering of related services under IP address view * [#17169](https://github.com/netbox-community/netbox/issues/17169) - Avoid duplicating catalog listings for installed plugins * [#17301](https://github.com/netbox-community/netbox/issues/17301) - Correct styling of the edit & delete buttons for custom script modules * [#17302](https://github.com/netbox-community/netbox/issues/17302) - Fix log level filtering support for custom script messages * [#17306](https://github.com/netbox-community/netbox/issues/17306) - Correct rounding of reported VLAN group utilization ### Plugins * [#15692](https://github.com/netbox-community/netbox/issues/15692) - Introduce improved plugin support for background jobs * [#16359](https://github.com/netbox-community/netbox/issues/16359) - Enable plugins to embed content in the top navigation bar * [#16726](https://github.com/netbox-community/netbox/issues/16726) - Extend `PluginTemplateExtension` to enable registering multiple models * [#16776](https://github.com/netbox-community/netbox/issues/16776) - Add an `alerts()` method to `PluginTemplateExtension` for embedding important information on object views * [#16886](https://github.com/netbox-community/netbox/issues/16886) - Introduce a mechanism for plugins to register custom event types (for use with user notifications) ### Other Changes * [#14692](https://github.com/netbox-community/netbox/issues/14692) - Change the atomic unit for virtual disks from 1GB to 1MB * [#14861](https://github.com/netbox-community/netbox/issues/14861) - The URL path for UI views concerning virtual disks has been standardized to `/virtualization/virtual-disks/` * [#15410](https://github.com/netbox-community/netbox/issues/15410) - Remove various deprecated query filters * [#15908](https://github.com/netbox-community/netbox/issues/15908) - Indicate product edition in release data * [#16388](https://github.com/netbox-community/netbox/issues/16388) - Move all change logging resources from `extras` to `core` * [#16884](https://github.com/netbox-community/netbox/issues/16884) - Remove the ID column from the default table configuration for changelog records * [#16988](https://github.com/netbox-community/netbox/issues/16988) - Relocate rack items in navigation menu * [#17143](https://github.com/netbox-community/netbox/issues/17143) - The use of legacy "nested" serializer classes has been deprecated --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 00:19:49 +01:00
adam closed this issue 2025-12-30 00:19:49 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#15076
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?