v5 Release Notes

5.3.0 (2026-03-12)

Reworked merge stage of sync process to be more robust.
Errors during merge are now logged as IngestionIssue and shown in Ingestion details page.
Added phase to IngestionIssue to be able to track in which stage of the sync process the error happened.
Added merge Job progress and logs to Ingestion details page.
Added buttons to Ingestion detail to switch between sync and merge Job logs and progress statistics.
Both buttons are linked together, so logs and statistics are always shown for the same phase of the sync process.

Job logs should be saved in most cases now, even if there are unhandled errors during Job run.

Warning

Make sure to have enough DB connections to support the number of threads configured, otherwise it may cause issues during sync. See Parallel sync — PostgreSQL connection requirements for details.

Added Thread count field to Sync form.
Added thread_count field to Sync API endpoint.
Error finding related object from transform map template now shows the evaluated query.
Device primary IP is now obtainable from both loginIP and loginIpv4.
Object snapshot is calculated only when needed, improving performance of sync process.
Added update_custom_fields field to Sync API endpoint.
Support for new StrFilterLookup GraphQL filter provided in strawberry-graphgl-django==0.75.1.

Fixed custom fields not using Branch DB connection as target when saving.
Made sure to use correct Branch when evaluating templates.
Fixed stack master using DeviceType from device table instead of stack members table.
Several small fixes slightly improving sync performance.

Warning

This release requires at least NetBox v4.5.0.

Support for NetBox 4.5.0+.
Added a warning log to Ingestion when plugin version in worker differs from version in main NetBox instance.
Branch is now kept instead of getting removed if Ingestion fails in merge step.
Replaced *.png images in documentation with faster *.webp format.
Added Sync name to name of new Branches.
Added Timeout status to Sync, shown when Job times out.

Parent/child relationships in Transform Maps were ignored when cloning Transform Maps.
Fixed Job timeout handling, now it should create IngestionIssue, Job log and set Sync status to Timeout instead of getting stuck in Running.

Preprocessing data for Devices could run twice if dcim.virtualchassis was also enabled.
VSS Endpoint data were never pulled, even when dcim.virtualchassis was enabled.
Fix for following error happening when removing master Device from VirtualChassis and not assigning it to different one.

{'vc_position': ['A device assigned to a virtual chassis must have its position defined.']}

Devices Endpoint is pulled only when linked in TransformMap or when syncing VirtualChassis, Interface or IPAddress models since they need it too.
Endpoints tab in Sync now correctly shows all Endpoints that will get pulled.

Fixed moving master Device from VirtualChassis to another one.
Make sure master of VirtualChassis os assigned only if the Device is member of the VirtualChassis.
Fixed Endpoints list on Sync view to pick Endpoints based on Sync parameters instead of linked Filters.
Fixed sorting of statistics during Ingestion to be grouped by app label.

Danger

When upgrading to v5.0.0+, make sure to follow Upgrading plugin to v5.0+ (NetBox v4.4.0+) instructions on top of normal upgrade procedure.

Split data items before sync by model, allowing for better control over sync process.
Ingestion statistics are moved to the left side for better visibility.
Exposed MAC address logic from code to Transform Maps.
Dropped IPF 6.10 support and introduced IPF 7.5 explicit support.
New plugin models added: Endpoint, Filter, FilterExpression.
Added filtering of data pulled from IPF API using IPF filters.
Currently used hidden filters are now exposed and populated in migration as default filters.
When editing new FilterExpression it’s possible to directly poll IPF to test it.
Added read-only endpoint models and linked them as source transform maps.
Endpoint and Filter lists allow to show current combined filter expression.
Added hierarchy modeling to transform maps.
Sync models settings is now ordered by Transform map hierarchy.
Fixed signal in Site creation introduced in NetBox 4.4.9.
Sync settings now uses standard app_label.model notation for models instead of ipf_model(s).
Changed navigation menu to show new models and included missing Ingestions, Fields and Relationships lists.
New Sync Process overview section in User Guide providing high level understanding of sync process.
Added endpoint for VSS members to sync them to Virtual Chassis too.
Branching plugin version no longer has upper limit.

Fixed memory leak during sync causing ~1,6GB RAM consumption per 10k changes.
Correctly ignore global VRF during sync as it’s the default in NetBox.
VRF is now coalesce field for IPAddress.
Fixed blank VLAN name when it was empty string in IP Fabric.
mgmt_only=True is no longer set on Interface without IP address.
Inventory items now correctly include name in their coalesce fields.
Objects are no longer shown as created if they fail during validation.
Typo in diff template leading to %{ trans being shown instead of translated string.
Added missing {% trans in Snapshot detail view.
Ordering Ingestion list by name no longer causes error.
Ordering Ingestion changes list by object no longer causes errors.
Disabled ordering of Ingestion changes list by actions and renamed to diffs.
Ordering Sync by last ingestion no longer causes error.
Link in docs to branching plugin docs is now correct.
Removing primary IP from device when it’s not set in IPFabric anymore works correctly.
Added missing display field to API serializers for several models.