routeros-scripts/doc/check-health.md

63 lines
1.8 KiB
Markdown
Raw Normal View History

2020-03-27 20:41:40 +00:00
Notify about health state
=========================
[◀ Go back to main README](../README.md)
🛈 This script can not be used on its own but requires the base installation.
See [main README](../README.md) for details.
2020-03-27 20:41:40 +00:00
Description
-----------
This script is run from scheduler periodically, sending notification on
health related events:
* voltage jumps up or down more than configured threshold
* power supply failed or recovered
* temperature is above or below threshold
Note that bad initial state will not trigger an event.
Only sensors available in hardware can be checked. See what your
hardware supports:
/ system health print;
2021-06-17 13:23:51 +00:00
### Sample notifications
#### Voltage
![check-health notification voltage](check-health.d/notification-01-voltage.svg)
2021-06-17 13:23:51 +00:00
#### Temperature
![check-health notification](check-health.d/notification-02-temperature-high.svg)
![check-health notification](check-health.d/notification-03-temperature-ok.svg)
2021-06-17 13:23:51 +00:00
#### PSU state
![check-health notification](check-health.d/notification-04-psu-fail.svg)
![check-health notification](check-health.d/notification-05-psu-ok.svg)
2021-06-17 13:23:51 +00:00
2020-03-27 20:41:40 +00:00
Requirements and installation
-----------------------------
Just install the script and create a scheduler:
$ScriptInstallUpdate check-health;
/ system scheduler add interval=1m name=check-health on-event="/ system script run check-health;" start-time=startup;
Configuration
-------------
The configuration goes to `global-config-overlay`, these are the parameters:
2020-03-27 20:41:40 +00:00
* `CheckHealthTemperature`: an array specifying temperature thresholds for sensors
* `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps
Also notification settings are required for e-mail, matrix and/or telegram.
2020-03-27 20:41:40 +00:00
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)