Skip to content

Commit 51a81fd

Browse files
authored
failover: Added additional information about health checks (#1629)
Added additional information about health checks
1 parent 527d9c0 commit 51a81fd

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/configuration/protocols/failover.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Failover
33
########
44

55
Failover routes are manually configured routes, but they only install
6-
to the routing table if the health-check target is alive.
6+
to the routing table as kernel routes if the health-check target is alive.
77
If the target is not alive the route is removed from the routing table
88
until the target becomes available.
99

@@ -28,7 +28,12 @@ Failover Routes
2828
.. cfgcmd:: set protocols failover route <subnet> next-hop <address> check
2929
type <protocol>
3030

31-
Defines protocols for checking ARP, ICMP, TCP
31+
Defines protocols for checking ARP, ICMP, TCP.
32+
* ICMP probe sends 2 ICMP request packets with a response timeout of 1 second.
33+
If one ICMP response is received, the health check is successful.
34+
* ARP probe sends 2 ARP requests with a response timeout of 1 second.
35+
If one response is received, the health check is successful.
36+
* TCP probe checks whether the destination port is open.
3237

3338
Default is ``icmp``.
3439

0 commit comments

Comments
 (0)