Netbox Sync Device IP Task¤
task api name:
sync_device_ip
The Netbox Sync Device IP Task synchronizes IP address assignments from live network devices into NetBox using a normalized desired/current state model and bulk-reconciliation. The task computes an explicit action plan — create, update, or mark in-sync — and applies it in a single pair of bulk API calls.
How It Works¤
The task follows a three-step pipeline:
- Collect live state — Run a Nornir
parse_ttpjob against the target devices to collect live IPv4 and IPv6 addresses per interface. - Fetch NetBox state — Retrieve all existing IP address objects from NetBox that match any discovered address value.
- Reconcile — Compare live addresses against NetBox records and classify each IP as:
- create — address not in NetBox at all; a new record is created and assigned to the interface
- update — address exists in NetBox but is unassigned or has a stale role/VRF; the record is updated
- in_sync — address already assigned to the correct interface with the correct role and VRF; no change needed
Roles are assigned automatically:
- Interfaces whose name starts with
loopbackorlo→ roleloopback - Addresses that fall within any configured
anycast_rangesprefix → roleanycast - All other addresses → no role (standard unicast)

- Client submits an on-demand request to the NorFab Netbox worker to sync device IP addresses
- Netbox worker sends a job request to the Nornir service to fetch live interface data from devices
- Nornir service collects IP address data from the network using
parse_ttp - Nornir returns normalized interface and IP data to the Netbox worker
- Netbox worker reconciles live addresses against NetBox and applies bulk create/update operations
Result Structure¤
Both dry-run and live-run modes return the same per-device structure keyed by device name:
{
"<device>": {
"created": ["10.0.0.1/31", "192.168.1.1/32"],
"updated": ["10.0.0.3/31"],
"in_sync": ["10.0.0.5/31", "2001:db8::1/128"]
}
}
Dry-run mode (dry_run=True) returns what would be created or updated without making any changes to NetBox.
Live-run mode (dry_run=False, default) applies changes and returns the same structure showing what was done.
Filtering¤
IP addresses and interfaces can be scoped before reconciliation. All filters are applied at the live-data collection phase, so excluded addresses are completely ignored — they are neither created nor updated.
filter_by_name— glob pattern matched against interface names, e.g."Loopback*"or"Ethernet[1-4]". Interfaces not matching are skipped entirely.filter_by_description— glob pattern matched against interface descriptions, e.g."uplink*". Interfaces not matching are skipped.filter_by_prefix— CIDR prefix such as"10.0.0.0/8". Only IP addresses whose host address falls within the prefix are included; supports both IPv4 and IPv6.filter_by_ip— glob pattern matched against the host portion of the IP address (without prefix length), e.g."10.0.1.*". Only matching addresses are included.
Multiple filters combine as intersection — all specified conditions must be satisfied for an IP to be included.
Anycast Support¤
IP addresses in one or more anycast_ranges prefixes are assigned the anycast role. NetBox allows multiple IP address records with the same value when the role is anycast, so each device gets its own record. Without anycast_ranges, a second device trying to use the same IP address triggers a duplicate-conflict error.
Set anycast_ranges to a prefix string or list of prefixes:
anycast_ranges = "10.0.250.0/24"
anycast_ranges = ["10.0.250.0/24", "2001:db8:ffff::/48"]
Process Prefixes¤
When create_prefixes=True the task also creates a NetBox prefix record for the network of each discovered IP address (e.g. 10.0.1.0/31 for 10.0.1.1/31). Existing prefixes are never updated or deleted — this is a create-only, idempotent operation. Site and VRF are propagated from the device and interface context.
Branching Support¤
The task is branch-aware and can push changes into a NetBox branch. The Netbox Branching Plugin must be installed. Specify the branch parameter; the branch is created automatically if it does not already exist.
Duplicate IP Guard¤
Before executing bulk writes the task checks that no non-anycast IP address appears more than once across the combined create and update payloads. If a duplicate is detected, all copies are removed from the payload and an error is recorded in the result, preventing NetBox from receiving conflicting assignments in a single request.
Examples¤
Sync IP addresses for a list of devices:
nf#netbox sync ip-addresses devices ceos-spine-1 ceos-spine-2
Preview changes without writing to NetBox (dry run):
nf#netbox sync ip-addresses devices ceos-spine-1 dry-run
Sync only loopback interface addresses:
nf#netbox sync ip-addresses devices ceos-spine-1 filter-by-name "Loopback*"
Sync only addresses within a specific prefix:
nf#netbox sync ip-addresses devices ceos-spine-1 filter-by-prefix "10.3.0.0/16"
Classify addresses in an anycast range and sync all devices:
nf#netbox sync ip-addresses devices ceos-spine-1 ceos-spine-2 ceos-leaf-1 anycast-ranges 10.0.250.0/24
Also create prefix records for each discovered IP subnet:
nf#netbox sync ip-addresses devices ceos-spine-1 create-prefixes
Sync into a NetBox branch:
nf#netbox sync ip-addresses devices ceos-spine-1 ceos-spine-2 branch sprint-42-ips
Sync using Nornir host filters instead of explicit device names:
nf#netbox sync ip-addresses FC spine
from norfab.core.nfapi import NorFab
nf = NorFab(inventory="./inventory.yaml")
nf.start()
client = nf.make_client()
# sync IP addresses for specific devices
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2"],
},
)
# dry run — preview creates/updates without writing to NetBox
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2"],
"dry_run": True,
},
)
# restrict sync to loopback interfaces only
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1"],
"filter_by_name": "Loopback*",
},
)
# restrict sync to addresses within a specific prefix
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2"],
"filter_by_prefix": "10.3.0.0/16",
},
)
# restrict sync to addresses matching a glob pattern
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1"],
"filter_by_ip": "10.3.4.*",
},
)
# restrict sync to interfaces with a specific description pattern
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1"],
"filter_by_description": "uplink*",
},
)
# classify addresses in anycast ranges and sync all fabric devices
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2", "ceos-leaf-1", "ceos-leaf-2"],
"anycast_ranges": "10.0.250.0/24",
},
)
# multiple anycast ranges (IPv4 and IPv6)
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2"],
"anycast_ranges": ["10.0.250.0/24", "2001:db8:ffff::/48"],
},
)
# also create prefix records for each discovered IP subnet
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1"],
"create_prefixes": True,
},
)
# sync into a NetBox branch
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2"],
"branch": "sprint-42-ips",
},
)
# use Nornir host filters instead of explicit device names
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"FC": "spine",
},
)
# combine filters: loopback interfaces within a specific prefix, dry run
result = client.run_job(
"netbox",
"sync_device_ip",
workers="any",
kwargs={
"devices": ["ceos-spine-1", "ceos-spine-2"],
"filter_by_name": "Loopback*",
"filter_by_prefix": "10.3.4.0/24",
"dry_run": True,
},
)
nf.destroy()
NORFAB Netbox Sync Device IP Command Shell Reference¤
NorFab shell supports these command options for the sync_device_ip task:
nf# man tree netbox.sync.ip-addresses
root
└── netbox: Netbox service
└── sync: Sync Netbox data
└── ip-addresses: Sync device IP addresses with NetBox
├── timeout: Job timeout in seconds
├── workers: Filter worker to target, default 'any'
├── verbose-result: Control output details, default 'False'
├── progress: Display progress events, default 'True'
├── instance: Netbox instance name to target
├── dry-run: Return reconciliation plan without pushing changes to NetBox
├── devices: List of NetBox device names to sync
├── anycast-ranges: IP prefix(es) used to classify addresses as anycast role
├── create-prefixes: Create missing IP prefix records for each discovered address
├── filter-by-name: Glob pattern to restrict sync by interface name, e.g. 'Loopback*'
├── filter-by-description: Glob pattern to restrict sync by interface description
├── filter-by-prefix: CIDR prefix to restrict sync to addresses within it, e.g. '10.0.0.0/8'
├── filter-by-ip: Glob pattern to restrict sync by IP host address, e.g. '10.0.1.*'
├── branch: Branching plugin branch name to push changes into
├── FO: Filter Nornir hosts using Filter Object
├── FB: Filter Nornir hosts by name using Glob Patterns
├── FH: Filter Nornir hosts by hostname
├── FC: Filter Nornir hosts by name containment
├── FR: Filter Nornir hosts by name using Regular Expressions
├── FG: Filter Nornir hosts by group
├── FP: Filter Nornir hosts by hostname using IP Prefix
├── FL: Filter Nornir hosts by names list
├── FM: Filter Nornir hosts by platform
└── FN: Negate the Nornir host filter match
nf#
Python API Reference¤
Synchronize IP addresses from live devices into NetBox.
The task follows a three-step pipeline:
- Collect live state: Run a Nornir
parse_ttpget interfaces job against devices to collect live IP addresses per interface. - Fetch NetBox state: Retrieve existing IP address objects from NetBox.
- Reconcile: Create new IP address objects, update existing unassigned or stale ones, and mark already-correct entries as in-sync.
Dry-run mode (dry_run=True): returns the reconciliation plan without
making any changes. Result is keyed by device name::
{
"<device>": {
"created": ["10.0.0.1/31", ...],
"updated": ["10.0.0.3/31", ...],
"in_sync": ["10.0.0.5/31", ...]
}
}
Live-run mode (dry_run=False, default): applies changes and returns
the same structure showing what was done.
Side Effects
- When overlapping IP discovered in Netbox and it is part of anycast range,
existing IP role update to
anycast
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job
|
Job
|
NorFab Job object containing relevant metadata. |
required |
instance
|
str
|
The NetBox instance name to use. |
None
|
dry_run
|
bool
|
If True, no changes will be made to NetBox. |
False
|
timeout
|
int
|
Timeout in seconds for the Nornir parse_ttp job. |
60
|
devices
|
list
|
List of device names to sync. |
None
|
branch
|
str
|
NetBox branch name to use. |
None
|
anycast_ranges
|
list
|
IP prefix(es) used to classify
IP addresses as anycast role, e.g. |
None
|
ignore_ranges
|
list
|
Prefixes to ignore IP addresses for, includes by default 127.0.0.0/8, 224.0.0.0/24 and others |
None
|
create_prefixes
|
bool
|
If True, create missing IP prefixes in NetBox for each discovered IP address. No updates or deletions are done. |
False
|
filter_by_name
|
str
|
Glob pattern to restrict which interfaces
are included by name, e.g. |
None
|
filter_by_description
|
str
|
Glob pattern to restrict which
interfaces are included by description, e.g. |
None
|
filter_by_prefix
|
str
|
IP prefix to restrict which IP addresses
are included, e.g. |
None
|
filter_by_ip
|
str
|
Glob pattern to restrict which IP addresses
are included, e.g. |
None
|
**kwargs
|
Any
|
Additional Nornir host filter keyword arguments passed to
|
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
Result |
Result
|
Per-device action summary with |
Source code in norfab\workers\netbox_worker\ip_tasks.py
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 | |