2023-01-09 10:13:40 -05:00
# NetBox v3.5
2023-01-09 10:08:26 -05:00
2023-05-05 12:58:09 -04:00
## v3.5.2 (FUTURE)
2023-05-05 15:25:08 -04:00
### Enhancements
2023-05-12 11:00:33 -04:00
* [#7671 ](https://github.com/netbox-community/netbox/issues/7671 ) - Introduce `REMOTE_AUTH_AUTO_CREATE_GROUPS` config parameter to enable the automatic creation of new groups when remote authentication is in use
2023-05-15 09:13:11 -04:00
* [#11017 ](https://github.com/netbox-community/netbox/issues/11017 ) - Increase the maximum values for allocated and maximum power draws
2023-05-12 11:00:33 -04:00
* [#11233 ](https://github.com/netbox-community/netbox/issues/11233 ) - Intercept and cleanly report errors upon attempted database writes when maintenance mode is enabled
* [#11599 ](https://github.com/netbox-community/netbox/issues/11599 ) - Move contacts panels to separate tabs under object views
2023-05-10 09:39:25 -04:00
* [#11670 ](https://github.com/netbox-community/netbox/issues/11670 ) - Enable setting device type & module type weight via bulk import
* [#11900 ](https://github.com/netbox-community/netbox/issues/11900 ) - Add an outline to the reservation markers on rack elevations
* [#12131 ](https://github.com/netbox-community/netbox/issues/12131 ) - Show custom field description as an icon tooltip under object views
2023-05-05 15:25:08 -04:00
* [#12223 ](https://github.com/netbox-community/netbox/issues/12223 ) - Add columns for parent device bay and position to devices list
2023-05-10 09:39:25 -04:00
* [#12233 ](https://github.com/netbox-community/netbox/issues/12233 ) - Move related IP addresses table to a separate tab
* [#12286 ](https://github.com/netbox-community/netbox/issues/12286 ) - Show height and total weight under device view
* [#12323 ](https://github.com/netbox-community/netbox/issues/12323 ) - Add 100GE CXP interface type
2023-05-05 15:25:08 -04:00
* [#12498 ](https://github.com/netbox-community/netbox/issues/12498 ) - Hide map button if `MAPS_URL` is empty
2023-05-12 11:00:33 -04:00
* [#12554 ](https://github.com/netbox-community/netbox/issues/12554 ) - Allow customization or disabling of the maintenance mode banner
2023-05-05 15:25:08 -04:00
2023-05-10 10:44:01 -04:00
### Bug Fixes
2023-05-12 11:00:33 -04:00
* [#10686 ](https://github.com/netbox-community/netbox/issues/10686 ) - Enable specifying termination object by virtual chassis master when importing cables
2023-05-15 09:13:11 -04:00
* [#12468 ](https://github.com/netbox-community/netbox/issues/12468 ) - Custom field names should not permit double underscores
2023-05-10 10:44:01 -04:00
* [#12550 ](https://github.com/netbox-community/netbox/issues/12550 ) - Fix rear port selection widget under front port creation form
2023-05-12 11:08:32 -04:00
* [#12570 ](https://github.com/netbox-community/netbox/issues/12570 ) - Disable ordering of synchronized object tables by the "synced" attribute
2023-05-10 10:44:01 -04:00
2023-05-05 12:58:09 -04:00
---
2023-05-05 12:29:10 -04:00
## v3.5.1 (2023-05-05)
2023-04-27 14:52:07 -04:00
2023-05-05 12:31:12 -04:00
### Enhancements
2023-05-03 09:32:48 -04:00
* [#10759 ](https://github.com/netbox-community/netbox/issues/10759 ) - Support Markdown rendering for custom field descriptions
2023-05-05 10:01:54 -04:00
* [#11190 ](https://github.com/netbox-community/netbox/issues/11190 ) - Including systemd service & timer configurations for housekeeping tasks
2023-05-03 09:32:48 -04:00
* [#11422 ](https://github.com/netbox-community/netbox/issues/11422 ) - Match on power panel name when searching for power feeds
* [#11504 ](https://github.com/netbox-community/netbox/issues/11504 ) - Add filter to select individual racks under rack elevations view
2023-05-04 14:14:21 -04:00
* [#11652 ](https://github.com/netbox-community/netbox/issues/11652 ) - Add a module status column to module bay tables
* [#11791 ](https://github.com/netbox-community/netbox/issues/11791 ) - Enable configuration of custom database backend via `ENGINE` parameter
2023-05-05 10:01:54 -04:00
* [#11801 ](https://github.com/netbox-community/netbox/issues/11801 ) - Include device description within rack elevation tooltip
* [#11932 ](https://github.com/netbox-community/netbox/issues/11932 ) - Introduce a list view for image attachments, orderable by date and other attributes
* [#12122 ](https://github.com/netbox-community/netbox/issues/12122 ) - Enable bulk import oj journal entries
* [#12245 ](https://github.com/netbox-community/netbox/issues/12245 ) - Enable the assignment of wireless LANs to interfaces under bulk edit
2023-05-03 09:32:48 -04:00
2023-05-01 14:19:56 -04:00
### Bug Fixes
2023-05-04 14:14:21 -04:00
* [#10757 ](https://github.com/netbox-community/netbox/issues/10757 ) - Simplify IP address interface and NAT IP assignment form fields to avoid confusion
2023-05-05 10:01:54 -04:00
* [#11715 ](https://github.com/netbox-community/netbox/issues/11715 ) - Prefix within a VRF should list global prefixes as parents only if they are containers
2023-05-04 14:14:21 -04:00
* [#12363 ](https://github.com/netbox-community/netbox/issues/12363 ) - Fix whitespace for paragraph elements in Markdown-rendered table columns
2023-05-02 16:40:56 -04:00
* [#12367 ](https://github.com/netbox-community/netbox/issues/12367 ) - Fix `RelatedObjectDoesNotExist` exception under certain conditions (regression from #11550 )
2023-05-01 14:19:56 -04:00
* [#12380 ](https://github.com/netbox-community/netbox/issues/12380 ) - Allow selecting object change as model under object list widget configuration
2023-05-01 16:19:39 -04:00
* [#12384 ](https://github.com/netbox-community/netbox/issues/12384 ) - Add a three-second timeout for RSS reader widget
2023-05-01 14:19:56 -04:00
* [#12395 ](https://github.com/netbox-community/netbox/issues/12395 ) - Fix "create & add another" action for objects with custom fields
* [#12396 ](https://github.com/netbox-community/netbox/issues/12396 ) - Provider account should not be a required field in REST API serializer
2023-05-02 09:28:15 -04:00
* [#12400 ](https://github.com/netbox-community/netbox/issues/12400 ) - Validate default values for object and multi-object custom fields
2023-05-01 16:51:10 -04:00
* [#12401 ](https://github.com/netbox-community/netbox/issues/12401 ) - Support the creation of front ports without a pre-populated device ID
2023-05-01 14:19:56 -04:00
* [#12405 ](https://github.com/netbox-community/netbox/issues/12405 ) - Fix filtering for VLAN groups displayed under site view
2023-05-02 16:40:56 -04:00
* [#12410 ](https://github.com/netbox-community/netbox/issues/12410 ) - Fix base path for OpenAPI schema (fixes Swagger UI requests)
2023-05-05 10:01:54 -04:00
* [#12416 ](https://github.com/netbox-community/netbox/issues/12416 ) - Fix `FileNotFoundError` exception when a managed script file is missing from disk
2023-05-01 14:19:56 -04:00
* [#12412 ](https://github.com/netbox-community/netbox/issues/12412 ) - Device/VM interface MAC addresses can be nullified via REST API
2023-05-02 08:46:54 -04:00
* [#12415 ](https://github.com/netbox-community/netbox/issues/12415 ) - Fix `ImportError` exception when running RQ worker
2023-05-03 09:32:48 -04:00
* [#12433 ](https://github.com/netbox-community/netbox/issues/12433 ) - Correct the application of URL query parameters for object list dashboard widgets
2023-05-02 16:40:56 -04:00
* [#12436 ](https://github.com/netbox-community/netbox/issues/12436 ) - Remove extraneous "add" button from contact assignments list
2023-05-05 10:17:13 -04:00
* [#12463 ](https://github.com/netbox-community/netbox/issues/12463 ) - Fix the association of completed jobs with reports & scripts in the REST API
2023-05-04 14:14:21 -04:00
* [#12464 ](https://github.com/netbox-community/netbox/issues/12464 ) - Apply credentials for git data source only when connecting via HTTP/S
2023-05-05 10:01:54 -04:00
* [#12476 ](https://github.com/netbox-community/netbox/issues/12476 ) - Fix `TypeError` exception when running the `runscript` management command
* [#12483 ](https://github.com/netbox-community/netbox/issues/12483 ) - Fix git remote data syncing when with HTTP proxies defined
* [#12496 ](https://github.com/netbox-community/netbox/issues/12496 ) - Remove obsolete account field from provider UI view
2023-05-01 14:19:56 -04:00
2023-04-27 14:52:07 -04:00
---
2023-04-27 14:24:44 -04:00
## v3.5.0 (2023-04-27)
2023-01-09 10:08:26 -05:00
2023-03-27 12:17:42 -04:00
### Breaking Changes
2023-04-11 15:56:34 -04:00
* The `account` field has been removed from the provider model. This information is now tracked using the new provider account model. Multiple accounts can be assigned per provider.
2023-04-27 10:35:39 -04:00
* A minimum length of 50 characters is now enforced for the `SECRET_KEY` configuration parameter.
2023-03-27 12:17:42 -04:00
* The JobResult model has been moved from the `extras` app to `core` and renamed to Job. Accordingly, its REST API endpoint has been moved from `/api/extras/job-results/` to `/api/core/jobs/` .
* The `obj_type` field on the Job model (previously JobResult) has been renamed to `object_type` for consistency with other models.
* The `JOBRESULT_RETENTION` configuration parameter has been renamed to `JOB_RETENTION` .
2023-04-19 09:58:18 -04:00
* The `obj` context variable is no longer passed when rendering custom links: Use `object` instead.
2023-03-30 14:36:02 -04:00
* The REST API schema is now generated using the OpenAPI 3.0 spec
* The URLs for the REST API schema documentation have changed:
* `/api/docs/` is now `/api/schema/swagger-ui/`
* `/api/redoc/` is now `/api/schema/redoc/`
2023-03-27 12:17:42 -04:00
2023-02-24 16:46:01 -05:00
### New Features
#### Customizable Dashboard ([#9416](https://github.com/netbox-community/netbox/issues/9416))
2023-03-30 13:21:03 -04:00
The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the information most pertinent to them. Supported widgets include object statistics, configurable object lists, RSS feeds, and notes, and we expect to continue adding new widgets over time.
2023-02-24 16:46:01 -05:00
#### Remote Data Sources ([#11558](https://github.com/netbox-community/netbox/issues/11558))
2023-03-15 12:11:52 -04:00
NetBox now has the ability to synchronize arbitrary data from external sources through the new [DataSource ](../models/core/datasource.md ) and [DataFile ](../models/core/datafile.md ) models. Synchronized files are stored in the PostgreSQL database, and may be referenced and consumed by other NetBox models, such as export templates and config contexts. Currently, replication from local filesystem paths, git repositories, and Amazon S3 buckets is supported, and we expect to introduce additional backends in the near future.
2023-02-24 16:46:01 -05:00
#### Configuration Template Rendering ([#11559](https://github.com/netbox-community/netbox/issues/11559))
This release introduces the ability to render device configurations from Jinja2 templates natively within NetBox, via both the UI and REST API. The new [ConfigTemplate ](../models/extras/configtemplate.md ) model stores template code (which may be defined locally or sourced from remote data files). The rendering engine passes data gleaned from both config contexts and request parameters to generate complete configurations suitable for direct application to network devices.
2023-04-27 14:24:44 -04:00
#### NAPALM Integration Plugin ([#10520](https://github.com/netbox-community/netbox/issues/10520))
2023-02-24 16:46:01 -05:00
2023-03-30 13:21:03 -04:00
The NAPALM integration feature found in previous NetBox releases has been moved from the core application to a [dedicated plugin ](https://github.com/netbox-community/netbox-napalm ). This allows greater control over the feature's configuration and will unlock additional potential as a separate project.
2023-02-24 16:46:01 -05:00
2023-02-27 16:36:05 -05:00
#### ASN Ranges ([#8550](https://github.com/netbox-community/netbox/issues/8550))
A new ASN range model has been introduced to facilitate the provisioning of new autonomous system numbers from within a prescribed range. For example, an administrator might define an ASN range of 65000-65099 to be used for internal site identification. This includes a REST API endpoint suitable for automatic provisioning, very similar to the allocation of available prefixes and IP addresses.
2023-03-29 08:31:40 -04:00
#### Provider Accounts ([#9047](https://github.com/netbox-community/netbox/issues/9047))
A new model has been introduced to represent individual accounts within a common circuit provider. This replaces the `account` field on the provider model, enabling users to track multiple accounts per provider. New provider account instances will be created automatically during upgrade for all providers which currently have an account assigned. The assignment of individual circuits to a provider account remains optional.
2023-03-20 16:37:47 -04:00
#### Job-Triggered Webhooks ([#8958](https://github.com/netbox-community/netbox/issues/8958))
Two new webhook trigger events have been introduced: `job_start` and `job_end` . These enable users to configure webhook to trigger when a background job starts or ends, respectively. This new functionality can be used, for example, to inform a remote system when a custom script has been executed.
2023-01-13 11:41:57 -05:00
### Enhancements
2023-02-28 10:09:09 -05:00
* [#7947 ](https://github.com/netbox-community/netbox/issues/7947 ) - Enable marking IP ranges as fully utilized
2023-03-30 13:21:03 -04:00
* [#8184 ](https://github.com/netbox-community/netbox/issues/8184 ) - Employ HTMX to dynamically render tables listing related objects
2023-03-10 09:00:28 -05:00
* [#8272 ](https://github.com/netbox-community/netbox/issues/8272 ) - Support bridge relationships among device type interfaces
2023-03-14 15:18:03 -04:00
* [#8749 ](https://github.com/netbox-community/netbox/issues/8749 ) - Support replicating custom field values when cloning an object
2023-02-07 16:44:05 -05:00
* [#9073 ](https://github.com/netbox-community/netbox/issues/9073 ) - Enable syncing config context data from remote sources
2023-02-24 16:46:01 -05:00
* [#9653 ](https://github.com/netbox-community/netbox/issues/9653 ) - Enable setting a default platform for device types
2023-03-13 15:15:38 -04:00
* [#10054 ](https://github.com/netbox-community/netbox/issues/10054 ) - Introduce advanced object selector for UI forms
2023-03-20 16:37:47 -04:00
* [#10242 ](https://github.com/netbox-community/netbox/issues/10242 ) - Redirect to filtered objects list after bulk import
* [#10374 ](https://github.com/netbox-community/netbox/issues/10374 ) - Require unique tenant names & slugs per group
2023-02-28 13:33:40 -05:00
* [#10729 ](https://github.com/netbox-community/netbox/issues/10729 ) - Add date & time custom field type
2023-04-10 10:40:56 -04:00
* [#11029 ](https://github.com/netbox-community/netbox/issues/11029 ) - Enable change logging for cable terminations
2023-01-13 11:41:57 -05:00
* [#11254 ](https://github.com/netbox-community/netbox/issues/11254 ) - Introduce the `X-Request-ID` HTTP header to annotate the unique ID of each request for change logging
2023-04-17 13:12:14 -04:00
* [#11255 ](https://github.com/netbox-community/netbox/issues/11255 ) - Introduce the `scheduling_enabled` settings for reports & scripts
2023-03-23 08:44:42 -04:00
* [#11291 ](https://github.com/netbox-community/netbox/issues/11291 ) - Optimized GraphQL API request handling
2023-01-24 09:41:56 -05:00
* [#11440 ](https://github.com/netbox-community/netbox/issues/11440 ) - Add an `enabled` field for device type interfaces
2023-03-16 16:29:43 -04:00
* [#11494 ](https://github.com/netbox-community/netbox/issues/11494 ) - Enable filtering objects by create/update request IDs
2023-01-31 10:07:24 -05:00
* [#11517 ](https://github.com/netbox-community/netbox/issues/11517 ) - Standardize the inclusion of related objects across the entire UI
* [#11584 ](https://github.com/netbox-community/netbox/issues/11584 ) - Add a list view for contact assignments
* [#11625 ](https://github.com/netbox-community/netbox/issues/11625 ) - Add HTMX support to ObjectEditView
2023-02-09 09:22:43 -05:00
* [#11693 ](https://github.com/netbox-community/netbox/issues/11693 ) - Enable syncing export template content from remote sources
2023-03-14 14:53:26 -04:00
* [#11780 ](https://github.com/netbox-community/netbox/issues/11780 ) - Enable loading import data from remote sources
2023-03-30 13:21:03 -04:00
* [#11790 ](https://github.com/netbox-community/netbox/issues/11790 ) - Create database indexes for all generic foreign keys
2023-03-13 15:15:38 -04:00
* [#11968 ](https://github.com/netbox-community/netbox/issues/11968 ) - Add navigation menu buttons to create device & VM components
2023-03-30 13:21:03 -04:00
* [#12068 ](https://github.com/netbox-community/netbox/issues/12068 ) - Enable generic foreign key relationships from jobs to NetBox objects
2023-03-29 16:58:35 -04:00
* [#12085 ](https://github.com/netbox-community/netbox/issues/12085 ) - Add a file source view for reports
2023-04-25 14:49:43 -04:00
* [#12218 ](https://github.com/netbox-community/netbox/issues/12218 ) - Provide more relevant API endpoint descriptions in schema
2023-04-27 10:35:39 -04:00
* [#12343 ](https://github.com/netbox-community/netbox/issues/12343 ) - Enforce a minimum length for `SECRET_KEY` configuration parameter
2023-01-13 11:41:57 -05:00
2023-04-21 11:40:28 -04:00
### Bug Fixes (From Beta2)
* [#12149 ](https://github.com/netbox-community/netbox/issues/12149 ) - Fix OpenAPI schema warnings relating to enum collisions
2023-04-25 14:49:43 -04:00
* [#12195 ](https://github.com/netbox-community/netbox/issues/12195 ) - Fix exception when setting IP address role to null via REST API
2023-04-21 11:40:28 -04:00
* [#12256 ](https://github.com/netbox-community/netbox/issues/12256 ) - Fix OpenAPI schema warnings relating to nested serializers
2023-04-25 14:49:43 -04:00
* [#12278 ](https://github.com/netbox-community/netbox/issues/12278 ) - Fix schema warnings related to IPAddressField
2023-04-21 11:40:28 -04:00
* [#12288 ](https://github.com/netbox-community/netbox/issues/12288 ) - Include `servers` definition in OpenAPI spec
2023-04-21 11:54:28 -04:00
* [#12299 ](https://github.com/netbox-community/netbox/issues/12299 ) - Fix object list widget support for filtering by multiple values
2023-03-31 08:59:15 -04:00
2023-01-09 10:08:26 -05:00
### Other Changes
2023-04-11 15:56:34 -04:00
* [#9608 ](https://github.com/netbox-community/netbox/issues/9608 ) - Upgrade REST API schema to OpenAPI 3.0
2023-01-09 10:13:40 -05:00
* [#10604 ](https://github.com/netbox-community/netbox/issues/10604 ) - Remove unused `extra_tabs` block from `object.html` generic template
2023-01-09 10:08:26 -05:00
* [#10923 ](https://github.com/netbox-community/netbox/issues/10923 ) - Remove unused `NetBoxModelCSVForm` class (replaced by `NetBoxModelImportForm` )
2023-03-31 09:52:07 -04:00
* [#11489 ](https://github.com/netbox-community/netbox/issues/11489 ) - Consolidated several middleware classes
2023-01-27 16:30:31 -05:00
* [#11611 ](https://github.com/netbox-community/netbox/issues/11611 ) - Refactor API viewset classes and introduce NetBoxReadOnlyModelViewSet
2023-02-24 16:46:01 -05:00
* [#11694 ](https://github.com/netbox-community/netbox/issues/11694 ) - Remove obsolete `SmallTextarea` form widget
* [#11737 ](https://github.com/netbox-community/netbox/issues/11737 ) - `ChangeLoggedModel` now inherits `WebhooksMixin`
* [#11765 ](https://github.com/netbox-community/netbox/issues/11765 ) - Retire the `StaticSelect` and `StaticSelectMultiple` form widgets
2023-03-30 13:21:03 -04:00
* [#11955 ](https://github.com/netbox-community/netbox/issues/11955 ) - Remove the unused `CSVDataField` and `CSVFileField` classes
2023-03-27 12:17:42 -04:00
* [#12067 ](https://github.com/netbox-community/netbox/issues/12067 ) - Move & rename `extras.JobResult` to `core.Job`
2023-03-20 16:37:47 -04:00
### REST API Changes
* All API responses now include a `X-Request-ID` HTTP header indicating the request's unique ID
2023-03-23 08:44:42 -04:00
* Introduced new endpoints:
2023-03-29 08:31:40 -04:00
* `/api/circuits/provider-accounts/`
2023-03-23 08:44:42 -04:00
* `/api/core/data-files/`
* `/api/core/data-sources/`
* `/api/dcim/device/<id>/render-config/`
* `/api/extras/config-templates/`
* `/api/ipam/asn-ranges/`
2023-03-29 08:31:40 -04:00
* Removed existing endpoints:
2023-03-23 08:44:42 -04:00
* `/api/dcim/device/<id>/napalm/`
2023-03-29 08:31:40 -04:00
* circuits.Circuit
* Added the optional `account` foreign key to ProviderAccount
* circuits.Provider
* Removed the `account` field
2023-04-10 10:40:56 -04:00
* dcim.CableTermination
* Added `default_platform` foreign key (optional)
2023-03-23 08:44:42 -04:00
* dcim.DeviceType
2023-03-20 16:37:47 -04:00
* Added `default_platform` foreign key (optional)
* dcim.InterfaceTemplate
2023-03-23 08:44:42 -04:00
* Added `enabled` boolean field
2023-03-20 16:37:47 -04:00
* Added optional `bridge` foreign key (optional)
* extras.ConfigContext
* Added `data_source` , `data_file` , `data_path` , and `data_synced` fields to enable syncing data from remote sources
2023-03-23 08:44:42 -04:00
* extras.ExportTemplate
* Added `data_source` , `data_file` , `data_path` , and `data_synced` fields to enable syncing content from remote sources
2023-03-20 16:37:47 -04:00
* extras.Webhook
* Added `type_job_start` and `type_job_end` boolean fields
* ipam.ASN
* The `rir` field now fully represents the assigned RIR (if any)
* ipam.IPRange
* Added the `mark_utilized` boolean field (default: false)