nornir-collection 0.0.1__py3-none-any.whl

nornir_collection/netbox/set_device_status.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+"""
+This module sets the device status in NetBox by running a custom script.
+The Main function is intended to import and execute by other scripts.
+"""
+
+
+import sys
+from nornir_collection.utils import exit_error, load_yaml_file
+from nornir_collection.netbox.custom_script import run_nb_custom_script
+
+
+__author__ = "Willi Kubny"
+__maintainer__ = "Willi Kubny"
+__version__ = "1.0"
+__license__ = "MIT"
+__email__ = "willi.kubny@dreyfusbank.ch"
+__status__ = "Production"
+
+
+def main(nr_config: str) -> None:
+    """
+    Main function is intended to import and execute by other scripts.
+    It load Nornir configuration, retrieve NetBox URL, and run a custom NetBox script.
+
+    * Args:
+        * nr_config (str): Path to the Nornir configuration YAML file.
+
+    * Steps:
+        * Loads the Nornir configuration file.
+        * Checks if the configuration file is loaded successfully; exits with code 1 if not.
+        * Retrieves the NetBox URL from the configuration.
+        * Runs the NetBox custom script 'set_device_status.SetDeviceStatus'.
+        * Checks the result of the custom script execution.
+
+    * Exits:
+        * Exits with code 1 if the Nornir configuration file is empty or if any task fails.
+    """
+
+    # Load the Nornir yaml config file as dict and print a error message
+    nr_config_dict = load_yaml_file(
+        file=nr_config, text="Load Nornir Config File", silent=False, verbose=False
+    )
+    # Check the loaded config file and exit the script with exit code 1 if the dict is empty
+    if not nr_config_dict:
+        sys.exit(1)
+
+    # Get the NetBox URL (Authentication token will be loaded as nb_token env variable)
+    nb_url = nr_config_dict["inventory"]["options"]["nb_url"]
+
+    # Run the NetBox custom script 'set_device_status.SetDeviceStatus'
+    result_failed = run_nb_custom_script(
+        name="set_device_status.SetDeviceStatus",
+        url=f"{nb_url}/api/extras/scripts/set_device_status.SetDeviceStatus/",
+        payload={"data": {}, "commit": True},
+        verbose=False,
+    )
+
+    # Check the result and exit the script with exit code 1 and a error message
+    if result_failed:
+        exit_error(
+            task_text="NetBox Custom Script Failed",
+            msg=[
+                "Check the result details in the pipeline log or directly in NetBox",
+                "-> One or more device primary ip-address is not reachable by ping",
+            ],
+        )

