summaryrefslogtreecommitdiff
path: root/docs/configuration/highavailability/index.rst
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-06-26 21:35:38 +0200
committerChristian Breunig <christian@breunig.cc>2023-06-26 21:35:38 +0200
commit00cceb05741113ff81bdaff1e4a09586165a257d (patch)
tree8fd73d5077df9121ad845dcd82f6f24a2a7b731b /docs/configuration/highavailability/index.rst
parentf32d6adf209372ddd6f3d213f46971bf33e0007d (diff)
downloadvyos-documentation-00cceb05741113ff81bdaff1e4a09586165a257d.tar.gz
vyos-documentation-00cceb05741113ff81bdaff1e4a09586165a257d.zip
vrrp: T5315: add support to explicitly specify version
Diffstat (limited to 'docs/configuration/highavailability/index.rst')
-rw-r--r--docs/configuration/highavailability/index.rst47
1 files changed, 29 insertions, 18 deletions
diff --git a/docs/configuration/highavailability/index.rst b/docs/configuration/highavailability/index.rst
index bc8aad99..2f20e783 100644
--- a/docs/configuration/highavailability/index.rst
+++ b/docs/configuration/highavailability/index.rst
@@ -229,8 +229,8 @@ is needed.
.. cfgcmd:: set high-availability vrrp global-parameters startup_delay <1-600>
-This option specifies a delay in seconds before vrrp instances start up after
-keepalived starts.
+ This option specifies a delay in seconds before vrrp instances start up
+ after keepalived starts.
Gratuitous ARP
--------------
@@ -242,20 +242,19 @@ need to configure it. But if necessary, Gratuitous ARP can be configured in
.. cfgcmd:: set high-availability vrrp global-parameters garp interval
<0.000-1000>
-.. cfgcmd:: set high-availability vrrp group <name> garp interval
- <0.000-1000>
+.. cfgcmd:: set high-availability vrrp group <name> garp interval <0.000-1000>
+
+ Set delay between gratuitous ARP messages sent on an interface.
+
+ 0 if not defined.
-Set delay between gratuitous ARP messages sent on an interface. 0 if not
-defined.
+.. cfgcmd:: set high-availability vrrp global-parameters garp master-delay <1-255>
-.. cfgcmd:: set high-availability vrrp global-parameters garp master-delay
- <1-255>
+.. cfgcmd:: set high-availability vrrp group <name> garp master-delay <1-255>
-.. cfgcmd:: set high-availability vrrp group <name> garp master-delay
- <1-255>
+ Set delay for second set of gratuitous ARPs after transition to MASTER.
-Set delay for second set of gratuitous ARPs after transition to MASTER. 5 if
-not defined.
+ 5 if not defined.
.. cfgcmd:: set high-availability vrrp global-parameters garp master-refresh
<1-600>
@@ -263,8 +262,9 @@ not defined.
.. cfgcmd:: set high-availability vrrp group <name> garp master-refresh
<1-600>
-Set minimum time interval for refreshing gratuitous ARPs while MASTER. 0 if
-not defined, which means no refreshing.
+ Set minimum time interval for refreshing gratuitous ARPs while MASTER.
+
+ 0 if not defined, which means no refreshing.
.. cfgcmd:: set high-availability vrrp global-parameters garp
master-refresh-repeat <1-600>
@@ -272,8 +272,9 @@ not defined, which means no refreshing.
.. cfgcmd:: set high-availability vrrp group <name> garp
master-refresh-repeat <1-600>
-Set number of gratuitous ARP messages to send at a time while MASTER. 1 if not
-defined.
+ Set number of gratuitous ARP messages to send at a time while MASTER.
+
+ 1 if not defined.
.. cfgcmd:: set high-availability vrrp global-parameters garp master-repeat
<1-600>
@@ -281,8 +282,18 @@ defined.
.. cfgcmd:: set high-availability vrrp group <name> garp master-repeat
<1-600>
-Set number of gratuitous ARP messages to send at a time after transition to
-MASTER. 5 if not defined.
+ Set number of gratuitous ARP messages to send at a time after transition to
+ MASTER.
+
+ 5 if not defined.
+
+Version
+-------
+
+.. cfgcmd:: set high-availability vrrp global-parameters version 2|3
+
+ Set the default VRRP version to use. This defaults to 2, but IPv6 instances
+ will always use version 3.
Scripting
---------