org_conf_deploy_only.py

'''
-------------------------------------------------------------------------------

    Written by Thomas Munzer (tmunzer@juniper.net)
    Github repository: https://github.com/tmunzer/Mist_library/

    This script is licensed under the MIT License.

-------------------------------------------------------------------------------
Python script to deploy organization backup/template file.
You can use the script "org_conf_backup.py" to generate the backup file from an
existing organization.

This script cannot restore the configuration to an existing organization, and 
will only allow to deploy the configuration to a new org.
This script is trying to maintain objects integrity as much as possible. To do
so, when an object is referencing another object by its ID, the script will 
replace be ID from the original organization by the corresponding ID from the
destination org.

-------
Requirements:
mistapi: https://pypi.org/project/mistapi/

-------
Usage:
This script can be run as is (without parameters), or with the options below.
If no options are defined, or if options are missing, the missing options will
be asked by the script or the default values will be used.

It is recommended to use an environment file to store the required information
to request the Mist Cloud (see https://pypi.org/project/mistapi/ for more 
information about the available parameters).

-------
Script Parameters:
-h, --help              display this help
-n, --org_name=         Org name where to deploy the configuration. The script
                        will create a new org and name it with the org_name value                        
-f, --backup_folder=    Path to the folder where to save the org backup (a subfolder
                        will be created with the org name)
                        default is "./org_backup"
-b, --source_backup=    Name of the backup/template to deploy. This is the name of
                        the folder where all the backup files are stored.
-l, --log_file=         define the filepath/filename where to write the logs
                        default is "./script.log"
-e, --env=              define the env file to use (see mistapi env file documentation 
                        here: https://pypi.org/project/mistapi/)
                        default is "~/.mist_env"

-------
Examples:
python3 ./org_conf_deploy.py     
python3 ./org_conf_deploy.py --org_id=203d3d02-xxxx-xxxx-xxxx-76896a3330f4 -n "my test org"

'''

#### IMPORTS ####
import logging
import json
import os
import sys
import re
import getopt
import signal
from typing import Callable

import mistapi.__version

MISTAPI_MIN_VERSION = "0.55.6"

try:
    import mistapi
    from mistapi.__logger import console
except:
        print("""
        Critical: 
        \"mistapi\" package is missing. Please use the pip command to install it.

        # Linux/macOS
        python3 -m pip install mistapi

        # Windows
        py -m pip install mistapi
        """)
        sys.exit(2)

#####################################################################
#### PARAMETERS #####
backup_folder = "./org_backup"
backup_file = "org_conf_file.json"
log_file = "./script.log"
file_prefix = ".".join(backup_file.split(".")[:-1])
env_file = "~/.mist_env"

#####################################################################
#### LOGS ####
LOGGER = logging.getLogger(__name__)

#####################################################################
#### GLOBALS #####
sys_exit = False


def sigint_handler(signal, frame):
    global sys_exit
    sys_exit = True
    ('[Ctrl C],KeyboardInterrupt exception occured.')


signal.signal(signal.SIGINT, sigint_handler)