nornir_collection/netbox/sync_datasource.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+"""
+This module sync a list of NetBox datasources and print the result.
+The Main function is intended to import and execute by other scripts.
+"""
+
+
+import time
+import json
+import sys
+from nornir_collection.utils import load_yaml_file, task_name, task_error, task_info, exit_error
+from nornir_collection.netbox.utils import get_nb_resources, post_nb_resources
+
+__author__ = "Willi Kubny"
+__maintainer__ = "Willi Kubny"
+__version__ = "1.0"
+__license__ = "MIT"
+__email__ = "willi.kubny@dreyfusbank.ch"
+__status__ = "Production"
+
+
+def main(nr_config: str, datasources: list[str]) -> None:
+    """
+    Main function is intended to import and execute by other scripts.
+    It sync external data sources to NetBox.
+
+    * Args:
+        * nr_config (str): Path to the Nornir YAML configuration file.
+        * datasources (list[str]): List of data source names to be synced.
+
+    * Steps:
+        * Loads the Nornir configuration from the specified YAML file.
+        * Retrieves the NetBox URL from the configuration.
+        * Iterates over the provided data sources and attempts to sync each one with NetBox.
+        * For each data source, it checks if the data source exists in NetBox.
+        * If the data source exists, it initiates a sync operation and monitors its status.
+        * Logs the result of each sync operation.
+        * If any data sources fail to sync, it exits with an error message and a list of failed data sources.
+
+    * Exit:
+        * Exits with code 1 if the Nornir configuration file is empty or if any task fails.
+    """
+
+    # Create a empty list to fill with all datasources that fail to sync
+    failed_datasources = []
+
+    # Load the Nornir yaml config file from the filepath
+    nr_config = load_yaml_file(file=nr_config)
+    # Check the loaded config file and exit the script with exit code 1 if the dict is empty
+    if not nr_config:
+        sys.exit(1)
+    # Get the NetBox URL
+    nb_url = nr_config["inventory"]["options"]["nb_url"]
+
+    task_text = "NETBOX Sync External Git Datasource"
+    print(task_name(text=task_text))
+
+    # Loop over all datasources and sync the data into NetBox
+    for datasource in datasources:
+        # Get the NetBox datasource
+        query = {"name": datasource, "enabled": True}
+        response = get_nb_resources(url=f"{nb_url}/api/core/data-sources/", params=query)
+        # Verify the result (list of dict)
+        if not response:
+            failed_datasources.append(datasource)
+            print(task_error(text=task_text, changed=False))
+            print(f"'{task_text} {datasource}' -> NetBoxResponse <Success: False>")
+            print(f"-> Datasource '{datasource}' not found")
+            # Continue because the datasource sync failed
+            continue
+
+        # Start the NetBox datasource sync
+        ds_id = response[0]["id"]
+        response = post_nb_resources(url=f"{nb_url}/api/core/data-sources/{ds_id}/sync/", payload=[])
+        result = response.json()
+
+        # Do thee GET request to verify the status of the running NetBox datasource sync
+        # Terminate the while loop with a timeout of max 300s (5min)
+        timeout_start = time.time()
+        while time.time() < timeout_start + 300:
+            # Verify the NetBox datasource status
+            if result["status"]["value"] not in ("queued", "syncing"):
+                # Break out of the loop as the datasource sync was successful
+                break
+            # Get the NetBox datasource
+            response = get_nb_resources(url=f"{nb_url}/api/core/data-sources/", params=query)
+            result = response[0]
+            time.sleep(1)
+
+        # Print the status after the datasource sync
+        if result["status"]["value"] == "completed":
+            print(task_info(text=f"{task_text} {datasource}", changed=True))
+            print(f"'{task_text} {datasource}' -> NetBoxResponse <Success: True>")
+            print(f"-> Completed {task_text} '{datasource}'")
+        else:
+            failed_datasources.append(datasource)
+            print(task_error(text=f"{task_text} {datasource}", changed=False))
+            print(f"'{task_text} {datasource}' -> NetBoxResponse <Success: False>")
+            print(f"-> Failed {task_text} '{datasource}'")
+            print(json.dumps(result, indent=4))
+
+    # Check the result and exit the script with exit code 1 and a error message
+    if failed_datasources:
+        exit_error(
+            task_text=f"{task_text} Failed",
+            msg=[
+                "Check the result details in the pipeline log or directly in NetBox",
+                "-> The following datasources failed to sync:",
+                failed_datasources,
+            ],
+        )

nornir_collection/netbox/update_cisco_inventory_data.py

