Skip to content

Sync VRRP Task¤

The sync_vrrp task collects live VRRP data with the Nornir parse_ttp task and its vrrp getter, then reconciles NetBox FHRP groups, device-interface assignments, priorities, authentication types, and virtual IP addresses.

result = client.run_job(
    service="netbox",
    task="sync_vrrp",
    workers="any",
    kwargs={
        "devices": ["router-1", "router-2"],
        "name_template": "{{ device.name }}_{{ interface }}_VRRP{{ group_id }}",
        "dry_run": True,
    },
)

The parser must return a list per device with these fields:

- interface: Ethernet1
  group: 10
  protocol: vrrpv2
  virtual_address: 192.0.2.1
  priority: 110
  authentication_type: plaintext

virtual_address is required. A record with a missing or empty virtual address is reported explicitly and skipped because every synchronized FHRP group must have a VIP. If priority is missing or empty, the task uses the VRRP default of 100.

Identity and comparison¤

Each assignment is identified by (device, interface, protocol, group_id) and uses the normalized key interface:protocol:group_id. This is the correct synchronization key because NetBox stores priority on the interface-to-group assignment and the same interface and group ID can run VRRPv2 for IPv4 alongside VRRPv3 for IPv6. The task groups peers which have the same protocol, group ID, virtual address, and authentication type into one NetBox FHRP group and creates an assignment for each participating interface. Getter values vrrpv2 and vrrpv3 map to NetBox protocols vrrp2 and vrrp3, respectively.

protocol is part of the assignment identity. virtual_address, priority, and authentication_type are synchronized values. Common parser authentication values such as text, simple, and cleartext are normalized to NetBox's plaintext value.

Both live and NetBox data use a scalar virtual_address in the normalized comparison structure:

{
  "router-1": {
    "Ethernet1:vrrp2:10": {
      "interface": "Ethernet1",
      "group_id": 10,
      "protocol": "vrrp2",
      "virtual_address": "192.0.2.1",
      "name": "router-1_Ethernet1_VRRP10",
      "priority": 110,
      "authentication_type": null
    }
  }
}

Each VRRP group is represented by exactly one scalar virtual IP address.

Group names¤

name_template renders the NetBox FHRP group name and updates existing names when the rendered value changes. It accepts either an inline Jinja2 template or an nf:// path retrieved through the File Sharing service. The default is:

{{ device.name }}_{{ interface }}_VRRP{{ group_id }}

For device router-1, interface Ethernet1, and group 10, the default renders router-1_Ethernet1_VRRP10.

Jinja2 context¤

The task passes these variables directly to the Jinja2 environment:

Variable Type and content Example
device NetBox device object with id, name, platform, role, device_type, and site device.site.name
interface Interface name string Ethernet1
protocol NetBox-normalized protocol string vrrp2 or vrrp3
group_id Numeric VRRP group ID 10
virtual_address Bare virtual-address string 192.0.2.1

device is a pynetbox record, so templates can access nested NetBox fields:

{{ device.site.name }}_{{ device.role.name }}_{{ device.name }}_{{ interface | replace('/', '_') }}_VRRP{{ group_id }}

Related fields such as platform can be empty in NetBox. Use a Jinja2 conditional when a field is optional:

{{ device.platform.name if device.platform else 'no-platform' }}_{{ device.name }}_VRRP{{ group_id }}

The environment uses strict undefined-variable handling. A missing variable or device attribute fails rendering and prevents the sync from writing changes. The task strips surrounding whitespace from the result. The final name must contain between 1 and 100 characters. NetBox does not require FHRP group names to be unique.

For a group observed on multiple peers, the first device and interface in sorted order supply the context. The task renders the name once and applies the same name to the shared group for every peer.

Render an inline template¤

nf# netbox sync vrrp devices router-1 name-template "{{ device.site.name }}_{{ device.role.name }}_VRRP{{ group_id }}" dry-run
result = client.run_job(
    service="netbox",
    task="sync_vrrp",
    workers="any",
    kwargs={
        "devices": ["router-1"],
        "name_template": "{{ device.site.name }}_{{ device.role.name }}_VRRP{{ group_id }}",
        "dry_run": True,
    },
)

