nornir-collection 0.0.23__py3-none-any.whl → 0.0.25__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/netbox/inventory.py

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

{nornir_collection-0.0.23.dist-info → nornir_collection-0.0.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: nornir-collection
-Version: 0.0.23
+Version: 0.0.25
 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.23.dist-info → nornir_collection-0.0.25.dist-info}/RECORD

@@ -14,7 +14,7 @@ nornir_collection/cisco/configuration_management/cli/config_tasks.py,sha256=mWXy
 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,7 +35,7 @@ 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=2db5GogMsY5bZgc4mXIhlmH9pcvyQ7AE55dL0EiqxDI,15488
+nornir_collection/netbox/inventory.py,sha256=uDA8QOBZdg42hROki41fKYtA1g3Ev4wFhGDo-Y0l9Fo,15529
 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
@@ -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.23.dist-info/LICENSE,sha256=bOPVh1OVNwz2tCjkLaChWT6AoXdtqye3aua5l0tgYJo,1068
-nornir_collection-0.0.23.dist-info/METADATA,sha256=2pKMwHDmdthAjlvEixjw5ZWVqfGfHNS4NE7Nnyk_2DE,7169
-nornir_collection-0.0.23.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-nornir_collection-0.0.23.dist-info/top_level.txt,sha256=OyCzPWABf-D0AOHm9ihrwdk5eq200BnKna6gIDspwsE,18
-nornir_collection-0.0.23.dist-info/RECORD,,
+nornir_collection-0.0.25.dist-info/licenses/LICENSE,sha256=bOPVh1OVNwz2tCjkLaChWT6AoXdtqye3aua5l0tgYJo,1068
+nornir_collection-0.0.25.dist-info/METADATA,sha256=zoBgfwLBq-6GhxNSle_4AePSBf4Y35vlOMcgu4zShMc,7191
+nornir_collection-0.0.25.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+nornir_collection-0.0.25.dist-info/top_level.txt,sha256=OyCzPWABf-D0AOHm9ihrwdk5eq200BnKna6gIDspwsE,18
+nornir_collection-0.0.25.dist-info/RECORD,,

{nornir_collection-0.0.23.dist-info → nornir_collection-0.0.25.dist-info}/WHEEL

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