@@ -0,0 +1,158 @@
+#!/usr/bin/env python3
+"""
+This module updates the serial numbers of Cisco devices in NetBox using Nornir.
+The Main function is intended to import and execute by other scripts.
+"""
+
+
+from nornir.core import Nornir
+from nornir.core.filter import F
+from nornir.core.task import Task, Result
+from nornir_collection.nornir_plugins.inventory.utils import init_nornir
+from nornir_collection.cisco.configuration_management.cli.show_tasks import _get_serial_numbers
+from nornir_collection.netbox.utils import get_nb_resources, patch_nb_resources
+from nornir_collection.netbox.utils import _nb_patch_resources, _nb_create_payload_patch_device_serials
+from nornir_collection.utils import (
+    print_task_title,
+    print_result,
+    task_name,
+    task_info,
+    exit_error,
+)
+
+
+def update_serial_number(task: Task) -> Result:
+    """
+    Update the device serial number in NetBox based on the serial number retrieved from the Cisco device.
+
+    Args:
+        task (Task): The Nornir task object.
+
+    Returns:
+        Result: The Nornir result object.
+    """
+    task_text = "Update device serial number"
+
+    # Use the helper function _get_serial_numbers to get the software version
+    serials, sub_serials, verbose_result, failed = _get_serial_numbers(task=task)
+    # If failed is the the verbose result contains the full Nornir result string (result + verbose_result)
+    if failed:
+        # Return the Nornir result as failed
+        return Result(host=task.host, result=verbose_result, failed=True)
+
+    # Create the API payload to update the device serial number or return the Nornir result as failed
+    payload = _nb_create_payload_patch_device_serials(task=task, task_text=task_text, serials=serials)
+
+    # Update the device serial number in NetBox
+    url = f"{task.nornir.config.inventory.options['nb_url']}/api/dcim/devices/"
+    result = _nb_patch_resources(task=task, task_text=task_text, url=url, payload=payload)
+    result += f"\n-> Serials: {[item['serial'] for item in payload]}"
+
+    # If the add_serials dict is not empty, then the dict contains managed devices by a controller (e.g. WLC)
+    if not sub_serials:
+        return Result(host=task.host, result=result, changed=False, failed=failed)
+
+    # Create a list of dicts. Multiple dicts if its a virtual chassis
+    payload = []
+    for serial, device in sub_serials.items():
+        nb_device = get_nb_resources(url=f"{url}?name={device}")
+        if nb_device:
+            payload.append({"id": nb_device[0]["id"], "serial": serial})
+            result += f"\n-> Serial: {serial} (Sub-Device)"
+        else:
+            result += f"\n-> Serial: {serial} (Sub-Device '{device}' not in NetBox)"
+            failed = True
+
+    # POST request to update the Cisco Support Plugin desired release
+    response = patch_nb_resources(url=url, payload=payload)
+    # Verify the response code and return the result
+    if response.status_code != 200:
+        failed = True
+
+    return Result(host=task.host, result=result, changed=False, failed=failed)
+
+
+def update_cisco_inventory_data(nr: Nornir) -> bool:
+    """
+    Update NetBox Cisco Device Inventory Data. This function runs a Nornir task to update the serial number
+    of Cisco devices in NetBox. The Nornir inventory is filtered by device manufacturer (Cisco), device
+    status (active), and device role (router, switch or wlc). If any of the tasks fail, the function returns
+    True, otherwise it returns False.
+
+    Args:
+        nr: The Nornir inventory object.
+
+    Returns:
+        bool: True if any of the tasks failed, False otherwise.
+    """
+    # pylint: disable=invalid-name
+    # Track if one of the tasks has failed
+    failed = False
+
+    print_task_title(title="Update NetBox Cisco Device Inventory Data")
+
+    # Filter Nornir inventory by device manufacturer, device status and device role
+    nr_cisco = nr.filter(
+        F(device_type__manufacturer__slug__contains="cisco")
+        & F(status__value="active")
+        & ~F(role__slug__any=["ap", "access-point", "srv", "server"])
+    )
+    task_text = "Filter nornir inventory"
+    print(task_name(text=task_text))
+    print(task_info(text=task_text, changed=False))
+    print(
+        f"'{task_text}' -> NornirResult <Success: True>\n"
+        + "-> Filter condition: Device manufacturer slug contains 'cisco'\n"
+        + "                     & Device status value is 'active'\n"
+        + "                     & Device role is not 'ap', 'access-point', 'srv' or 'server'"
+    )
+
+    # Run the custom Nornir task update_serial_number
+    task_text = "NETBOX update device serial number"
+    result = nr_cisco.run(name=task_text, task=update_serial_number, on_failed=True)
+    # Print the whole result for each host
+    print_result(result)
+    if result.failed:
+        failed = True
+
+    return failed
+
+
+def main(nr_config: str) -> None:
+    """
+    Main function is intended to import and execute by other scripts. It initialize Nornir and update Cisco
+    inventory data in NetBox.
+
+    * Args:
+        * nr_config (str): Path to the Nornir configuration file.
+
+    * Steps:
+        * Initializes the Nornir inventory object using the provided configuration file.
+        * Runs the Nornir Cisco support plugin to update NetBox Cisco inventory data.
+        * Checks the result of the update task and exits the script with an error message if the task failed.
+
+    * Exit:
+        * Exits with code 1 if the Nornir configuration file is empty or if any task fails.
+    """
+    # pylint: disable=invalid-name
+
+    #### Initialize Nornir ##################################################################################
+
+    # Initialize, transform and filter the Nornir inventory are return the filtered Nornir object
+    # Define data to load from NetBox in addition to the base Nornir inventory plugin
+    add_netbox_data = {"load_virtual_chassis_data": True}
+    nr = init_nornir(config_file=nr_config, add_netbox_data=add_netbox_data)
+
+    #### Run Nornir Cisco Support Plugin Update Tasks #######################################################
+
+    # Update NetBox Cisco inventory data
+    result_failed = update_cisco_inventory_data(nr=nr)
+
+    # Check the result and exit the script with exit code 1 and a error message
+    if result_failed:
+        text = "Update NetBox Cisco Device Inventory Data with Nornir"
+        print(task_name(text=text))
+        exit_error(
+            task_text=f"{text} Failed",
+            msg="Check the result details for failed Nornir tasks",
+        )