Load a template using nf://¤

Store only the Jinja2 expression in a file available to the File Sharing service, for example netbox/vrrp_group_name.j2:

{{ device.name }}-{{ interface | replace('/', '-') }}-vrrp{{ group_id }}

Then pass its nf:// URL to the task:

nf# netbox sync vrrp devices router-1 name-template nf://netbox/vrrp_group_name.j2 dry-run
result = client.run_job(
    service="netbox",
    task="sync_vrrp",
    workers="any",
    kwargs={
        "devices": ["router-1"],
        "name_template": "nf://netbox/vrrp_group_name.j2",
        "dry_run": True,
    },
)

Bare virtual addresses receive the most-specific prefix length from a containing NetBox prefix. If no containing prefix exists, /32 or /128 is used. Before creating an address, the task searches NetBox by its bare host value and compares matches without their prefix lengths. It reuses an address already assigned to the target FHRP group first. Otherwise, it selects only unassigned records, preferring an address with the vip or vrrp role before the first unassigned match. A reused address is assigned to the FHRP group and its role is set to vrrp; newly created addresses also use the vrrp role. If all matching records are assigned to other NetBox objects, the task reports an error and leaves the address, FHRP group, and interface assignment unchanged.

The normalized live and NetBox states store virtual_address as one string because a VRRP group has one virtual IP. The task is additive: it does not delete FHRP groups, assignments, or virtual IP addresses that are absent from live parsing. Use dry_run to inspect the plan, or with_approval to review it before writes are applied.

If parsing returns no usable VRRP assignments across the selected devices, the task fails before loading synchronization state or searching NetBox IP addresses. This prevents an empty address filter from becoming an unfiltered NetBox IP query.

Synchronize live VRRP state with NetBox.

An assignment is identified by device, interface, protocol, and group ID. Virtual address, assignment priority, and group authentication type are synchronized. Compatible peer assignments reuse a NetBox FHRP group when their protocol, group ID, virtual address, and authentication match.

The sync is additive. Existing groups, assignments, and virtual addresses which are absent from live data are retained.

Parameters:

Name Type Description Default
job Job

NorFab job object.

required
instance Union[None, str]

NetBox instance name. Uses the default instance when omitted.

None
dry_run bool

Return the calculated diff without writing to NetBox.

False
with_approval bool

Ask for approval before applying the prepared diff.

False
timeout int

Timeout in seconds for Nornir host resolution and parsing.

600
devices Union[None, list]

Explicit NetBox and Nornir device names.

None
branch Union[None, str]

NetBox Branching plugin branch name.

None
name_template str

Inline Jinja2 template or nf:// path used to render the NetBox FHRP group name.

VRRP_NAME_TEMPLATE
**kwargs Any

Nornir FFun host filters.

{}

Returns:

Name Type Description
Result Result

Per-device VRRP synchronization actions.