#####################################################################
# DEPLOY OBJECTS REFS
org_steps = {
    "assetfilters": {"mistapi_function": mistapi.api.v1.orgs.assetfilters.createOrgAssetFilter, "text": "Org assetfilters"},
    "deviceprofiles": {"mistapi_function": mistapi.api.v1.orgs.deviceprofiles.createOrgDeviceProfile, "text": "Org deviceprofiles"},
    "switchprofiles": {"mistapi_function": mistapi.api.v1.orgs.deviceprofiles.createOrgDeviceProfile, "text": "Org switchprofiles"},
    "hubprofiles": {"mistapi_function": mistapi.api.v1.orgs.deviceprofiles.createOrgDeviceProfile, "text": "Org hubprofiles"},
    "evpn_topologies": {"mistapi_function": mistapi.api.v1.orgs.evpn_topologies.createOrgEvpnTopology, "text": "Org evpn_topologies"},
    "secpolicies": {"mistapi_function": mistapi.api.v1.orgs.secpolicies.createOrgSecPolicy, "text": "Org secpolicies"},
    "aptempaltes": {"mistapi_function": mistapi.api.v1.orgs.aptemplates.createOrgAptemplate, "text": "Org aptemplates"},
    "networktemplates": {"mistapi_function": mistapi.api.v1.orgs.networktemplates.createOrgNetworkTemplate, "text": "Org networktemplates"},
    "networks": {"mistapi_function": mistapi.api.v1.orgs.networks.createOrgNetwork, "text": "Org networks"},
    "services": {"mistapi_function": mistapi.api.v1.orgs.services.createOrgService, "text": "Org services"},
    "servicepolicies": {"mistapi_function": mistapi.api.v1.orgs.servicepolicies.createOrgServicePolicy, "text": "Org servicepolicies"},
    "vpns": {"mistapi_function": mistapi.api.v1.orgs.vpns.createOrgVpn, "text": "Org vpns"},
    "gatewaytemplates": {"mistapi_function": mistapi.api.v1.orgs.gatewaytemplates.createOrgGatewayTemplate, "text": "Org gatewaytemplates"},
    "alarmtemplates": {"mistapi_function": mistapi.api.v1.orgs.alarmtemplates.createOrgAlarmTemplate, "text": "Org alarmtemplates"},
    "rftemplates": {"mistapi_function": mistapi.api.v1.orgs.rftemplates.createOrgRfTemplate, "text": "Org rftemplates"},
    "webhooks": {"mistapi_function": mistapi.api.v1.orgs.webhooks.createOrgWebhook, "text": "Org webhooks"},
    "mxclusters": {"mistapi_function": mistapi.api.v1.orgs.mxclusters.createOrgMxEdgeCluster, "text": "Org mxclusters"},
    "mxtunnels": {"mistapi_function": mistapi.api.v1.orgs.mxtunnels.createOrgMxTunnel, "text": "Org mxtunnels"},
    "wxtunnels": {"mistapi_function": mistapi.api.v1.orgs.wxtunnels.createOrgWxTunnel, "text": "Org wxtunnels"},
    "sitetemplates": {"mistapi_function": mistapi.api.v1.orgs.sitetemplates.createOrgSiteTemplate, "text": "Org sitetemplates"},
    "sitegroups": {"mistapi_function": mistapi.api.v1.orgs.sitegroups.createOrgSiteGroup, "text": "Org sitegroups"},
    "sites": {"mistapi_function": mistapi.api.v1.orgs.sites.createOrgSite, "text": "Org Sites"},
    "templates": {"mistapi_function": mistapi.api.v1.orgs.templates.createOrgTemplate, "text": "Org templates"},
    "wlans": {"mistapi_function": mistapi.api.v1.orgs.wlans.createOrgWlan, "text": "Org wlans"},
    "wxtags": {"mistapi_function": mistapi.api.v1.orgs.wxtags.createOrgWxTag, "text": "Org wxtags"},
    "wxrules": {"mistapi_function": mistapi.api.v1.orgs.wxrules.createOrgWxRule, "text": "Org wxrules"},
    "pskportals": {"mistapi_function": mistapi.api.v1.orgs.pskportals.createOrgPskPortal, "text": "Org pskportals"},
    "psks": {"mistapi_function": mistapi.api.v1.orgs.psks.createOrgPsk, "text": "Org psks"},
    "nactags": {"mistapi_function": mistapi.api.v1.orgs.nactags.createOrgNacTag, "text": "Org nactags"},
    "nacrules": {"mistapi_function": mistapi.api.v1.orgs.nacrules.createOrgNacRule, "text": "Org nacrules"},
    "ssos": {"mistapi_function": mistapi.api.v1.orgs.ssos.createOrgSso, "text": "Org ssos"},
    "ssoroles": {"mistapi_function": mistapi.api.v1.orgs.ssoroles.createOrgSsoRole, "text": "Org ssoroles"},
}
site_steps = {
    "settings": {"mistapi_function": mistapi.api.v1.sites.setting.updateSiteSettings, "text": "Site settings"},
    "maps": {"mistapi_function": mistapi.api.v1.sites.maps.createSiteMap, "text": "Site maps"},
    "zones": {"mistapi_function": mistapi.api.v1.sites.zones.createSiteZone, "text": "Site zones"},
    "rssizones": {"mistapi_function": mistapi.api.v1.sites.rssizones.createSiteRssiZone, "text": "Site rssizones"},
    "assets": {"mistapi_function": mistapi.api.v1.sites.assets.createSiteAsset, "text": "Site assets"},
    "assetfilters": {"mistapi_function": mistapi.api.v1.sites.assetfilters.createSiteAssetFilter, "text": "Site assetfilters"},
    "beacons": {"mistapi_function": mistapi.api.v1.sites.beacons.createSiteBeacon, "text": "Site beacons"},
    "psks": {"mistapi_function": mistapi.api.v1.sites.psks.importSitePsks, "text": "Site psks"},
    "vbeacons": {"mistapi_function": mistapi.api.v1.sites.vbeacons.createSiteVBeacon, "text": "Site vbeacons"},
    "webhooks": {"mistapi_function": mistapi.api.v1.sites.webhooks.createSiteWebhook, "text": "Site webhooks"},
    "wxtunnels": {"mistapi_function": mistapi.api.v1.sites.wxtunnels.createSiteWxTunnel, "text": "Site wxtunnels"},
    "wlans": {"mistapi_function": mistapi.api.v1.sites.wlans.createSiteWlan, "text": "Site wlans"},
    "wxtags": {"mistapi_function": mistapi.api.v1.sites.wxtags.createSiteWxTag, "text": "Site wxtags"},
    "wxrules": {"mistapi_function": mistapi.api.v1.sites.wxrules.createSiteWxRule, "text": "Site wxrules"},
}