nornir_collection/netbox/update_cisco_support_plugin_data.py

@@ -0,0 +1,339 @@
+#!/usr/bin/env python3
+"""
+This module updates Cisco support plugin data in NetBox using Nornir.
+The Main function is intended to import and execute by other scripts.
+"""
+
+
+import sys
+from nornir.core.filter import F
+from nornir.core import Nornir
+from nornir.core.task import Task, Result
+from nornir_collection.nornir_plugins.inventory.utils import init_nornir
+from nornir_collection.netbox.utils import patch_nb_resources
+from nornir_collection.cisco.configuration_management.cli.show_tasks import _get_software_version
+from nornir_collection.utils import (
+    print_task_title,
+    task_name,
+    task_info,
+    exit_error,
+    print_result,
+    load_yaml_file,
+)
+
+
+__author__ = "Willi Kubny"
+__maintainer__ = "Willi Kubny"
+__version__ = "1.0"
+__license__ = "MIT"
+__email__ = "willi.kubny@dreyfusbank.ch"
+__status__ = "Production"
+
+
+def update_cisco_support_contract_supplier(task: Task, data: dict) -> Result:
+    """
+    Update the contract supplier information for a Cisco device in NetBox using the Cisco Support Plugin API.
+
+    Args:
+        task (Task): The Nornir task object.
+        data (dict): A dictionary containing the contract supplier information for the device.
+
+    Returns:
+        Result: A Nornir Result object containing the result of the task.
+    """
+    # Create empty lists to fill with the payload and the serials of all devices
+    payload = []
+    serials = []
+
+    # Get the NetBox device serial number and database id for the device depending if its a virtual chassis
+    if "master" in task.host["cisco_support"]:
+        nb_serial = task.host["cisco_support"]["master"]["serial"]
+        nb_id = task.host["cisco_support"]["master"]["id"]
+    else:
+        nb_serial = task.host["cisco_support"]["serial"]
+        nb_id = task.host["cisco_support"]["id"]
+    # Add the serial to the serials list
+    serials.append(nb_serial)
+    # Check if the master is covered by a 3rd party support contract
+    if nb_serial not in data.keys():
+        payload.append(
+            {
+                "id": nb_id,
+                "contract_supplier": None,
+                "partner_status": None,
+                "partner_service_level": None,
+                "partner_customer_number": None,
+                "partner_coverage_end_date": None,
+            }
+        )
+    else:
+        payload.append(
+            {
+                "id": nb_id,
+                "contract_supplier": data[str(nb_serial)]["contract_supplier"],
+                "partner_status": data[str(nb_serial)]["partner_status"],
+                "partner_service_level": data[str(nb_serial)]["partner_service_level"],
+                "partner_customer_number": data[str(nb_serial)]["partner_customer_number"],
+                "partner_coverage_end_date": data[str(nb_serial)]["partner_coverage_end_date"],
+            }
+        )
+
+    # Check if the members are covered by a 3rd party support contract
+    if "members" in task.host["cisco_support"]:
+        for member in task.host["cisco_support"]["members"]:
+            # Get the NetBox device serial number and database id for the virtual chassis member
+            nb_serial = member["serial"]
+            nb_id = member["id"]
+            # Add the serial to the serials list
+            serials.append(nb_serial)
+            if nb_serial not in data.keys():
+                payload.append(
+                    {
+                        "id": nb_id,
+                        "contract_supplier": None,
+                        "partner_status": None,
+                        "partner_service_level": None,
+                        "partner_customer_number": None,
+                        "partner_coverage_end_date": None,
+                    }
+                )
+            else:
+                payload.append(
+                    {
+                        "id": nb_id,
+                        "contract_supplier": data[str(nb_serial)]["contract_supplier"],
+                        "partner_status": data[str(nb_serial)]["partner_status"],
+                        "partner_service_level": data[str(nb_serial)]["partner_service_level"],
+                        "partner_customer_number": data[str(nb_serial)]["partner_customer_number"],
+                        "partner_coverage_end_date": data[str(nb_serial)]["partner_coverage_end_date"],
+                    }
+                )
+
+    # Get the NetBox url from the inventory options
+    nb_url = task.nornir.config.inventory.options["nb_url"]
+    # POST request to update the Cisco Support Plugin desired release
+    response = patch_nb_resources(
+        url=f"{nb_url}/api/plugins/device-support/cisco-device/",
+        payload=payload,
+    )
+
+    # Verify the response code and set the result
+    if response.status_code == 200:
+        result = "'Update contract supplier' -> NetBoxResponse: <Success: True>\n" + f"-> Serials: {serials}"
+        return Result(host=task.host, result=result, changed=False, failed=False)
+
+    result = (
+        "'Update contract supplier' -> NetBoxResponse: <Success: True>\n"
+        + f"-> Response Status Code: {response.status_code}\n"
+        + f"-> Response Text: {response.text}\n"
+        + f"-> Payload: {payload}"
+    )
+    return Result(host=task.host, result=result, changed=False, failed=True)
+
+
+def update_cisco_support_desired_and_current_release(task: Task) -> Result:
+    """
+    Update the current and desired release of a Cisco device in NetBox using the Cisco Support Plugin.
+
+    Args:
+        task (Task): A Nornir task object.
+
+    Returns:
+        Result: A Nornir result object with the following attributes:
+            - result (str): A string describing the result of the task.
+            - changed (bool): Whether or not the task made any changes.
+            - failed (bool): Whether or not the task failed.
+    """
+    # Skip hosts which have no software -> 'PID without Cisco software' (managed over a controller)
+    if "recommended_release" in task.host["cisco_support"]:
+        if "PID without Cisco software" in task.host["cisco_support"]["recommended_release"]:
+            result = (
+                "'Update device current and desired release' -> NetBoxResponse: <Success: True>\n"
+                + "-> Device without Cisco software (managed over a controller)"
+            )
+            return Result(host=task.host, result=result, changed=False, failed=False)
+
+    # Use the helper function _get_software_version to get the current software release
+    current_rel, verbose_result, failed = _get_software_version(task=task)
+    # If failed, the the verbose result contains the full Nornir result string (result + verbose_result)
+    if failed:
+        # Return the Nornir result as failed
+        return Result(host=task.host, result=verbose_result, failed=True)
+
+    try:
+        # Get the desired release from the host config context
+        desired_rel = task.host["software"]["version"]
+
+        # Create a list of dicts. Multiple dicts if its a virtual chassis
+        payload = []
+        # Add the device depending if its a virtual chassis in NetBox or not
+        nb_id = (
+            task.host["cisco_support"]["master"]["id"]
+            if "master" in task.host["cisco_support"]
+            else task.host["cisco_support"]["id"]
+        )
+        payload.append({"id": nb_id, "current_release": current_rel, "desired_release": desired_rel})
+
+        # Add all members to the payload if available
+        if "members" in task.host["cisco_support"]:
+            for member in task.host["cisco_support"]["members"]:
+                payload.append(
+                    {"id": member["id"], "current_release": current_rel, "desired_release": desired_rel}
+                )
+
+    except KeyError as error:
+        result = (
+            f"'{task.name}' -> NornirResponse <Success: False>\n"
+            + f"-> Nornir inventory key {error} not found"
+        )
+        # Return the Nornir result
+        return Result(host=task.host, result=result, changed=False, failed=True)
+
+    # Get the NetBox url from the inventory options
+    nb_url = task.nornir.config.inventory.options["nb_url"]
+    # POST request to update the Cisco Support Plugin desired release
+    response = patch_nb_resources(
+        url=f"{nb_url}/api/plugins/device-support/cisco-device/",
+        payload=payload,
+    )
+
+    # Verify the response code and set the result
+    if response.status_code == 200:
+        result = (
+            "'Update device current and desired release' -> NetBoxResponse: <Success: True>\n"
+            + f"-> Current release: {current_rel}\n"
+            + f"-> Desired release: {desired_rel}"
+        )
+        return Result(host=task.host, result=result, changed=False, failed=False)
+
+    result = (
+        "'Update device current and desired release' -> NetBoxResponse: <Success: False>\n"
+        + f"-> Response Status Code: {response.status_code}\n"
+        + f"-> Response Text: {response.text}\n"
+        + f"-> Payload: {payload}"
+    )
+    return Result(host=task.host, result=result, changed=False, failed=True)
+
+
+def update_cisco_support_plugin_data(nr: Nornir, partner_inv: str = None) -> bool:
+    """
+    Update NetBox Cisco Support Plugin Data which can't be retrieved from the Cisco Support API.
+
+    Args:
+        nr (Nornir): The Nornir object.
+        partner_inv (str, optional): Path to the partner inventory file. Defaults to None.
+
+    Returns:
+        bool: True if any of the tasks failed, False otherwise.
+    """
+
+    # pylint: disable=invalid-name
+    # Track if one of the tasks has failed
+    failed = False
+
+    print_task_title(title="Update NetBox Cisco Support Plugin Data")
+
+    # Filter Nornir inventory by device manufacturer, device status and device role
+    nr_cisco = nr.filter(
+        F(device_type__manufacturer__slug__contains="cisco")
+        & F(status__value="active")
+        & ~F(role__slug__any=["ap", "access-point", "srv", "server"])
+    )
+    task_text = "Filter nornir inventory"
+    print(task_name(text=task_text))
+    print(task_info(text=task_text, changed=False))
+    print(
+        f"'{task_text}' -> NornirResult <Success: True>\n"
+        + "-> Filter condition: Device manufacturer slug contains 'cisco'\n"
+        + "                     & Device status value is 'active'\n"
+        + "                     & Device role is not 'ap', 'access-point', 'srv' or 'server'"
+    )
+
+    # Run the custom Nornir task update_cisco_support_desired_and_current_release
+    task_text = "NETBOX update device current and desired release"
+    result = nr_cisco.run(
+        name=task_text,
+        task=update_cisco_support_desired_and_current_release,
+        on_failed=True,
+    )
+    # Print the whole result for each host
+    print_result(result)
+    if result.failed:
+        failed = True
+
+    if not partner_inv:
+        print(task_name(text=task_text))
+        print(task_info(text=task_text, changed=False))
+        print(f"'{task_text}' -> NornirResponse: <Success: True>")
+        print("-> No list of 3rd party Cisco support partners provided")
+        print("-> All devices are expected to be covered by Cisco SNTC")
+
+        return failed
+
+    # Load the partner inventory file as dict and print a error message
+    data = load_yaml_file(
+        file=partner_inv, text="Load Cisco support partner inventory file", silent=False, verbose=False
+    )
+    # Check the loaded file and exit the script with exit code 1 if the list is empty
+    if not data:
+        sys.exit(1)
+    # Run the custom Nornir task update_cisco_support_contract_supplier
+    task_text = "NETBOX update contract supplier"
+    result = nr_cisco.run(
+        name=task_text,
+        task=update_cisco_support_contract_supplier,
+        data=data,
+        on_failed=True,
+    )
+    # Print the whole result for each host
+    print_result(result)
+    if result.failed:
+        failed = True
+
+    return failed
+
+
+def main(nr_config: str, partner_inv: str = None) -> None:
+    """
+    Main function is intended to import and execute by other scripts.
+    It initialize Nornir, filter the inventory for Cisco devices, and update the NetBox Cisco support
+    plugin data.
+
+    * Args:
+        * nr_config (str): Path to the Nornir configuration file.
+        * partner_inv (str, optional): Path to the partner inventory file. Defaults to None.
+
+    * Steps:
+        * Initializes the Nornir inventory object using the provided configuration file.
+        * Filters the Nornir inventory by device manufacturer (Cisco) and status (active).
+        * Runs the custom Nornir tasks update_cisco_support_desired_and_current_release and
+          update_cisco_support_contract_supplier.
+        * If no partner inventory file is provided, all devices are expected to be covered by Cisco SNTC.
+        * Checks the result of the update tasks and exits the script with an error message if any task
+
+    * Exit:
+        * Exits with code 1 if the Nornir configuration file is empty or if any task fails.
+    """
+
+    # pylint: disable=invalid-name
+
+    #### Initialize Nornir ##################################################################################
+
+    # Initialize and transform the Nornir inventory object
+    # Define data to load from NetBox in addition to the base Nornir inventory plugin
+    add_netbox_data = {"load_virtual_chassis_data": True, "load_cisco_support_data": True}
+    nr = init_nornir(config_file=nr_config, add_netbox_data=add_netbox_data)
+
+    #### Run Nornir Cisco Support Plugin Update Tasks #######################################################
+
+    # Update NetBox Cisco support plugin data
+    result_failed = update_cisco_support_plugin_data(nr=nr, partner_inv=partner_inv)
+
+    # Check the result and exit the script with exit code 1 and a error message
+    if result_failed:
+        text = "Update NetBox Cisco Support Plugin Data with Nornir"
+        print(task_name(text=text))
+        exit_error(
+            task_text=f"{text} Failed",
+            msg="Check the result details for failed Nornir tasks",
+        )