huawei.py

#! /usr/bin/env python3
# -*- coding: utf-8; py-indent-offset: 4 -*-
#
# Author:  Linuxfabrik GmbH, Zurich, Switzerland
# Contact: info (at) linuxfabrik (dot) ch
#          https://www.linuxfabrik.ch/
# License: The Unlicense, see LICENSE file.

# https://github.com/Linuxfabrik/monitoring-plugins/blob/main/CONTRIBUTING.rst

"""This library collects some Huawei related functions that are
needed by Huawei check plugins.
"""

__author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
__version__ = '2024031401'

import time as _time

from . import base
from . import cache
from . import time
from . import url


def get_creds(args):
    # we cache credentials to reuse them until they expire, because logins might be
    # rate-limited for security reasons
    ibasetoken = cache.get('huawei-{}-ibasetoken'.format(args.DEVICE_ID))
    cookie = cache.get('huawei-{}-cookie'.format(args.DEVICE_ID))
    if ibasetoken:
        return ibasetoken, cookie

    uri = '{}/deviceManager/rest/{}/sessions'.format(args.URL, args.DEVICE_ID)
    header = {
        'Content-Type': 'application/json',
    }
    data = {
        'username': args.USERNAME,
        'password': args.PASSWORD,
        'scope': args.SCOPE,
    }
    result = base.coe(url.fetch_json(
        uri,
        data=data,
        encoding='serialized-json',
        extended=True,
        header=header,
        insecure=args.INSECURE,
        no_proxy=args.NO_PROXY,
        timeout=args.TIMEOUT,
    ))
    ibasetoken = result.get('response_json').get('data').get('iBaseToken')
    # In Python 3, getheader() should be get()
    cookie = result.get('response_header').get('Set-Cookie')
    expire = time.now() + args.CACHE_EXPIRE*60
    cache.set('huawei-{}-ibasetoken'.format(args.DEVICE_ID), ibasetoken, expire)
    cache.set('huawei-{}-cookie'.format(args.DEVICE_ID), cookie, expire)
    return ibasetoken, cookie


def get_data(endpoint, args, params=''):
    # login and get iBaseToken and Cookie
    ibasetoken, cookie = get_creds(args)

    # fetch data
    uri = '{}/deviceManager/rest/{}/{}{}'.format(
        args.URL,
        args.DEVICE_ID,
        endpoint,
        params,
    )
    header = {
        'Content-Type': 'application/json',
        'iBaseToken' : ibasetoken,
        'Cookie': cookie,
    }

    # Sometimes we get "-401: This operation fails to be performed because of the unauthorized
    # REST.", and shortly after that everything works as expected. Crap. So try to fetch
    # info multiple times, but limit the queries to a certain amount.
    counter = 0
    while True:
        counter += 1
        result = base.coe(url.fetch_json(
            uri,
            header=header,
            insecure=args.INSECURE,
            no_proxy=args.NO_PROXY,
            timeout=args.TIMEOUT,
        ))
        if result.get('error').get('code') == 0:
            break
        if counter == 9:
            break
        _time.sleep(1)
    result['counter'] = counter
    return result


def get_health_status(hs):
    hs = int(hs)
    if hs == 1:
        return 'Normal (1)'
    if hs == 2:
        return 'Faulty (2)'
    if hs == 3:
        return 'About to fail (3)'
    if hs == 4:
        return 'Partially damaged (4)'
    if hs == 5:
        return 'Degraded (5)'
    if hs == 9:
        return 'Inconsistent (9)'
    if hs == 11:
        return 'No Input (11)'
    if hs == 12:
        return 'Low Battery (12)'
    if hs == 14:
        return 'Invalid (14)'
    if hs == 15:
        return 'Write-protected (15)'
    if hs == 17:
        return 'Single link (17)'
    if hs == 18:
        return 'Offline (18)'
    return 'Unknown'


def get_runlevel(rl):
    rl = int(rl)
    if rl == 0:
        return 'low (0)'
    if rl == 1:
        return 'normal (1)'
    if rl == 2:
        return 'high (2)'
    return 'Unknown'


def get_running_status(rs):
    rs = int(rs)
    if rs == 1:
        return 'Normal (1)'
    if rs == 2:
        return 'Running (2)'
    if rs == 3:
        return 'Not running (3)'
    if rs == 5:
        return 'Sleep in High Temperature (5)'
    if rs == 12:
        return 'Powering on (12)'
    if rs == 13:
        return 'Powered off (13)'
    if rs == 14:
        return 'Pre-Copy (14)'
    if rs == 16:
        return 'Reconstruction (16)'
    if rs == 23:
        return 'Synchronizing (23)'
    if rs == 27:
        return 'Online (27)'
    if rs == 28:
        return 'Offline (28)'
    if rs == 33:
        return 'To be recovered (33)'
    if rs == 35:
        return 'Invalid (35)'
    if rs == 41:
        return 'Paused (41)'
    if rs == 47:
        return 'Powering off (47)'
    if rs == 51:
        return 'Upgrading (51)'
    if rs == 93:
        return 'Forcibly started (93)'
    if rs == 100:
        return 'To be synchronized (100)'
    if rs == 103:
        return 'Power-on failed (103)'
    if rs == 105:
        return 'Abnormal (105)'
    if rs == 114:
        return 'Erasing (114)'
    if rs == 115:
        return 'Verifying (115)'
    return 'Unknown'


