nornir-collection 0.0.24__py3-none-any.whl → 0.0.26__py3-none-any.whl

nornir_collection/cisco/configuration_management/netconf/config_tasks.py

@@ -360,6 +360,71 @@ def nc_edit_cleanup_svi(task: Task, verbose: bool = False) -> Result:
     return Result(host=task.host, custom_result=custom_result, failed=task_failed)
 
 
+def nc_edit_cleanup_vlan(task: Task, verbose: bool = False) -> Result:
+    """
+    TBD
+    """
+    # The custom_result list will be filled with the results
+    custom_result = []
+
+    #### Get all current configured VLANs with RESTCONF #####################################################
+
+    task_text = "RESTCONF GET VLANs"
+
+    # Set the RESTCONF port, yang query and url to get all configured SVIs
+    yang_query = "Cisco-IOS-XE-native:native/vlan/Cisco-IOS-XE-vlan:vlan-list"
+    url = f"https://{task.host.hostname}:443/restconf/data/{yang_query}"
+
+    # RESTCONF HTTP Get for all SVIs
+    response = rc_cisco_get(url=url, auth=(task.host.username, task.host.password), verify=False)
+
+    # Set the RESTCONF result and return the Nornir result if the RESTCONF response status_code is not 200
+    custom_result = set_restconf_result(
+        task=Task,
+        task_text=task_text,
+        yang_query=yang_query,
+        response=response,
+        custom_result=custom_result,
+        verbose=verbose,
+    )
+
+    # Create a list with all current configured VLANs except the default VLAN 1
+    current_vlans = [x for x in response["json"]["Cisco-IOS-XE-vlan:vlan-list"] if x["id"] != 1]
+
+    #### Render NETCONF payload to remove VLANs with Jinja2 #################################################
+
+    task_text = "Render Jinja2 NETCONF payload"
+    # Create a list with all configured VLANs which are not part of the inventory
+    remove_vlans = [x for x in current_vlans if x["id"] not in [x["vid"] for x in task.host["cfg_vlans"]]]
+
+    # If there are no VLANs to remove, return the Nornir result
+    if not remove_vlans:
+        custom_result.append(
+            f"{task_result(text=task_text, changed=False, level_name='INFO', failed=False)}\n"
+            + f"'{task_text}' -> NornirResponse <Success: True>\n"
+            + "-> No VLANs to remove"
+        )
+        return Result(host=task.host, custom_result=custom_result, failed=False)
+
+    # Set the info message for the Nornir result
+    info_msg = f"VLANs to remove: {len(remove_vlans)}"
+
+    # Render the Jinja2 payload template and configure the NETCONF candidate datastore
+    custom_result, task_failed = netconf_configure_jinja2_rendered_payload_template(
+        task=task,
+        j2_task_text=task_text,
+        j2_tpl_path="iosxe_netconf/tpl_sys/cleanup/cleanup_vlan.j2",
+        custom_result=custom_result,
+        task_failed=False,
+        info_msg=info_msg,
+        verbose=verbose,
+        j2_kwargs={"remove_vlans": remove_vlans},
+    )
+
+    # Return the Nornir NETCONF result
+    return Result(host=task.host, custom_result=custom_result, failed=task_failed)
+
+
 def nc_edit_tpl_config(task: Task, tpl_startswith: str, verbose: bool = False) -> Result:
     """
     TBD
@@ -477,7 +542,6 @@ def nc_cfg_cleanup(nr: Nornir, cfg_status: bool = True, verbose: bool = False) -
     """
     TBD
     """
-
     # Return False if cfg_status argument is False
     if not cfg_status:
         return False
@@ -485,6 +549,7 @@ def nc_cfg_cleanup(nr: Nornir, cfg_status: bool = True, verbose: bool = False) -
     tasks = {
         nc_edit_cleanup_portchannel: "NETCONF portchannel cleanup",
         nc_edit_cleanup_svi: "NETCONF vlan interface cleanup",
+        nc_edit_cleanup_vlan: "NETCONF vlan cleanup",
     }
 
     # Run each task from the Nornir tasks list

nornir_collection/cisco/configuration_management/utils.py

@@ -234,9 +234,7 @@ def add_interface_data(task: Task, interface: dict) -> dict:
     """
     # If the interface is part of a Port-channel
     if "lag" in interface and interface["lag"] is not None:
