Breaking Changes
- Device position and rack unit values are now reported as decimals (e.g.
1.0or1.5) to support modeling half-height rack units. - The
nat_outsiderelation 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_completehas been added.)
New Features
Multi-object Cable Terminations (#9102)
When creating a cable in NetBox, each end can now be attached to multiple objects. This allows accurate modeling of duplex fiber connections to individual termination ports and breakout cables, as examples. (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. Each L2VPN can be terminated to multiple device or virtual machine interfaces and/or VLANs 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 half-height devices. 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 only permit authentication from API clients within that network; requests from other sources will fail authentication. This can be very useful for restricting 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 links which have been assigned to a common 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 settings 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_datefield to Circuit - #7744 - Add
statusfield 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
statusfield 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 Beta1)
- #9728 - Fix validation when assigning a virtual machine to a device
- #9729 - Fix ordering of content type creation to ensure compatability with demo data
- #9730 - Fix validation error when creating a new cable via UI form
- #9733 - Handle split paths during trace when fanning out to front ports with differing cables
- #9765 - Report correct segment count under cable trace UI view
- #9778 - Fix exception during cable deletion after deleting a connected termination
- #9788 - Ensure denormalized fields on CableTermination are kept in sync with related objects
- #9789 - Fix rendering of cable traces ending at provider networks
- #9794 - Fix link to connect a rear port to a circuit termination
- #9818 - Fix circuit side selection when connecting a cable to a circuit termination
- #9829 - Arrange custom fields by group when editing objects
- #9843 - Fix rendering of custom field values (regression from #9647)
- #9844 - Fix interface api request when creating/editing L2VPN termination
- #9847 - Respect
desc_unitswhen ordering rack units
Plugins API
- #9075 - Introduce
AbortRequestexception for cleanly interrupting object mutations - #9092 - Add support for
ObjectChildrenViewgeneric view - #9228 - Subclasses of
ChangeLoggingMixincan overrideserialize_object()to control JSON serialization for change logging - #9414 - Add
clone()method to NetBoxModel for copying instance attributes - #9647 - Introduce
customfield_valuetemplate tag