routeros-scripts-main/doc/check-lte-state-update.md
2022-11-11 22:06:17 +01:00

54 lines
1.9 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Notify on LTE state update
==========================
[◀ Go back to main README](../README.md)
> **Info**: 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, checking for LTE state changes.
### Sample notification
![check-lte-state-update notification](check-lte-state-update.d/notification.avif)
Requirements and installation
-----------------------------
Just install the script:
$ScriptInstallUpdate check-lte-state-update;
... and create a scheduler:
/system/scheduler/add interval=1h name=check-lte-state-update on-event="/system/script/run check-lte-state-update;" start-time=startup;
Configuration
-------------
The configuration goes to `global-config-overlay`, this is the only parameter:
* `CheckLteStateUpdateBtestHost`: host to test for internet connectivity (btest server), leave empty to disable internet connectivity check
* `CheckLteStateUpdateBtestUser`: user to test for internet connectivity (btest server)
* `CheckLteStateUpdateBtestPassword`: password to test for internet connectivity (btest server)
* `CheckLteStateUpdateIP`: check the IP address, set to false to disable IP address check (default true, enabled)
* `CheckLteStateUpdatePrimaryBand`: check the primary band, set to true to enable primary band check, (default false, disabled)
* `CheckLteStateUpdateCABand`: check the CA band, set to true to enable CA band check, (default false, disabled)
Also notification settings are required for
[e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or
[telegram](mod/notification-telegram.md).
See also
--------
* [Notify on RouterOS update](check-routeros-update.md)
* [Install LTE firmware upgrade](unattended-lte-firmware-upgrade.md)
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)