##########################################################################################
# CLASS TO MANAGE UUIDS UPDATES (replace UUIDs from source org to the newly created ones)


class UUIDM():

    def __init__(self):
        self.uuids = {}
        self.requests_to_replay = []

    def add_uuid(self, new: str, old: str):
        if new and old:
            self.uuids[old] = new

    def get_new_uuid(self, old: str):
        return self.uuids.get(old)

    def add_replay(self, mistapi_function: Callable, scope_id: str, object_type: str, data: dict):
        self.requests_to_replay.append({"mistapi_function": mistapi_function,
                                       "scope_id": scope_id, "data": data, "object_type": object_type, "retry": 0})

    def get_replay(self):
        return self.requests_to_replay

    def _uuid_string(self, obj_str: str, missing_uuids: list):
        uuid_re = "\"[a-zA_Z_-]*\": \"[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}\""
        uuids_to_replace = re.findall(uuid_re, obj_str)
        if uuids_to_replace:
            for uuid in uuids_to_replace:
                uuid_key = uuid.replace('"', "").split(":")[0].strip()
                uuid_val = uuid.replace('"', "").split(":")[1].strip()
                if self.get_new_uuid(uuid_val):
                    obj_str = obj_str.replace(
                        uuid_val, self.get_new_uuid(uuid_val))
                elif uuid_key not in ["issuer", "idp_sso_url", "custom_logout_url", "sso_issuer", "sso_idp_sso_url", "ibeacon_uuid"]:
                    missing_uuids.append({uuid_key: uuid_val})
        return obj_str, missing_uuids

    def _uuid_list(self, obj_str: str, missing_uuids: list):
        uuid_list_re = r"(\"[a-zA_Z_-]*\": \[\"[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}\"[^\]]*)]"
        uuid_lists_to_replace = re.findall(uuid_list_re, obj_str)
        if uuid_lists_to_replace:
            for uuid_list in uuid_lists_to_replace:
                uuid_key = uuid_list.replace('"', "").split(":")[0].strip()
                uuids = uuid_list.replace('"', "").replace(
                    '[', "").replace(']', "").split(":")[1].split(",")
                for uuid in uuids:
                    uuid_val = uuid.strip()
                    if self.get_new_uuid(uuid_val):
                        obj_str = obj_str.replace(
                            uuid_val, self.get_new_uuid(uuid_val))
                    else:
                        missing_uuids.append({uuid_key: uuid_val})
        return obj_str, missing_uuids

    def find_and_replace(self, obj: dict, object_type: str):
        # REMOVE READONLY FIELDS
        ids_to_remove = ["id", "msp_id", "org_id", "site_id", "site_ids", "url", "bg_image_url",
                         "portal_template_url", "portal_sso_url", "thumbnail_url", "template_url", "ui_url"]

        for id_name in ids_to_remove:
            if not object_type == "webhooks" or not id_name == "url":
                if id_name in obj:
                    del obj[id_name]
        if "service_policies" in obj:
            for service_policy in obj.get("service_policies", []):
                if "id" in service_policy:
                    del service_policy["id"]

        # REPLACE REMAINING IDS
        obj_str = json.dumps(obj)
        obj_str, missing_uuids = self._uuid_string(obj_str, [])
        obj_str, missing_uuids = self._uuid_list(obj_str, missing_uuids)
        obj = json.loads(obj_str)

        return obj, missing_uuids


uuid_matching = UUIDM()
#####################################################################
# PROGRESS BAR AND DISPLAY


