File size: 8,187 Bytes
8247f19 | 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 | # Patch-overlapping Python context after the fix
## `nautobot_device_onboarding/jobs.py` — `class:OnboardingTask` (lines 15-93)
```python
class OnboardingTask(Job):
"""Nautobot Job for onboarding a new device."""
location = ObjectVar(model=Location, query_params={"": ""}, required=False, description="")
ip_address = IPAddressVar(description="", label="")
port = IntegerVar(description="")
timeout = IntegerVar(description="")
credentials = ObjectVar(model=SecretsGroup, query_params={"": ""}, required=False, description="")
platform = ObjectVar(model=Platform, required=False, description="")
role = ObjectVar(model=Role, query_params={"": ""}, required=False, description="")
device_type = ObjectVar(model=DeviceType, required=False, description="")
class Meta: # pylint: disable=too-few-public-methods
"""Meta object boilerplate for onboarding."""
name = "Perform Device Onboarding"
description = "Login to a device and populate Nautobot device object."
has_sensitive_variables = False
def __init__(self, *args, **kwargs):
"""Overload init to instantiate class attributes per W0201."""
self.username = None
self.password = None
self.secret = None
super().__init__(*args, **kwargs)
def run(self, *args, **data):
"""Process a single Onboarding Task instance."""
self.logger.info("START: onboard device")
self._parse_credentials(data["credentials"])
platform = data["platform"]
netdev = NetdevKeeper(
hostname=data["ip_address"],
port=data["port"],
timeout=data["timeout"],
username=self.username,
password=self.password,
secret=self.secret,
napalm_driver=platform.napalm_driver if platform and platform.napalm_driver else None,
optional_args=platform.napalm_args if platform and platform.napalm_args else settings.NAPALM_ARGS,
)
netdev.get_onboarding_facts()
netdev_dict = netdev.get_netdev_dict()
onboarding_kwargs = {
# Kwargs extracted from OnboardingTask:
"netdev_mgmt_ip_address": data["ip_address"],
"netdev_nb_location_name": data["location"].name,
"netdev_nb_device_type_name": data["device_type"],
"netdev_nb_role_name": data["role"].name if data["role"] else PLUGIN_SETTINGS["default_device_role"],
"netdev_nb_role_color": PLUGIN_SETTINGS["default_device_role_color"],
"netdev_nb_platform_name": data["platform"].name if data["platform"] else None,
# Kwargs discovered on the Onboarded Device:
"netdev_hostname": netdev_dict["netdev_hostname"],
"netdev_vendor": netdev_dict["netdev_vendor"],
"netdev_model": netdev_dict["netdev_model"],
"netdev_serial_number": netdev_dict["netdev_serial_number"],
"netdev_mgmt_ifname": netdev_dict["netdev_mgmt_ifname"],
"netdev_mgmt_pflen": netdev_dict["netdev_mgmt_pflen"],
"netdev_netmiko_device_type": netdev_dict["netdev_netmiko_device_type"],
"onboarding_class": netdev_dict["onboarding_class"],
"driver_addon_result": netdev_dict["driver_addon_result"],
}
onboarding_cls = netdev_dict["onboarding_class"]()
onboarding_cls.credentials = {"username": self.username, "password": self.password, "secret": self.secret}
onboarding_cls.run(onboarding_kwargs=onboarding_kwargs)
def _parse_credentials(self, credentials):
"""Parse and return dictionary of credentials."""
if credentials:
self.username = credentials.secrets.get(secret_type=SecretsGroupSecretTypeChoices.TYPE_USERNAME)
self.password = credentials.secrets.get(secret_type=SecretsGroupSecretTypeChoices.TYPE_PASSWORD)
secret = credentials.secrets.filter(secret_type=SecretsGroupSecretTypeChoices.TYPE_SECRET)
if secret.exists():
self.secret = secret.first()
else:
self.username = settings.NAPALM_USERNAME
self.password = settings.NAPALM_PASSWORD
self.secret = settings.NAPALM_ARGS.get("secret", None)
```
## `nautobot_device_onboarding/jobs.py` — `class:OnboardingTask.Meta` (lines 27-32)
```python
class Meta: # pylint: disable=too-few-public-methods
"""Meta object boilerplate for onboarding."""
name = "Perform Device Onboarding"
description = "Login to a device and populate Nautobot device object."
has_sensitive_variables = False
```
## `nautobot_device_onboarding/jobs.py` — `function:OnboardingTask.__init__` (lines 34-39)
```python
def __init__(self, *args, **kwargs):
"""Overload init to instantiate class attributes per W0201."""
self.username = None
self.password = None
self.secret = None
super().__init__(*args, **kwargs)
```
## `nautobot_device_onboarding/jobs.py` — `function:OnboardingTask.run` (lines 41-80)
```python
def run(self, *args, **data):
"""Process a single Onboarding Task instance."""
self.logger.info("START: onboard device")
self._parse_credentials(data["credentials"])
platform = data["platform"]
netdev = NetdevKeeper(
hostname=data["ip_address"],
port=data["port"],
timeout=data["timeout"],
username=self.username,
password=self.password,
secret=self.secret,
napalm_driver=platform.napalm_driver if platform and platform.napalm_driver else None,
optional_args=platform.napalm_args if platform and platform.napalm_args else settings.NAPALM_ARGS,
)
netdev.get_onboarding_facts()
netdev_dict = netdev.get_netdev_dict()
onboarding_kwargs = {
# Kwargs extracted from OnboardingTask:
"netdev_mgmt_ip_address": data["ip_address"],
"netdev_nb_location_name": data["location"].name,
"netdev_nb_device_type_name": data["device_type"],
"netdev_nb_role_name": data["role"].name if data["role"] else PLUGIN_SETTINGS["default_device_role"],
"netdev_nb_role_color": PLUGIN_SETTINGS["default_device_role_color"],
"netdev_nb_platform_name": data["platform"].name if data["platform"] else None,
# Kwargs discovered on the Onboarded Device:
"netdev_hostname": netdev_dict["netdev_hostname"],
"netdev_vendor": netdev_dict["netdev_vendor"],
"netdev_model": netdev_dict["netdev_model"],
"netdev_serial_number": netdev_dict["netdev_serial_number"],
"netdev_mgmt_ifname": netdev_dict["netdev_mgmt_ifname"],
"netdev_mgmt_pflen": netdev_dict["netdev_mgmt_pflen"],
"netdev_netmiko_device_type": netdev_dict["netdev_netmiko_device_type"],
"onboarding_class": netdev_dict["onboarding_class"],
"driver_addon_result": netdev_dict["driver_addon_result"],
}
onboarding_cls = netdev_dict["onboarding_class"]()
onboarding_cls.credentials = {"username": self.username, "password": self.password, "secret": self.secret}
onboarding_cls.run(onboarding_kwargs=onboarding_kwargs)
```
## `nautobot_device_onboarding/jobs.py` — `function:OnboardingTask._parse_credentials` (lines 82-93)
```python
def _parse_credentials(self, credentials):
"""Parse and return dictionary of credentials."""
if credentials:
self.username = credentials.secrets.get(secret_type=SecretsGroupSecretTypeChoices.TYPE_USERNAME)
self.password = credentials.secrets.get(secret_type=SecretsGroupSecretTypeChoices.TYPE_PASSWORD)
secret = credentials.secrets.filter(secret_type=SecretsGroupSecretTypeChoices.TYPE_SECRET)
if secret.exists():
self.secret = secret.first()
else:
self.username = settings.NAPALM_USERNAME
self.password = settings.NAPALM_PASSWORD
self.secret = settings.NAPALM_ARGS.get("secret", None)
```
|