-        # Set the int_config_context of the Port-channel to the int_config_context of the interface
         po_interface = [i for i in task.host["interfaces"] if i["name"] == interface["lag"]["name"]]
-        interface["int_config_context"] = po_interface[0]["int_config_context"]
         interface["description"] = po_interface[0]["description"]
         interface["portchannel_number"] = extract_interface_number(interface["lag"]["name"])
 

nornir_collection/netbox/inventory.py

@@ -92,7 +92,7 @@ def _load_interface_data(task: Task, all_interfaces: List[Dict], enrich_vlan_dat
     # fmt: off
     include_keys = [
         "name", "int_template", "description", "type", "lag", "mode", "untagged_vlan", "tagged_vlans",
-        "count_ipaddresses", "count_fhrp_groups", "int_peer_device", "int_config_context", "enabled",
+        "count_ipaddresses", "count_fhrp_groups", "int_peer_device", "enabled",
     ]
     # fmt: on
     # Make some normalization to the device interfaces data with the interface_filter list and others

nornir_collection/netbox/update_prefixes_ip_addresses.py

@@ -306,6 +306,24 @@ def nmap_scan_host_ip_or_subnet(hosts: str) -> list:
     return nmap_scan_result
 
 
+def nmap_double_check_ips(ip_list: dict) -> list:
+    """
+    TBD
+    """
+    verified_ips = []
+    # Nmap scan ip-addresses of the maybe_delete_ips list
+    for ip in ip_list:
+        # Scan the prefix with nmap
+        scan_result = nmap_scan_host_ip_or_subnet(hosts=ip["address"])
+        # Add the nmap scan result to the inactive_ips list with the ID of the ip-address
+        if scan_result:
+            # As a single ip-address is scanned the scan_result can have only one list item
+            verified_ips.append({"id": ip["id"], **scan_result[0]})
+
+    # Return the verified ip-addresses list
+    return verified_ips
+
+
 def get_ipfabric_data_for_prefix(prefix: dict) -> tuple:
     """
     TBD
@@ -571,15 +589,8 @@ def delete_inactive_auto_discovered_ip_addresses(
     maybe_delete_ips = create_ip_list(
         loop_list=prefix["discovered_ips"], check_list=prefix["datasource_ips"], is_in_both=False
     )
-    delete_ips = []
-    if maybe_delete_ips:
-        # Nmap scan ip-addresses of the maybe_delete_ips list
-        for ip in maybe_delete_ips:
-            # Scan the prefix with nmap
-            scan_result = nmap_scan_host_ip_or_subnet(hosts=ip["address"])
-            # Add the nmal scan result to the inactive_ips list
-            if scan_result:
-                delete_ips.extend(scan_result)
+    # Nmap scan ip-addresses of the maybe_delete_ips list
+    delete_ips = nmap_double_check_ips(ip_list=maybe_delete_ips)
 
     # If ip-addresses have been found
     if delete_ips:
@@ -659,14 +670,8 @@ def update_inactive_ip_addresses(nb_url: str, prefix: dict, ds: Literal["nmap",
     maybe_active_ips = create_ip_list(
         loop_list=prefix["inactive_ips"], check_list=prefix["datasource_ips"], is_in_both=False
     )
-    if maybe_active_ips:
-        # Nmap scan ip-addresses of the maybe_inactive_ips list
-        for ip in maybe_active_ips:
-            # Scan the prefix with nmap
-            scan_result = nmap_scan_host_ip_or_subnet(hosts=ip["address"])
-            # Add the nmal scan result to the inactive_ips list
-            if scan_result:
-                active_ips.extend(scan_result)
+    # Nmap scan ip-addresses of the maybe_active_ips list
+    active_ips = nmap_double_check_ips(ip_list=maybe_active_ips)
 
     # If ip-addresses have been found
     if active_ips:
@@ -722,21 +727,16 @@ def update_active_ip_addresses(
             resp=resp, nb_type="ip", data=active_ips, ds=ds, task_text=task_text, text=text
         )
         result.extend(sub_result)
-        failed = True if sub_failed else failed
+        if sub_failed:
+            failed = True
+            result.append(f"-> Payload:\n{payload}")
 
     # Update the ip-addresses with the status 'active' that are not part of the datacenter list
     maybe_inactive_ips = create_ip_list(
         loop_list=prefix["active_ips"], check_list=prefix["datasource_ips"], is_in_both=False
     )
-    inactive_ips = []
-    if maybe_inactive_ips:
-        # Nmap scan ip-addresses of the maybe_inactive_ips list
-        for ip in maybe_inactive_ips:
-            # Scan the prefix with nmap
-            scan_result = nmap_scan_host_ip_or_subnet(hosts=ip["address"])
-            # Add the nmal scan result to the inactive_ips list
-            if scan_result:
-                inactive_ips.extend(scan_result)
+    # Nmap scan ip-addresses of the maybe_inactive_ips list
+    inactive_ips = nmap_double_check_ips(ip_list=maybe_inactive_ips)
     # Create a new list to exclude the overwrite_active ip-addresses
     inactive_ips = [ip for ip in inactive_ips if ip["address"] not in overwrite_active]
 
@@ -756,7 +756,10 @@ def update_active_ip_addresses(
             resp=resp, nb_type="ip", data=inactive_ips, ds=ds, task_text=task_text, text=text
         )
         result.extend(sub_result)
-        failed = True if sub_failed else failed
+        if sub_failed:
+            failed = True
+            result.append(f"-> Data for Payload:\n{inactive_ips}")
+            result.append(f"-> Payload:\n{payload}")
 
     return result, failed
 

{nornir_collection-0.0.24.dist-info → nornir_collection-0.0.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: nornir-collection
-Version: 0.0.24
+Version: 0.0.26
 Summary: Nornir-Collection contains network automation functions and complete IaC workflows with         Nornir and other python libraries. It contains Nornir tasks and general functions in Nornir style.
 Author: Willi Kubny
 Author-email: willi.kubny@gmail.ch
@@ -47,6 +47,7 @@ Dynamic: author-email
 Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{nornir_collection-0.0.24.dist-info → nornir_collection-0.0.26.dist-info}/RECORD

@@ -8,13 +8,13 @@ nornir_collection/cisco/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG
 nornir_collection/cisco/configuration_management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nornir_collection/cisco/configuration_management/processor.py,sha256=KjhilyyDDiYL7wFemGEWSP16OLeM4dENmrtb20LRssY,6443
 nornir_collection/cisco/configuration_management/pyats.py,sha256=j9XzG3ttURR0wtu2Se9QQEpG5o2kq9mqDkReNCdWKpk,8932
-nornir_collection/cisco/configuration_management/utils.py,sha256=X20A1G0MMlTt5VJ0mqRmqFlA_Bpi7_0FPKPJLaqoKNc,18632
+nornir_collection/cisco/configuration_management/utils.py,sha256=YZE3pgaA4kKnIQkkLenUhxLoYLi1sd0sa4jNfSulC34,18452
 nornir_collection/cisco/configuration_management/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nornir_collection/cisco/configuration_management/cli/config_tasks.py,sha256=mWXysgUm6ymNLQjomB1T05QT9A-fdV1aEKFzzDrfCUw,22147
 nornir_collection/cisco/configuration_management/cli/config_workflow.py,sha256=GIka5SPLZ7M2zCFv8Jadl73QC-InnGopzI8xQt36MfM,3459
 nornir_collection/cisco/configuration_management/cli/show_tasks.py,sha256=w9p2Iks33-pE4-YztH6vj-eI0MuPI7YD6gZhRcpQF7M,27971
 nornir_collection/cisco/configuration_management/netconf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nornir_collection/cisco/configuration_management/netconf/config_tasks.py,sha256=wcrAuijvMZMe7dbGwtKzRgAlWsbxVJSup65yJda_930,22995
+nornir_collection/cisco/configuration_management/netconf/config_tasks.py,sha256=V1goW79OWxA7kNle4M2NzK47TZLw7TGji-2QaTiviSI,25696
 nornir_collection/cisco/configuration_management/netconf/config_workflow.py,sha256=qxB4DolQL2WJO9JRATzANhIwYPNuKyuN0hI9-ABzJq8,14557
 nornir_collection/cisco/configuration_management/netconf/nr_cfg_iosxe_netconf.py,sha256=qKb1EeiYbCO96AE6ETaNxRrM2nCfsbX00nwcPK9ZSkc,8629
 nornir_collection/cisco/configuration_management/netconf/ops_tasks.py,sha256=cj7cpJNvY2bytv9VOqwg_7qOekL-cIL0EjML2KT4TQM,10659
@@ -35,13 +35,13 @@ nornir_collection/fortinet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJ
 nornir_collection/fortinet/utils.py,sha256=xkvxdJy3-aD39WK_9Gc0rY9r-OxfHnPVNMspy3KZbcE,1174
 nornir_collection/netbox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nornir_collection/netbox/custom_script.py,sha256=yU1lbv_25b3qAWA6GRsVYpEuh0KUPTVo47U5s_lksjo,4050
-nornir_collection/netbox/inventory.py,sha256=uDA8QOBZdg42hROki41fKYtA1g3Ev4wFhGDo-Y0l9Fo,15529
+nornir_collection/netbox/inventory.py,sha256=4KrmvHrY29PH9prs7D_oTfraUDg1svDbXEamaAxev1M,15507
 nornir_collection/netbox/set_device_status.py,sha256=vtn0KcR-91Z2aLjbEpZRef1Jip8eM9GWbKRiAJuEjLY,2437
 nornir_collection/netbox/sync_datasource.py,sha256=eEsgwy_arIPbA-ObqqzTNdU9aiP80s7LCzAKA6hCXYQ,4703
 nornir_collection/netbox/update_cisco_inventory_data.py,sha256=Aq4VGvAIiBhOCsSOF-wBUrpYtBXR8HwR3NCWEeM4d0g,6426
 nornir_collection/netbox/update_cisco_support_plugin_data.py,sha256=H8SfqESad64LrZrsWOaICHKj122sgu96dK9RcbvtzGM,13896
 nornir_collection/netbox/update_fortinet_inventory_data.py,sha256=ltwkE_bFljRUR4aeOxorChCsHdZciD1TqvoPnWTUIUg,6367
-nornir_collection/netbox/update_prefixes_ip_addresses.py,sha256=td-4EiiDY8j7aLhzCIEe_BxhP2vM9OmM0iUWTc8VMFg,49696
+nornir_collection/netbox/update_prefixes_ip_addresses.py,sha256=tPdFkjv84OU9yOwyAWiI9ZV1JdtwUWy08NGgnN0uZhk,49692
 nornir_collection/netbox/update_purestorage_inventory_data.py,sha256=cGZNMTZWJ0wu1BYdE92EVN-C-oLMJHxaKi_-1cMg0Ow,5368
 nornir_collection/netbox/utils.py,sha256=mCV7QfLeR6kKurZVpMrHucIoru759RiwzE4NGEx91kI,12140
 nornir_collection/netbox/verify_device_primary_ip.py,sha256=6UCdZaZxhV4v8KqpjSpE9c7jaxIAF2krrknrrRj1AvM,8690
@@ -52,8 +52,8 @@ nornir_collection/nornir_plugins/inventory/staggered_yaml.py,sha256=nBvUFq7U5zVT
 nornir_collection/nornir_plugins/inventory/utils.py,sha256=mxIlKK-4PHqCnFKn7Oozu1RW_JB5z1TgEYc-ave70nE,11822
 nornir_collection/purestorage/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nornir_collection/purestorage/utils.py,sha256=TqU2sKz0ENnmSDEBcSvXPnVkI1DVHOogI68D7l32g7I,1730
-nornir_collection-0.0.24.dist-info/LICENSE,sha256=bOPVh1OVNwz2tCjkLaChWT6AoXdtqye3aua5l0tgYJo,1068
-nornir_collection-0.0.24.dist-info/METADATA,sha256=20Q1UDl_oOFN8fcLu_vG_RTX-dh5BAm4i7HPX1yZtS4,7169
-nornir_collection-0.0.24.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-nornir_collection-0.0.24.dist-info/top_level.txt,sha256=OyCzPWABf-D0AOHm9ihrwdk5eq200BnKna6gIDspwsE,18
-nornir_collection-0.0.24.dist-info/RECORD,,
+nornir_collection-0.0.26.dist-info/licenses/LICENSE,sha256=bOPVh1OVNwz2tCjkLaChWT6AoXdtqye3aua5l0tgYJo,1068
+nornir_collection-0.0.26.dist-info/METADATA,sha256=b27m0rRe6UVYls_c-iZCGNeHlcDquUvM79naa8c5k8k,7191
+nornir_collection-0.0.26.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+nornir_collection-0.0.26.dist-info/top_level.txt,sha256=OyCzPWABf-D0AOHm9ihrwdk5eq200BnKna6gIDspwsE,18
+nornir_collection-0.0.26.dist-info/RECORD,,

{nornir_collection-0.0.24.dist-info → nornir_collection-0.0.26.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any