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 |
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 | |