15
16
17
18
19
20
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 | @Task(fastapi={"methods": ["GET"], "schema": NetboxFastApiArgs.model_json_schema()})
def get_connections(
self,
job: Job,
devices: list[str],
instance: Union[None, str] = None,
dry_run: bool = False,
cables: bool = False,
cache: Union[None, bool, str] = None,
include_virtual: bool = True,
interface_regex: Union[None, str] = None,
) -> Result:
"""
Retrieve interface connection details for specified devices from Netbox.
This task retrieves these connections:
- Physical interfaces connections
- Child/virtual interfaces connections using parent interface connections details
- Lag interfaces connections using member ports connections details
- Lag child interfaces connections using member ports connections details
- Console port and console server ports connections
- Connections to provider networks for physical, child/virtual and lag interfaces
Args:
job: NorFab Job object containing relevant metadata
devices (list): List of device names to retrieve connections for.
instance (str, optional): Netbox instance name for the GraphQL query.
dry_run (bool, optional): If True, perform a dry run without making actual changes.
cables (bool, optional): if True includes interfaces' directly attached cables and peers details
include_virtual (bool, optional): if True include connections for virtual and LAG interfaces
interface_regex (str, optional): Regex pattern to match interfaces, console ports and
console server ports by name, case insensitive.
Returns:
dict: A dictionary containing connection details for each device:
```
{
"netbox-worker-1.2": {
"r1": {
"Console": {
"breakout": false,
"remote_device": "termserv1",
"remote_device_status": "active",
"remote_interface": "ConsoleServerPort1",
"remote_termination_type": "consoleserverport",
"termination_type": "consoleport"
},
"eth1": {
"breakout": false,
"remote_device": "r2",
"remote_device_status": "active",
"remote_interface": "eth8",
"remote_termination_type": "interface",
"termination_type": "interface"
}
}
}
}
```
Raises:
Exception: If there is an error in the GraphQL query or data retrieval process.
"""
instance = instance or self.default_instance
log.info(
f"{self.name} - Get connections: Fetching connections for {len(devices)} device(s) from '{instance}'"
)
job.event(f"fetching connections for {len(devices)} device(s)")
ret = Result(
task=f"{self.name}:get_connections",
result={d: {} for d in devices},
resources=[instance],
)
# form lists of fields to request from netbox
cable_fields = """
cable {
type
status
tenant {name}
label
tags {name}
length
length_unit
custom_fields
}
"""
interfaces_fields = [
"name",
"type",
"device {name, status}",
"""
member_interfaces {
name
connected_endpoints {
__typename
... on ProviderNetworkType {name}
... on InterfaceType {name, device {name, status}, child_interfaces {name}, lag {name child_interfaces {name}}}
}
}
""",
"""
parent {
name
type
member_interfaces {
name
connected_endpoints {
__typename
... on ProviderNetworkType {name}
... on InterfaceType {name, device {name, status}, child_interfaces {name}, lag {name child_interfaces {name}}}
}
}
connected_endpoints {
__typename
... on ProviderNetworkType {name}
... on InterfaceType {name, device {name, status}, child_interfaces {name}, lag {name child_interfaces {name}}}
}
}
""",
"""
connected_endpoints {
__typename
... on ProviderNetworkType {name}
... on InterfaceType {name, device {name, status}, child_interfaces {name}, lag {name child_interfaces {name}}}
}
""",
"""
link_peers {
__typename
... on InterfaceType {name device {name, status}}
... on FrontPortType {name device {name, status}}
... on RearPortType {name device {name, status}}
}
""",
]
console_ports_fields = [
"name",
"device {name, status}",
"type",
"""connected_endpoints {
__typename
... on ConsoleServerPortType {name device {name, status}}
}""",
"""link_peers {
__typename
... on ConsoleServerPortType {name device {name, status}}
... on FrontPortType {name device {name, status}}
... on RearPortType {name device {name, status}}
}""",
]
console_server_ports_fields = [
"name",
"device {name, status}",
"type",
"""connected_endpoints {
__typename
... on ConsolePortType {name device {name, status}}
}""",
"""link_peers {
__typename
... on ConsolePortType {name device {name, status}}
... on FrontPortType {name device {name, status}}
... on RearPortType {name device {name, status}}
}""",
]
power_outlet_fields = [
"name",
"device {name, status}",
"type",
"""connected_endpoints {
__typename
... on PowerPortType {name device {name, status}}
}""",
"""link_peers {
__typename
... on PowerPortType {name device {name, status}}
}""",
]
# check if need to include cables info
if cables is True:
interfaces_fields.append(cable_fields)
console_ports_fields.append(cable_fields)
console_server_ports_fields.append(cable_fields)
power_outlet_fields.append(cable_fields)
# form query dictionary with aliases to get data from Netbox
dlist = str(devices).replace("'", '"') # swap quotes
if self.nb_version[instance] >= (4, 4, 0):
if interface_regex:
filters = (
"{device: {name: {in_list: "
+ dlist
+ "}}, "
+ "name: {i_regex: "
+ f'"{interface_regex}"'
+ "}}"
)
else:
filters = "{device: {name: {in_list: " + dlist + "}}}"
else:
raise UnsupportedNetboxVersion(
f"{self.name} - Netbox version {self.nb_version[instance]} is not supported, "
f"minimum required version is {self.compatible_ge_v4}"
)
queries = {
"interface": {
"obj": "interface_list",
"filters": filters,
"fields": interfaces_fields,
},
"consoleport": {
"obj": "console_port_list",
"filters": filters,
"fields": console_ports_fields,
},
"consoleserverport": {
"obj": "console_server_port_list",
"filters": filters,
"fields": console_server_ports_fields,
},
"poweroutlet": {
"obj": "power_outlet_list",
"filters": filters,
"fields": power_outlet_fields,
},
}
# retrieve full list of devices interface with all cables
query_result = self.graphql(
job=job, queries=queries, instance=instance, dry_run=dry_run
)
# return dry run result
if dry_run:
return query_result
all_ports = query_result.result
if not all_ports:
log.info(
f"{self.name} - Get connections: No ports returned for {len(devices)} device(s)"
)
return ret
# extract physical interfaces connections
for port_type, ports in all_ports.items():
for port in ports:
# skip ports that have no remote device connected
endpoints = port["connected_endpoints"]
if not endpoints or not all(i for i in endpoints):
continue
# extract required parameters
cable = port.get("cable", {})
device_name = port["device"]["name"]
port_name = port["name"]
link_peers = port["link_peers"]
remote_termination_type = endpoints[0]["__typename"].lower()
remote_termination_type = remote_termination_type.replace("type", "")
# form initial connection dictionary
connection = {
"breakout": len(endpoints) > 1,
"remote_termination_type": remote_termination_type,
"termination_type": port_type,
}
# add remote connection details
if remote_termination_type == "providernetwork":
connection["remote_device"] = None
connection["remote_device_status"] = None
connection["remote_interface"] = None
connection["provider"] = endpoints[0]["name"]
else:
remote_interface = endpoints[0]["name"]
if len(endpoints) > 1:
remote_interface = list(sorted([i["name"] for i in endpoints]))
connection["remote_interface"] = remote_interface
connection["remote_device"] = endpoints[0]["device"]["name"]
connection["remote_device_status"] = endpoints[0]["device"][
"status"
]
# add cable and its peer details
if cables:
peer_termination_type = link_peers[0]["__typename"].lower()
peer_termination_type = peer_termination_type.replace("type", "")
cable["peer_termination_type"] = peer_termination_type
cable["peer_device"] = link_peers[0].get("device", {}).get("name")
cable["peer_interface"] = link_peers[0].get("name")
if len(link_peers) > 1: # handle breakout cable
cable["peer_interface"] = [i["name"] for i in link_peers]
connection["cable"] = cable
# add physical connection to the results
ret.result[device_name][port_name] = connection
# extract virtual interfaces connections
for port_type, ports in all_ports.items():
for port in ports:
# add child virtual interfaces connections
if (
not include_virtual
or port["type"] != "virtual"
or not port["parent"]
):
continue
device_name = port["device"]["name"]
interface_name = port["name"]
parent = port["parent"]
connection = {
"remote_device": None,
"remote_device_status": None,
"remote_interface": None,
"remote_termination_type": "virtual",
"termination_type": "virtual",
}
# find connection endpoint
if parent["type"] == "lag":
try:
endpoint = parent["member_interfaces"][0][
"connected_endpoints"
][0]
except Exception:
continue
elif parent["connected_endpoints"]:
try:
endpoint = parent["connected_endpoints"][0]
except Exception:
continue
else:
log.error(
f"{device_name}:{interface_name} Parent has no connected endpoints"
)
continue
connection["remote_device"] = endpoint["device"]["name"]
connection["remote_device_status"] = endpoint["device"]["status"]
remote_termination_type = endpoint["__typename"].lower()
remote_termination_type = remote_termination_type.replace("type", "")
# collect virtual interfaces facing provider
if remote_termination_type == "providernetwork":
connection["provider"] = endpoint["name"]
# find matching remote virtual interface for LAG subif
elif "." in interface_name and parent["type"] == "lag":
subif_id = interface_name.split(".")[1]
for remote_child in endpoint["lag"]["child_interfaces"]:
if remote_child["name"].endswith(f".{subif_id}"):
connection["remote_interface"] = remote_child["name"]
break
# no matching subinterface found, associate child interface with remote interface
else:
connection["remote_interface"] = endpoint["lag"]["name"]
connection["remote_termination_type"] = "lag"
# find matching remote virtual interface for physical interface subif
elif "." in interface_name:
subif_id = interface_name.split(".")[1]
for remote_child in endpoint["child_interfaces"]:
if remote_child["name"].endswith(f".{subif_id}"):
connection["remote_interface"] = remote_child["name"]
break
# no matching subinterface found, associate child interface with remote interface
else:
connection["remote_interface"] = endpoint["name"]
connection["remote_termination_type"] = remote_termination_type
# add virtual interface connection to results
ret.result[device_name][interface_name] = connection
# extract LAG interfaces connections
for port_type, ports in all_ports.items():
for port in ports:
if not include_virtual or port["type"] != "lag":
continue
device_name = port["device"]["name"]
interface_name = port["name"]
connection = {
"remote_device": None,
"remote_device_status": None,
"remote_interface": None,
"remote_termination_type": "lag",
"termination_type": "lag",
}
try:
endpoint = port["member_interfaces"][0]["connected_endpoints"][0]
except Exception:
continue
remote_termination_type = endpoint["__typename"].lower()
remote_termination_type = remote_termination_type.replace("type", "")
# collect lag interfaces facing provider
if remote_termination_type == "providernetwork":
connection["provider"] = endpoint["name"]
# find remote lag interface
elif endpoint["lag"]:
connection["remote_interface"] = endpoint["lag"]["name"]
connection["remote_device"] = endpoint["device"]["name"]
connection["remote_device_status"] = endpoint["device"]["status"]
# add lag interface connection to results
ret.result[device_name][interface_name] = connection
log.info(
f"{self.name} - get_connections: completed with connection data for {len(ret.result)} device(s)"
)
job.event(f"retrieved connections for {len(ret.result)} device(s)")
return ret
|