class ProgressBar():
    def __init__(self):
        self.steps_total = 0
        self.steps_count = 0

    def _pb_update(self, size: int = 80):
        if self.steps_count > self.steps_total:
            self.steps_count = self.steps_total

        percent = self.steps_count/self.steps_total
        delta = 17
        x = int((size-delta)*percent)
        print(f"Progress: ", end="")
        print(f"[{'█'*x}{'.'*(size-delta-x)}]", end="")
        print(f"{int(percent*100)}%".rjust(5), end="")

    def _pb_new_step(self, message: str, result: str, inc: bool = False, size: int = 80, display_pbar: bool = True):
        if inc:
            self.steps_count += 1
        text = f"\033[A\033[F{message}"
        print(f"{text} ".ljust(size + 4, "."), result)
        print("".ljust(80))
        if display_pbar:
            self._pb_update(size)

    def _pb_title(self, text: str, size: int = 80, end: bool = False, display_pbar: bool = True):
        print("\033[A")
        print(f" {text} ".center(size, "-"), "\n")
        if not end and display_pbar:
            print("".ljust(80))
            self._pb_update(size)

    def set_steps_total(self, steps_total: int):
        self.steps_total = steps_total

    def log_message(self, message, display_pbar: bool = True):
        self._pb_new_step(message, " ", display_pbar=display_pbar)

    def log_debug(self, message):
        LOGGER.debug(f"{message}")

    def log_success(self, message, inc: bool = False, display_pbar: bool = True):
        LOGGER.info(f"{message}: Success")
        self._pb_new_step(
            message, "\033[92m\u2714\033[0m\n", inc=inc, display_pbar=display_pbar)

    def log_warning(self, message, inc: bool = False, display_pbar: bool = True):
        LOGGER.warning(f"{message}")
        self._pb_new_step(
            message, "\033[93m\u2B58\033[0m\n", inc=inc, display_pbar=display_pbar)

    def log_failure(self, message, inc: bool = False, display_pbar: bool = True):
        LOGGER.error(f"{message}: Failure")
        self._pb_new_step(
            message, '\033[31m\u2716\033[0m\n', inc=inc, display_pbar=display_pbar)

    def log_title(self, message, end: bool = False, display_pbar: bool = True):
        LOGGER.info(message)
        self._pb_title(message, end=end, display_pbar=display_pbar)


pb = ProgressBar()
##########################################################################################
##########################################################################################
# DEPLOY FUNCTIONS
##########################################################################################
# COMMON FUNCTION


def _common_deploy(apisession: mistapi.APISession, mistapi_function: Callable, scope_id: str, object_type: str, data: dict, retry: bool = False):
    if sys_exit:
        sys.exit(0)
    old_id = None
    new_id = None
    if "name" in data:
        object_name = f"\"{data['name']}\" "
    elif "ssid" in data:
        object_name = f"\"{data['ssid']}\" "
    else:
        object_name = ""
    if "id" in data:
        old_id = data["id"]
    else:
        old_id = None

    message = f"Creating {object_type} {object_name}"
    pb.log_message(message)
    data, missing_uuids = uuid_matching.find_and_replace(data, object_type)

    if missing_uuids and not retry:
        uuid_matching.add_replay(mistapi_function, scope_id, object_type, data)
        pb.log_warning(message, inc=True)
    else:
        try:
            response = mistapi_function(apisession, scope_id, data).data
            if "id" in response:
                new_id = response["id"]
            pb.log_success(message, inc=True)
        except:
            pb.log_failure(message, inc=True)
        uuid_matching.add_uuid(new_id, old_id)
        return new_id
    return None

##########################################################################################
# WLAN FUNCTIONS


def _deploy_wlan(apisession: mistapi.APISession, mistapi_function: Callable, scope_id: str, data: dict, old_org_id: str, old_site_id: str = None):
    if sys_exit:
        sys.exit(0)
    old_wlan_id = data["id"]
    new_wlan_id = _common_deploy(
        apisession, mistapi_function, scope_id, 'wlans', data)
    uuid_matching.add_uuid(new_wlan_id, old_wlan_id)
    _deploy_wlan_portal(apisession, old_org_id, old_site_id,
                        old_wlan_id, scope_id, new_wlan_id, data["ssid"])


