Check huawei-dorado-host¶
Overview¶
Checks the health and running status of all hosts attached to a Huawei OceanStor Dorado storage system via the REST API (/host endpoint). Alerts when any host reports a non-normal health or running state. Reports operating system type and allocated capacity per host in the output table, and summarizes the hosts in the performance data.
Important Notes:
- Tested on Huawei OceanStor Dorado 8000 V6 6.1.0
- Create a read-only API user that can perform queries only
- The default session timeout period on the storage system is 20 minutes;
--cache-expiredefaults to 15 minutes to stay within that window - The host list reflects host objects configured on the storage system, not necessarily their actual online/offline status on the network
- A decommissioned or powered-off server that is still configured on the array reports the health status "Offline", and the array raises no alarm for it. This check reports such a host as WARN by default; set
--host-offline-severityto change that, for example tocriton an array where every configured host is expected to be up, or tookwhile old host objects are still waiting to be cleaned up
Data Collection:
- Queries the Huawei OceanStor Dorado REST API at
https://<ip>:<port>/deviceManager/rest/<deviceId>/host - Authenticates via session tokens (iBaseToken + cookie), cached in a SQLite database to avoid repeated logins
- If the appliance rejects a request, the check logs in again and retries, up to three attempts one second apart
Fact Sheet¶
| Fact | Value |
|---|---|
| Check Plugin Download | https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/huawei-dorado-host |
| Nagios/Icinga Check Name | check_huawei_dorado_host |
| Check Interval Recommendation | Every 5 minutes |
| Can be called without parameters | No (--device-id, --password, --url and --username are required) |
| Runs on | Cross-platform |
| Compiled for Windows | No (runs with Python interpreter) |
| Uses State File | $TEMP/linuxfabrik-monitoring-plugins-huawei-dorado.db |
Help¶
usage: huawei-dorado-host [-h] [-V] [--always-ok] [--brief]
[--cache-expire CACHE_EXPIRE]
[--device-id DEVICE_ID]
[--host-offline-severity {ok,warn,crit,unknown}]
[--ignore IGNORE] [--insecure] [--match MATCH]
[--no-insecure]
[--no-match-severity {ok,warn,crit,unknown}]
[--no-perfdata] [--no-proxy] [--password PASSWORD]
[--password-file PASSWORD_FILE] [--proxy PROXY]
[--scope SCOPE] [--timeout TIMEOUT] -u URL
--username USERNAME [-v]
Checks the health and running status of all hosts attached to a Huawei
OceanStor Dorado storage system via the REST API (/host endpoint). Alerts when
any host reports a non-normal state.
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
--always-ok Always returns OK.
--brief Hide the rows that are within the thresholds and show
only those in a WARN or CRIT state. Perfdata and
alerting are unaffected: every item still emits
performance data and still drives the overall check
state, so this is safe to leave on. Worth setting on
an array with many hosts.
--cache-expire CACHE_EXPIRE
The amount of time after which the credential/data
cache expires, in minutes. Default: 15
--device-id DEVICE_ID
Huawei OceanStor Dorado API device ID. Optional: the
appliance reports its own at login, so this is only
needed to override that answer.
--host-offline-severity {ok,warn,crit,unknown}
State to report for a host whose health status is
"Offline". A decommissioned or powered-off server that
is still configured on the array reports the same, and
the array raises no alarm for it. Every other health
status keeps its own state. Default: warn
--ignore IGNORE Skip hosts. Any item matching this Python regex will
be ignored. Can be specified multiple times. Example:
`(?i)linuxfabrik` for a case-insensitive match. The
regex is anchored at the start of the string (Python
`re.match`) and is matched against `UUID`, `NAME`, so
prefix with `.*` to match anywhere.
--insecure This option explicitly allows insecure SSL
connections.
--match MATCH Limit to hosts. Filter by this Python regular
expression. Case-sensitive by default; use `(?i)` for
case-insensitive matching. Can be specified multiple
times. If both `--match` and `--ignore` are given, an
item must match `--match` AND not match `--ignore` to
be reported (include first, exclude second). Examples:
`(?i)example` to match "example" regardless of case.
`^(?!.*example).*$` to match any string except
"example" (negative lookahead). The regex is anchored
at the start of the string (Python `re.match`) and is
matched against `UUID`, `NAME`, so prefix with `.*` to
match anywhere.
--no-insecure Verify the TLS certificate against the system trust
store, overriding the insecure default of this check.
Use it once the endpoint presents a publicly trusted
certificate, or once its CA has been added to the
system trust store.
--no-match-severity {ok,warn,crit,unknown}
State to report when no item matches the filters and
nothing is checked. Default: ok
--no-perfdata Suppress the performance data section from the output.
The status message and the exit code are unaffected,
so alerting keeps working while trending data is
dropped.
--no-proxy Do not use a proxy, not even one the environment
names. Overrides `--proxy`.
--password PASSWORD Huawei OceanStor Dorado API password.
--password-file PASSWORD_FILE
Path to a file holding the password, read from its
first line. Keeps the password out of the process
list, where a command-line argument is visible to
every user on the host. Takes precedence over
`--password`. Keep the file readable only by the
monitoring user. Example: `--password-
file=/etc/icinga2/secrets/storage`.
--proxy PROXY Proxy to reach the target through. The scheme defaults
to `http` when omitted. Overrides the proxy the
environment names (`http_proxy`, `https_proxy`,
`all_proxy`) together with the exceptions it lists in
`no_proxy`, and is itself overridden by `--no-proxy`.
Without either parameter the environment applies.
Credentials belong into the environment variable
rather than here, because a command-line argument is
visible to every user on the host. Example:
`--proxy=http://proxy.example.com:3128`.
--scope SCOPE Huawei OceanStor Dorado API scope.
--timeout TIMEOUT Network timeout in seconds. Default: 3 (seconds)
-u, --url URL Huawei OceanStor Dorado API URL.
--username USERNAME Huawei OceanStor Dorado API username.
-v, --verbose Makes this plugin verbose during the operation. Useful
for debugging and seeing what is going on under the
hood. Appends what every API request returned, so the
appliance's own answers can be read while working out
how it reports something. Session tokens are redacted.
The output is as long as those answers are, so this is
a debugging aid rather than something to leave
switched on.
Documentation:
https://linuxfabrik.github.io/monitoring-plugins/check-plugins/huawei-dorado-host/
Usage Examples¶
./huawei-dorado-host --url=https://oceanstor:8088 --device-id=123456789 --username=monitoring --password=linuxfabrik
Output:
There are warnings.
UUID ! Name ! OS ! Allocated ! Health ! Running ! State
------+-----------+------------+-----------+--------------------------------------+------------+----------
21:1 ! host1 ! Solaris ! 535.7MiB ! Normal (1) ! Normal (1) ! [OK]
21:2 ! host2 ! Linux ! 535.7MiB ! Single link / No redundant link (17) ! Normal (1) ! [WARNING]
21:0 ! site01-01 ! VMware ESX ! 25.5TiB ! Normal (1) ! Normal (1) ! [OK]
21:1 ! site01-02 ! VMware ESX ! 25.5TiB ! Normal (1) ! Normal (1) ! [OK]
States¶
- OK if all hosts report normal health and running status.
- WARN if any host reports a degraded health status, or one this check does not know.
- WARN if any host reports health status "Offline";
--host-offline-severitysets a different state for it. - WARN if any host's running status is not "Normal", unless it reports an outright failure.
- CRIT if any host reports health status "Faulty", "No Input" or "Invalid".
- CRIT if any host's running status reports a failure ("Not running", "Sleep in High Temperature", "Offline", "Invalid", "Migration fault", "Error/Faulty", "To be synchronized", "Power-on failed", "Abnormal" or "Rollback failure").
--matchlimits the check to the hosts whose identifier, location or name matches the regex;--no-match-severitysets what to report when nothing matches (default: OK).- UNKNOWN on invalid API responses or responses with error codes.
--always-oksuppresses all alerts and always returns OK.
Perfdata / Metrics¶
| Name | Type | Description |
|---|---|---|
| hosts | Number | Number of hosts checked, after --match and --ignore. |
| hosts_not_ok | Number | Number of checked hosts whose state is not OK. |
The performance data summarizes the hosts, because an array can hold hundreds of them. The per-host detail is in the plugin output table, not in the performance data.
Have a look at the API documentation for details.
Troubleshooting¶
No valuable response from the API¶
Got no valuable response from https://...
Check the --url, --device-id, --username and --password parameters. Verify that the API user has query permissions and that the storage system REST API is reachable.
This operation fails to be performed because of the unauthorized REST.¶
This is a known transient issue with the Huawei REST API. The check makes up to three attempts and forces a fresh login before the second one. If the error persists, verify the API credentials and session timeout settings.
Credits, License¶
- Authors: Linuxfabrik GmbH, Zurich
- License: The Unlicense, see LICENSE file.