The premier source of truth powering network automation. Open source under Apache 2. Public demo: https://demo.netbox.dev
associate_by_email() from default social auth pipelineconfig_template field on REST API serializer for virtual machinesgroup field should be optional when creating VPN tunnel via REST APIfront_image & rear_image on DeviceTypeNoReverseMatch exception when rendering a custom field which references a usercan_add() template filter should accept a model (not an instance)available_at_site filter when filtering VLANs under prefix forminstalled_device on DeviceBaycontent_types, type_create, type_update, type_delete, type_job_start, type_job_end, enabled, and conditions. Webhooks are now tied to events via event rules. New event rules will be created for any existing webhooks automatically upon upgrade.ui_visibility field on the custom field model has been replaced with two new fields: ui_visible and ui_editable. These new fields will have their values mapped from the original field automatically upon upgrade.FeatureQuery class used internally for querying content types by model feature has been removed. It has been replaced by the new with_feature() manager method on NetBox's proxy model for ContentType (core.models.ContentType).extras to core. Configuration history will be retained throughout the upgrade process.ipam app to the new vpn app. All object data will be retained, however please note that the relevant API endpoints have likewise moved to /api/vpn/.CustomFieldsMixin, SavedFiltersMixin, and TagsMixin classes have moved from the extras.forms.mixins module to netbox.forms.mixins.Several new models have been introduced to enable VPN tunnel management. Users can now define tunnels with two or more terminations to represent peer-to-peer or hub-and-spoke topologies. Each termination is made to a virtual interface on a device or virtual machine. Additionally, users can define IKE and IPSec proposals and policies, which can be applied to tunnels to document encryption and authentication strategies.
This release introduces event rules, which can be used to send webhooks or execute custom scripts automatically in response to events that occur in NetBox. For example, it's now possible to run a custom script whenever a new site is created with a particular status or tag.
Event rules replace and extend functionality that was previously built into the webhook model. New event rules will be created for any existing webhooks automatically upon upgrade.
A new VirtualDisk model has been introduced to enable tracking the assignment of discrete virtual disks to virtual machines. The size field has been retained on the VirtualMachine model, and will be populated automatically with the aggregate size of all assigned virtual disks. (Users who opt to eschew the new model may continue using the VirtualMachine size attribute independently as in previous releases.)
A new PROTECTION_RULES configuration parameter has been introduced. Similar to how custom validation rules can be used to enforce certain values for object attributes, protection rules guard against the deletion of objects which do not meet specified criteria. This enables an administrator to prevent, for example, the deletion of a site which has a status of "active."
The ui_visible field on the custom field model has been superseded by two new fields, ui_visible and ui_editable, which control how and whether a custom field is displayed when view and editing an object, respectively. Separating these two functions into discrete fields allows more control over how each custom field is presented to users. The values of these fields will be appropriately set automatically during the upgrade process from the value of the original field.
Global search results now include additional context about each object, such as a description, status, and/or related objects. The set of attributes to be displayed is specific to each object type, and is defined by setting display_attrs under the object's SearchIndex class.
Plugins can now register their own custom columns for inclusion on core NetBox tables. For example, a plugin can register a new column on SiteTable using the new register_table_column() utility function, and it will become available for users to select for display.
Plugins can now register their own data backends for use with synchronized data sources. This enables plugins to introduce new backends in addition to the git, S3, and local path backends provided natively.
color field for circuit typeserror field to the Job model to record any errors associated with its execution/render-config REST API endpoint for virtual machinesCHANGELOG_SKIP_EMPTY_CHANGES config parameterdescription field for webhooksjob_start and job_end signals to allow automated plugin actionsinterface_id and consoleport_id)ActionsMixin (backward compatibility has been retained)sentry-sdk Python library is now required only if Sentry reporting is enabledextras app into netbox (backward compatibility has been retained)FeatureQuery with new with_feature() method on proxy ContentType manageripam app to the new vpn appextras app to core
extras app to netbox
extras.webhooks_worker.process_webhook() to extras.webhooks.send_webhook() (backward compatibility has been retained)clearcache management commandENFORCE_GLOBAL_UNIQUE now defaults to true)available_at_site filter for VLANssyncdatasource management commandrunscript management commandclasses parameter to copy_content template tag/available-ips/ API endpointsstarting_unit cannot be zero:warning: This is a beta release intended only for testing and evaluation. Do not deploy it in a production environment. No upgrade path to future releases will be provided.
content_types, type_create, type_update, type_delete, type_job_start, type_job_end, enabled, and conditions. Webhooks are now tied to events via event rules. Existing webhooks will have event rules created automatically upon upgrade.ui_visibility field on the custom field model has been replaced with two new fields: ui_visible and ui_editable. Existing values will be migrated automatically upon upgrade.FeatureQuery class for querying content types by model feature has been removed. Plugins should now use the new with_feature() manager method on NetBox's proxy model for ContentType.extras to core. Configuration history will be retained throughout the upgrade process.ipam app to the new vpn app. All object data will be retained, however please note that the relevant API endpoints have moved to /api/vpn/.CustomFieldsMixin, SavedFiltersMixin, and TagsMixin classes have moved from the extras.forms.mixins module to netbox.forms.mixins.Several new models have been introduced to enable VPN tunnel management. Users can now define tunnels with two or more terminations to replicate peer-to-peer or hub-and-spoke topologies. Each termination is made to a virtual interface on a device or VM. Additionally, users can define IKE and IPSec policies which can be applied to tunnels to document encryption and authentication strategies.
This release introduces event rules, which can be used to send webhooks or execute custom scripts automatically in response to NetBox events. For example, it's now possible to run a custom script whenever a new site is created with a particular status or tag.
Event rules replace and extend functionality that was previously built into the webhook model. Event rules will be created for any existing webhooks upon upgrade.
A new VirtualDisk model has been introduced to enable tracking the assignment of discrete virtual disks to virtual machines. The original size field has been retained on the VirtualMachine model, and will be automatically updated with the aggregate size of all assigned virtual disks. (Users who opt to eschew the new model may continue using the VirtualMachine size attribute as before.)
A new PROTECTION_RULES configuration parameter is now available. Similar to how custom validation rules can be used to enforce certain values for object attributes, protection rules guard against the deletion of objects which do not meet specified criteria. This enables an administrator to prevent, for example, the deletion of a site which has a status of "active."
The old ui_visible field on the custom field model](https://docs.netbox.dev/en/feature/models/extras/customfield/) has been replaced by two new fields, ui_visible and ui_editable, which control how and whether a custom field is displayed when view and editing an object, respectively. Separating these two functions into discrete fields enables more control over how each custom field is presented to users. The values of these fields will be appropriately set automatically during the upgrade process depending on the value of the original field.
Global search results now include additional context about each object, such as a description, status, and/or related objects. The set of attributes to be displayed is specific to each object type, and is defined by setting display_attrs under the object's SearchIndex class.
Plugins can now register their own custom columns for inclusion on core NetBox tables. For example, a plugin can register a new column on SiteTable using the new register_table_column() utility function, and it will become available for users to select for display.
Plugins can now register their own data backends for use with synchronized data sources. This enables plugins to introduce new backends in addition to the git, S3, and local path backends provided natively.
color field for circuit typeserror field to the Job model to record any errors associated with its execution/render-config REST API endpoint for virtual machinesdescription field for webhooksjob_start and job_end signalsActionsMixin (backward compatibility has been retained)sentry-sdk Python library is now required only if Sentry reporting is enabledextras app into netbox (backward compatibility has been retained)FeatureQuery with new with_feature() method on ContentType manageripam app to the new vpn appextras app to core
extras app to netbox
extras.webhooks_worker.process_webhook() to extras.webhooks.send_webhook() (backward compatibility has been retained)get_client_ip()