Source code in norfab\workers\netbox_worker\fhrp_tasks.py
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
@Task(
    fastapi={"methods": ["POST"], "schema": NetboxFastApiArgs.model_json_schema()},
    input=SyncVrrpInput,
    output=SyncVrrpResult,
    mcp={
        "annotations": {
            "title": "Sync VRRP",
            "readOnlyHint": False,
            "destructiveHint": True,
            "idempotentHint": True,
            "openWorldHint": True,
        }
    },
)
def sync_vrrp(
    self,
    job: Job,
    instance: Union[None, str] = None,
    dry_run: bool = False,
    with_approval: bool = False,
    timeout: int = 600,
    devices: Union[None, list] = None,
    branch: Union[None, str] = None,
    name_template: str = VRRP_NAME_TEMPLATE,
    **kwargs: Any,
) -> Result:
    """Synchronize live VRRP state with NetBox.

    An assignment is identified by device, interface, protocol, and group
    ID. Virtual address, assignment priority, and group
    authentication type are synchronized. Compatible peer assignments reuse
    a NetBox FHRP group when their protocol, group ID, virtual address, and
    authentication match.

    The sync is additive. Existing groups, assignments, and virtual addresses
    which are absent from live data are retained.

    Args:
        job: NorFab job object.
        instance: NetBox instance name. Uses the default instance when omitted.
        dry_run: Return the calculated diff without writing to NetBox.
        with_approval: Ask for approval before applying the prepared diff.
        timeout: Timeout in seconds for Nornir host resolution and parsing.
        devices: Explicit NetBox and Nornir device names.
        branch: NetBox Branching plugin branch name.
        name_template: Inline Jinja2 template or ``nf://`` path used to render
            the NetBox FHRP group name.
        **kwargs: Nornir FFun host filters.

    Returns:
        Result: Per-device VRRP synchronization actions.
    """
    devices = list(devices or [])
    instance = instance or self.default_instance
    ret = Result(
        task=f"{self.name}:sync_vrrp",
        result={},
        resources=[instance],
        dry_run=dry_run,
        diff={},
    )

    job.event(
        f"starting VRRP sync using NetBox instance '{instance}' for "
        f"{len(devices)} explicit device(s)"
    )
    log.info(f"{self.name} - Sync VRRP: instance '{instance}', dry_run={dry_run}")

    name_template = name_template or VRRP_NAME_TEMPLATE
    if self.is_url(name_template):
        job.event(f"fetching VRRP group name template '{name_template}'")
        name_template = self.fetch_file(name_template, raise_on_fail=True).strip()
    try:
        group_name_template = VRRP_NAME_TEMPLATE_ENV.from_string(name_template)
    except TemplateError as exc:
        msg = f"invalid VRRP group name template: {exc}"
        job.event(msg, severity="ERROR")
        log.error(f"{self.name} - Sync VRRP: {msg}")
        ret.errors.append(msg)
        ret.failed = True
        return ret
    job.event("prepared VRRP group name template")

    nb = self._get_pynetbox(instance, branch=branch, job=job)

    # Resolve filters once and validate devices before doing network work.
    if kwargs:
        job.event("resolving devices from Nornir filters")
        devices.extend(self.get_nornir_hosts(kwargs, timeout))
    devices = sorted(set(devices))
    if not devices:
        msg = "no devices specified"
        job.event(msg, severity="ERROR")
        log.error(f"{self.name} - Sync VRRP: {msg}")
        ret.errors.append(msg)
        ret.failed = True
        return ret
    job.event(f"selected {len(devices)} device(s) for VRRP sync")

    nb_devices = {
        device.name: device
        for device in self.bulk_filter(
            nb.dcim.devices,
            name=devices,
            fields="id,name,platform,role,device_type,site",
        )
    }
    for device_name in devices:
        if device_name in nb_devices:
            continue
        msg = f"device '{device_name}' not found in NetBox"
        job.event(msg, severity="ERROR")
        log.error(f"{self.name} - Sync VRRP: {msg}")
        ret.errors.append(msg)
    devices = [name for name in devices if name in nb_devices]
    if not devices:
        ret.failed = True
        return ret

    interfaces = self.bulk_filter(
        nb.dcim.interfaces,
        device_id=[nb_devices[name].id for name in devices],
        fields="id,name,device",
    )
    interfaces_by_name = {
        (interface.device.name, interface.name): interface
        for interface in interfaces
    }
    interfaces_by_id = {interface.id: interface for interface in interfaces}
    job.event(
        f"validated {len(devices)} device(s) and loaded "
        f"{len(interfaces)} NetBox interface(s)"
    )

    # Collect live records and normalize them directly into the shape used
    # by make_diff. Getter protocol values are mapped to NetBox choices.
    job.event(f"collecting live VRRP state from {len(devices)} device(s)")
    log.info(f"{self.name} - Sync VRRP: collecting from {len(devices)} device(s)")
    parse_data = self.client.run_job(
        "nornir",
        "parse_ttp",
        kwargs={"get": "vrrp", "FL": devices},
        workers="all",
        timeout=timeout,
    )
    job.event(f"received VRRP data from {len(parse_data)} Nornir worker(s)")

    live_state = {}
    failed_devices = set()
    for worker_name, worker_data in parse_data.items():
        if worker_data.get("failed"):
            msg = f"worker '{worker_name}' failed to collect live VRRP data"
            job.event(msg, severity="ERROR")
            log.error(f"{self.name} - Sync VRRP: {msg}")
            ret.errors.append(msg)
            continue

        resources_failed = worker_data.get("resources_failed") or []
        if resources_failed:
            failed_devices.update(resources_failed)
            msg = (
                f"{worker_name} failed to fetch VRRP data from devices "
                f"{', '.join(sorted(resources_failed))}"
            )
            job.event(msg, severity="ERROR")
            log.error(f"{self.name} - Sync VRRP: {msg}")
            ret.errors.append(msg)

        worker_result = worker_data.get("result")
        if not isinstance(worker_result, dict):
            msg = f"worker '{worker_name}' returned malformed VRRP data"
            job.event(msg, severity="ERROR")
            log.error(f"{self.name} - Sync VRRP: {msg}")
            ret.errors.append(msg)
            continue

        for device_name, records in worker_result.items():
            if device_name not in nb_devices:
                continue
            device_state = live_state.setdefault(device_name, {})
            if not isinstance(records, list):
                msg = f"device '{device_name}' VRRP result is not a list"
                job.event(msg, severity="ERROR")
                log.error(f"{self.name} - Sync VRRP: {msg}")
                ret.errors.append(msg)
                continue

            for record in records:
                try:
                    interface_name = str(record["interface"]).strip()
                    group_id = int(record["group"])
                    protocol = VRRP_PROTOCOLS.get(
                        str(record["protocol"]).strip().lower()
                    )
                    if protocol is None:
                        raise ValueError(
                            f"unsupported protocol '{record['protocol']}'"
                        )
                    priority_value = record.get("priority")
                    priority = (
                        100
                        if priority_value is None or not str(priority_value).strip()
                        else int(priority_value)
                    )
                    virtual_address_value = str(
                        record.get("virtual_address") or ""
                    ).strip()
                    if not virtual_address_value:
                        raise ValueError(f"{interface_name} virtual address is missing")
                    virtual_address = str(
                        ipaddress.ip_interface(virtual_address_value).ip
                    )
                    authentication_type = getattr(
                        record.get("authentication_type"),
                        "value",
                        record.get("authentication_type"),
                    )
                    authentication_type = (
                        str(authentication_type).strip().lower()
                        if authentication_type
                        else None
                    )
                    if authentication_type in (
                        "cleartext",
                        "plain",
                        "simple",
                        "text",
                    ):
                        authentication_type = "plaintext"
                    if not 0 <= priority <= 255:
                        raise ValueError("priority must be between 0 and 255")
                    if authentication_type not in (None, "plaintext", "md5"):
                        raise ValueError(
                            f"unsupported authentication type "
                            f"'{authentication_type}'"
                        )
                except (KeyError, TypeError, ValueError) as exc:
                    msg = (
                        f"device '{device_name}' returned invalid VRRP data: {exc}"
                    )
                    job.event(msg, severity="ERROR")
                    log.error(f"{self.name} - Sync VRRP: {msg}")
                    ret.errors.append(msg)
                    continue

                if (device_name, interface_name) not in interfaces_by_name:
                    msg = (
                        f"device '{device_name}' interface '{interface_name}' "
                        "does not exist in NetBox"
                    )
                    job.event(msg, severity="ERROR")
                    log.error(f"{self.name} - Sync VRRP: {msg}")
                    ret.errors.append(msg)
                    continue

                key = f"{interface_name}:{protocol}:{group_id}"
                device_state[key] = {
                    "interface": interface_name,
                    "group_id": group_id,
                    "protocol": protocol,
                    "virtual_address": virtual_address,
                    "priority": priority,
                    "authentication_type": authentication_type,
                }

    for device_name in devices:
        if device_name not in live_state and device_name not in failed_devices:
            msg = f"device '{device_name}' is missing a live VRRP result"
            job.event(msg, severity="ERROR")
            log.error(f"{self.name} - Sync VRRP: {msg}")
            ret.errors.append(msg)
    live_count = sum(len(records) for records in live_state.values())
    if live_count == 0:
        msg = "no usable live VRRP assignments returned"
        job.event(msg, severity="ERROR")
        log.error(f"{self.name} - Sync VRRP: {msg}")
        ret.errors.append(msg)
        ret.failed = True
        return ret

    job.event(
        f"normalized {live_count} VRRP assignment(s) from "
        f"{len(live_state)} device(s)"
    )

    # A NetBox FHRP group is shared by its peers, so render its name once
    # from the first device/interface in deterministic sorted order.
    group_names = {}
    try:
        for device_name in sorted(live_state):
            for key in sorted(live_state[device_name]):
                desired = live_state[device_name][key]
                group_signature = (
                    desired["protocol"],
                    desired["group_id"],
                    desired["virtual_address"],
                    desired["authentication_type"],
                )
                if group_signature not in group_names:
                    group_name = group_name_template.render(
                        device=nb_devices[device_name],
                        interface=desired["interface"],
                        protocol=desired["protocol"],
                        group_id=desired["group_id"],
                        virtual_address=desired["virtual_address"],
                    ).strip()
                    if not group_name:
                        raise ValueError("rendered an empty name")
                    if len(group_name) > 100:
                        raise ValueError(
                            f"rendered name '{group_name}' exceeds 100 characters"
                        )
                    group_names[group_signature] = group_name
                desired["name"] = group_names[group_signature]
    except (TemplateError, ValueError) as exc:
        msg = f"failed to render VRRP group name: {exc}"
        job.event(msg, severity="ERROR")
        log.error(f"{self.name} - Sync VRRP: {msg}")
        ret.errors.append(msg)
        ret.failed = True
        return ret
    job.event(f"rendered {len(group_names)} VRRP group name(s)")

    # Load only groups already assigned to the selected interfaces. Global
    # FHRP groups outside this device set are not part of the comparison.
    job.event("loading current VRRP assignments from NetBox")
    assignments = self.bulk_filter(
        nb.ipam.fhrp_group_assignments,
        device=devices,
        fields="id,group,interface_type,interface_id,priority",
    )
    assignment_group_ids = sorted(
        {assignment.group.id for assignment in assignments}
    )
    groups = {}
    if assignment_group_ids:
        for group in self.bulk_filter(
            nb.ipam.fhrp_groups,
            id=assignment_group_ids,
            fields="id,protocol,group_id,name,auth_type",
        ):
            group_protocol = str(
                getattr(group.protocol, "value", group.protocol)
            ).lower()
            if group_protocol in VRRP_PROTOCOLS.values():
                authentication_type = getattr(
                    group.auth_type, "value", group.auth_type
                )
                groups[group.id] = {
                    "object": group,
                    "virtual_address": None,
                    "name": str(group.name or ""),
                    "protocol": group_protocol,
                    "authentication_type": (
                        str(authentication_type).strip().lower()
                        if authentication_type
                        else None
                    ),
                }

    if groups:
        for ip_record in self.bulk_filter(
            nb.ipam.ip_addresses,
            assigned_object_type="ipam.fhrpgroup",
            assigned_object_id=sorted(groups),
            fields="id,address,assigned_object_id,role",
        ):
            ip_role = getattr(ip_record.role, "value", ip_record.role)
            if str(ip_role or "").lower() == "vrrp":
                groups[ip_record.assigned_object_id]["virtual_address"] = str(
                    ipaddress.ip_interface(str(ip_record.address)).ip
                )

    current_state = {device_name: {} for device_name in devices}
    current_objects = {}
    for assignment in sorted(assignments, key=lambda item: item.id):
        interface = interfaces_by_id.get(assignment.interface_id)
        group_data = groups.get(assignment.group.id)
        if interface is None or group_data is None:
            continue
        group = group_data["object"]

        device_name = interface.device.name
        key = f"{interface.name}:{group_data['protocol']}:{int(group.group_id)}"
        current_state[device_name][key] = {
            "interface": interface.name,
            "group_id": int(group.group_id),
            "protocol": group_data["protocol"],
            "virtual_address": group_data["virtual_address"],
            "name": group_data["name"],
            "priority": int(assignment.priority),
            "authentication_type": group_data["authentication_type"],
        }
        current_objects[(device_name, key)] = (assignment, group_data)

    current_count = sum(len(records) for records in current_state.values())
    job.event(
        f"loaded {current_count} VRRP assignment(s) in "
        f"{len(groups)} NetBox group(s)"
    )

    job.event("calculating VRRP synchronization diff")
    sync_diff = self.make_diff(live_state, current_state)
    for actions in sync_diff.values():
        actions["create"] = sorted(actions["create"])
        actions["update"] = {
            key: actions["update"][key] for key in sorted(actions["update"])
        }
        actions["delete"] = []

    create_count = sum(len(actions["create"]) for actions in sync_diff.values())
    update_count = sum(len(actions["update"]) for actions in sync_diff.values())
    in_sync_count = sum(len(actions["in_sync"]) for actions in sync_diff.values())
    job.event(
        "vrrp sync diff complete: "
        f"{create_count} create, {update_count} update, "
        f"{in_sync_count} in sync"
    )
    log.info(
        f"{self.name} - Sync VRRP diff: {create_count} create, "
        f"{update_count} update, {in_sync_count} in sync"
    )

    if dry_run:
        job.event("dry-run requested, returning VRRP diff without changes")
        log.info(f"{self.name} - Sync VRRP: dry-run complete")
        ret.result = sync_diff
        ret.dry_run = True
        return ret

    if with_approval:
        job.event("requesting approval for the prepared VRRP sync plan")
    if with_approval and not review_sync_task_result(job, "VRRP sync", sync_diff):
        ret.status = "skipped"
        ret.result = sync_diff
        ret.dry_run = True
        ret.messages.append("review declined; changes were not applied")
        log.info(f"{self.name} - Sync VRRP: approval declined")
        return ret

    ret.diff = sync_diff
    ret.result = {
        device_name: {
            "created": [],
            "updated": [],
            "deleted": [],
            "in_sync": actions["in_sync"],
        }
        for device_name, actions in sync_diff.items()
    }

    desired_addresses = sorted(
        {
            assignment["virtual_address"]
            for device_state in live_state.values()
            for assignment in device_state.values()
        }
    )
    job.event(
        f"fetching {len(desired_addresses)} matching IP address(es) from NetBox"
    )
    nb_ips = self.bulk_filter(
        endpoint=nb.ipam.ip_addresses,
        address=desired_addresses,
        fields="id,address,role,assigned_object_type,assigned_object_id",
    )
    job.event(f"retrieved {len(nb_ips)} matching IP address object(s) from NetBox")

    # Apply assignments in deterministic order. A new assignment reuses a
    # compatible group when possible; otherwise it gets a new VRRP group.
    for device_name in sorted(sync_diff):
        actions = sync_diff[device_name]
        changed_keys = sorted(set(actions["create"]) | set(actions["update"]))
        if not changed_keys:
            continue
        job.event(
            f"applying {device_name}: {len(actions['create'])} create, "
            f"{len(actions['update'])} update"
        )

        for key in changed_keys:
            desired = live_state[device_name][key]
            assignment, group_data = current_objects.get(
                (device_name, key), (None, None)
            )

            if group_data is None:
                for candidate in sorted(
                    groups.values(), key=lambda item: item["object"].id
                ):
                    candidate_group = candidate["object"]
                    if (
                        candidate["protocol"] == desired["protocol"]
                        and int(candidate_group.group_id) == desired["group_id"]
                        and candidate["authentication_type"]
                        == desired["authentication_type"]
                        and candidate["virtual_address"]
                        == desired["virtual_address"]
                    ):
                        group_data = candidate
                        break

            # Do not steal an existing IP from another NetBox object. Check
            # this before changing or creating the FHRP group so a conflict
            # cannot leave a partially applied group behind.
            address = desired["virtual_address"]
            assign_ip = not (
                group_data and address == group_data["virtual_address"]
            )
            ip_record = None
            if assign_ip:
                matching_ips = [
                    ip_record
                    for ip_record in nb_ips
                    if str(ip_record.address).startswith(f"{address}/")
                ]
                ip_record = next(
                    (
                        item
                        for item in matching_ips
                        if group_data
                        and item.assigned_object_type == "ipam.fhrpgroup"
                        and item.assigned_object_id == group_data["object"].id
                    ),
                    None,
                )
                if ip_record is None:
                    unassigned_ips = [
                        item
                        for item in matching_ips
                        if item.assigned_object_id is None
                    ]
                    ip_record = next(
                        (
                            item
                            for item in unassigned_ips
                            if str(
                                getattr(item.role, "value", item.role) or ""
                            ).lower()
                            in ("vip", "vrrp")
                        ),
                        unassigned_ips[0] if unassigned_ips else None,
                    )
                if ip_record is None and matching_ips:
                    ip_record = matching_ips[0]
                    msg = (
                        f"matching NetBox IP '{ip_record.address}' is already "
                        f"assigned to {ip_record.assigned_object_type} "
                        f"{ip_record.assigned_object_id}; cannot use it for "
                        f"VRRP assignment '{device_name}:{key}'"
                    )
                    job.event(msg, severity="ERROR")
                    log.error(f"{self.name} - Sync VRRP: {msg}")
                    ret.errors.append(msg)
                    continue

            if group_data is None:
                group = nb.ipam.fhrp_groups.create(
                    protocol=desired["protocol"],
                    group_id=desired["group_id"],
                    name=desired["name"],
                    auth_type=desired["authentication_type"],
                )
                group_data = {
                    "object": group,
                    "virtual_address": None,
                    "name": desired["name"],
                    "protocol": desired["protocol"],
                    "authentication_type": desired["authentication_type"],
                }
                groups[group.id] = group_data
            else:
                group = group_data["object"]
                group_updates = {}
                if group_data["name"] != desired["name"]:
                    group_updates["name"] = desired["name"]
                if (
                    group_data["authentication_type"]
                    != desired["authentication_type"]
                ):
                    group_updates["auth_type"] = desired["authentication_type"]
                if group_updates:
                    group.update(group_updates)
                    group_data["name"] = desired["name"]
                    group_data["authentication_type"] = desired[
                        "authentication_type"
                    ]

            if assign_ip:
                if ip_record is not None:
                    ip_record.update(
                        {
                            "role": "vrrp",
                            "assigned_object_type": "ipam.fhrpgroup",
                            "assigned_object_id": group.id,
                        }
                    )
                    job.event(
                        f"reused NetBox IP '{ip_record.address}' for VRRP "
                        f"group {group.group_id}"
                    )
                    log.info(
                        f"{self.name} - Sync VRRP: reused NetBox IP "
                        f"'{ip_record.address}' for group {group.group_id}"
                    )
                else:
                    prefixes = list(nb.ipam.prefixes.filter(contains=address))
                    prefix_length = (
                        max(
                            ipaddress.ip_network(
                                str(prefix.prefix), strict=False
                            ).prefixlen
                            for prefix in prefixes
                        )
                        if prefixes
                        else (
                            32
                            if ipaddress.ip_address(address).version == 4
                            else 128
                        )
                    )
                    ip_record = nb.ipam.ip_addresses.create(
                        address=f"{address}/{prefix_length}",
                        status="active",
                        role="vrrp",
                        assigned_object_type="ipam.fhrpgroup",
                        assigned_object_id=group.id,
                    )
                    job.event(
                        f"created NetBox VRRP IP '{ip_record.address}' for "
                        f"VRRP group {group.group_id}"
                    )
                    log.info(
                        f"{self.name} - Sync VRRP: created NetBox VRRP IP "
                        f"'{ip_record.address}' for group {group.group_id}"
                    )
                    nb_ips.append(ip_record)
                group_data["virtual_address"] = address

            if assignment is None:
                interface = interfaces_by_name[(device_name, desired["interface"])]
                nb.ipam.fhrp_group_assignments.create(
                    group=group.id,
                    interface_type="dcim.interface",
                    interface_id=interface.id,
                    priority=desired["priority"],
                )
                ret.result[device_name]["created"].append(key)
            else:
                if int(assignment.priority) != desired["priority"]:
                    assignment.update({"priority": desired["priority"]})
                ret.result[device_name]["updated"].append(key)

        job.event(f"completed VRRP changes for {device_name}")

    job.event("vrrp sync complete")
    create_count = sum(len(actions["created"]) for actions in ret.result.values())
    update_count = sum(len(actions["updated"]) for actions in ret.result.values())
    log.info(
        f"{self.name} - Sync VRRP complete: {create_count} created, "
        f"{update_count} updated, {in_sync_count} in sync"
    )
    return ret