mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code
netbox-community-netbox/docs/release-notes/version-3.5.md

11 KiB
Raw Blame History

NetBox v3.5

v3.5.0 (FUTURE)

Breaking Changes

  • 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.
  • 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/

New Features

Customizable Dashboard (#9416)

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.

Remote Data Sources (#11558)

NetBox now has the ability to synchronize arbitrary data from external sources through the new DataSource and DataFile 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.

Configuration Template Rendering (#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 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.

NAPALM Plugin (#10520)

The NAPALM integration feature found in previous NetBox releases has been moved from the core application to a dedicated plugin. This allows greater control over the feature's configuration and will unlock additional potential as a separate project.

ASN Ranges (#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.

Provider Accounts (#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.

Job-Triggered Webhooks (#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.

Enhancements

  • #7947 - Enable marking IP ranges as fully utilized
  • #8184 - Employ HTMX to dynamically render tables listing related objects
  • #8272 - Support bridge relationships among device type interfaces
  • #8749 - Support replicating custom field values when cloning an object
  • #9073 - Enable syncing config context data from remote sources
  • #9653 - Enable setting a default platform for device types
  • #10054 - Introduce advanced object selector for UI forms
  • #10242 - Redirect to filtered objects list after bulk import
  • #10374 - Require unique tenant names & slugs per group
  • #10729 - Add date & time custom field type
  • #11254 - Introduce the X-Request-ID HTTP header to annotate the unique ID of each request for change logging
  • #11291 - Optimized GraphQL API request handling
  • #11440 - Add an enabled field for device type interfaces
  • #11494 - Enable filtering objects by create/update request IDs
  • #11517 - Standardize the inclusion of related objects across the entire UI
  • #11584 - Add a list view for contact assignments
  • #11625 - Add HTMX support to ObjectEditView
  • #11693 - Enable syncing export template content from remote sources
  • #11780 - Enable loading import data from remote sources
  • #11790 - Create database indexes for all generic foreign keys
  • #11968 - Add navigation menu buttons to create device & VM components
  • #12068 - Enable generic foreign key relationships from jobs to NetBox objects
  • #12085 - Add a file source view for reports

Bug Fixes (From Beta1)

  • #12103 - Limit the types of objects available for object count & list widgets
  • #12105 - Prevent data sources from becoming stuck in "syncing" status when an exception is raised
  • #12106 - Fix exception when saving dashboard widget with minimum width/height
  • #12108 - Limit the draggable area of widgets to their headers
  • #12109 - Fix migration error when replicating more than 100 job results
  • #12112 - Do not link data source URL for local paths
  • #12115 - Fix rendering config templates from a data file
  • #12144 - Ensure consistent treatment of context data when rendering config templates via UI & API
  • #12145 - Employ HTMXSelect widget to fix inclusion of <select> field values during form regeneration
  • #12146 - Do not display object selector for disabled fields
  • #12151 - Remove incorrect OpenAPI string mapping for choice fields
  • #12167 - Catch and report on exceptions raised when rendering a config template

Other Changes

  • #10604 - Remove unused extra_tabs block from object.html generic template
  • #10923 - Remove unused NetBoxModelCSVForm class (replaced by NetBoxModelImportForm)
  • #11489 - Consolidated several middleware classes
  • #11611 - Refactor API viewset classes and introduce NetBoxReadOnlyModelViewSet
  • #11694 - Remove obsolete SmallTextarea form widget
  • #11737 - ChangeLoggedModel now inherits WebhooksMixin
  • #11765 - Retire the StaticSelect and StaticSelectMultiple form widgets
  • #11955 - Remove the unused CSVDataField and CSVFileField classes
  • #12067 - Move & rename extras.JobResult to core.Job

REST API Changes

  • All API responses now include a X-Request-ID HTTP header indicating the request's unique ID
  • Introduced new endpoints:
    • /api/circuits/provider-accounts/
    • /api/core/data-files/
    • /api/core/data-sources/
    • /api/dcim/device/<id>/render-config/
    • /api/extras/config-templates/
    • /api/ipam/asn-ranges/
  • Removed existing endpoints:
    • /api/dcim/device/<id>/napalm/
  • circuits.Circuit
    • Added the optional account foreign key to ProviderAccount
  • circuits.Provider
    • Removed the account field
  • dcim.DeviceType
    • Added default_platform foreign key (optional)
  • dcim.InterfaceTemplate
    • Added enabled boolean field
    • 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
  • extras.ExportTemplate
    • Added data_source, data_file, data_path, and data_synced fields to enable syncing content from remote sources
  • 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)