summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoraapostoliuk <108394744+aapostoliuk@users.noreply.github.com>2025-04-29 16:35:29 +0300
committerGitHub <noreply@github.com>2025-04-29 14:35:29 +0100
commit51a81fdbfd166248e2c13c4e121176895880d95e (patch)
tree4f4ab93e2cc281866defbe6e96dbfb811dab0da4
parent527d9c0126748062c92a830bf4dbea3a7a94a37f (diff)
downloadvyos-documentation-51a81fdbfd166248e2c13c4e121176895880d95e.tar.gz
vyos-documentation-51a81fdbfd166248e2c13c4e121176895880d95e.zip
failover: Added additional information about health checks (#1629)
Added additional information about health checks
-rw-r--r--docs/configuration/protocols/failover.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/configuration/protocols/failover.rst b/docs/configuration/protocols/failover.rst
index 8088e104..651fc5c3 100644
--- a/docs/configuration/protocols/failover.rst
+++ b/docs/configuration/protocols/failover.rst
@@ -3,7 +3,7 @@ Failover
########
Failover routes are manually configured routes, but they only install
-to the routing table if the health-check target is alive.
+to the routing table as kernel routes if the health-check target is alive.
If the target is not alive the route is removed from the routing table
until the target becomes available.
@@ -28,7 +28,12 @@ Failover Routes
.. cfgcmd:: set protocols failover route <subnet> next-hop <address> check
type <protocol>
- Defines protocols for checking ARP, ICMP, TCP
+ Defines protocols for checking ARP, ICMP, TCP.
+* ICMP probe sends 2 ICMP request packets with a response timeout of 1 second.
+ If one ICMP response is received, the health check is successful.
+* ARP probe sends 2 ARP requests with a response timeout of 1 second.
+ If one response is received, the health check is successful.
+* TCP probe checks whether the destination port is open.
Default is ``icmp``.