def get_product_mode(pm):
    pm = int(pm)
    if pm == 812:
        return 'Dorado 5000 V6 (NVMe) (812)'
    if pm == 813:
        return 'Dorado 6000 V6 (SAS) (813)'
    if pm == 814:
        return 'Dorado 6000 V6 (NVMe) (814)'
    if pm == 815:
        return 'Dorado 8000 V6 (SAS) (815)'
    if pm == 816:
        return 'Dorado 8000 V6 (NVMe) (816)'
    if pm == 817:
        return 'Dorado 18000 V6 (SAS) (817)'
    if pm == 818:
        return 'Dorado 18000 V6 (NVMe) (818)'
    if pm == 819:
        return 'Dorado 3000 V6 (SAS) (819)'
    if pm == 821:
        return 'Dorado 5000 V6 (IP SAS) (821)'
    if pm == 822:
        return 'Dorado 6000 V6 (IP SAS) (822)'
    if pm == 823:
        return 'Dorado 8000 V6 (IP SAS) (823)'
    if pm == 824:
        return 'Dorado 18000 V6 (IP SAS) (824)'
    if pm == 825:
        return 'Dorado 3000 V6  (825)'
    if pm == 826:
        return 'Dorado 5000 V6 (826)'
    if pm == 827:
        return 'Dorado 6000 V6 (827)'
    if pm == 828:
        return 'Dorado 6000 V6 (828)'
    if pm == 829:
        return 'Dorado 8000 V6 (829)'
    if pm == 830:
        return 'Dorado 18000 V6 (830)'
    if pm == 831:
        return 'Dorado 18000 V6 (831)'
    if pm == 832:
        return 'Dorado 18000 V6 (832)'
    return 'Unknown'


def get_enclosure_model(em):
    em = int(em)
    if em == 39:
        return '4 U 75-slot 3.5-inch 12 Gbit/s SAS disk enclosure'
    if em == 67:
        return '2 U 25-slot 2.5-inch SAS disk enclosure'
    if em == 69:
        return '4 U 24-slot 3.5-inch SAS disk enclosure'
    if em == 112:
        return '4 U 4-controller controller enclosure'
    if em == 113:
        return '2 U 2-controller 25-slot 2.5-inch SAS controller enclosure'
    if em == 114:
        return '2 U 2-controller 12-slot 3.5-inch SAS controller enclosure'
    if em == 115:
        return '2 U 2-controller 36-slot NVMe controller enclosure'
    if em == 116:
        return '2 U 2-controller 25-slot 2.5-inch SAS controller enclosure'
    if em == 117:
        return '2 U 2-controller 12-slot 3.5-inch SAS controller enclosure'
    if em == 118:
        return '2 U 25-slot 2.5-inch smart SAS disk enclosure'
    if em == 119:
        return '2 U 12-slot 3.5-inch smart SAS disk enclosure'
    if em == 120:
        return '2 U 36-slot smart NVMe disk enclosure'
    if em == 122:
        return '2 U 2-controller 25-slot 2.5-inch NVMe controller enclosure'
    return 'Unknown'


def get_logic_type(lt):
    lt = int(lt)
    if lt == 0:
        return 'Expansion Enclosure (Disk Enclosure)'
    if lt == 1:
        return 'Controller Enclosure'
    if lt == 2:
        return 'Data Switch'
    if lt == 3:
        return 'Management Switch'
    if lt == 4:
        return 'Management Server'
    return 'Unknown'


def get_switch_status(st):
    st = int(st)
    if st == 1:
        return 'On'
    if st == 2:
        return 'Off'
    return 'Unknown'


