report_gateway_firmware.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 report the firmware deployed on all the SRX for a specified
org/site with, for each Module:
        - Cluster name
        - Cluster reported Version
        - Module Serial Number
        - Module MAC Address
        - Module Version
        - Module Backup version
        - Module Need Backup (if the Backup Version must be updated)
        - Module Pending version
        - Module Need Reboot (if pending version is present)

-------
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).

-------
Options:
-h, --help          display this help

-o, --org_id=       Set the org_id (only one of the org_id or site_id can be defined)
-s, --site_id=      Set the site_id  (only one of the org_id or site_id can be defined)

-f, --out_file=     define the filepath/filename where to save the data
                    default is "./report_gateway_firmware.csv"
-d, --datetime      append the current date and time (ISO format) to the report name
-t, --timestamp     append the current timestamp to the report name

-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 ./report_gateway_firmware.py
python3 ./report_gateway_firmware.py --site_id=203d3d02-xxxx-xxxx-xxxx-76896a3330f4

'''

#### IMPORTS #####
import sys
import csv
import datetime
import getopt
import logging

MISTAPI_MIN_VERSION = "0.44.1"

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)



#### LOGS ####
LOGGER = logging.getLogger(__name__)
out=sys.stdout

#### PARAMETERS #####
CSV_FILE = "./report_gateway_firmware.csv"
LOG_FILE = "./script.log"
ENV_FILE = "~/.mist_env"


###############################################################################
### PROGRESS BAR
def _progress_bar_update(count:int, total:int, size:int):
    if total == 0:
        return
    if count > total:
        count = total
    x = int(size*count/total)
    out.write(f"Progress: ".ljust(10))
    out.write(f"[{'█'*x}{'.'*(size-x)}]")
    out.write(f"{count}/{total}\r".rjust(79 - size - 10))
    out.flush()

def _progress_bar_end(total:int, size:int):
    if total == 0:
        return
    _progress_bar_update(total, total, size)
    out.write("\n")
    out.flush()

###############################################################################
#### FUNCTIONS ####
def _process_module(
        cluster_name:str,
        cluster_version:str,
        cluster_device_id:str,
        cluster_site_id:str,
        module:dict,
        data:dict
        ) -> None:
    data.append({
        "cluster_name": cluster_name,
        "cluster_version": cluster_version,
        "cluster_device_id": cluster_device_id,
        "cluster_site_id": cluster_site_id,
        "module_serial": module.get("serial"),
        "module_mac": module.get("mac"),
        "module_model": module.get("model"),
        "module_version": module.get("version"),
        "module_backup_version": module.get("backup_version"),
        "module_need_snapshot": module.get("version") != module.get("backup_version"),
        "module_pending_version": module.get("pending_version"),
        "module_need_reboot": module.get("pending_version", "") != ""
    })

def _process_gateways(gateways:list) -> list:
    i=0
    data = []
    _progress_bar_update(i, len(gateways), 55)
    for cluster in gateways:
        if True:#"SRX" in cluster.get("version", ""):
            cluster_name = cluster.get("name")
            cluster_version = cluster.get("version")
            cluster_device_id = cluster.get("id")
            cluster_site_id = cluster.get("site_id")
            _process_module(cluster_name, cluster_version, cluster_device_id, cluster_site_id, cluster.get("module_stat", [{}])[0], data)
            if cluster.get("module2_stat"):
                _process_module(cluster_name, cluster_version,  cluster_device_id, cluster_site_id, cluster.get("module2_stat", [{}])[0], data)
        i+=1
        _progress_bar_update(i, len(gateways), 55)
    _progress_bar_end(len(gateways), 55)
    return data

def _get_org_gateways(apisession, org_id:str) -> list:
    print(" Retrieving Gateways ".center(80, '-'))
    response = mistapi.api.v1.orgs.stats.listOrgDevicesStats(apisession, org_id, type="gateway", limit=1000)
    gateways = response.data
    while response.next:
        response = mistapi.get_next(apisession, response)
        gateways = gateways + response.data
    return gateways

def _get_site_gateways(apisession, site_id:str) -> list:
    print(" Retrieving Gateways ".center(80, '-'))
    response = mistapi.api.v1.sites.stats.listSiteDevicesStats(apisession, site_id, type="gateway", limit=1000)
    gateways = response.data
    while response.next:
        response = mistapi.get_next(apisession, response)
        gateways = gateways + response.data
    return gateways

### SAVE REPORT
def _save_as_csv(
        data:list,
        scope:str,
        scope_id:str,
        csv_file:str,
        append_dt:bool,
        append_ts:bool
    ):

    print(" Saving Data ".center(80, "-"))
    print()
    print("Generating CSV Headers ".ljust(80,"."))

    headers=[]
    size = 50
    total = len(data)

    if append_dt:
        dt = datetime.datetime.isoformat(datetime.datetime.now()).split('.')[0].replace(':','.')
        csv_file = f"{csv_file.replace('.csv', f'_{dt}')}.csv"
    elif append_ts:
        ts = round(datetime.datetime.timestamp(datetime.datetime.now()))
        csv_file = f"{csv_file.replace('.csv', f'_{ts}')}.csv"

    i = 0
    for entry in data:
        for key in entry:
            if not key in headers:
                headers.append(key)
        i += 1
        _progress_bar_update(i, total, size)
    _progress_bar_end(total, size)
    print()
    print("Saving to file ".ljust(80,"."))
    i = 0
    with open(csv_file, "w", encoding='UTF8', newline='') as f:
        csv_writer = csv.writer(f)
        csv_writer.writerow([f"#Gateways Firmware Backup for {scope} {scope_id}"])
        csv_writer.writerow(headers)
        for entry in data:
            tmp=[]
            for header in headers:
                tmp.append(entry.get(header, ""))
            csv_writer.writerow(tmp)
            i += 1
            _progress_bar_update(i, total, size)
        _progress_bar_end(total, size)
        print()

####################
## MENU
def _show_menu(header:str, menu:list) -> str:
    print()
    print("".center(80, "-"))
    resp=None
    while True:
        print(f"{header}")
        i=0
        for entry in menu:
            print(f"{i}) {entry}")
            i+=1
        resp = input(f"Please select an option (0-{i-1}, q to quit): ")
        if resp.lower() == "q":
            sys.exit(0)
        else:
            try:
                resp=int(resp)
                if resp < 0 or resp >= i:
                    console.error(f"Please enter a number between 0 and {i -1}.")
                else:
                    return menu[resp]
            except:
                console.error("Please enter a number\r\n ")

###############################################################################
### START
def _start(
    apisession: mistapi.APISession,
    scope:str,
    scope_id: str,
    csv_file:str,
    append_dt:bool=False,
    append_ts:bool=False,
    ) -> None:

    """
    Start the backup process

    PARAMS
    -------
    apisession : mistapi.APISession
        mistapi session 
    scope : str, enum: org, site
        At which level the devices must be retrieved
    scope_id : str
        ID of the scope (org_id or site_id) where the devices must be retrieved
    csv_file : str
        define the filepath/filename where to save the data
        default is "./report_gateway_firmware.csv"
    append_dt : bool, default = False
        append the current date and time (ISO format) to the backup name 
    append_ts : bool, default = False
        append the timestamp at the end of the report and summary files

    """
    if not scope:
        menu = ["org", "site"]
        scope = _show_menu("", menu)
        if scope == "org":
            scope_id = mistapi.cli.select_org(apisession)[0]
        elif scope == "site":
            scope_id = mistapi.cli.select_site(apisession)[0]

    gateways = None
    data = None
    if scope == "org":
        gateways = _get_org_gateways(apisession, scope_id)
    elif scope == "site":
        gateways = _get_site_gateways(apisession, scope_id)
    print(" Processing gateways ".center(80, '-'))
    if gateways:
        data = _process_gateways(gateways)

    if data:
        print(" Process Done ".center(80, '-'))
        _save_as_csv(data, scope, scope_id, csv_file, append_dt, append_ts)
        mistapi.cli.pretty_print(data)


###############################################################################
### USAGE
def usage(error_message:str=None):
    """
    display 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 report the firmware deployed on all the SRX for a specified
org/site with, for each Module:
        - Cluster name
        - Cluster reported Version
        - Module Serial Number
        - Module MAC Address
        - Module Version
        - Module Backup version
        - Module Need Backup (if the Backup Version must be updated)
        - Module Pending version
        - Module Need Reboot (if pending version is present)

-------
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).

-------
Options:
-h, --help          display this help

-o, --org_id=       Set the org_id (only one of the org_id or site_id can be defined)
-s, --site_id=      Set the site_id  (only one of the org_id or site_id can be defined)

-f, --out_file=     define the filepath/filename where to save the data
                    default is "./report_gateway_firmware.csv"
-d, --datetime      append the current date and time (ISO format) to the report name
-t, --timestamp     append the current timestamp to the report name

-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 ./report_gateway_firmware.py
python3 ./report_gateway_firmware.py --site_id=203d3d02-xxxx-xxxx-xxxx-76896a3330f4

''')
    if error_message:
        console.critical(error_message)
    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__
        )



