summaryrefslogtreecommitdiff
path: root/docs/high-availability.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:36 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:38 +0100
commit6aa3cbb611f74bdf8e44d5527f5138f3122a7497 (patch)
tree009a1fe9447bdd980d5017d49f102e7ccdace03b /docs/high-availability.rst
parent76bbe2744d7184ee50626d9d7b65f21dad1c7e99 (diff)
downloadvyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.tar.gz
vyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.zip
Refactor "code-block:: sh" to "code-block:: console"
This will add proper new-lines into the rendered PDF. Before if it has been a long line, not all content was preserved in the PDF.
Diffstat (limited to 'docs/high-availability.rst')
-rw-r--r--docs/high-availability.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/high-availability.rst b/docs/high-availability.rst
index 07818e92..634b8742 100644
--- a/docs/high-availability.rst
+++ b/docs/high-availability.rst
@@ -21,7 +21,7 @@ The required parameters are interface, vrid, and virtual-address.
minimal config
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo vrid 10
set high-availability vrrp group Foo interface eth0
@@ -29,7 +29,7 @@ minimal config
You can verify your VRRP group status with the operational mode ``run show vrrp`` command:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# run show vrrp
Name Interface VRID State Last Transition
@@ -46,7 +46,7 @@ Disabling a VRRP group
You can disable a VRRP group with ``disable`` option:
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo disable
@@ -57,7 +57,7 @@ Setting VRRP group priority
VRRP priority can be set with ``priority`` option:
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo priority 200
@@ -68,7 +68,7 @@ Sync groups
A sync group allows VRRP groups to transition together.
-.. code-block:: sh
+.. code-block:: console
edit high-availability
set sync-group MAIN member VLAN9
@@ -76,7 +76,7 @@ A sync group allows VRRP groups to transition together.
In the following example, when VLAN9 transitions, VLAN20 will also transition:
-.. code-block:: sh
+.. code-block:: console
vrrp {
group VLAN9 {
@@ -108,13 +108,13 @@ VRRP can use two modes: preemptive and non-preemptive. In the preemptive mode, i
By default VRRP uses preemption. You can disable it with the "no-preempt" option:
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo no-preempt
You can also configure the time interval for preemption with the "preempt-delay" option. For example, to set the higher priority router to take over in 180 seconds, use:
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo preempt-delay 180
@@ -123,7 +123,7 @@ Unicast VRRP
By default VRRP uses multicast packets. If your network does not support multicast for whatever reason, you can make VRRP use unicast communication instead.
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo peer-address 192.0.2.10
set high-availability vrrp group Foo hello-source-address 192.0.2.15
@@ -139,7 +139,7 @@ Health check scripts
This setup will make the VRRP process execute the ``/config/scripts/vrrp-check.sh script`` every 60 seconds, and transition the group to the fault state if it fails (i.e. exits with non-zero status) three times:
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo health-check script /config/scripts/vrrp-check.sh
set high-availability vrrp group Foo health-check interval 60
@@ -151,7 +151,7 @@ Transition scripts
Transition scripts can help you implement various fixups, such as starting and stopping services, or even modifying the VyOS config on VRRP transition.
This setup will make the VRRP process execute the ``/config/scripts/vrrp-fail.sh`` with argument ``Foo`` when VRRP fails, and the ``/config/scripts/vrrp-master.sh`` when the router becomes the master:
-.. code-block:: sh
+.. code-block:: console
set high-availability vrrp group Foo transition-script backup "/config/scripts/vrrp-fail.sh Foo"
set high-availability vrrp group Foo transition-script fault "/config/scripts/vrrp-fail.sh Foo"