def get_controller_model(cm):
    cm = int(cm)
    if cm == 4127:
        return 'V6R1C00 2U2C mid-range PALM control board'
    if cm == 4128:
        return 'V6R1C00 2U2C mid-range _SAS control board'
    if cm == 4129:
        return 'V6R1C00 2U2C SAS entry-level control board (Hi1620S)'
    if cm == 4132:
        return 'V6R1C00 4U4C high-end control board'
    if cm == 4135:
        return 'V6R1C00 2U2C mid-range control Board'
    if cm == 4136:
        return 'V6R1C00 2U2C mid-range SAS1711 control board'
    if cm == 4137:
        return 'V6R1C00 2U2C SAS 1711 entry-level control board (Hi1620S)'
    if cm == 4140:
        return 'V6R1C00 4U4C high-end 1711 control board'
    if cm == 4141:
        return 'V6R1C00 2U2C mid-range SAS 1711 control board (100GE extension board)'
    if cm == 4142:
        return 'V6R1C00 2U2C mid-range SAS control board (100GE extension board)'
    if cm == 4144:
        return 'V6R3C00 2U2C low-end NVMe control board'
    return 'Unknown'


def get_role(role):
    role = int(role)
    if role == 0:
        return 'Member'
    if role == 1:
        return 'Primary'
    if role == 2:
        return 'Secondary'
    return 'Unknown'


def get_host_access_state(has):
    has = int(has)
    if has == 1:
        return 'Forbidden'
    if has == 2:
        return 'Read-only'
    if has == 3:
        return 'R/W'
    if has == 5:
        return 'Unknown'
    return 'Unknown'


def get_cp_type(cp):
    cp = int(cp)
    if cp == 1:
        return 'Quorum Server'
    if cp == 2:
        return 'Quorum Disk'
    if cp == 3:
        return 'None'
    return 'Unknown'


def get_os(os):
    os = int(os)
    if os == 0:
        return 'Linux'
    if os == 1:
        return 'Windows'
    if os == 2:
        return 'Solaris'
    if os == 3:
        return 'HP-UX'
    if os == 4:
        return 'AIX'
    if os == 5:
        return 'XenServer'
    if os == 6:
        return 'Mac OS'
    if os == 7:
        return 'VMware ESX'
    if os == 8:
        return 'LINUX_VIS'
    if os == 9:
        return 'Windows Server 2012'
    if os == 10:
        return 'Oracle VM'
    if os == 11:
        return 'OpenVMS'
    if os == 12:
        return 'Oracle_VM_Server_for_x86'
    if os == 13:
        return 'Oracle_VM_Server_for_SPARC'
    return 'Unknown'


