summaryrefslogtreecommitdiff
path: root/docs/routing
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2020-01-04 14:12:53 +0100
committerRobert Göhler <github@ghlr.de>2020-01-04 14:12:53 +0100
commit52595595f76d85b20477b61a886a9ff09f17e604 (patch)
treeb33d14410f79ee8c716f22bd765cf9722cd196cf /docs/routing
parent156eef177980052027db572e4b60d984626e0081 (diff)
parenta4fbdcf4b01c8a1806576bcd62a6f166b5645dc6 (diff)
downloadvyos-documentation-52595595f76d85b20477b61a886a9ff09f17e604.tar.gz
vyos-documentation-52595595f76d85b20477b61a886a9ff09f17e604.zip
Merge branch 'master' into newdirectives
Diffstat (limited to 'docs/routing')
-rw-r--r--docs/routing/bgp.rst10
-rw-r--r--docs/routing/ospf.rst4
-rw-r--r--docs/routing/static.rst32
3 files changed, 22 insertions, 24 deletions
diff --git a/docs/routing/bgp.rst b/docs/routing/bgp.rst
index d8860e15..14ea1238 100644
--- a/docs/routing/bgp.rst
+++ b/docs/routing/bgp.rst
@@ -159,14 +159,14 @@ BGP Router Configuration
ASN and Router ID
-----------------
-.. cfgcmd:: set protocols bgp '<ASN>'
+.. cfgcmd:: set protocols bgp <asn>
First of all you must configure BGP router with the :abbr:`ASN (Autonomous
System Number)`. The AS number is an identifier for the autonomous system.
The BGP protocol uses the AS number for detecting whether the BGP connection
is internal or external.
-.. cfgcmd:: set protocols bgp '<ASN>' parameters router-id
+.. cfgcmd:: set protocols bgp <asn> parameters router-id
This command specifies the router-ID. If router ID is not specified it will
use the highest interface IP address.
@@ -174,19 +174,19 @@ ASN and Router ID
Route Selection
---------------
-.. cfgcmd:: set protocols bgp '<ASN>' parameters bestpath as-path confed
+.. cfgcmd:: set protocols bgp <asn> parameters bestpath as-path confed
This command specifies that the length of confederation path sets and
sequences should should be taken into account during the BGP best path
decision process.
-.. cfgcmd:: set protocols bgp '<ASN>' parameters bestpath as-path multipath-relax
+.. cfgcmd:: set protocols bgp <asn> parameters bestpath as-path multipath-relax
This command specifies that BGP decision process should consider paths
of equal AS_PATH length candidates for multipath computation. Without
the knob, the entire AS_PATH must match for multipath computation.
-.. cfgcmd:: set protocols bgp '<ASN>' parameters bestpath as-path ignore
+.. cfgcmd:: set protocols bgp <asn> parameters bestpath as-path ignore
Ignore AS_PATH length when selecting a route
diff --git a/docs/routing/ospf.rst b/docs/routing/ospf.rst
index bee70895..acffb7b3 100644
--- a/docs/routing/ospf.rst
+++ b/docs/routing/ospf.rst
@@ -90,7 +90,7 @@ A typical configuration using 2 nodes.
.. note:: You can not easily redistribute IPv6 routes via OSPFv3 on a WireGuard
interface link. This requires you to configure link-local addresses manually
- on the WireGuard interfaces, see Phabricator task T1483_.
+ on the WireGuard interfaces, see :vytask:`T1483`.
Example configuration for WireGuard interfaces:
@@ -136,5 +136,3 @@ Example configuration for WireGuard interfaces:
Neighbor ID Pri DeadTime State/IfState Duration I/F[State]
192.168.0.1 1 00:00:39 Full/PointToPoint 00:19:44 wg01[PointToPoint]
-.. _T1483: https://phabricator.vyos.net/T1483
-
diff --git a/docs/routing/static.rst b/docs/routing/static.rst
index cebe42fa..52a73354 100644
--- a/docs/routing/static.rst
+++ b/docs/routing/static.rst
@@ -18,32 +18,32 @@ used to determine the forwarding table used for unicast packet forwarding.
Static Routes
#############
-.. cfgcmd:: set protocols static route '<subnet>' next-hop '<address>'
+.. cfgcmd:: set protocols static route <subnet> next-hop <address>
Configure next-hop `<address>` for an IPv4 static route. Multiple static
routes can be created.
-.. cfgcmd:: set protocols static route '<subnet>' next-hop '<address>' disable
+.. cfgcmd:: set protocols static route <subnet> next-hop <address> disable
Disable this IPv4 static route entry.
-.. cfgcmd:: set protocols static route '<subnet>' next-hop '<address>' distance '<distance>'
+.. cfgcmd:: set protocols static route <subnet> next-hop <address> distance <distance>
Defines next-hop distance for this route, routes with smaller administrative
distance are elected prior those with a higher distance.
Range is 1 to 255, default is 1.
-.. cfgcmd:: set protocols static route6 '<subnet>' next-hop '<address>'
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address>
Configure next-hop `<address>` for an IPv6 static route. Multiple static
routes can be created.
-.. cfgcmd:: set protocols static route6 '<subnet>' next-hop '<address>' disable
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> disable
Disable this IPv6 static route entry.
-.. cfgcmd:: set protocols static route6 '<subnet>' next-hop '<address>' distance '<distance>'
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> distance <distance>
Defines next-hop distance for this route, routes with smaller administrative
distance are elected prior those with a higher distance.
@@ -57,34 +57,34 @@ Static Routes
Interface Routes
================
-.. cfgcmd:: set protocols static interface-route '<subnet>' next-hop-interface '<interface>'
+.. cfgcmd:: set protocols static interface-route <subnet> next-hop-interface <interface>
Allows you to configure the next-hop interface for an interface-based IPv4
static route. `<interface>` will be the next-hop interface where trafic is
routed for the given `<subnet>`.
-.. cfgcmd:: set protocols static interface-route '<subnet>' next-hop-interface '<interface>' disable
+.. cfgcmd:: set protocols static interface-route <subnet> next-hop-interface <interface> disable
Disables interface-based IPv4 static route.
-.. cfgcmd:: set protocols static interface-route '<subnet>' next-hop-interface '<interface>' distance '<distance>'
+.. cfgcmd:: set protocols static interface-route <subnet> next-hop-interface <interface> distance <distance>
Defines next-hop distance for this route, routes with smaller administrative
distance are elected prior those with a higher distance.
Range is 1 to 255, default is 1.
-.. cfgcmd:: set protocols static interface-route6 '<subnet>' next-hop-interface '<interface>'
+.. cfgcmd:: set protocols static interface-route6 <subnet> next-hop-interface <interface>
Allows you to configure the next-hop interface for an interface-based IPv6
static route. `<interface>` will be the next-hop interface where trafic is
routed for the given `<subnet>`.
-.. cfgcmd:: set protocols static interface-route6 '<subnet>' next-hop-interface '<interface>' disable
+.. cfgcmd:: set protocols static interface-route6 <subnet> next-hop-interface <interface> disable
Disables interface-based IPv6 static route.
-.. cfgcmd:: set protocols static interface-route6 '<subnet>' next-hop-interface '<interface>' distance '<distance>'
+.. cfgcmd:: set protocols static interface-route6 <subnet> next-hop-interface <interface> distance <distance>
Defines next-hop distance for this route, routes with smaller administrative
distance are elected prior those with a higher distance.
@@ -95,7 +95,7 @@ Interface Routes
Blackhole
=========
-.. cfgcmd:: set protocols static route '<subnet>' blackhole
+.. cfgcmd:: set protocols static route <subnet> blackhole
Use this command to configure a "black-hole" route on the router. A
black-hole route is a route for which the system silently discard packets
@@ -103,12 +103,12 @@ Blackhole
it does not prevent them from being used as a more specific route inside your
network.
-.. cfgcmd:: set protocols static route '<subnet>' blackhole distance '<distance>'
+.. cfgcmd:: set protocols static route <subnet> blackhole distance <distance>
Defines blackhole distance for this route, routes with smaller administrative
distance are elected prior those with a higher distance.
-.. cfgcmd:: set protocols static route6 '<subnet>' blackhole
+.. cfgcmd:: set protocols static route6 <subnet> blackhole
Use this command to configure a "black-hole" route on the router. A
black-hole route is a route for which the system silently discard packets
@@ -116,7 +116,7 @@ Blackhole
it does not prevent them from being used as a more specific route inside your
network.
-.. cfgcmd:: set protocols static route6 '<subnet>' blackhole distance '<distance>'
+.. cfgcmd:: set protocols static route6 <subnet> blackhole distance <distance>
Defines blackhole distance for this route, routes with smaller administrative
distance are elected prior those with a higher distance.