nornir-collection 0.0.1__tar.gz

nornir_collection-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Willi Kubny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nornir_collection-0.0.1/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.2
+Name: nornir-collection
+Version: 0.0.1
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nornir==3.3.0
+Requires-Dist: nornir-jinja2==0.2.0
+Requires-Dist: nornir-salt==0.20.3
+Requires-Dist: nornir-netmiko==1.0.1
+Requires-Dist: nornir-scrapli==2023.7.30
+Requires-Dist: scrapli-netconf==2023.7.30
+Requires-Dist: scrapli[ssh2]
+Requires-Dist: scrapli[genie]
+Requires-Dist: nornir-utils==0.2.0
+Requires-Dist: pynetbox==7.4.0
+Requires-Dist: py-pure-client==1.51.0
+Requires-Dist: nornir-pyfgt==1.0.3
+Requires-Dist: python-nmap==0.7.1
+Requires-Dist: pybatfish==2023.12.16.1270
+Requires-Dist: requests==2.31.0
+Requires-Dist: pre-commit==3.6.0
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: pyfiglet==1.0.2
+Requires-Dist: GitPython==3.1.40
+Requires-Dist: python-dotenv==1.0.0
+Requires-Dist: beautifultable==1.1.0
+Requires-Dist: pandas==2.2.2
+Requires-Dist: openpyxl==3.1.2
+Requires-Dist: XlsxWriter==3.1.9
+Requires-Dist: yaspin==3.0.1
+Requires-Dist: rich==13.7.0
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: black==23.12.0
+Requires-Dist: yamllint==1.33.0
+Requires-Dist: pylint==3.0.3
+Requires-Dist: bandit==1.7.6
+Requires-Dist: vulture==2.10
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+![Header-Image](docs/header.png)
+
+> Infrastructure as Code or IaC is the process of provisioning and managing infrastructure defined through code, instead of doing so with a manual process.
+>
+> Infrastructure as code brings a lot of advantages into the network operation:
+> + Reducing shadow IT within organizations and allowing timely and efficient infrastructure changes
+> + Integrating directly with CI/CD platforms
+> + Enabling version-controlled infrastructure and configuration changes leading to trackable configurations
+> + Standardizing infrastructure with reproducible configurations
+> + Effectively managing configurating drift and keeping infrastructure and configurations in their desired state
+> + Having the ability to easily scale up infrastructure as automation eliminates the need for manual configurations
+
+# DSC-Nornir Python-Package
+----
+</br>
+
+This repository builds a python package and is a complete solution to manage the network configuration from code.
+The DSC-Nornir package modules are a collection of network automation functions and complete workflows with Nornir
+and other python tools. All scripts can be executed manually from a central server, workstation or integrated into
+a CI/CD pipeline. The folder azure_pipelines provides bash functions to facilitate the writing of Azure DevOps
+pipelines.
+
+The complete documentation is available on MkDocs: [DSC MkDocs Network Documentation](http://192.168.1.10:9000/netdevops/architecture/dsc_nornir/)
+
+# Python Development and Testing
+----
+</br>
+
+The Python scripts were developed with static code analysis, black auto-formatting and functional testing with Azure
+DevOps pipelines executed by a pipeline agent installed within the Kyndryl labor network. The `Makefile` is used to
+run the black auto-formatter, yamllint, pylint and prospector linting, bandit for security and vulnerability verification
+as well as vulture for dead code verification. All pylint warnings that should be ignored are part of the script with a
+pylint control message e.g `# pylint: disable=import-error`. Pylint and prospector uses a custom configuration profile.
+The other tools use the default configuration.
+
+The `Makefile` contains the tasks `all`, `fmt` and `lint`
+
+To execute the `Makefile` with all tasks (black auto-formatting, yamllint, pylint, bandit and vulture):
+```bash
+make
+```
+
+To execute only the black auto-formatting:
+```bash
+make fmt
+```
+
+To execute only the linting with yamllint, pylint, bandit and vulture:
+```bash
+make lint
+```
+
+# Languages and Tools
+----
+</br>
+
+<p align="center">
+  <img width="7.8%" src="https://user-images.githubusercontent.com/70367776/177972422-da6933d5-310e-4cdb-9433-89f2dc6ebb7a.png" alt="Python" />
+  <img width="9.5%" src="https://user-images.githubusercontent.com/70367776/177969859-476bd542-2c0e-41a9-82f2-3e4919a61d4e.png" alt="YAML" />
+  <img width="10%" src="https://user-images.githubusercontent.com/70367776/177966199-e8476a0d-f972-4409-8b9a-d493d339bf38.png" alt="Nornir" />
+  <img width="8.9%" src="https://user-images.githubusercontent.com/70367776/177970540-b59a294f-82fd-4647-b8e2-9305c399c900.png" alt="Scrapli" />
+  <img width="19.5%" src="https://user-images.githubusercontent.com/70367776/229153411-6e5d10c3-634e-47b9-8920-0ed5e2311f9b.png" alt="Netmiko" />
+  <img width="10.5%" src="https://user-images.githubusercontent.com/70367776/183677690-fd956308-fda9-4583-863e-3a39d3ecc7f7.png" alt="NETCONF" />
+  <img width="9%" src="https://user-images.githubusercontent.com/70367776/183678136-4fbf50a8-adbb-468e-91b6-988d4c1ccd72.png" alt="RESTCONF" />
+  <img width="9.5%" src="https://user-images.githubusercontent.com/70367776/177966474-e66d8a59-e26e-4a3d-ac59-ded7cc005e4b.png" alt="Jinja2" />
+  <img width="10%" src="https://user-images.githubusercontent.com/70367776/177971288-e32552cd-1529-470a-8881-30c22d2df8ac.png" alt="pyATS" />
+  <img width="10%" src="https://user-images.githubusercontent.com/70367776/222764714-1ff86034-76f9-49d0-9e24-68798d779f56.png" alt="Batfish" />
+  <img width="10.2%" src="https://user-images.githubusercontent.com/70367776/183678800-403cf0ea-3c8a-47bb-b52a-2caa0cedc195.png" alt="Makefile" />
+  <img width="10.5%" src="https://user-images.githubusercontent.com/70367776/183679432-2b89f00c-f5b1-4d47-9c68-ad7fa332de01.png" alt="Prospector" />
+  <img width="9%" src="https://user-images.githubusercontent.com/70367776/183680151-62d5c625-0430-4c90-adfc-1ebb47fce4a9.png" alt="Bandit" />
+  <img width="9.4%" src="https://user-images.githubusercontent.com/70367776/177972703-3be3c4c3-aa9a-4468-97a6-e7760d536b89.png" alt="Git" />
+  <img width="9.4%" src="https://user-images.githubusercontent.com/70367776/177972925-1780012f-64a6-4b93-a215-fd47e3222b8f.png" alt="GitHub" />
+  <img width="11.5%" src="https://user-images.githubusercontent.com/70367776/232078456-8aee2fda-1289-4cd9-b7f3-9b34fcb4d7c7.png" alt="Docker" />
+  <img width="9.4%" src="https://user-images.githubusercontent.com/70367776/231501139-a449202e-6a81-4364-a4ea-1e42906e846e.png" alt="Azure Pipeline" />
+  <img width="33.2%" src="https://user-images.githubusercontent.com/70367776/231500048-77eeff9a-166b-4bd7-a0cc-3c5fc58be368.png" alt="NetBox" />
+</p>
+
+<br>
+
+<h3 align="center">APIs can also be amusing to provide a programming joke ...</h3>
+<p align="center"><img src="https://readme-jokes.vercel.app/api?hideBorder&theme=calm" /></p>
+<h3 align="center">... or an interesting quote.</h3>
+<p align="center"><img src="https://quotes-github-readme.vercel.app/api?type=horizontal&theme=dracula" /></p>

nornir_collection-0.0.1/README.md

@@ -0,0 +1,83 @@
+![Header-Image](docs/header.png)
+
+> Infrastructure as Code or IaC is the process of provisioning and managing infrastructure defined through code, instead of doing so with a manual process.
+>
+> Infrastructure as code brings a lot of advantages into the network operation:
+> + Reducing shadow IT within organizations and allowing timely and efficient infrastructure changes
+> + Integrating directly with CI/CD platforms
+> + Enabling version-controlled infrastructure and configuration changes leading to trackable configurations
+> + Standardizing infrastructure with reproducible configurations
+> + Effectively managing configurating drift and keeping infrastructure and configurations in their desired state
+> + Having the ability to easily scale up infrastructure as automation eliminates the need for manual configurations
+
+# DSC-Nornir Python-Package
+----
+</br>
+
+This repository builds a python package and is a complete solution to manage the network configuration from code.
+The DSC-Nornir package modules are a collection of network automation functions and complete workflows with Nornir
+and other python tools. All scripts can be executed manually from a central server, workstation or integrated into
+a CI/CD pipeline. The folder azure_pipelines provides bash functions to facilitate the writing of Azure DevOps
+pipelines.
+
+The complete documentation is available on MkDocs: [DSC MkDocs Network Documentation](http://192.168.1.10:9000/netdevops/architecture/dsc_nornir/)
+
+# Python Development and Testing
+----
+</br>
+
+The Python scripts were developed with static code analysis, black auto-formatting and functional testing with Azure
+DevOps pipelines executed by a pipeline agent installed within the Kyndryl labor network. The `Makefile` is used to
+run the black auto-formatter, yamllint, pylint and prospector linting, bandit for security and vulnerability verification
+as well as vulture for dead code verification. All pylint warnings that should be ignored are part of the script with a
+pylint control message e.g `# pylint: disable=import-error`. Pylint and prospector uses a custom configuration profile.
+The other tools use the default configuration.
+
+The `Makefile` contains the tasks `all`, `fmt` and `lint`
+
+To execute the `Makefile` with all tasks (black auto-formatting, yamllint, pylint, bandit and vulture):
+```bash
+make
+```
+
+To execute only the black auto-formatting:
+```bash
+make fmt
+```
+
+To execute only the linting with yamllint, pylint, bandit and vulture:
+```bash
+make lint
+```
+
+# Languages and Tools
+----
+</br>
+
+<p align="center">
+  <img width="7.8%" src="https://user-images.githubusercontent.com/70367776/177972422-da6933d5-310e-4cdb-9433-89f2dc6ebb7a.png" alt="Python" />
+  <img width="9.5%" src="https://user-images.githubusercontent.com/70367776/177969859-476bd542-2c0e-41a9-82f2-3e4919a61d4e.png" alt="YAML" />
+  <img width="10%" src="https://user-images.githubusercontent.com/70367776/177966199-e8476a0d-f972-4409-8b9a-d493d339bf38.png" alt="Nornir" />
+  <img width="8.9%" src="https://user-images.githubusercontent.com/70367776/177970540-b59a294f-82fd-4647-b8e2-9305c399c900.png" alt="Scrapli" />
+  <img width="19.5%" src="https://user-images.githubusercontent.com/70367776/229153411-6e5d10c3-634e-47b9-8920-0ed5e2311f9b.png" alt="Netmiko" />
+  <img width="10.5%" src="https://user-images.githubusercontent.com/70367776/183677690-fd956308-fda9-4583-863e-3a39d3ecc7f7.png" alt="NETCONF" />
+  <img width="9%" src="https://user-images.githubusercontent.com/70367776/183678136-4fbf50a8-adbb-468e-91b6-988d4c1ccd72.png" alt="RESTCONF" />
+  <img width="9.5%" src="https://user-images.githubusercontent.com/70367776/177966474-e66d8a59-e26e-4a3d-ac59-ded7cc005e4b.png" alt="Jinja2" />
+  <img width="10%" src="https://user-images.githubusercontent.com/70367776/177971288-e32552cd-1529-470a-8881-30c22d2df8ac.png" alt="pyATS" />
+  <img width="10%" src="https://user-images.githubusercontent.com/70367776/222764714-1ff86034-76f9-49d0-9e24-68798d779f56.png" alt="Batfish" />
+  <img width="10.2%" src="https://user-images.githubusercontent.com/70367776/183678800-403cf0ea-3c8a-47bb-b52a-2caa0cedc195.png" alt="Makefile" />
+  <img width="10.5%" src="https://user-images.githubusercontent.com/70367776/183679432-2b89f00c-f5b1-4d47-9c68-ad7fa332de01.png" alt="Prospector" />
+  <img width="9%" src="https://user-images.githubusercontent.com/70367776/183680151-62d5c625-0430-4c90-adfc-1ebb47fce4a9.png" alt="Bandit" />
+  <img width="9.4%" src="https://user-images.githubusercontent.com/70367776/177972703-3be3c4c3-aa9a-4468-97a6-e7760d536b89.png" alt="Git" />
+  <img width="9.4%" src="https://user-images.githubusercontent.com/70367776/177972925-1780012f-64a6-4b93-a215-fd47e3222b8f.png" alt="GitHub" />
+  <img width="11.5%" src="https://user-images.githubusercontent.com/70367776/232078456-8aee2fda-1289-4cd9-b7f3-9b34fcb4d7c7.png" alt="Docker" />
+  <img width="9.4%" src="https://user-images.githubusercontent.com/70367776/231501139-a449202e-6a81-4364-a4ea-1e42906e846e.png" alt="Azure Pipeline" />
+  <img width="33.2%" src="https://user-images.githubusercontent.com/70367776/231500048-77eeff9a-166b-4bd7-a0cc-3c5fc58be368.png" alt="NetBox" />
+</p>
+
+<br>
+
+<h3 align="center">APIs can also be amusing to provide a programming joke ...</h3>
+<p align="center"><img src="https://readme-jokes.vercel.app/api?hideBorder&theme=calm" /></p>
+<h3 align="center">... or an interesting quote.</h3>
+<p align="center"><img src="https://quotes-github-readme.vercel.app/api?type=horizontal&theme=dracula" /></p>

nornir_collection-0.0.1/nornir_collection/batfish/assert_config.py

@@ -0,0 +1,358 @@
+#!/usr/bin/env python3
+"""
+This module contains general functions and tasks related to Batfish.
+
+The functions are ordered as followed:
+- Batfish Helper Functions
+- Nornir Batfish Tasks
+- Nornir Batfish Tasks in regular Function
+"""
+
+from pybatfish.client.session import Session
+from nornir.core import Nornir
+from nornir.core.task import Task, Result
+from nornir_collection.batfish.utils import (
+    batfish_question_failed,
+    batfish_assert_type_failed,
+    batfish_exit_error,
+)
+from nornir_collection.utils import print_result, task_result, list_flatten, get_dict_value_by_path
+
+
+#### Batfish Helper Functions ################################################################################
+
+
+def batfish_assert_cfg_prop(task: Task, data: tuple, name_add: str = False) -> list:
+    """
+    Batfish assert helper task to assert the ref_prop against the cfg_prop based on the ref_prop data type.
+    The col_name specifies the configuration property which should be asked to Batfish.
+    """
+    # Extract the variables from the data tuple
+    col_name, ref_prop, cfg_prop = data
+    # Set the name_add variable if exists, else col_name
+    name_add = name_add if name_add else col_name
+
+    if isinstance(ref_prop, str):
+        # Define the property in the snapshot
+        snap_prop = cfg_prop[col_name].to_string(index=False)
+        snap_prop = snap_prop.rstrip()
+        snap_prop = snap_prop.lstrip()
+        # Set the Nornir task failed variable
+        failed = bool(ref_prop != snap_prop)
+        cfg_result = f"-> Expected: '{ref_prop}'\n" f"-> Configured: '{snap_prop}'"
+
+    elif isinstance(ref_prop, list):
+        ref_prop = list_flatten(ref_prop)
+        # Define the property in the snapshot
+        snap_prop = list_flatten(cfg_prop[col_name].tolist())
+        snap_prop = [str(x) for x in snap_prop]
+        # Find extra and missing referency properties
+        ref_prop_extra = [x for x in snap_prop if x not in ref_prop]
+        ref_prop_missing = [x for x in ref_prop if x not in snap_prop]
+        # Set the Nornir task failed variable
+        failed = bool(ref_prop_extra + ref_prop_missing)
+        cfg_result = (
+            f"-> Expected: {ref_prop}\n"
+            f"-> Missing (to add): {ref_prop_missing if ref_prop_missing else '[]'}\n"
+            f"-> Extra (to remove): {ref_prop_extra if ref_prop_extra else '[]'}"
+        )
+
+    else:
+        # Set the Nornir task failed variable
+        failed = True
+        cfg_result = (
+            f"->'ref_prop' argument type {type(ref_prop)} is not implemented to assert\n"
+            f"-> Update the function _batfish_assert_cfg_prop() to support this 'ref_prop' data type"
+        )
+
+    # Set the Nornir result to return
+    level_name = "ERROR" if failed else "INFO"
+    result = (
+        f"{task_result(text=f'{task.name} {name_add}', changed=False, level_name=level_name)}\n"
+        f"'{task.name} {col_name}' -> BatfishResponse <Success: {not failed}>\n"
+        f"{cfg_result}"
+    )
+
+    return result, failed
+
+
+def batfish_get_ref_props_from_nr_inv(task: Task, inv_key: str) -> dict:
+    """
+    Loop over all hosts keys to find keys which starts with the inv_startswith string and add the values
+    to a dict. Then return this dict which should contain all ref_props data.
+    """
+    ref_props = {}
+    # Loop over all hosts keys to find keys which starts with the inv_startswith string
+    for key, value in task.host.items():
+        if key.startswith(inv_key):
+            # Update the ref_props dict with the value
+            ref_props.update(value)
+
+    return ref_props
+
+
+#### Nornir Batfish Tasks ####################################################################################
+
+
+def batfish_assert_cfg_node_property_task(task: Task, nr_inv: bool, data: tuple[Session, dict]) -> Result:
+    """
+    Nornir task to assert Batfish node properties agains values from the Nornir inventory or direct specified
+    values in the ref_props dict. The ref_props argument in the data tuple specifies the Batfish node property
+    question to ask as the key The value can be the Nornir inventory which have to be added as  a map list
+    of the Nornir inventory dict keys if nr_inv is True or the correct value have to be specified if nr_inv
+    is False.
+
+    ref_props = {
+        "Domain_Name": ["cfg_domain_name"],
+        "NTP_Servers": ["cfg_ntp", "server"],
+        "NTP_Source_Interface": ["cfg_ntp", "source"],
+    }
+    """
+    # pylint: disable=invalid-name
+
+    # Extract the variables from the data tuple
+    bf, ref_props = data
+
+    # If the ref_props is a string to specify the inventory startswith key, then create a dict with all
+    # inventory keys which start with this string (nested dict not supported)
+    if isinstance(ref_props, str):
+        ref_props = batfish_get_ref_props_from_nr_inv(task=task, inv_key=ref_props)
+
+    # Set the initial Nornir Result object variables
+    result = []
+    failed = False
+
+    # Extract the node properties for the host
+    cfg_prop = bf.q.nodeProperties(nodes=str(task.host)).answer().frame()
+
+    # If the cfg_prop dataframe is empty
+    if cfg_prop.empty:
+        subresult, subresult_failed = batfish_question_failed(task=task, df=cfg_prop)
+        # Add the subresult to the Nornir result list
+        result.append(subresult)
+        # Return the Nornir result
+        return Result(host=task.host, result=result, failed=True)
+
+    # Loop over each column name, reference property key-value pair in the dict
+    for col_name, ref_prop in ref_props.items():
+        if nr_inv:
+            # Get the value from the Nornir inventory with the ref_prop map list
+            ref_prop = get_dict_value_by_path(data_dict=task.host, map_list=ref_prop)
+
+        # Create a tuple with all needed data to assert the Batfish question
+        data = (col_name, ref_prop, cfg_prop)
+
+        # Assert the correct ref_prop type
+        if isinstance(ref_prop, (str, list)):
+            subresult, subresult_failed = batfish_assert_cfg_prop(task=task, data=data)
+        else:
+            data = (col_name, ref_prop, "'str' or 'list'")
+            subresult, subresult_failed = batfish_assert_type_failed(task=task, data=data)
+
+        # Add the subresult to the Nornir result list
+        result.append(subresult)
+        if subresult_failed:
+            failed = True
+
+    # Return the Nornir result
+    return Result(host=task.host, result=result, failed=failed)
+
+
+def batfish_assert_cfg_interface_property_task(
+    task: Task, nr_inv: bool, data: tuple[Session, dict]
+) -> Result:
+    """
+    Nornir task to assert Batfish interface properties agains values from the Nornir inventory or direct
+    specified values in the ref_props dict. The ref_props argument in the data tuple specifies a dict for each
+    interface with the Batfish interface property question to ask as the key. The value can be the Nornir
+    inventory which have to be added as a map list of the Nornir inventory dict keys if nr_inv is True or
+    the correct value have to be specified if nr_inv is False.
+
+    ref_props = {
+        "FortyGigabitEthernet1/1/1" : {
+            "Switchport_Trunk_Encapsulation" : "DOT1Q",
+            "Admin_Up" : "True",
+            "Active" : "True",
+        }
+        "FortyGigabitEthernet1/1/2" : {
+            "Switchport_Trunk_Encapsulation" : "DOT1Q",
+            "Admin_Up" : "True",
+            "Active" : "True",
+        }
+    }
+    """
+    # pylint: disable=invalid-name
+
+    # Extract the variables from the data tuple
+    bf, ref_props = data
+
+    # If the Nornir inventory should be used and ref_props is a string to specify the inventory startswith
+    # key, then create a dict with all inventory keys which start with this string (nested dict not supported)
+    if nr_inv and isinstance(ref_props, str):
+        ref_props = batfish_get_ref_props_from_nr_inv(task=task, inv_key=ref_props)
+
+    # Set the initial Nornir Result object variables
+    result = []
+    failed = False
+
+    # Loop over each interface
+    for interface in ref_props.keys():
+        # Extract the interface properties for the host
+        cfg_prop = bf.q.interfaceProperties(nodes=str(task.host), interfaces=interface).answer().frame()
+
+        # If the cfg_prop dataframe is empty
+        if cfg_prop.empty:
+            subresult, subresult_failed = batfish_question_failed(task=task, df=cfg_prop, name_add=interface)
+            # Add the subresult to the Nornir result list
+            result.append(subresult)
+            if subresult_failed:
+                failed = True
+        else:
+            # Loop over each column name, reference property key-value pair in the dict
+            for col_name, ref_prop in ref_props[interface].items():
+                if nr_inv:
+                    # Get the value from the Nornir inventory with the ref_prop map list
+                    ref_prop = get_dict_value_by_path(data_dict=task.host, map_list=ref_prop)
+
+                # Create a tuple with all needed data to assert the Batfish question
+                data = (col_name, ref_prop, cfg_prop)
+
+                # Assert the correct ref_prop type
+                if isinstance(ref_prop, (str, list)):
+                    subresult, subresult_failed = batfish_assert_cfg_prop(
+                        task=task, data=data, name_add=interface
+                    )
+                else:
+                    data = (col_name, ref_prop, "'str' or 'list'")
+                    subresult, subresult_failed = batfish_assert_type_failed(
+                        task=task, data=data, name_add=interface
+                    )
+
+                # Add the subresult to the Nornir result list
+                result.append(subresult)
+                if subresult_failed:
+                    failed = True
+
+    # Return the Nornir result
+    return Result(host=task.host, result=result, failed=failed)
+
+
+def batfish_assert_cfg_switched_vlan_property_task(
+    task: Task, nr_inv: bool, data: tuple[Session, dict]
+) -> Result:
+    """
+    Nornir task to assert Batfish switched vlan properties agains values from the Nornir inventory or direct
+    specified values in the ref_props dict. The ref_props argument in the data tuple specifies the Batfish
+    node property question to ask as the key The value can be the Nornir inventory which have to be added
+    as a map list of the Nornir inventory dict keys if nr_inv is True or the correct value have to be
+    specified if nr_inv is False.
+
+    ref_props = {
+        "VLAN_ID": ["cfg_vlans"],
+        "VLAN_ID_ADD": ["cfg_vlans_add"],
+    }
+    """
+    # pylint: disable=invalid-name
+
+    # Extract the variables from the data tuple
+    bf, ref_props = data
+
+    # If the Nornir inventory should be used and ref_props is a string to specify the inventory startswith
+    # key, then create a dict with all inventory keys which start with this string (nested dict not supported)
+    if nr_inv and isinstance(ref_props, str):
+        ref_props = batfish_get_ref_props_from_nr_inv(task=task, inv_key=ref_props)
+
+    # Set the initial Nornir Result object variables
+    result = []
+    failed = False
+
+    # Extract the node properties for the host
+    cfg_prop = bf.q.switchedVlanProperties(nodes=str(task.host)).answer().frame()
+
+    # If the cfg_prop dataframe is empty
+    if cfg_prop.empty:
+        subresult, subresult_failed = batfish_question_failed(task=task, df=cfg_prop)
+        # Add the subresult to the Nornir result list
+        result.append(subresult)
+        # Return the Nornir result
+        return Result(host=task.host, result=result, failed=True)
+
+    # Loop over each column name, reference property key-value pair in the dict
+    for col_name, ref_prop in ref_props.items():
+        if nr_inv:
+            # Get the value from the Nornir inventory with the ref_prop map list
+            ref_prop = get_dict_value_by_path(data_dict=task.host, map_list=ref_prop)
+            # If the Nornir inventory is a dict, assume that the key is the vlan number and create a list
+            if isinstance(ref_prop, dict):
+                ref_prop = [str(vlan) for vlan in ref_prop.keys()]
+            # If the custom column name VLAN_ID_ADD exists in the ref_prop, then add these vlans to the list
+            if "VLAN_ID_ADD" in ref_prop:
+                # Get the value from the Nornir inventory with the ref_prop map list
+                ref_prop_add = get_dict_value_by_path(data_dict=task.host, map_list=ref_prop["VLAN_ID_ADD"])
+                # If the Nornir inventory is a dict, assume that the key is the vlan number and create a list
+                if isinstance(ref_prop_add, dict):
+                    ref_prop_add = [str(vlan) for vlan in ref_prop_add.keys()]
+                # Add both vlan lists together
+                ref_prop = ref_prop + ref_prop_add
+
+        # Add vlan 1 as it's the default and can't be deleted
+        ref_prop = ["1"] + ref_prop
+
+        # Create a tuple with all needed data to assert the Batfish question
+        data = (col_name, ref_prop, cfg_prop)
+
+        # Assert the correct ref_prop type
+        if isinstance(ref_prop, list):
+            subresult, subresult_failed = batfish_assert_cfg_prop(task=task, data=data)
+        else:
+            data = (col_name, ref_prop, "'list'")
+            subresult, subresult_failed = batfish_assert_type_failed(task=task, data=data)
+
+        # Add the subresult to the Nornir result list
+        result.append(subresult)
+        if subresult_failed:
+            failed = True
+
+    # Return the Nornir result
+    return Result(host=task.host, result=result, failed=failed)
+
+
+#### Nornir Batfish Tasks in regular Function ################################################################
+
+
+def batfish_assert_config_property(nr: Nornir, nr_inv: bool, data: tuple, soft: bool = False) -> Result:
+    """
+    This function runs a Nornir task to ask Batfish configuration properties. The batfish session, the batfish
+    question and the ref_props dict according to the specified batfish question have to be specified as the
+    data tuple. The nr_inv argument specified is the values to assert should be loaded from the Nornir
+    inventory by a dict key map list or are specified already directly correct.
+    The result is printed in Nornir style and in case of an assert error the script exits with error code 1.
+    """
+    # pylint: disable=invalid-name
+
+    # Extract the variables from the data tuple
+    bf, bf_question, ref_props = data
+
+    # Map list to identify which Nornir task to execute for the correct Batfish question
+    batfish_config_property_task = {
+        "node": batfish_assert_cfg_node_property_task,
+        "interface": batfish_assert_cfg_interface_property_task,
+        "vlan": batfish_assert_cfg_switched_vlan_property_task,
+    }
+
+    # Run the Nornir task to assert Batfish configuration properties
+    result = nr.run(
+        task=batfish_config_property_task[bf_question],
+        name=f"BATFISH query {bf_question}",
+        nr_inv=nr_inv,
+        data=(bf, ref_props),
+        on_failed=True,
+    )
+
+    # Print the Nornir task result
+    print_result(result=result, result_sub_list=True)
+
+    if not soft:
+        # If the task failed exit with error code 1
+        if result.failed:
+            batfish_exit_error(result=result, bf_question="config")