summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorViacheslav Hletenko <v.gletenko@vyos.io>2026-04-30 16:49:34 +0300
committerGitHub <noreply@github.com>2026-04-30 16:49:34 +0300
commitb52041394c363a06a69ebf4033923014707c2f96 (patch)
tree069bacedf6e244d29e4f8b1fe5201652d539407c
parentdb52b7b86afde8f79340fd67667eacf75da4ff5b (diff)
parent4da7ae9cd5d9775c0e0e1a7dfe02e3935dca9499 (diff)
downloadvyos-documentation-b52041394c363a06a69ebf4033923014707c2f96.tar.gz
vyos-documentation-b52041394c363a06a69ebf4033923014707c2f96.zip
Merge pull request #1861 from natali-rs1985/T8293
T8293: Add ability to set timeout for high-availability health-check
-rw-r--r--docs/configuration/highavailability/index.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/configuration/highavailability/index.rst b/docs/configuration/highavailability/index.rst
index c82391c7..952a345b 100644
--- a/docs/configuration/highavailability/index.rst
+++ b/docs/configuration/highavailability/index.rst
@@ -347,6 +347,22 @@ times:
.. start_vyoslinter
+An optional ``timeout`` can be set to define the maximum number of seconds the
+script is allowed to run. This is useful for scripts that may hang or take
+longer than expected — setting the timeout higher than the interval allows
+longer-running scripts to complete before being considered failed.
+
+.. stop_vyoslinter
+
+.. code-block:: none
+
+ set high-availability vrrp group Foo health-check script /config/scripts/vrrp-check.sh
+ set high-availability vrrp group Foo health-check interval 20
+ set high-availability vrrp group Foo health-check failure-count 3
+ set high-availability vrrp group Foo health-check timeout 40
+
+.. start_vyoslinter
+
When the vrrp group is a member of the sync group will use only
the sync group health check script.
This example shows how to configure it for the sync group: