Sync VLANs¤
Use sync_vlans to create missing VLANs and update VLAN names, descriptions,
and tagged or untagged interface assignments in Netbox from live devices.
Select devices by name or with Nornir host filters. Use a dry run to review
changes before applying them.
Devices must exist in Netbox and be reachable through the Nornir service with
a supported TTP vlans getter. Run
sync_device_interfaces
first if their interfaces are missing.
Output¤
Each worker returns created, updated, deleted, and in_sync lists per
device. All references use scope:VID, such as group:CAMPUS:100. Membership
changes place the affected VLAN in updated. A newly created VLAN can also appear
in updated when its interface assignments change. A dry run reports planned
actions; a live run reports completed actions.
{
"leaf-1": {
"created": ["group:CAMPUS:100"],
"updated": ["group:CAMPUS:100", "group:CAMPUS:110"],
"deleted": [],
"in_sync": ["group:CAMPUS:120"]
}
}
diff[device].vlans[scope] contains create, update, delete, and in_sync
actions. VLAN updates are keyed by VID and show old_value and new_value for
each field. diff[device].interfaces contains the same action keys, with updates
keyed by interface name and showing previous and desired VLAN assignments.
The diff retains this preview after writes are applied. Existing VLANs are matched
by VID and scope independently of interface assignments.
Check errors for skipped VLANs, missing interfaces, and conflicting live data.
Skipped name updates remain visible in the diff; selected values already matching NetBox do not trigger writes.
The task does not delete VLAN records, so deleted remains empty. Shared VLAN writes may appear under multiple contributing devices.
Interface names mapped to the same NetBox interface contribute to one membership target; their tagged VLAN assignments are combined.
Examples¤
Preview VLANs 100-199 on leaf-1 in the existing CAMPUS group, keeping
existing Netbox names. Remove dry_run or dry-run to apply the changes.
Python examples assume an established NorFab client. FastAPI examples require
a running NorFab FastAPI service that has discovered the Netbox tasks.
nf# netbox sync vlans devices leaf-1 vlan-ids 100-199 vlan-group CAMPUS preserve-name dry-run
To review and approve changes interactively:
nf# netbox sync vlans devices leaf-1 vlan-ids 100-199 vlan-group CAMPUS preserve-name with-approval
result = client.run_job(
"netbox",
"sync_vlans",
workers="any",
kwargs={
"devices": ["leaf-1"],
"filter_by_vlan_ids": ["100-199"],
"vlan_group": "CAMPUS",
"preserve_name": True,
"dry_run": True,
},
)
print(result)
Replace the service URL and bearer token with your deployment values.
import requests
response = requests.post(
"http://localhost:8000/api/netbox/sync_vlans/",
headers={"Authorization": "Bearer <TOKEN>"},
json={
"workers": "any",
"devices": ["leaf-1"],
"filter_by_vlan_ids": ["100-199"],
"vlan_group": "CAMPUS",
"preserve_name": True,
"dry_run": True,
},
timeout=660,
)
response.raise_for_status()
print(response.json())
curl -X POST 'http://localhost:8000/api/netbox/sync_vlans/' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"workers":"any","devices":["leaf-1"],"filter_by_vlan_ids":["100-199"],"vlan_group":"CAMPUS","preserve_name":true,"dry_run":true}'
Use the NorFab Netbox sync_vlans tool to preview VLANs 100-199 from leaf-1
in the CAMPUS VLAN group. Preserve existing Netbox VLAN names and report
planned VLAN and interface changes without applying them.
Preserve names and descriptions¤
preserve_name=False is the default. Descriptive live names replace differing
Netbox names. Set preserve_name=True to keep existing names. In either mode,
a generated live name such as VLAN100 does not replace an existing Netbox
name. New VLANs always use live names.
For existing VLAN descriptions, preserve_description=None keeps Netbox text
when live text is empty. Use True to always keep Netbox text or False to
always use live text, including an empty string. New VLANs use live descriptions.
VLAN Groups Mapping¤
VLANs are matched by VID and scope, not name. Supply vlan_group to select an
existing group. Its scope must apply to the device, and its allowed VID ranges
must include the VLAN IDs.
Use vlan_map for ordered group selection rules, supplied inline or as an
nf:// YAML file. For example:
- set_vlan_group: CAMPUS
match_vlan_ids: ["100-199"]
vlan_names: ["USERS*", "VOICE*"]
match_device_names: ["leaf-*"]
match_interface_names: ["Ethernet*"]
The first matching rule wins. All supplied criteria must match. Values within
one criterion are alternatives. Name patterns are case-sensitive, and VLAN ID
ranges must stay within 1-4094. Interface patterns match any member interface.
VLANs without a matching rule use vlan_group. Set require_vlan_group=True
to skip VLANs without either selection.
Without an explicit group, the task prefers a device-compatible group, then a VLAN in the device's site, then a global VLAN. Equally preferred matches are reported as ambiguous and skipped. If no match exists, it creates a site VLAN. An invalid explicit group selection is skipped without falling back.
Group scopes support sites, regions, site groups, locations, racks, and rack groups. Region matching includes up to five levels, starting with the site's region. Other scopes require a direct match. If device location is unset, the rack's location is used. Cluster scopes are ignored.
Interface assignments¤
Reported tagged memberships are added to existing assignments. Empty live
membership lists do not clear assignments. A reported untagged VLAN replaces
the current untagged VLAN, even if the old VLAN is outside the selected ID range.
Interfaces with tagged VLANs use tagged mode. Interfaces with only an untagged
VLAN use access mode. Q-in-Q service VLANs are not synchronized.
If live and Netbox interface names differ, pass the same interface_map to
this task and sync_device_interfaces.
Review and apply changes¤
dry_run=True previews changes without writing. with_approval=True asks for
review before applying them and is ignored during a dry run. Use branch to
target a branch when the Netbox Branching plugin is configured.
Bulk writes use batch_size=1000 by default. If a request fails, earlier
successful writes remain applied. Review the error and preview again before
retrying.
Troubleshooting¤
- Missing live data: check device connectivity and support for the TTP
vlansgetter on the Nornir worker. - Missing interface: create it with
sync_device_interfaces, then rerun. - Group not found or incompatible: check its exact name, scope, and allowed VID ranges. Groups must already exist.
- Ambiguous VLAN match: select the intended group with
vlan_grouporvlan_map. - Conflicting live names or descriptions: correct differences between devices sharing the VLAN. The first descriptive name and first non-empty description in device-name order are used. Conflicts are reported even when existing names are preserved.
- Name collision: choose a unique VLAN name within the scope, or preserve
the existing name with
preserve_name=True. Conflicting creations or updates are skipped.
Task Command Shell Reference¤
nf#man tree netbox.sync.vlans
R - required field, M - supports multiline input, D - dynamic key
root
└── netbox: Netbox service
└── sync: Sync Netbox data
└── vlans: Sync live VLAN configuration with NetBox
├── instance: Netbox instance name to target
├── dry-run: Calculate the VLAN diff without writing to NetBox, default 'False'
├── branch: NetBox branching plugin branch name to use
├── batch-size: Number of objects per NetBox bulk request, default '1000'
├── FO: Filter hosts using Filter Object
├── FB: Filter hosts by name using Glob Patterns
├── FH: Filter hosts by hostname
├── FC: Filter hosts containment of pattern in name
├── FR: Filter hosts by name using Regular Expressions
├── FG: Filter hosts by group
├── FP: Filter hosts by hostname using IP Prefix
├── FL: Filter hosts by names list
├── FM: Filter hosts by platform
├── FX: Filter hosts excluding them by name
├── FN: Negate the match
├── devices: List of NetBox devices to collect VLANs from
├── timeout: Job timeout
├── with-approval: Preview VLAN changes and ask for review before writing to NetBox, default 'False'
├── vlan-group: Exact group name for live VLANs not matched by vlan-map
├── vlan-map: Ordered VLAN and interface membership mapping rules or nf:// YAML file reference
├── interface-map: Interface name mapping rules shared with interface sync
├── require-vlan-group: Require every live VLAN to resolve to a VLAN group, default 'False'
├── vlan-ids: VLAN IDs or inclusive ranges to reconcile
├── preserve-description: Preserve existing NetBox descriptions always (true), only when live text is empty (null), or never (false)
├── preserve-name: Keep existing NetBox VLAN names; new VLANs use live names, default 'False'
├── workers: Filter worker to target, default 'any'
├── verbose-result: Control output details, default 'False'
└── nowait: Do not wait for job to complete, default 'False'
nf#
Python API Reference¤
Synchronize live VLAN attributes and interface memberships with NetBox.
VLANs are mapped by the first matching vlan_map rule. Rule criteria
match VLAN IDs, VLAN names, device names, and each interface name;
populated criteria are combined with AND. VLANs which match no rule use
vlan_group when supplied. Otherwise, they use their device site
unless require_vlan_group=True.
Name conflicts with NetBox or between proposed VLANs in the same scope are reported and skipped. The first proposed name is retained; skipped creations are also removed from interface membership targets.
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
|
interface_map
|
Union[None, str, list]
|
Interface rename rules shared with interface sync. |
None
|
vlan_group
|
Union[None, str]
|
Group for VLANs not matched by |
None
|
vlan_map
|
Union[None, str, list]
|
Ordered VLAN-to-group mapping rules, or an |
None
|
require_vlan_group
|
bool
|
Require every VLAN to resolve to a VLAN group instead of falling back to its device site. |
False
|
filter_by_vlan_ids
|
Union[None, list[str]]
|
VLAN IDs or inclusive ranges to reconcile. |
None
|
preserve_description
|
Union[None, bool]
|
Description preservation policy. |
None
|
batch_size
|
int
|
Maximum number of objects per bulk write. |
1000
|
preserve_name
|
bool
|
Keep existing NetBox VLAN names when |
False
|
**kwargs
|
Any
|
Nornir FFun host filters. |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
Result |
Result
|
Per-device created, updated, deleted and in_sync references. Diff contains per-device VLAN actions by scope and interface field changes. |
Source code in norfab\workers\netbox_worker\vlan_tasks.py
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 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 | |