def _deploy_wlan_portal(apisession: mistapi.APISession, old_org_id: str, old_site_id: str, old_wlan_id: str, scope_id: str, new_wlan_id: str, wlan_name: str):
    if sys_exit:
        sys.exit(0)
    if old_site_id is None:
        portal_file_name = f"{file_prefix}_org_{old_org_id}_wlan_{old_wlan_id}.json"
        portal_image = f"{file_prefix}_org_{old_org_id}_wlan_{old_wlan_id}.png"
        upload_image_function = mistapi.api.v1.orgs.wlans.uploadOrgWlanPortalImageFile
        update_template_function = mistapi.api.v1.orgs.wlans.updateOrgWlanPortalTemplate
    else:
        portal_file_name = f"{file_prefix}_org_{old_org_id}_site_{old_site_id}_wlan_{old_wlan_id}.json"
        portal_image = f"{file_prefix}_org_{old_org_id}_site_{old_site_id}_wlan_{old_wlan_id}.png"
        upload_image_function = mistapi.api.v1.sites.wlans.uploadSiteWlanPortalImageFile
        update_template_function = mistapi.api.v1.sites.wlans.updateSiteWlanPortalTemplate

    if os.path.isfile(portal_file_name):
        message = f"Creating Portal Template for WLAN \"{wlan_name}\" "
        pb.log_message(message)
        try:
            template = open(portal_file_name, 'r')
        except Exception as e:
            pb.log_failure(
                f"Unable to open the template file \"{portal_file_name}\" ")
            LOGGER.error("Exception occurred", exc_info=True)
            return
        try:
            template = json.load(template)
        except Exception as e:
            pb.log_failure(
                f"Unable to read the template file \"{portal_file_name}\" ")
            LOGGER.error("Exception occurred", exc_info=True)
            return
        try:
            update_template_function(
                apisession, scope_id, new_wlan_id, template)
            pb.log_success(message)
        except Exception as e:
            pb.log_failure(
                f"Unable to upload the template \"{portal_file_name}\" ")
            LOGGER.error("Exception occurred", exc_info=True)

    else:
        pb.log_debug(f"No Portal template found for WLAN \"{wlan_name}\"")

    if os.path.isfile(portal_image):
        message = f"Uploading Portal image for WLAN \"{wlan_name}\" "
        try:
            upload_image_function(apisession, scope_id,
                                  new_wlan_id, portal_image)
            pb.log_success(message)
        except Exception as e:
            pb.log_failure(message)
            LOGGER.error("Exception occurred", exc_info=True)
    else:
        pb.log_debug(f"No Portal Template image found for WLAN {wlan_name} ")

##########################################################################################
# SITE FUNCTIONS


def _deploy_site_maps(apisession: mistapi.APISession, old_org_id: str, old_site_id: str, new_site_id: str, data: dict):
    if sys_exit:
        sys.exit(0)
    old_map_id = data["id"]
    new_map_id = _common_deploy(
        apisession, site_steps["maps"]["mistapi_function"], new_site_id, 'maps', data)

    image_name = f"{file_prefix}_org_{old_org_id}_site_{old_site_id}_map_{old_map_id}.png"
    if os.path.isfile(image_name):
        message = f"Uploading image floorplan  \"{data['name']}\""
        pb.log_message(message)
        try:
            mistapi.api.v1.sites.maps.addSiteMapImageFile(
                apisession, new_site_id, new_map_id, image_name)
            pb.log_success(message)
        except:
            pb.log_failure(message)
    else:
        pb.log_debug(f"No image found for \"{data['name']}\"")


def _deploy_site(apisession: mistapi.APISession, org_id: str, old_org_id: str, site_info: dict, sites_backup: dict):
    if sys_exit:
        sys.exit(0)
    old_site_id = site_info["id"]
    site_data = sites_backup.get(old_site_id, {})

    pb.log_title(f" Deploying Site {site_info['name']} ".center(80, "_"))
    new_site_id = _common_deploy(
        apisession, org_steps["sites"]["mistapi_function"], org_id, "sites", site_info)

    for step_name in site_steps:
        step = site_steps[step_name]
        if step_name == "settings":
            step_data = site_data.get(step_name, {})
            _common_deploy(
                apisession, step["mistapi_function"], new_site_id, step_name, step_data)
        else:
            for step_data in site_data.get(step_name, []):
                if step_name == "maps":
                    _deploy_site_maps(apisession, old_org_id,
                                      old_site_id, new_site_id, step_data)
                elif step_name == "wlans":
                    _deploy_wlan(
                        apisession, step["mistapi_function"], org_id, step_data, old_org_id, old_site_id)
                else:
                    _common_deploy(
                        apisession, step["mistapi_function"], new_site_id, step_name, step_data)

##########################################################################################
#  ORG FUNCTIONS


