summaryrefslogtreecommitdiff
path: root/docs/routing
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/routing
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/routing')
-rw-r--r--docs/routing/arp.rst4
-rw-r--r--docs/routing/bgp.rst20
-rw-r--r--docs/routing/igmp-proxy.rst2
-rw-r--r--docs/routing/mss-clamp.rst6
-rw-r--r--docs/routing/ospf.rst18
-rw-r--r--docs/routing/pbr.rst14
-rw-r--r--docs/routing/rip.rst4
-rw-r--r--docs/routing/routing-policy.rst6
-rw-r--r--docs/routing/static.rst4
9 files changed, 39 insertions, 39 deletions
diff --git a/docs/routing/arp.rst b/docs/routing/arp.rst
index b2a02f9b..bcc542d1 100644
--- a/docs/routing/arp.rst
+++ b/docs/routing/arp.rst
@@ -31,7 +31,7 @@ Operation
Display all known ARP table entries spanning accross all interfaces
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show protocols static arp
Address HWtype HWaddress Flags Mask Iface
@@ -43,7 +43,7 @@ Display all known ARP table entries spanning accross all interfaces
Display all known ARP table entries on a given interface only (`eth1`):
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show protocols static arp interface eth1
Address HWtype HWaddress Flags Mask Iface
diff --git a/docs/routing/bgp.rst b/docs/routing/bgp.rst
index 319213ca..6a2ce581 100644
--- a/docs/routing/bgp.rst
+++ b/docs/routing/bgp.rst
@@ -15,7 +15,7 @@ A simple eBGP configuration:
**Node 1:**
-.. code-block:: sh
+.. code-block:: console
set protocols bgp 65534 neighbor 192.168.0.2 ebgp-multihop '2'
set protocols bgp 65534 neighbor 192.168.0.2 remote-as '65535'
@@ -25,7 +25,7 @@ A simple eBGP configuration:
**Node 2:**
-.. code-block:: sh
+.. code-block:: console
set protocols bgp 65535 neighbor 192.168.0.1 ebgp-multihop '2'
set protocols bgp 65535 neighbor 192.168.0.1 remote-as '65534'
@@ -40,13 +40,13 @@ creating a static route:**
**Node 1:**
-.. code-block:: sh
+.. code-block:: console
set protocols static route 172.16.0.0/16 blackhole distance '254'
**Node 2:**
-.. code-block:: sh
+.. code-block:: console
set protocols static route 172.17.0.0/16 blackhole distance '254'
@@ -58,7 +58,7 @@ A simple BGP configuration via IPv6.
**Node 1:**
-.. code-block:: sh
+.. code-block:: console
set protocols bgp 65534 neighbor 2001:db8::2 ebgp-multihop '2'
set protocols bgp 65534 neighbor 2001:db8::2 remote-as '65535'
@@ -69,7 +69,7 @@ A simple BGP configuration via IPv6.
**Node 2:**
-.. code-block:: sh
+.. code-block:: console
set protocols bgp 65535 neighbor 2001:db8::1 ebgp-multihop '2'
set protocols bgp 65535 neighbor 2001:db8::1 remote-as '65534'
@@ -84,13 +84,13 @@ creating a static route:**
**Node 1:**
-.. code-block:: sh
+.. code-block:: console
set protocols static route6 2001:db8:1::/48 blackhole distance '254'
**Node 2:**
-.. code-block:: sh
+.. code-block:: console
set protocols static route6 2001:db8:2::/48 blackhole distance '254'
@@ -101,7 +101,7 @@ Route filter can be applied using a route-map:
**Node1:**
-.. code-block:: sh
+.. code-block:: console
set policy prefix-list AS65535-IN rule 10 action 'permit'
set policy prefix-list AS65535-IN rule 10 prefix '172.16.0.0/16'
@@ -124,7 +124,7 @@ Route filter can be applied using a route-map:
**Node2:**
-.. code-block:: sh
+.. code-block:: console
set policy prefix-list AS65534-IN rule 10 action 'permit'
set policy prefix-list AS65534-IN rule 10 prefix '172.17.0.0/16'
diff --git a/docs/routing/igmp-proxy.rst b/docs/routing/igmp-proxy.rst
index fd16892d..3a44ced6 100644
--- a/docs/routing/igmp-proxy.rst
+++ b/docs/routing/igmp-proxy.rst
@@ -14,7 +14,7 @@ simple example:
Interface eth1 LAN is behind NAT. In order to subscribe 10.0.0.0/23 subnet multicast which is in eth0 WAN we need igmp-proxy.
-.. code-block:: sh
+.. code-block:: console
# show protocols igmp-proxy
interface eth0 {
diff --git a/docs/routing/mss-clamp.rst b/docs/routing/mss-clamp.rst
index 7cec4b7c..329910b0 100644
--- a/docs/routing/mss-clamp.rst
+++ b/docs/routing/mss-clamp.rst
@@ -9,7 +9,7 @@ to clamp your TCP MSS value for IPv4 and IPv6.
Clamping can be disabled per interface using the `disable` keyword:
-.. code-block:: sh
+.. code-block:: console
set firewall options interface pppoe0 disable
@@ -19,7 +19,7 @@ IPv4
Clamp outgoing MSS value in a TCP SYN packet to `1452` for `pppoe0` and `1372`
for your WireGuard `wg02` tunnel.
-.. code-block:: sh
+.. code-block:: console
set firewall options interface pppoe0 adjust-mss '1452'
set firewall options interface wg02 adjust-mss '1372'
@@ -32,7 +32,7 @@ Clamp outgoing MSS value in a TCP SYN packet to `1280` for both `pppoe0` and
To achieve the same for IPv6 please use:
-.. code-block:: sh
+.. code-block:: console
set firewall options interface pppoe0 adjust-mss6 '1280'
set firewall options interface wg02 adjust-mss6 '1280'
diff --git a/docs/routing/ospf.rst b/docs/routing/ospf.rst
index 78768145..eca0acd3 100644
--- a/docs/routing/ospf.rst
+++ b/docs/routing/ospf.rst
@@ -19,13 +19,13 @@ OSPFv2 (IPv4)
In order to have a VyOS system exchanging routes with OSPF neighbors, you will
at least need to configure the area and a network,
-.. code-block:: sh
+.. code-block:: console
set protocols ospf area 0 network 192.168.0.0/24
as well as the router ID.
-.. code-block:: sh
+.. code-block:: console
set protocols ospf parameters router-id 10.1.1.1
@@ -36,7 +36,7 @@ address and the node 1 sending the default route:
**Node 1**
-.. code-block:: sh
+.. code-block:: console
set interfaces loopback lo address 10.1.1.1/32
set protocols ospf area 0 network 192.168.0.0/24
@@ -53,7 +53,7 @@ address and the node 1 sending the default route:
**Node 2**
-.. code-block:: sh
+.. code-block:: console
set interfaces loopback lo address 10.2.2.2/32
set protocols ospf area 0 network 192.168.0.0/24
@@ -72,7 +72,7 @@ A typical configuration using 2 nodes.
**Node 1:**
-.. code-block:: sh
+.. code-block:: console
set protocols ospfv3 area 0.0.0.0 interface eth1
set protocols ospfv3 area 0.0.0.0 range 2001:db8:1::/64
@@ -81,7 +81,7 @@ A typical configuration using 2 nodes.
**Node 2:**
-.. code-block:: sh
+.. code-block:: console
set protocols ospfv3 area 0.0.0.0 interface eth1
set protocols ospfv3 area 0.0.0.0 range 2001:db8:2::/64
@@ -96,7 +96,7 @@ Example configuration for WireGuard interfaces:
**Node 1**
-.. code-block:: sh
+.. code-block:: console
set interfaces wireguard wg01 address 'fe80::216:3eff:fe51:fd8c/64'
set interfaces wireguard wg01 address '192.168.0.1/24'
@@ -111,7 +111,7 @@ Example configuration for WireGuard interfaces:
**Node 2**
-.. code-block:: sh
+.. code-block:: console
set interfaces wireguard wg01 address 'fe80::216:3eff:fe0a:7ada/64'
set interfaces wireguard wg01 address '192.168.0.2/24'
@@ -126,7 +126,7 @@ Example configuration for WireGuard interfaces:
**Status**
-.. code-block:: sh
+.. code-block:: console
vyos@ospf01:~$ sh ipv6 ospfv3 neighbor
Neighbor ID Pri DeadTime State/IfState Duration I/F[State]
diff --git a/docs/routing/pbr.rst b/docs/routing/pbr.rst
index 9f649672..c2746fa3 100644
--- a/docs/routing/pbr.rst
+++ b/docs/routing/pbr.rst
@@ -13,7 +13,7 @@ Transparent Proxy
The following example will show how VyOS can be used to redirect web traffic to
an external transparent proxy:
-.. code-block:: sh
+.. code-block:: console
set policy route FILTER-WEB rule 1000 destination port 80
set policy route FILTER-WEB rule 1000 protocol tcp
@@ -26,7 +26,7 @@ default routing table.
To create routing table 100 and add a new default gateway to be used by
traffic matching our route policy:
-.. code-block:: sh
+.. code-block:: console
set protocols static table 100 route 0.0.0.0/0 next-hop 10.255.0.2
@@ -35,7 +35,7 @@ This can be confirmed using the show ip route table 100 operational command.
Finally, to apply the policy route to ingress traffic on our LAN interface,
we use:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth1 policy route FILTER-WEB
@@ -62,14 +62,14 @@ Routing tables that will be used in this example are:
Add default routes for routing ``table 10`` and ``table 11``
-.. code-block:: sh
+.. code-block:: console
set protocols static table 10 route 0.0.0.0/0 next-hop 192.0.1.1
set protocols static table 11 route 0.0.0.0/0 next-hop 192.0.2.2
Add policy route matching VLAN source addresses
-.. code-block:: sh
+.. code-block:: console
set policy route PBR rule 20 set table '10'
set policy route PBR rule 20 description 'Route VLAN10 traffic to table 10'
@@ -81,7 +81,7 @@ Add policy route matching VLAN source addresses
Apply routing policy to **inbound** direction of out VLAN interfaces
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 vif 10 policy route 'PBR'
set interfaces ethernet eth0 vif 11 policy route 'PBR'
@@ -89,7 +89,7 @@ Apply routing policy to **inbound** direction of out VLAN interfaces
**OPTIONAL:** Exclude Inter-VLAN traffic (between VLAN10 and VLAN11) from PBR
-.. code-block:: sh
+.. code-block:: console
set policy route PBR rule 10 description 'VLAN10 <-> VLAN11 shortcut'
set policy route PBR rule 10 destination address '192.168.188.0/24'
diff --git a/docs/routing/rip.rst b/docs/routing/rip.rst
index 17f6064f..261a3c5e 100644
--- a/docs/routing/rip.rst
+++ b/docs/routing/rip.rst
@@ -19,7 +19,7 @@ Simple RIP configuration using 2 nodes and redistributing connected interfaces.
**Node 1:**
-.. code-block:: sh
+.. code-block:: console
set interfaces loopback address 10.1.1.1/32
set protocols rip network 192.168.0.0/24
@@ -27,7 +27,7 @@ Simple RIP configuration using 2 nodes and redistributing connected interfaces.
**Node 2:**
-.. code-block:: sh
+.. code-block:: console
set interfaces loopback address 10.2.2.2/32
set protocols rip network 192.168.0.0/24
diff --git a/docs/routing/routing-policy.rst b/docs/routing/routing-policy.rst
index f1b7d778..4c4a4707 100644
--- a/docs/routing/routing-policy.rst
+++ b/docs/routing/routing-policy.rst
@@ -15,7 +15,7 @@ Routing Policy Example
**Policy definition:**
-.. code-block:: sh
+.. code-block:: console
#Create policy
set policy route-map setmet rule 2 action 'permit'
@@ -29,7 +29,7 @@ Routing Policy Example
**Routes learned before routing policy applied:**
-.. code-block:: sh
+.. code-block:: console
vyos@vos1:~$ show ip bgp
BGP table version is 0, local router ID is 192.168.56.101
@@ -44,7 +44,7 @@ Routing Policy Example
**Routes learned after routing policy applied:**
-.. code-block:: sh
+.. code-block:: console
vyos@vos1:~$ sho ip b
BGP table version is 0, local router ID is 192.168.56.101
diff --git a/docs/routing/static.rst b/docs/routing/static.rst
index 3c042844..003a8767 100644
--- a/docs/routing/static.rst
+++ b/docs/routing/static.rst
@@ -9,7 +9,7 @@ Static routes are manually configured network routes.
A typical use for a static route is a static default route for systems that do
not make use of DHCP or dynamic routing protocols:
-.. code-block:: sh
+.. code-block:: console
set protocols static route 0.0.0.0/0 next-hop 10.1.1.1 distance '1'
@@ -19,7 +19,7 @@ example below, :rfc:`1918` networks are set as blackhole routes.
This prevents these networks leaking out public interfaces, but it does not prevent
them from being used as the most specific route has the highest priority.
-.. code-block:: sh
+.. code-block:: console
set protocols static route 10.0.0.0/8 blackhole distance '254'
set protocols static route 172.16.0.0/12 blackhole distance '254'