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

[PR #10051] [MERGED] Release v3.3.0 #13550

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

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/10051
Author: @jeremystretch
Created: 8/17/2022
Status: ✅ Merged
Merged: 8/17/2022
Merged by: @jeremystretch

Base: master ← Head: develop

📝 Commits (10+)

  • bb9eb11 Extend cable tracing tests
  • 594964a Simplify Cable init signature
  • 3a461d0 Update Cable instantiations to match new signature
  • 4c51dbb Update connected_endpoint serializer field to support multiple objects
  • 3082c76 Update object trace() method
  • 6ff2e55 Add origins, destinations properties on CablePath
  • 9516270 Test cleanup
  • 1b59338 Restore reverse relation to CableTerminations from Cable
  • 906c3dc Tests cleanup
  • 399afff Fix CablePath migration

📊 Changes

450 files changed (+13860 additions, -5905 deletions)

View changed files

📝 .github/ISSUE_TEMPLATE/bug_report.yaml (+1 -1)
📝 .github/ISSUE_TEMPLATE/feature_request.yaml (+1 -1)
📝 base_requirements.txt (+6 -3)
➕ docs/_theme/main.html (+9 -0)
➖ docs/additional-features/webhooks.md (+0 -57)
📝 docs/administration/housekeeping.md (+2 -2)
📝 docs/administration/permissions.md (+70 -3)
➕ docs/configuration/data-validation.md (+86 -0)
➕ docs/configuration/date-time.md (+20 -0)
➕ docs/configuration/default-values.md (+77 -0)
➕ docs/configuration/development.md (+21 -0)
➖ docs/configuration/dynamic-settings.md (+0 -232)
📝 docs/configuration/index.md (+38 -12)
➕ docs/configuration/miscellaneous.md (+159 -0)
➕ docs/configuration/napalm.md (+51 -0)
➖ docs/configuration/optional-settings.md (+0 -487)
➕ docs/configuration/plugins.md (+35 -0)
📝 docs/configuration/remote-authentication.md (+16 -16)
📝 docs/configuration/required-parameters.md (+0 -0)
➕ docs/configuration/security.md (+144 -0)

...and 80 more files

📄 Description

Breaking Changes

  • Device position, device type height, and rack unit values are now reported as decimals (e.g. 1.0 or 1.5) to support modeling half-height rack units.
  • The nat_outside relation on the IP address model now returns a list of zero or more related IP addresses, rather than a single instance (or None).
  • Several fields on the cable API serializers have been altered or removed to support multiple-object cable terminations:
Old Name Old Type New Name New Type
termination_a_type string Removed -
termination_b_type string Removed -
termination_a_id integer Removed -
termination_b_id integer Removed -
termination_a object a_terminations list
termination_b object b_terminations list
  • As with the cable model, several API fields on all objects to which cables can be connected (interfaces, circuit terminations, etc.) have been changed:
Old Name Old Type New Name New Type
link_peer object link_peers list
link_peer_type string link_peers_type string
connected_endpoint object connected_endpoints list
connected_endpoint_type string connected_endpoints_type string
connected_endpoint_reachable boolean connected_endpoints_reachable boolean
  • The cable path serialization returned by the /paths/ endpoint for pass-through ports has been simplified, and the following fields removed: origin_type, origin, destination_type, destination. (Additionally, is_complete has been added.)

New Features

Multi-object Cable Terminations (#9102)

When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to individual termination ports and breakout cables, for example. (Note that all terminations attached to one end of a cable must be the same object type, but do not need to connect to the same parent object.) Additionally, cable terminations can now be modified without needing to delete and recreate the cable.

L2VPN Modeling (#8157)

NetBox can now model a variety of L2 VPN technologies, including VXLAN, VPLS, and others. Interfaces and VLANs can be attached to L2VPNs to track connectivity across an overlay. Similarly to VRFs, each L2VPN can also have import and export route targets associated with it.

PoE Interface Attributes (#1099)

Two new fields have been added to the device interface model to track Power over Ethernet (PoE) capabilities:

  • PoE mode: Power supplying equipment (PSE) or powered device (PD)
  • PoE type: Applicable IEEE standard or other power type

Half-Height Rack Units (#51)

Device type height can now be specified in 0.5U increments, allowing for the creation of devices consume partial rack units. Additionally, a device can be installed at the half-unit mark within a rack (e.g. U2.5). For example, two half-height devices positioned in sequence will consume a single rack unit; two consecutive 1.5U devices will consume 3U of space.

Restrict API Tokens by Client IP (#8233)

API tokens can now be restricted to use by certain client IP addresses or networks. For example, an API token with its allowed_ips list set to [192.0.2.0/24] will permit authentication only from API clients within that network; requests from other sources will fail authentication. This enables administrators to restrict the use of a token to specific clients.

Reference User in Permission Constraints (#9074)

NetBox's permission constraints have been expanded to support referencing the current user associated with a request using the special $user token. As an example, this enables an administrator to efficiently grant each user to edit his or her own journal entries, but not those created by other users.

{
  "created_by": "$user"
}

Custom Field Grouping (#8495)

A group_name field has been added to the custom field model to enable organizing related custom fields by group. Similarly to custom links, custom fields which have been assigned to the same group will be rendered within that group when viewing an object in the UI. (Custom field grouping has no effect on API operation.)

Toggle Custom Field Visibility (#9166)

The behavior of each custom field within the NetBox UI can now be controlled individually by toggling its UI visibility. Three options are available:

  • Read/write: The custom field is included when viewing and editing objects (default).
  • Read-only: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.)
  • Hidden: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users.

Custom field UI visibility has no impact on API operation.

Enhancements

  • #1202 - Support overlapping assignment of NAT IP addresses
  • #4350 - Illustrate reservations vertically alongside rack elevations
  • #4434 - Enable highlighting devices within rack elevations
  • #5303 - A virtual machine may be assigned to a site and/or cluster
  • #7120 - Add termination_date field to Circuit
  • #7744 - Add status field to Location
  • #8171 - Populate next available address when cloning an IP
  • #8222 - Enable the assignment of a VM to a specific host device within a cluster
  • #8471 - Add status field to Cluster
  • #8511 - Enable custom fields and tags for circuit terminations
  • #8995 - Enable arbitrary ordering of REST API results
  • #9070 - Hide navigation menu items based on user permissions
  • #9177 - Add tenant assignment for wireless LANs & links
  • #9391 - Remove 500-character limit for custom link text & URL fields
  • #9536 - Track API token usage times
  • #9582 - Enable assigning config contexts based on device location

Bug Fixes (from Beta2)

  • #9758 - Display parent object of connected termination
  • #9900 - Pre-populate site & rack fields for cable connection form
  • #9938 - Exclude virtual interfaces from terminations list when connecting a cable
  • #9939 - Fix list of next nodes for split paths under trace view

Plugins API

  • #9075 - Introduce AbortRequest exception for cleanly interrupting object mutations
  • #9092 - Add support for ObjectChildrenView generic view
  • #9228 - Subclasses of ChangeLoggingMixin can override serialize_object() to control JSON serialization for change logging
  • #9414 - Add clone() method to NetBoxModel for copying instance attributes
  • #9647 - Introduce customfield_value template tag

Other Changes

  • #9261 - NetBoxTable no longer automatically clears pre-existing calls to prefetch_related() on its queryset
  • #9434 - Enabled django-rich test runner for more user-friendly output
  • #9903 - Implement a mechanism for automatically updating denormalized fields

🔄 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/10051 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 8/17/2022 **Status:** ✅ Merged **Merged:** 8/17/2022 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `master` ← **Head:** `develop` --- ### 📝 Commits (10+) - [`bb9eb11`](https://github.com/netbox-community/netbox/commit/bb9eb119a424dad0d7abca0b6d0c91d993a5d0ae) Extend cable tracing tests - [`594964a`](https://github.com/netbox-community/netbox/commit/594964aebe2d98785cffb5bf1cfc968d95ee6239) Simplify Cable init signature - [`3a461d0`](https://github.com/netbox-community/netbox/commit/3a461d02793e6f9d41c2b1a92647e691de1abaac) Update Cable instantiations to match new signature - [`4c51dbb`](https://github.com/netbox-community/netbox/commit/4c51dbba809b6b199a96da30f32f4dd3cd6ea6ed) Update connected_endpoint serializer field to support multiple objects - [`3082c76`](https://github.com/netbox-community/netbox/commit/3082c76ec67353b15df84579c83aa46174c4e7c4) Update object trace() method - [`6ff2e55`](https://github.com/netbox-community/netbox/commit/6ff2e55ce408f0f7f2fe99129048421c25ecafe6) Add origins, destinations properties on CablePath - [`9516270`](https://github.com/netbox-community/netbox/commit/951627093c11584ffb73ad2be2aef40a91a90934) Test cleanup - [`1b59338`](https://github.com/netbox-community/netbox/commit/1b593384e597d7f60077e27d0777317fac6215fa) Restore reverse relation to CableTerminations from Cable - [`906c3dc`](https://github.com/netbox-community/netbox/commit/906c3dca8b63dfa9c3ec459346d20e74da3e062c) Tests cleanup - [`399afff`](https://github.com/netbox-community/netbox/commit/399afffddfb4611708bc63ffff39a8a58459de94) Fix CablePath migration ### 📊 Changes **450 files changed** (+13860 additions, -5905 deletions) <details> <summary>View changed files</summary> 📝 `.github/ISSUE_TEMPLATE/bug_report.yaml` (+1 -1) 📝 `.github/ISSUE_TEMPLATE/feature_request.yaml` (+1 -1) 📝 `base_requirements.txt` (+6 -3) ➕ `docs/_theme/main.html` (+9 -0) ➖ `docs/additional-features/webhooks.md` (+0 -57) 📝 `docs/administration/housekeeping.md` (+2 -2) 📝 `docs/administration/permissions.md` (+70 -3) ➕ `docs/configuration/data-validation.md` (+86 -0) ➕ `docs/configuration/date-time.md` (+20 -0) ➕ `docs/configuration/default-values.md` (+77 -0) ➕ `docs/configuration/development.md` (+21 -0) ➖ `docs/configuration/dynamic-settings.md` (+0 -232) 📝 `docs/configuration/index.md` (+38 -12) ➕ `docs/configuration/miscellaneous.md` (+159 -0) ➕ `docs/configuration/napalm.md` (+51 -0) ➖ `docs/configuration/optional-settings.md` (+0 -487) ➕ `docs/configuration/plugins.md` (+35 -0) 📝 `docs/configuration/remote-authentication.md` (+16 -16) 📝 `docs/configuration/required-parameters.md` (+0 -0) ➕ `docs/configuration/security.md` (+144 -0) _...and 80 more files_ </details> ### 📄 Description ### Breaking Changes * Device position, device type height, and rack unit values are now reported as decimals (e.g. `1.0` or `1.5`) to support modeling half-height rack units. * The `nat_outside` relation on the IP address model now returns a list of zero or more related IP addresses, rather than a single instance (or None). * Several fields on the cable API serializers have been altered or removed to support multiple-object cable terminations: | Old Name | Old Type | New Name | New Type | |----------------------|----------|-----------------------|----------| | `termination_a_type` | string | _Removed_ | - | | `termination_b_type` | string | _Removed_ | - | | `termination_a_id` | integer | _Removed_ | - | | `termination_b_id` | integer | _Removed_ | - | | `termination_a` | object | `a_terminations` | list | | `termination_b` | object | `b_terminations` | list | * As with the cable model, several API fields on all objects to which cables can be connected (interfaces, circuit terminations, etc.) have been changed: | Old Name | Old Type | New Name | New Type | |--------------------------------|----------|---------------------------------|----------| | `link_peer` | object | `link_peers` | list | | `link_peer_type` | string | `link_peers_type` | string | | `connected_endpoint` | object | `connected_endpoints` | list | | `connected_endpoint_type` | string | `connected_endpoints_type` | string | | `connected_endpoint_reachable` | boolean | `connected_endpoints_reachable` | boolean | * The cable path serialization returned by the `/paths/` endpoint for pass-through ports has been simplified, and the following fields removed: `origin_type`, `origin`, `destination_type`, `destination`. (Additionally, `is_complete` has been added.) ### New Features #### Multi-object Cable Terminations ([#9102](https://github.com/netbox-community/netbox/issues/9102)) When creating a cable in NetBox, each end can now be attached to multiple termination points. This allows accurate modeling of duplex fiber connections to individual termination ports and breakout cables, for example. (Note that all terminations attached to one end of a cable must be the same object type, but do not need to connect to the same parent object.) Additionally, cable terminations can now be modified without needing to delete and recreate the cable. #### L2VPN Modeling ([#8157](https://github.com/netbox-community/netbox/issues/8157)) NetBox can now model a variety of L2 VPN technologies, including VXLAN, VPLS, and others. Interfaces and VLANs can be attached to L2VPNs to track connectivity across an overlay. Similarly to VRFs, each L2VPN can also have import and export route targets associated with it. #### PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) Two new fields have been added to the device interface model to track Power over Ethernet (PoE) capabilities: * **PoE mode**: Power supplying equipment (PSE) or powered device (PD) * **PoE type**: Applicable IEEE standard or other power type #### Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) Device type height can now be specified in 0.5U increments, allowing for the creation of devices consume partial rack units. Additionally, a device can be installed at the half-unit mark within a rack (e.g. U2.5). For example, two half-height devices positioned in sequence will consume a single rack unit; two consecutive 1.5U devices will consume 3U of space. #### Restrict API Tokens by Client IP ([#8233](https://github.com/netbox-community/netbox/issues/8233)) API tokens can now be restricted to use by certain client IP addresses or networks. For example, an API token with its `allowed_ips` list set to `[192.0.2.0/24]` will permit authentication only from API clients within that network; requests from other sources will fail authentication. This enables administrators to restrict the use of a token to specific clients. #### Reference User in Permission Constraints ([#9074](https://github.com/netbox-community/netbox/issues/9074)) NetBox's permission constraints have been expanded to support referencing the current user associated with a request using the special `$user` token. As an example, this enables an administrator to efficiently grant each user to edit his or her own journal entries, but not those created by other users. ```json { "created_by": "$user" } ``` #### Custom Field Grouping ([#8495](https://github.com/netbox-community/netbox/issues/8495)) A `group_name` field has been added to the custom field model to enable organizing related custom fields by group. Similarly to custom links, custom fields which have been assigned to the same group will be rendered within that group when viewing an object in the UI. (Custom field grouping has no effect on API operation.) #### Toggle Custom Field Visibility ([#9166](https://github.com/netbox-community/netbox/issues/9166)) The behavior of each custom field within the NetBox UI can now be controlled individually by toggling its UI visibility. Three options are available: * **Read/write**: The custom field is included when viewing and editing objects (default). * **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) * **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. Custom field UI visibility has no impact on API operation. ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses * [#4350](https://github.com/netbox-community/netbox/issues/4350) - Illustrate reservations vertically alongside rack elevations * [#4434](https://github.com/netbox-community/netbox/issues/4434) - Enable highlighting devices within rack elevations * [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster * [#7120](https://github.com/netbox-community/netbox/issues/7120) - Add `termination_date` field to Circuit * [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location * [#8171](https://github.com/netbox-community/netbox/issues/8171) - Populate next available address when cloning an IP * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8511](https://github.com/netbox-community/netbox/issues/8511) - Enable custom fields and tags for circuit terminations * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9070](https://github.com/netbox-community/netbox/issues/9070) - Hide navigation menu items based on user permissions * [#9177](https://github.com/netbox-community/netbox/issues/9177) - Add tenant assignment for wireless LANs & links * [#9391](https://github.com/netbox-community/netbox/issues/9391) - Remove 500-character limit for custom link text & URL fields * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location ### Bug Fixes (from Beta2) * [#9758](https://github.com/netbox-community/netbox/issues/9758) - Display parent object of connected termination * [#9900](https://github.com/netbox-community/netbox/issues/9900) - Pre-populate site & rack fields for cable connection form * [#9938](https://github.com/netbox-community/netbox/issues/9938) - Exclude virtual interfaces from terminations list when connecting a cable * [#9939](https://github.com/netbox-community/netbox/issues/9939) - Fix list of next nodes for split paths under trace view ### Plugins API * [#9075](https://github.com/netbox-community/netbox/issues/9075) - Introduce `AbortRequest` exception for cleanly interrupting object mutations * [#9092](https://github.com/netbox-community/netbox/issues/9092) - Add support for `ObjectChildrenView` generic view * [#9228](https://github.com/netbox-community/netbox/issues/9228) - Subclasses of `ChangeLoggingMixin` can override `serialize_object()` to control JSON serialization for change logging * [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes * [#9647](https://github.com/netbox-community/netbox/issues/9647) - Introduce `customfield_value` template tag ### Other Changes * [#9261](https://github.com/netbox-community/netbox/issues/9261) - `NetBoxTable` no longer automatically clears pre-existing calls to `prefetch_related()` on its queryset * [#9434](https://github.com/netbox-community/netbox/issues/9434) - Enabled `django-rich` test runner for more user-friendly output * [#9903](https://github.com/netbox-community/netbox/issues/9903) - Implement a mechanism for automatically updating denormalized fields --- <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-29 23:19:30 +01:00
adam closed this issue 2025-12-29 23:19:30 +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#13550
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?