def get_interface_model(im):
    im = int(im)
    if im == 516:
        return '4 ports FE 1 Gbit/s ETH I/O module'
    if im == 518:
        return '4 ports BE 12 Gbit/s SAS I/O module'
    if im == 529:
        return 'AI Accelerator Card'
    if im == 535:
        return 'AI Accelerator Card'
    if im == 537:
        return '4 ports FE 1 Gbit/s ETH I/O module'
    if im == 538:
        return '4 ports BE 12 Gbit/s SAS I/O module'
    if im == 580:
        return '4 ports FE 1 Gbit/s ETH I/O module'
    if im == 583:
        return '4 ports BE 12 Gbit/s SAS V2 I/O module'
    if im == 601:
        return '4 ports FE 1 Gbit/s ETH I/O module'
    if im == 2304:
        return '4 ports FE 8 Gbit/s Fibre Channel I/O module'
    if im == 2305:
        return '4 ports FE 16 Gbit/s Fibre Channel I/O module'
    if im == 2306:
        return '4 ports FE 32 Gbit/s Fibre Channel I/O module'
    if im == 2307:
        return '4 ports FE 10 Gbit/s ETH I/O module'
    if im == 2308:
        return '4 ports FE 25 Gbit/s ETH I/O module'
    if im == 2309:
        return '4 ports SO 25 Gbit/s RDMA I/O module'
    if im == 2310:
        return '4 ports FE 8 Gbit/s Fibre Channel I/O module'
    if im == 2311:
        return '4 ports FE 16 Gbit/s Fibre Channel I/O module'
    if im == 2312:
        return '4 ports FE 32 Gbit/s Fibre Channel I/O module'
    if im == 2313:
        return '4 ports FE 10 Gbit/s ETH I/O module'
    if im == 2314:
        return '4 ports FE 25 Gbit/s ETH I/O module'
    if im == 2315:
        return '2 ports FE 40 Gbit/s ETH I/O module'
    if im == 2316:
        return '2 ports FE 100 Gbit/s ETH I/O module'
    if im == 2317:
        return '2 ports BE 100 Gbit/s RDMA I/O module'
    if im == 2318:
        return '2 ports SO 100 Gbit/s RDMA I/O module'
    if im == 2319:
        return '2 ports FE 40 Gbit/s ETH I/O module'
    if im == 2320:
        return '2 ports FE 100 Gbit/s ETH I/O module'
    if im == 2321:
        return '2 ports BE 100 Gbit/s RDMA I/O module'
    if im == 2322:
        return '2 ports SO 100 Gbit/s RDMA I/O module'
    if im == 2323:
        return '4 ports FE 10 Gbit/s ROCE I/O module'
    if im == 2324:
        return '4 ports FE 25 Gbit/s ROCE I/O module'
    if im == 2325:
        return '4 ports FE 10 Gbit/s ROCE I/O module'
    if im == 2326:
        return '4 ports FE 25 Gbit/s ROCE I/O module'
    if im == 2327:
        return '2 ports FE 40 Gbit/s ROCE I/O module'
    if im == 2328:
        return '2 ports FE 100 Gbit/s ROCE I/O module'
    if im == 2329:
        return '2 ports FE 40 Gbit/s ROCE I/O module'
    if im == 2330:
        return '2 ports FE 10  Gbit/s ROCE I/O module'
    if im == 2331:
        return '4 ports FE 10  bit/s ETH I/O module'
    if im == 2332:
        return '4 ports FE 10 G it/s ETH I/O module'
    if im == 2333:
        return '4 ports FE 8 Gbi /s Fibre Channel I/O module'
    if im == 2334:
        return '4 ports FE 16 Gbi /s Fibre Channel I/O module'
    if im == 2335:
        return '4 ports FE 32 Gbit/s Fibre Channel I/O module'
    if im == 2336:
        return '4 ports FE 10 Gbit/s ETH I/O module'
    if im == 2337:
        return '4 ports FE 25 Gbit/s ETH I/O module'
    if im == 2338:
        return '4 ports SO 25 Gbit/s RDMA I/O module'
    if im == 2339:
        return '4 ports FE 10 Gbit/s ROCE I/O module'
    if im == 2340:
        return '4 ports FE 25 Gbit/s ROCE I/O module'
    if im == 2341:
        return '4 ports FE 8 Gbit/s Fibre Channel I/O module'
    if im == 2342:
        return '4 ports FE 16 Gbit/s Fibre Channel I/O module'
    if im == 2343:
        return '4 ports FE 32 Gbit/s Fibre Channel I/O module'
    if im == 2344:
        return '4 ports FE 10 Gbit/s ETH I/O module'
    if im == 2345:
        return '4 ports FE 25 Gbit/s ETH I/O module'
    if im == 2346:
        return '4 ports FE 10 Gbit/s ROCE I/O module'
    if im == 2347:
        return '4 ports FE 25 Gbit/s ROCE I/O module'
    if im == 2348:
        return '2 ports FE 40 Gbit/s ETH I/O module'
    if im == 2349:
        return '2 ports FE 100 Gbit/s ETH I/O module'
    if im == 2350:
        return '2 ports BE 100 Gbit/s RDMA I/O module'
    if im == 2351:
        return '2 ports SO 100 Gbit/s RDMA I/O module'
    if im == 2352:
        return '2 ports FE 40 Gbit/s ROCE I/O module'
    if im == 2353:
        return '2 ports FE 100 Gbit/s ROCE I/O module'
    if im == 2354:
        return '2 ports FE 40 Gbit/s ETH I/O module'
    if im == 2355:
        return '2 ports FE 100 Gbit/s ETH I/O module'
    if im == 2356:
        return '2 ports BE 100 Gbit/s RDMA I/O module'
    if im == 2357:
        return '2 ports SO 100 Gbit/s RDMA I/O module'
    if im == 2358:
        return '2 ports FE 40 Gbit/s ROCE I/O module'
    if im == 2359:
        return '2 ports FE 100 Gbit/s ROCE I/O module'
    if im == 2360:
        return '4 ports FE 10 Gbit/s ETH I/O module'
    if im == 2361:
        return '4 ports SO 25 Gbit/s RDMA I/O module'
    if im == 2362:
        return '2 ports SO 100 Gbit/s RDMA I/O module'
    if im == 2363:
        return '2 ports SO 100 Gbit/s RDMA I/O module'
    if im == 4133:
        return 'System Management Module'
    if im == 4134:
        return 'System Management Module'
    return 'Unknown'


def get_interface_runmode(rm):
    rm = int(rm)
    if rm == 1:
        return 'FC'
    if rm == 2:
        return 'FCoE/iSCSI'
    if rm == 3:
        return 'Cluster'
    if rm == 4:
        return 'Ethernet'
    if rm == 5:
        return 'RoCE'
    return 'Unknown'


def get_led_status(st):
    st = int(st)
    if st == 0:
        return 'Off'
    if st == 1:
        return 'On'
    return 'Unknown'


def get_uuid(data):
    """Returns the Universally unique identifier (UUID) of a managed object.
       It is expressed in the format of object type:object ID. For example, if a controller's
       object type number is "207" and the controller ID is "0A", the UUID is "207:0A".

       The UUID is often needed for querying performance statistics, for example.
    """
    return '{}:{}'.format(data['TYPE'], data['ID'])