-
Notifications
You must be signed in to change notification settings - Fork 25
/
nautobot_keeper.py
499 lines (431 loc) · 21.4 KB
/
nautobot_keeper.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
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
"""Nautobot Keeper.
(c) 2020-2021 Network To Code
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import logging
import re
from django.conf import settings
from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ValidationError
from django.utils.text import slugify
from nautobot.dcim.choices import InterfaceTypeChoices
from nautobot.dcim.models import Manufacturer, Device, Interface, DeviceType, DeviceRole
from nautobot.dcim.models import Platform
from nautobot.dcim.models import Site
from nautobot.extras.models import Status
from nautobot.extras.models.customfields import CustomField
from nautobot.ipam.models import IPAddress
from .constants import NETMIKO_TO_NAPALM_STATIC
from .exceptions import OnboardException
logger = logging.getLogger("rq.worker")
PLUGIN_SETTINGS = settings.PLUGINS_CONFIG["nautobot_device_onboarding"]
def ensure_default_cf(obj, model):
"""Update objects's default custom fields."""
for cf in CustomField.objects.get_for_model(model):
if (cf.default is not None) and (cf.name not in obj.cf):
obj.cf[cf.name] = cf.default
try:
obj.validated_save()
except ValidationError as err:
raise OnboardException(
reason="fail-general",
message=f"ERROR: {obj} validation error: {err.messages}",
)
def object_match(obj, search_array):
"""Used to search models for multiple criteria.
Inputs:
obj: The model used for searching.
search_array: Nested dictionaries used to search models. First criteria will be used
for strict searching. Loose searching will loop through the search_array
until it finds a match. Example below.
[
{"slug__iexact": 'switch1'},
{"model__iexact": 'Cisco'}
]
"""
try:
result = obj.objects.get(**search_array[0])
return result
except obj.DoesNotExist:
if PLUGIN_SETTINGS["object_match_strategy"] == "loose":
for search_array_element in search_array[1:]:
try:
result = obj.objects.get(**search_array_element)
return result
except obj.DoesNotExist:
pass
except obj.MultipleObjectsReturned:
raise OnboardException(
reason="fail-general",
message=f"ERROR multiple objects found in {str(obj)} searching on {str(search_array_element)})",
)
raise
except obj.MultipleObjectsReturned:
raise OnboardException(
reason="fail-general",
message=f"ERROR multiple objects found in {str(obj)} searching on {str(search_array_element)})",
)
class NautobotKeeper:
"""Used to manage the information relating to the network device within the Nautobot server."""
def __init__( # pylint: disable=R0913,R0914
self,
netdev_hostname,
netdev_nb_role_slug,
netdev_vendor,
netdev_nb_site_slug,
netdev_nb_device_type_slug=None,
netdev_model=None,
netdev_nb_role_color=None,
netdev_mgmt_ip_address=None,
netdev_nb_platform_slug=None,
netdev_serial_number=None,
netdev_mgmt_ifname=None,
netdev_mgmt_pflen=None,
netdev_netmiko_device_type=None,
onboarding_class=None,
driver_addon_result=None,
):
"""Create an instance and initialize the managed attributes that are used throughout the onboard processing.
Args:
netdev_hostname (str): Nautobot's device name
netdev_nb_role_slug (str): Nautobot's device role slug
netdev_vendor (str): Device's vendor name
netdev_nb_site_slug (str): Device site's slug
netdev_nb_device_type_slug (str): Device type's slug
netdev_model (str): Device's model
netdev_nb_role_color (str): Nautobot device's role color
netdev_mgmt_ip_address (str): IPv4 Address of a device
netdev_nb_platform_slug (str): Nautobot device's platform slug
netdev_serial_number (str): Device's serial number
netdev_mgmt_ifname (str): Device's management interface name
netdev_mgmt_pflen (str): Device's management IP prefix-len
netdev_netmiko_device_type (str): Device's Netmiko device type
onboarding_class (Object): Onboarding Class (future use)
driver_addon_result (Any): Attached extended result (future use)
"""
self.netdev_mgmt_ip_address = netdev_mgmt_ip_address
self.netdev_nb_site_slug = netdev_nb_site_slug
self.netdev_nb_device_type_slug = netdev_nb_device_type_slug
self.netdev_nb_role_slug = netdev_nb_role_slug
self.netdev_nb_role_color = netdev_nb_role_color
self.netdev_nb_platform_slug = netdev_nb_platform_slug
self.netdev_hostname = netdev_hostname
self.netdev_vendor = netdev_vendor
self.netdev_model = netdev_model
self.netdev_serial_number = netdev_serial_number
self.netdev_mgmt_ifname = netdev_mgmt_ifname
self.netdev_mgmt_pflen = netdev_mgmt_pflen
self.netdev_netmiko_device_type = netdev_netmiko_device_type
self.onboarding_class = onboarding_class
self.driver_addon_result = driver_addon_result
# these attributes are nautobot model instances as discovered/created
# through the course of processing.
self.nb_site = None
self.nb_manufacturer = None
self.nb_device_type = None
self.nb_device_role = None
self.nb_platform = None
self.device = None
self.onboarded_device = None
self.nb_mgmt_ifname = None
self.nb_primary_ip = None
def ensure_onboarded_device(self):
"""Lookup if the device already exists in the Nautobot.
Lookup is performed by querying for the IP address of the onboarded device.
If the device with a given IP is already in Nautobot, its attributes including name could be updated
"""
try:
if self.netdev_mgmt_ip_address:
self.onboarded_device = Device.objects.get(primary_ip4__host=self.netdev_mgmt_ip_address)
except Device.DoesNotExist:
logger.info(
"Could not find existing Nautobot device for requested primary IP address (%s)",
self.netdev_mgmt_ip_address,
)
except Device.MultipleObjectsReturned:
raise OnboardException(
reason="fail-general",
message=f"ERROR multiple devices using same IP in Nautobot: {self.netdev_mgmt_ip_address}",
)
def ensure_device_site(self):
"""Ensure device's site."""
try:
self.nb_site = Site.objects.get(slug=self.netdev_nb_site_slug)
except Site.DoesNotExist:
raise OnboardException(reason="fail-config", message=f"Site not found: {self.netdev_nb_site_slug}")
def ensure_device_manufacturer(
self,
create_manufacturer=PLUGIN_SETTINGS["create_manufacturer_if_missing"],
skip_manufacturer_on_update=PLUGIN_SETTINGS["skip_manufacturer_on_update"],
):
"""Ensure device's manufacturer."""
# Support to skip manufacturer updates for existing devices
if self.onboarded_device and skip_manufacturer_on_update:
self.nb_manufacturer = self.onboarded_device.device_type.manufacturer
return
# First ensure that the vendor, as extracted from the network device exists
# in Nautobot. We need the ID for this vendor when ensuring the DeviceType
# instance.
nb_manufacturer_slug = slugify(self.netdev_vendor)
try:
search_array = [{"slug__iexact": nb_manufacturer_slug}]
self.nb_manufacturer = object_match(Manufacturer, search_array)
except Manufacturer.DoesNotExist:
if create_manufacturer:
self.nb_manufacturer = Manufacturer.objects.create(name=self.netdev_vendor, slug=nb_manufacturer_slug)
ensure_default_cf(obj=self.nb_manufacturer, model=Manufacturer)
else:
raise OnboardException(
reason="fail-config", message=f"ERROR manufacturer not found: {self.netdev_vendor}"
)
def ensure_device_type(
self,
create_device_type=PLUGIN_SETTINGS["create_device_type_if_missing"],
skip_device_type_on_update=PLUGIN_SETTINGS["skip_device_type_on_update"],
):
"""Ensure the Device Type (slug) exists in Nautobot associated to the netdev "model" and "vendor" (manufacturer).
Args:
create_device_type (bool): Flag to indicate if we need to create the device_type, if not already present
skip_device_type_on_update (bool): Flag to indicate if we skip device type updates for existing devices
Raises:
OnboardException('fail-config'):
When the device vendor value does not exist as a Manufacturer in
Nautobot.
OnboardException('fail-config'):
When the device-type exists by slug, but is assigned to a different
manufacturer. This should *not* happen, but guard-rail checking
regardless in case two vendors have the same model name.
"""
# Support to skip device type updates for existing devices
if self.onboarded_device and skip_device_type_on_update:
self.nb_device_type = self.onboarded_device.device_type
return
# Now see if the device type (slug) already exists,
# if so check to make sure that it is not assigned as a different manufacturer
# if it doesn't exist, create it if the flag 'create_device_type_if_missing' is defined
slug = self.netdev_model
if self.netdev_model and re.search(r"[^a-zA-Z0-9\-_]+", slug):
logger.warning("device model is not sluggable: %s", slug)
self.netdev_model = slug.replace(" ", "-")
logger.warning("device model is now: %s", self.netdev_model)
# Use declared device type or auto-discovered model
nb_device_type_text = self.netdev_nb_device_type_slug or self.netdev_model
if not nb_device_type_text:
raise OnboardException(reason="fail-config", message="ERROR device type not found")
nb_device_type_slug = slugify(nb_device_type_text)
try:
search_array = [
{"slug__iexact": nb_device_type_slug},
{"model__iexact": self.netdev_model},
{"part_number__iexact": self.netdev_model},
]
self.nb_device_type = object_match(DeviceType, search_array)
if self.nb_device_type.manufacturer.id != self.nb_manufacturer.id:
raise OnboardException(
reason="fail-config",
message=f"ERROR device type {self.netdev_model} " f"already exists for vendor {self.netdev_vendor}",
)
except DeviceType.DoesNotExist:
if create_device_type:
logger.info("CREATE: device-type: %s", self.netdev_model)
self.nb_device_type = DeviceType.objects.create(
slug=nb_device_type_slug,
model=nb_device_type_slug.upper(),
manufacturer=self.nb_manufacturer,
)
ensure_default_cf(obj=self.nb_device_type, model=DeviceType)
else:
raise OnboardException(
reason="fail-config", message=f"ERROR device type not found: {self.netdev_model}"
)
def ensure_device_role(
self,
create_device_role=PLUGIN_SETTINGS["create_device_role_if_missing"],
):
"""Ensure that the device role is defined / exist in Nautobot or create it if it doesn't exist.
Args:
create_device_role (bool) :Flag to indicate if we need to create the device_role, if not already present
Raises:
OnboardException('fail-config'):
When the device role value does not exist
Nautobot.
"""
try:
self.nb_device_role = DeviceRole.objects.get(slug=self.netdev_nb_role_slug)
except DeviceRole.DoesNotExist:
if create_device_role:
self.nb_device_role = DeviceRole.objects.create(
name=self.netdev_nb_role_slug,
slug=self.netdev_nb_role_slug,
color=self.netdev_nb_role_color,
vm_role=False,
)
ensure_default_cf(obj=self.nb_device_role, model=DeviceRole)
else:
raise OnboardException(
reason="fail-config", message=f"ERROR device role not found: {self.netdev_nb_role_slug}"
)
def ensure_device_platform(self, create_platform_if_missing=PLUGIN_SETTINGS["create_platform_if_missing"]):
"""Get platform object from Nautobot filtered by platform_slug.
Args:
platform_slug (string): slug of a platform object present in Nautobot, object will be created if not present
and create_platform_if_missing is enabled
Return:
nautobot.dcim.models.Platform object
Raises:
OnboardException
Lookup is performed based on the object's slug field (not the name field)
"""
try:
self.netdev_nb_platform_slug = (
self.netdev_nb_platform_slug
or PLUGIN_SETTINGS["platform_map"].get(self.netdev_netmiko_device_type)
or self.netdev_netmiko_device_type
)
if not self.netdev_nb_platform_slug:
raise OnboardException(
reason="fail-config", message=f"ERROR device platform not found: {self.netdev_hostname}"
)
self.nb_platform = Platform.objects.get(slug=self.netdev_nb_platform_slug)
logger.info("PLATFORM: found in Nautobot %s", self.netdev_nb_platform_slug)
except Platform.DoesNotExist:
if create_platform_if_missing:
platform_to_napalm_nautobot = {
platform.slug: platform.napalm_driver
for platform in Platform.objects.all()
if platform.napalm_driver
}
# Update Constants if Napalm driver is defined for Nautobot Platform
netmiko_to_napalm = {**NETMIKO_TO_NAPALM_STATIC, **platform_to_napalm_nautobot}
self.nb_platform = Platform.objects.create(
name=self.netdev_nb_platform_slug,
slug=self.netdev_nb_platform_slug,
napalm_driver=netmiko_to_napalm[self.netdev_netmiko_device_type],
)
ensure_default_cf(obj=self.nb_platform, model=Platform)
else:
raise OnboardException(
reason="fail-general",
message=f"ERROR platform not found in Nautobot: {self.netdev_nb_platform_slug}",
)
def ensure_device_instance(self, default_status=PLUGIN_SETTINGS["default_device_status"]):
"""Ensure that the device instance exists in Nautobot and is assigned the provided device role or DEFAULT_ROLE.
Args:
default_status (str) : status assigned to a new device by default.
"""
if self.onboarded_device:
# Construct lookup arguments if onboarded device already exists in Nautobot
logger.info(
"Found existing Nautobot device (%s) for requested primary IP address (%s)",
self.onboarded_device.name,
self.netdev_mgmt_ip_address,
)
lookup_args = {
"pk": self.onboarded_device.pk,
"defaults": dict(
name=self.netdev_hostname,
device_type=self.nb_device_type,
device_role=self.nb_device_role,
platform=self.nb_platform,
site=self.nb_site,
serial=self.netdev_serial_number,
# status= field is not updated in case of already existing devices to prevent changes
),
}
else:
# Construct lookup arguments if onboarded device does not exist in Nautobot
ct = ContentType.objects.get_for_model(Device) # pylint: disable=invalid-name
try:
device_status = Status.objects.get(content_types__in=[ct], name=default_status)
except Status.DoesNotExist:
raise OnboardException(
reason="fail-general",
message=f"ERROR could not find existing device status: {default_status}",
)
except Status.MultipleObjectsReturned:
raise OnboardException(
reason="fail-general",
message=f"ERROR multiple device status using same name: {default_status}",
)
lookup_args = {
"name": self.netdev_hostname,
"defaults": dict(
device_type=self.nb_device_type,
device_role=self.nb_device_role,
platform=self.nb_platform,
site=self.nb_site,
serial=self.netdev_serial_number,
# `status` field is defined only for new devices, no update for existing should occur
status=device_status,
),
}
try:
self.device, created = Device.objects.update_or_create(**lookup_args)
ensure_default_cf(obj=self.device, model=Device)
if created:
logger.info("CREATED device: %s", self.netdev_hostname)
else:
logger.info("GOT/UPDATED device: %s", self.netdev_hostname)
except Device.MultipleObjectsReturned:
raise OnboardException(
reason="fail-general",
message=f"ERROR multiple devices using same name in Nautobot: {self.netdev_hostname}",
)
def ensure_interface(self):
"""Ensures that the interface associated with the mgmt_ipaddr exists and is assigned to the device."""
if self.netdev_mgmt_ifname:
self.nb_mgmt_ifname, _ = Interface.objects.get_or_create(
name=self.netdev_mgmt_ifname, device=self.device, defaults=dict(type=InterfaceTypeChoices.TYPE_OTHER)
)
ensure_default_cf(obj=self.nb_mgmt_ifname, model=Interface)
def ensure_primary_ip(self):
"""Ensure mgmt_ipaddr exists in IPAM, has the device interface, and is assigned as the primary IP address."""
# see if the primary IP address exists in IPAM
if self.netdev_mgmt_ip_address and self.netdev_mgmt_pflen:
ct = ContentType.objects.get_for_model(IPAddress) # pylint: disable=invalid-name
default_status_name = PLUGIN_SETTINGS["default_ip_status"]
try:
ip_status = Status.objects.get(content_types__in=[ct], name=default_status_name)
except Status.DoesNotExist:
raise OnboardException(
reason="fail-general",
message=f"ERROR could not find existing IP Address status: {default_status_name}",
)
except Status.MultipleObjectsReturned:
raise OnboardException(
reason="fail-general",
message=f"ERROR multiple IP Address status using same name: {default_status_name}",
)
self.nb_primary_ip, created = IPAddress.objects.get_or_create(
address=f"{self.netdev_mgmt_ip_address}/{self.netdev_mgmt_pflen}", defaults={"status": ip_status}
)
ensure_default_cf(obj=self.nb_primary_ip, model=IPAddress)
if created or self.nb_primary_ip not in self.nb_mgmt_ifname.ip_addresses.all():
logger.info("ASSIGN: IP address %s to %s", self.nb_primary_ip.address, self.nb_mgmt_ifname.name)
self.nb_mgmt_ifname.ip_addresses.add(self.nb_primary_ip)
self.nb_mgmt_ifname.full_clean()
self.nb_mgmt_ifname.save()
# Ensure the primary IP is assigned to the device
self.device.primary_ip4 = self.nb_primary_ip
self.device.full_clean()
self.device.save()
def ensure_device(self):
"""Ensure that the device represented by the DevNetKeeper exists in the Nautobot system."""
self.ensure_onboarded_device()
self.ensure_device_site()
self.ensure_device_manufacturer()
self.ensure_device_type()
self.ensure_device_role()
self.ensure_device_platform()
self.ensure_device_instance()
if PLUGIN_SETTINGS["create_management_interface_if_missing"]:
self.ensure_interface()
self.ensure_primary_ip()