Check huawei-dorado-disk

Overview

Batch query basic status and performance data of a Huawei OceanStor Dorado storage system via the REST Interface, using the https://${ip}:${port}/deviceManager/rest/${deviceId}/disk endpoint. Cookies and iBaseTokens are stored and re-used (the session timeout period is usually 20 minutes).

Hints:

Tested on Huawei OceanStor Dorado 8000 V6 6.1.0.
Create a read-only API user that can perform query only.
Sometimes the API returns This operation fails to be performed because of the unauthorized REST. Before performing this operation, ensure that REST is authorized., although everything is fine. In this case, the check simply tries to retrieve the data again, a maximum of 9 times within 9 seconds.

Fact Sheet

Check Plugin Download	https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/huawei-dorado-disk
Check Interval Recommendation	Every 5 minutes
Can be called without parameters	No
Compiled for	Linux, Windows
Uses SQLite DBs	Yes

Help

usage: huawei-dorado-disk [-h] [-V] [--always-ok]
                          [--cache-expire CACHE_EXPIRE] --device-id DEVICE_ID
                          [--insecure] [--no-proxy] --password PASSWORD
                          [--scope SCOPE] [--test TEST] [--timeout TIMEOUT] -u
                          URL --username USERNAME

Batch query basic information about disks on a Huawei OceanStor Dorado storage
system via the REST Interface, using the ``/disk`` endpoint.

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  --always-ok           Always returns OK.
  --cache-expire CACHE_EXPIRE
                        The amount of time after which the credential cache
                        expires, in minutes. Default: 15
  --device-id DEVICE_ID
                        Huawei OceanStor Dorado API Device ID.
  --insecure            This option explicitly allows to perform "insecure"
                        SSL connections. Default: True
  --no-proxy            Do not use a proxy. Default: False
  --password PASSWORD   Huawei OceanStor Dorado API Password.
  --scope SCOPE         Huawei OceanStor Dorado API Scope.
  --test TEST           For unit tests. Needs "path-to-stdout-file,path-to-
                        stderr-file,expected-retc".
  --timeout TIMEOUT     Network timeout in seconds. Default: 3 (seconds)
  -u URL, --url URL     Huawei OceanStor Dorado API URL.
  --username USERNAME   Huawei OceanStor Dorado API Username.

Usage Examples

./huawei-dorado-disk --url https://oceanstor:8088 --device-id 123456789 --username monitoring --password mypass

Output:

Everything is ok.

UUID         ! Location ! Manufacturer ! Model            ! SerialNumber         ! Abrasion% ! Progress% ! Runtime ! Temp ! Health ! Running
-------------+----------+--------------+------------------+----------------------+-----------+-----------+---------+------+--------+---------
10:134234112 ! DAE000.0 ! HUAWEI       ! HSSD-D7294DL7T6E ! 12345678             ! 67        ! 0         ! 4M 2W   ! 36   ! [OK]   ! [OK]
10:134234113 ! DAE000.1 ! HUAWEI       ! HSSD-D7294DL7T6E ! 12345679             ! 70        ! 0         ! 4M 2W   ! 37   ! [OK]   ! [OK]
10:0         ! CTE0.0   ! Seagate      ! ST2000NM0023     ! Z1X2F480000094381WYN ! 0         ! 0         ! 1Y 4M   ! 37   ! [OK]   ! [OK]

Fetched API 2 times

States

UNKNOWN on invalid responses or responses with error codes.
WARN if disk health status is not equal to „Normal“.
WARN if disk running status is not equal to „Normal“ or „Online“.

Perfdata / Metrics

Name	Type	Description
<UUID>_ABRASIONRATE	Percentage	Wear (Wear is the percentage of used service life to total service life.).
<UUID>_CAPACITYUSAGE	Percentage	Capacity usage.
<UUID>_HEALTHMARK	Number	Health score of the disk.
<UUID>_HEALTHSTATUS	Number	0: unknown, 1: normal, 2: faulty, 3: about to fail, 17: single link
<UUID>_PROGRESS	Percentage	Progresses of reconstruction, copyback, pre-copy, and destruction.
<UUID>_REMAINLIFE	Seconds	Remaining service life.
<UUID>_RUNNINGSTATUS	Number	0: unknown, 1: normal, 14: pre-copy, 16: reconstruction, 27: online, 28: offline, 114: erasing, 115: verifying
<UUID>_RUNTIME	Seconds	Operating time.
<UUID>_TEMPERATURE	Number	Temperature.

Have a look at the API documentation for details.

Credits, License

Authors: Linuxfabrik GmbH, Zurich
License: The Unlicense, see LICENSE file.