The premier source of truth powering network automation. Open source under Apache 2. Public demo: https://demo.netbox.dev
[!WARNING] This is a beta release of NetBox intended for testing and evaluation. Do not use this software in production. Also be aware that no upgrade path is provided to future releases.
[!TIP] Plugin maintainers: Please see the dedicated plugin migration guide for a checklist of changes that may be needed to ensure compatibility with NetBox v4.0.
device_role & device_role_id filters for devices have been removed. (Use role and role_id instead.)device_role field has been removed from the REST API serializer for devices. (Use role instead.)parent and parent_id filters for locations now return only immediate children of the specified location. (Use ancestor and ancestor_id to return all descendants.)object_type field on the CustomField model has been renamed to related_object_type.utilities.utils module has been removed and its resources reorganized into separate modules organized by function.NullableCharField class has been removed. (Use Django's stock CharField class with null=True instead.)annotated_date template filter and annotated_now template tag have been removed.The NetBox user interface has been completely refreshed and updated. This massive effort entailed:
The REST API now supports specifying which fields to include in the response data. For example, the response to a request for
GET /api/dcim/sites/?fields=name,status,region,tenant
will include only the four specified fields in the representation of each site. Additionally, the underlying database queries effected by such requests have been optimized to omit fields which are not included in the response, resulting in a substantial performance improvement.
The GraphQL engine has been changed from using Graphene-Django to Strawberry-Django. Changes include:
New resources have been introduced to enable advanced form rendering without a need for custom HTML templates. These include:
The legacy admin user interface is now disabled by default, and the few remaining views it provided have been relocated to the primary UI. NetBox deployments which still depend on the legacy admin functionality for plugins can enable it by setting the DJANGO_ADMIN_ENABLED configuration parameter to true.
htmx_talble template tag to simplify the rendering of embedded tablesfacility field to Location modeldescription field in "brief" REST API serializationsnested keyword argument allowing it to represent a related objectis_staff restriction on admin menu itemsvc_position fieldProgrammingError exception when applying migrations to older databasesValueError exception when uploading a custom scriptForeignKeyViolation exception when applying migration users.0006_custom_group_model on older databasesusers.0008_flip_objectpermission_assignments migration to older databasesDJANGO_ADMIN_ENABLED to True to enable it)extras.plugins (now netbox.plugins)ActionsMixin
process_webhook() from extras.webhooks_worker (now extras.webhooks.send_webhook())BootstrapMixin form mixin classready() method of individual app configs, rather than relying on the class_prepared signaldevice_role and device_role_id filters for devicesNullableCharField classpsycopg librarydevice_role attribute from Device model (this field was renamed to role in v3.6)object_type field on the CustomField model has been renamed to related_object_type to avoid confusion with its object_types fieldutilities.utils moduleannotated_date template filter & annotated_now template tagENABLE_LOCALIZATION configuration parameterAttributeError exception when attempting to save an incomplete tunnel terminationike_policy & ike_policy_id filters for IKE proposalsid in list of supported fields for all bulk import formsbutton_class field on custom link bulk import form[!WARNING] This is a beta release of NetBox intended for testing and evaluation. Do not use this software in production. Also be aware that no upgrade path is provided to future releases.
[!TIP] Plugin maintainers: Please see the dedicated plugin migration guide for a checklist of changes that may be needed to ensure compatibility with NetBox v4.0.
device_role & device_role_id filters for devices have been removed. (Use role and role_id instead.)device_role field has been removed from the REST API serializer for devices. (Use role instead.)parent and parent_id filters for locations now return only immediate children of the specified location. (Use ancestor and ancestor_id to return all descendants.)object_type field on the CustomField model has been renamed to related_object_type.utilities.utils module has been removed and its resources reorganized into separate modules organized by function.NullableCharField class has been removed. (Use Django's stock CharField class with null=True instead.)The NetBox user interface has been completely refreshed and updated. This massive effort entailed:
The REST API now supports specifying which fields to include in the response data. For example, the response to a request for
GET /api/dcim/sites/?fields=name,status,region,tenant
will include only the four specified fields in the representation of each site. Additionally, the underlying database queries effected by such requests have been optimized to omit fields which are not included in the response, resulting in a substantial performance improvement.
The GraphQL engine has been changed from using Graphene-Django to Strawberry-Django. Changes include:
New resources have been introduced to enable advanced form rendering without a need for custom HTML templates. These include:
The legacy admin user interface is now disabled by default, and the few remaining views it provided have been relocated to the primary UI. NetBox deployments which still depend on the legacy admin functionality for plugins can enable it by setting the DJANGO_ADMIN_ENABLED configuration parameter to true.
htmx_talble template tag to simplify the rendering of embedded tablesfacility field to Location modeldescription field in "brief" REST API serializationsnested keyword argument allowing it to represent a related objectDJANGO_ADMIN_ENABLED to True to enable it)extras.plugins (now netbox.plugins)ActionsMixin
process_webhook() from extras.webhooks_worker (now extras.webhooks.send_webhook())BootstrapMixin form mixin classready() method of individual app configs, rather than relying on the class_prepared signaldevice_role and device_role_id filters for devicesNullableCharField classpsycopg librarydevice_role attribute from Device model (this field was renamed to role in v3.6)object_type field on the CustomField model has been renamed to related_object_type to avoid confusion with its object_types fieldutilities.utils moduledisplay field on VirtualDisk serialization in REST APIassociate_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)