def _deploy_org(apisession: mistapi.APISession, org_id: str, org_name: str, backup: dict):
    pb.log_title(f"Deploying Org {org_name}")

    ####################
    ####  ORG MAIN  ####
    org_backup = backup["org"]
    sites_backup = backup["sites"]

    org_data = org_backup["data"]
    old_org_id = org_data["id"]
    uuid_matching.add_uuid(org_id, old_org_id)

    message = "Org Info "
    pb.log_message(message)
    try:
        org_data["name"] = org_name
        mistapi.api.v1.orgs.orgs.updateOrg(apisession, org_id, org_data)
        pb.log_success(message, inc=True)
    except Exception as e:
        pb.log_failure(message, inc=True)
        LOGGER.error("Exception occurred", exc_info=True)

    ########################
    ####  ORG SETTINGS  ####
    message = "Org Settings "
    pb.log_message(message)
    try:
        mistapi.api.v1.orgs.setting.updateOrgSettings(
            apisession, org_id, org_data)
        pb.log_success(message, inc=True)
    except Exception as e:
        pb.log_failure(message, inc=True)
        LOGGER.error("Exception occurred", exc_info=True)

    #######################
    ####  ORG OBJECTS  ####
    pb.log_title(f"Deploying Common Org Objects")
    for step_name in org_steps:
        if step_name in org_backup:
            step = org_steps[step_name]
            for step_data in org_backup[step_name]:
                if step_name == "sites":
                    _deploy_site(apisession, org_id, old_org_id,
                                 step_data, sites_backup)
                elif step_name == "wlans":
                    _deploy_wlan(
                        apisession, step["mistapi_function"], org_id, step_data, old_org_id)
                else:
                    _common_deploy(
                        apisession, step["mistapi_function"], org_id, step_name, step_data)
            if step_name == "sites":
                pb.log_title(f"Deploying Reamining Org Objects")

    pb.log_title(f"Retrying missing objects")
    for replay in uuid_matching.get_replay():
        _common_deploy(apisession, replay["mistapi_function"],
                       replay["scope_id"], replay["object_type"], replay["data"], True)

    pb.log_title("Deployment Done", end=True)


def _start_deploy_org(apisession: mistapi.APISession, org_id: str, org_name: str, src_org_name: str = None, source_backup: str = None):
    _go_to_backup_folder(src_org_name, source_backup)
    print()
    try:
        message = f"Loading template/backup file {backup_file} "
        pb.log_message(message, display_pbar=False)
        with open(backup_file) as f:
            backup = json.load(f)
        pb.log_success(message, display_pbar=False)
    except:
        pb.log_failure(message, display_pbar=False)
        console.critical("Unable to load the template/bakup")
        sys.exit(1)

    try:
        message = f"Analyzing template/backup file {backup_file} "
        pb.log_message(message, display_pbar=False)
        steps_total = 2
        for step_name in org_steps:
            if step_name in backup["org"]:
                steps_total += len(backup["org"][step_name])
        for site_id in backup["sites"]:
            for step_name in site_steps:
                if step_name == "settings":
                    steps_total += 1
                elif step_name in backup["sites"][site_id]:
                    steps_total += len(backup["sites"][site_id][step_name])
        pb.set_steps_total(steps_total)
        pb.log_success(message, display_pbar=False)
        console.info(f"The process will deploy {steps_total} new objects")
    except:
        pb.log_failure(message, display_pbar=False)
        console.critical("Unable to parse the template/backup file")
        sys.exit(1)
    if backup:
        _display_warning(
            f"Are you sure about this? Do you want to import the configuration into the organization {org_name} with the id {org_id} (y/N)? ")
        _deploy_org(apisession, org_id, org_name, backup)


#####################################################################
#### MENUS ####
def _chdir(path: str):
    try:
        os.chdir(path)
        return True
    except FileNotFoundError:
        console.error("Le chemin spécifié n'existe pas.")
        return False
    except NotADirectoryError:
        console.error("Le chemin spécifié n'est pas un répertoire.")
        return False
    except PermissionError:
        console.error(
            "Vous n'avez pas les autorisations nécessaires pour accéder au répertoire spécifié.")
        return False
    except Exception as e:
        console.error(f"Une erreur s'est produite : {e}")
        return False


def _display_warning(message):
    resp = "x"
    while not resp.lower() in ["y", "n", ""]:
        print()
        resp = input(message)
    if not resp.lower() == "y":
        console.error("Interruption... Exiting...")
        LOGGER.error("Interruption... Exiting...")
        sys.exit(0)


