routeros-scripts/doc/check-health.md
Christian Hesse 64ff7fcf65 doc: inform about dependency on base installation
That should make the documentation clearer if external sites link to the
documentation of a specific script.
2021-05-03 15:07:50 +02:00

46 lines
1.3 KiB
Markdown

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.
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;
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:
* `CheckHealthTemperature`: an array specifying temperature thresholds for sensors
* `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps
Also notification settings are required for e-mail and telegram.
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)