###############################################################################
### ENTRY POINT
if __name__ == "__main__":
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:s:f:e:l:td", ["help", "org_id=", "site_id", "out_file=", "env=", "log_file=", "datetime", "timestamp"])
    except getopt.GetoptError as err:
        usage(err)

    SCOPE=None
    SCOPE_ID=None
    APPEND_DT = False
    APPEND_TS = False
    for o, a in opts:
        if o in ["-h", "--help"]:
            usage()
        elif o in ["-o", "--org_id"]:
            if SCOPE:
                usage("Invalid Parameters: \"-o\"/\"--org_id\" and \"-s\"/\"--site_id\" are exclusive")
            SCOPE = "org"
            SCOPE_ID = a
        elif o in ["-s", "--site_id"]:
            if SCOPE:
                usage("Invalid Parameters: \"-o\"/\"--org_id\" and \"-s\"/\"--site_id\" are exclusive")
            SCOPE = "site"
            SCOPE_ID = a
        elif o in ["-d", "--datetime"]:
            if APPEND_TS:
                usage("Invalid Parameters: \"-d\"/\"--date\" and \"-t\"/\"--timestamp\" are exclusive")
            else:
                APPEND_DT = True
        elif o in ["-t", "--timestamp"]:
            if APPEND_DT:
                usage("Invalid Parameters: \"-d\"/\"--date\" and \"-t\"/\"--timestamp\" are exclusive")
            else:
                APPEND_TS = True
        elif o in ["-f", "--out_file"]:
            CSV_FILE=a
        elif o in ["-e", "--env"]:
            ENV_FILE=a
        elif o in ["-l", "--log_file"]:
            LOG_FILE = a

        else:
            assert False, "unhandled option"

    #### LOGS ####
    logging.basicConfig(filename=LOG_FILE, filemode='w')
    LOGGER.setLevel(logging.DEBUG)
    check_mistapi_version()
    ### MIST SESSION ###
    APISESSION = mistapi.APISession(env_file=ENV_FILE)
    APISESSION.login()
    ### START ###
    _start(APISESSION, SCOPE, SCOPE_ID, CSV_FILE, APPEND_DT, APPEND_TS)