def _select_backup_folder(folders):
    i = 0
    print("Available Templates/Backups:")
    while i < len(folders):
        print(f"{i}) {folders[i]}")
        i += 1
    folder = None
    while folder is None:
        resp = input(
            f"Which template/backup do you want to deploy (0-{i - 1}, or q to quit)? ")
        if resp.lower() == "q":
            console.error("Interruption... Exiting...")
            LOGGER.error("Interruption... Exiting...")
            sys.exit(0)
        try:
            respi = int(resp)
            if respi >= 0 and respi <= i:
                folder = folders[respi]
            else:
                print(
                    f"The entry value \"{respi}\" is not valid. Please try again...")
        except:
            print("Only numbers are allowed. Please try again...")
    _chdir(folder)


def _go_to_backup_folder(src_org_name: str = None, source_backup: str = None):
    print()
    print(" Source Backup/Template ".center(80, "-"))
    print()
    _chdir(backup_folder)
    folders = []
    for entry in os.listdir("./"):
        if os.path.isdir(os.path.join("./", entry)):
            folders.append(entry)
    folders = sorted(folders, key=str.casefold)
    if source_backup in folders and _chdir(source_backup):
        print(
            f"Template/Backup {source_backup} found. It will be automatically used.")
    elif src_org_name in folders:
        print(f"Template/Backup found for organization {src_org_name}.")
        loop = True
        while loop:
            resp = input("Do you want to use this template/backup (y/N)? ")
            if resp.lower() in ["y", "n", " "]:
                loop = False
                if resp.lower() == "y" and _chdir(src_org_name):
                    pass
                else:
                    _select_backup_folder(folders)
    else:
        print(
            f"No Template/Backup found for organization {src_org_name}. Please select a folder in the following list.")
        _select_backup_folder(folders)


def _check_org_name_in_script_param(apisession: mistapi.APISession, org_id: str, org_name: str = None):
    response = mistapi.api.v1.orgs.orgs.getOrg(apisession, org_id)
    if response.status_code != 200:
        console.critical(
            f"Unable to retrieve the org information: {response.data}")
        sys.exit(3)
    org_name_from_mist = response.data["name"]
    return org_name == org_name_from_mist


def _check_org_name(apisession: mistapi.APISession, org_id: str, org_name: str = None):
    if not org_name:
        org_name = mistapi.api.v1.orgs.orgs.getOrg(
            apisession, org_id).data["name"]
    while True:
        print()
        resp = input(
            "To avoid any error, please confirm the current destination orgnization name: ")
        if resp == org_name:
            return True
        else:
            print()
            print("The orgnization names do not match... Please try again...")


def _create_org(apisession: mistapi.APISession, custom_dest_org_name: str = None):
    while True:
        if not custom_dest_org_name:
            custom_dest_org_name = input("New Organization name (q to quit)? ")
        if custom_dest_org_name == "q":
            sys.exit(0)
        elif custom_dest_org_name:
            org = {
                "name": custom_dest_org_name
            }
            message = f"Creating the organization \"{custom_dest_org_name}\" in {apisession.get_cloud()} "
            pb.log_message(message, display_pbar=False)
            try:
                pb.log_success(message, display_pbar=False)
            except Exception as e:
                pb.log_failure(message, display_pbar=False)
                LOGGER.error("Exception occurred", exc_info=True)
                sys.exit(10)
            org_id = mistapi.api.v1.orgs.orgs.createOrg(
                apisession, org).data["id"]
            return org_id, custom_dest_org_name


#####################################################################
#### START ####


def start(apisession: mistapi.APISession,  org_name: str = None, backup_folder_param: str = None, src_org_name: str = None, source_backup: str = None):
    '''
    Start the process to deploy a backup/template

    PARAMS
    -------
    :param  mistapi.APISession  apisession          - mistapi session, already logged in
    :param  str                 org_name            - Org name where to deploy the configuration. The script will create a new org and name it with the org_name value       
    :param  str                 backup_folder_param - Path to the folder where to save the org backup (a subfolder will be created with the org name). default is "./org_backup"
    :param  str                 src_org_name        - Name of the backup/template to deploy. This is the name of the folder where all the backup files are stored. If the backup is found, the script will ask for a confirmation to use it
    :param  str                 source_backup       - Name of the backup/template to deploy. This is the name of the folder where all the backup files are stored. If the backup is found, the script will NOT ask for a confirmation to use it
    '''
    current_folder = os.getcwd()
    org_id = None
    if backup_folder_param:
        global backup_folder
        backup_folder = backup_folder_param
    elif org_name:
        org_id, org_name = _create_org(apisession, org_name)
    else:
        org_id, org_name = _create_org(apisession)
    
    if org_id:
        _start_deploy_org(apisession, org_id, org_name, src_org_name, source_backup)
    os.chdir(current_folder)


