1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# Failover
Failover routes are manually configured routes, but they only install
to the routing table 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.
## Failover Routes
```{eval-rst}
.. cfgcmd:: set protocols failover route <subnet> next-hop <address> check
target <target-address>
Configure next-hop `<address>` and `<target-address>` for an IPv4 static
route. Specify the target
IPv4 address for health checking.
```
```{eval-rst}
.. cfgcmd:: set protocols failover route <subnet> next-hop <address> check
timeout <timeout>
Timeout in seconds between health target checks.
Range is 1 to 300, default is 10.
```
```{eval-rst}
.. cfgcmd:: set protocols failover route <subnet> next-hop <address> check
type <protocol>
Defines protocols for checking ARP, ICMP, TCP
Default is ``icmp``.
```
```{eval-rst}
.. cfgcmd:: set protocols failover route <subnet> next-hop <address> check
policy <policy>
Policy for checking targets
```
- `all-available` all checking target addresses must be available to pass
this check
- `any-available` any of the checking target addresses must be available
to pass this check
> Default is `any-available`.
```{eval-rst}
.. cfgcmd:: set protocols failover route <subnet> next-hop <address>
interface <interface>
Next-hop interface for the route
```
```{eval-rst}
.. cfgcmd:: set protocols failover route <subnet> next-hop <address>
metric <metric>
Route metric
Default 1.
```
## Example
**One gateway:**
```none
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 check target '192.0.2.1'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 check timeout '5'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 check type 'icmp'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 interface 'eth0'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 metric '10'
```
Show the route
```none
vyos@vyos:~$ show ip route 203.0.113.1
Routing entry for 203.0.113.1/32
Known via "kernel", distance 0, metric 10, best
Last update 00:00:39 ago
* 192.0.2.1, via eth0
```
**Two gateways and different metrics:**
```none
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 check target '192.0.2.1'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 check timeout '5'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 check type 'icmp'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 interface 'eth0'
set protocols failover route 203.0.113.1/32 next-hop 192.0.2.1 metric '10'
set protocols failover route 203.0.113.1/32 next-hop 198.51.100.1 check target '198.51.100.99'
set protocols failover route 203.0.113.1/32 next-hop 198.51.100.1 check timeout '5'
set protocols failover route 203.0.113.1/32 next-hop 198.51.100.1 check type 'icmp'
set protocols failover route 203.0.113.1/32 next-hop 198.51.100.1 interface 'eth2'
set protocols failover route 203.0.113.1/32 next-hop 198.51.100.1 metric '20'
```
Show the route
```none
vyos@vyos:~$ show ip route 203.0.113.1
Routing entry for 203.0.113.1/32
Known via "kernel", distance 0, metric 10, best
Last update 00:08:06 ago
* 192.0.2.1, via eth0
Routing entry for 203.0.113.1/32
Known via "kernel", distance 0, metric 20
Last update 00:08:14 ago
* 198.51.100.1, via eth2
```
|