#####################################################################
#### USAGE ####
def usage():
    print('''
-------------------------------------------------------------------------------

    Written by Thomas Munzer (tmunzer@juniper.net)
    Github repository: https://github.com/tmunzer/Mist_library/

    This script is licensed under the MIT License.

-------------------------------------------------------------------------------
Python script to deploy organization backup/template file.
You can use the script "org_conf_backup.py" to generate the backup file from an
existing organization.

This script cannot restore the configuration to an existing organization, and 
will only allow to deploy the configuration to a new org.
This script is trying to maintain objects integrity as much as possible. To do
so, when an object is referencing another object by its ID, the script will 
replace be ID from the original organization by the corresponding ID from the
destination org.

-------
Requirements:
mistapi: https://pypi.org/project/mistapi/

-------
Usage:
This script can be run as is (without parameters), or with the options below.
If no options are defined, or if options are missing, the missing options will
be asked by the script or the default values will be used.

It is recommended to use an environment file to store the required information
to request the Mist Cloud (see https://pypi.org/project/mistapi/ for more 
information about the available parameters).

-------
Script Parameters:
-h, --help              display this help
-n, --org_name=         Org name where to deploy the configuration. The script
                        will create a new org and name it with the org_name value                         
-f, --backup_folder=    Path to the folder where to save the org backup (a subfolder
                        will be created with the org name)
                        default is "./org_backup"
-b, --source_backup=    Name of the backup/template to deploy. This is the name of
                        the folder where all the backup files are stored.
-l, --log_file=         define the filepath/filename where to write the logs
                        default is "./script.log"
-e, --env=              define the env file to use (see mistapi env file documentation 
                        here: https://pypi.org/project/mistapi/)
                        default is "~/.mist_env"

-------
Examples:
python3 ./org_conf_deploy.py     
python3 ./org_conf_deploy.py --org_id=203d3d02-xxxx-xxxx-xxxx-76896a3330f4 -n "my test org"

''')
    sys.exit(0)

def check_mistapi_version():
    """Check if the installed mistapi version meets the minimum requirement."""

    current_version = mistapi.__version__.split(".")
    required_version = MISTAPI_MIN_VERSION.split(".")

    try:
        for i, req in enumerate(required_version):
            if current_version[int(i)] > req:
                break
            if current_version[int(i)] < req:
                raise ImportError(
                    f'"mistapi" package version {MISTAPI_MIN_VERSION} is required '
                    f"but version {mistapi.__version__} is installed."
                )
    except ImportError as e:
        LOGGER.critical(str(e))
        LOGGER.critical("Please use the pip command to update it.")
        LOGGER.critical("")
        LOGGER.critical("    # Linux/macOS")
        LOGGER.critical("    python3 -m pip install --upgrade mistapi")
        LOGGER.critical("")
        LOGGER.critical("    # Windows")
        LOGGER.critical("    py -m pip install --upgrade mistapi")
        print(
            f"""
Critical:\r\n
{e}\r\n
Please use the pip command to update it.
# Linux/macOS
python3 -m pip install --upgrade mistapi
# Windows
py -m pip install --upgrade mistapi
            """
        )
        sys.exit(2)
    finally:
        LOGGER.info(
            '"mistapi" package version %s is required, '
            "you are currently using version %s.",
            MISTAPI_MIN_VERSION,
            mistapi.__version__
        )


#####################################################################
#### SCRIPT ENTRYPOINT ####
if __name__ == "__main__":
    try:
        opts, args = getopt.getopt(sys.argv[1:], "hn:e:l:f:b:", [
                                   "help", "org_name=", "env=", "log_file=", "backup_folder=", "source_backup="])
    except getopt.GetoptError as err:
        console.error(err)
        usage()

    org_name = None
    backup_folder_param = None
    source_backup = None
    for o, a in opts:
        if o in ["-h", "--help"]:
            usage()
        elif o in ["-n", "--org_name"]:
            org_name = a
        elif o in ["-e", "--env"]:
            env_file = a
        elif o in ["-l", "--log_file"]:
            log_file = a
        elif o in ["-f", "--backup_folder"]:
            backup_folder_param = a
        elif o in ["-b", "--source_backup"]:
            source_backup = a
        else:
            assert False, "unhandled option"

    #### LOGS ####
    logging.basicConfig(filename=log_file, filemode='w')
    LOGGER.setLevel(logging.DEBUG)
    check_mistapi_version()
    ### START ###
    apisession = mistapi.APISession(env_file=env_file)
    apisession.login()
    start(apisession, org_name, backup_folder_param, source_backup=source_backup)