summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols
diff options
context:
space:
mode:
authorsrividya0208 <a.srividya@vyos.io>2021-05-27 14:18:26 -0400
committersrividya0208 <a.srividya@vyos.io>2021-05-27 14:18:26 -0400
commitcf3312318177f02ec33be403ec88eb1438a9892c (patch)
tree34c6c7b4713a447e49a39cb6f9a15874164fe640 /docs/configuration/protocols
parent8651aed3bd0f17e44d4a7fb486448a9f0526950f (diff)
parent546eced065d473ad2a1e2a7ef0bf8def6ff43ab3 (diff)
downloadvyos-documentation-cf3312318177f02ec33be403ec88eb1438a9892c.tar.gz
vyos-documentation-cf3312318177f02ec33be403ec88eb1438a9892c.zip
Merge branch 'master' of https://github.com/vyos/vyos-documentation
Diffstat (limited to 'docs/configuration/protocols')
-rw-r--r--docs/configuration/protocols/bfd.rst10
-rw-r--r--docs/configuration/protocols/bgp.rst77
-rw-r--r--docs/configuration/protocols/rpki.rst8
3 files changed, 52 insertions, 43 deletions
diff --git a/docs/configuration/protocols/bfd.rst b/docs/configuration/protocols/bfd.rst
index 8d19334c..e5153667 100644
--- a/docs/configuration/protocols/bfd.rst
+++ b/docs/configuration/protocols/bfd.rst
@@ -10,7 +10,7 @@ BFD
the following RFCs: :rfc:`5880`, :rfc:`5881` and :rfc:`5883`.
In the age of very fast networks, a second of unreachability may equal millions of lost packets.
-The idea behind BFD is to detect very quickly when a peer is down and take action extremely fast.
+The idea behind BFD is to detect very quickly when a peer is down and take action extremely fast.
BFD sends lots of small UDP packets very quickly to ensures that the peer is still alive.
@@ -31,7 +31,7 @@ Configure BFD
Allow this BFD peer to not be directly connected
-.. cfgcmd:: set protocols bfd peer <address> source
+.. cfgcmd:: set protocols bfd peer <address> source
[address <address> | interface <interface>]
Bind listener to specifid interface/address, mandatory for IPv6
@@ -45,7 +45,7 @@ Configure BFD
Remote transmission interval will be multiplied by this value
-.. cfgcmd:: set protocols bfd peer <address> interval
+.. cfgcmd:: set protocols bfd peer <address> interval
[receive | transmit] <10-60000>
Interval in milliseconds
@@ -58,11 +58,11 @@ Configure BFD
Enable BFD in BGP
-----------------
-.. cfgcmd:: set protocols bgp <asn> neighbor <address> bfd
+.. cfgcmd:: set protocols bgp neighbor <neighbor> bfd
Enable BFD on a single BGP neighbor
-.. cfgcmd:: set protocols bgp <asn> peer-group <group> bfd
+.. cfgcmd:: set protocols bgp peer-group <neighbor> bfd
Enable BFD on a BGP peer group
diff --git a/docs/configuration/protocols/bgp.rst b/docs/configuration/protocols/bgp.rst
index 2ef7c247..f1f15f38 100644
--- a/docs/configuration/protocols/bgp.rst
+++ b/docs/configuration/protocols/bgp.rst
@@ -897,15 +897,14 @@ between these sub-ASes we use something that looks like EBGP but behaves like
IBGP (called confederation BGP). Confederation mechanism is described in
:rfc:`5065`
-.. cfgcmd:: set protocols bgp <subasn> parameters confederation identifier
+.. cfgcmd:: set protocols bgp parameters confederation identifier
<asn>
This command specifies a BGP confederation identifier. <asn> is the number
of the autonomous system that internally includes multiple sub-autonomous
- systems (a confederation). <subasn> is the number sub-autonomous system
- inside <asn>.
+ systems (a confederation).
-.. cfgcmd:: set protocols bgp <subasn> parameters confederation confederation
+.. cfgcmd:: set protocols bgp parameters confederation confederation
peers <nsubasn>
This command sets other confederations <nsubasn> as members of autonomous
@@ -1070,21 +1069,23 @@ A simple eBGP configuration:
.. code-block:: none
- set protocols bgp 65534 neighbor 192.168.0.2 ebgp-multihop '2'
- set protocols bgp 65534 neighbor 192.168.0.2 remote-as '65535'
- set protocols bgp 65534 neighbor 192.168.0.2 update-source '192.168.0.1'
- set protocols bgp 65534 address-family ipv4-unicast network '172.16.0.0/16'
- set protocols bgp 65534 parameters router-id '192.168.0.1'
+ set protocols bgp local-as 65534
+ set protocols bgp neighbor 192.168.0.2 ebgp-multihop '2'
+ set protocols bgp neighbor 192.168.0.2 remote-as '65535'
+ set protocols bgp neighbor 192.168.0.2 update-source '192.168.0.1'
+ set protocols bgp address-family ipv4-unicast network '172.16.0.0/16'
+ set protocols bgp parameters router-id '192.168.0.1'
**Node 2:**
.. code-block:: none
- set protocols bgp 65535 neighbor 192.168.0.1 ebgp-multihop '2'
- set protocols bgp 65535 neighbor 192.168.0.1 remote-as '65534'
- set protocols bgp 65535 neighbor 192.168.0.1 update-source '192.168.0.2'
- set protocols bgp 65535 address-family ipv4-unicast network '172.17.0.0/16'
- set protocols bgp 65535 parameters router-id '192.168.0.2'
+ set protocols bgp local-as 65535
+ set protocols bgp neighbor 192.168.0.1 ebgp-multihop '2'
+ set protocols bgp neighbor 192.168.0.1 remote-as '65534'
+ set protocols bgp neighbor 192.168.0.1 update-source '192.168.0.2'
+ set protocols bgp address-family ipv4-unicast network '172.17.0.0/16'
+ set protocols bgp parameters router-id '192.168.0.2'
Don't forget, the CIDR declared in the network statement MUST **exist in your
@@ -1113,23 +1114,25 @@ A simple BGP configuration via IPv6.
.. code-block:: none
- set protocols bgp 65534 neighbor 2001:db8::2 ebgp-multihop '2'
- set protocols bgp 65534 neighbor 2001:db8::2 remote-as '65535'
- set protocols bgp 65534 neighbor 2001:db8::2 update-source '2001:db8::1'
- set protocols bgp 65534 neighbor 2001:db8::2 address-family ipv6-unicast
- set protocols bgp 65534 address-family ipv6-unicast network '2001:db8:1::/48'
- set protocols bgp 65534 parameters router-id '10.1.1.1'
+ set protocols bgp local-as 65534
+ set protocols bgp neighbor 2001:db8::2 ebgp-multihop '2'
+ set protocols bgp neighbor 2001:db8::2 remote-as '65535'
+ set protocols bgp neighbor 2001:db8::2 update-source '2001:db8::1'
+ set protocols bgp neighbor 2001:db8::2 address-family ipv6-unicast
+ set protocols bgp address-family ipv6-unicast network '2001:db8:1::/48'
+ set protocols bgp parameters router-id '10.1.1.1'
**Node 2:**
.. code-block:: none
- set protocols bgp 65535 neighbor 2001:db8::1 ebgp-multihop '2'
- set protocols bgp 65535 neighbor 2001:db8::1 remote-as '65534'
- set protocols bgp 65535 neighbor 2001:db8::1 update-source '2001:db8::2'
- set protocols bgp 65535 neighbor 2001:db8::1 address-family ipv6-unicast
- set protocols bgp 65535 address-family ipv6-unicast network '2001:db8:2::/48'
- set protocols bgp 65535 parameters router-id '10.1.1.2'
+ set protocols bgp local-as 65535
+ set protocols bgp neighbor 2001:db8::1 ebgp-multihop '2'
+ set protocols bgp neighbor 2001:db8::1 remote-as '65534'
+ set protocols bgp neighbor 2001:db8::1 update-source '2001:db8::2'
+ set protocols bgp neighbor 2001:db8::1 address-family ipv6-unicast
+ set protocols bgp address-family ipv6-unicast network '2001:db8:2::/48'
+ set protocols bgp parameters router-id '10.1.1.2'
Don't forget, the CIDR declared in the network statement **MUST exist in your
routing table (dynamic or static), the best way to make sure that is true is
@@ -1164,6 +1167,7 @@ Route filter can be applied using a route-map:
set policy prefix-list6 AS65535-IN rule 10 prefix '2001:db8:2::/48'
set policy prefix-list6 AS65535-OUT rule 10 action 'deny'
set policy prefix-list6 AS65535-OUT rule 10 prefix '2001:db8:2::/48'
+
set policy route-map AS65535-IN rule 10 action 'permit'
set policy route-map AS65535-IN rule 10 match ip address prefix-list 'AS65535-IN'
set policy route-map AS65535-IN rule 10 match ipv6 address prefix-list 'AS65535-IN'
@@ -1172,10 +1176,12 @@ Route filter can be applied using a route-map:
set policy route-map AS65535-OUT rule 10 match ip address prefix-list 'AS65535-OUT'
set policy route-map AS65535-OUT rule 10 match ipv6 address prefix-list 'AS65535-OUT'
set policy route-map AS65535-OUT rule 20 action 'permit'
- set protocols bgp 65534 neighbor 2001:db8::2 address-family ipv4-unicast route-map export 'AS65535-OUT'
- set protocols bgp 65534 neighbor 2001:db8::2 address-family ipv4-unicast route-map import 'AS65535-IN'
- set protocols bgp 65534 neighbor 2001:db8::2 address-family ipv6-unicast route-map export 'AS65535-OUT'
- set protocols bgp 65534 neighbor 2001:db8::2 address-family ipv6-unicast route-map import 'AS65535-IN'
+
+ set protocols bgp local-as 65534
+ set protocols bgp neighbor 2001:db8::2 address-family ipv4-unicast route-map export 'AS65535-OUT'
+ set protocols bgp neighbor 2001:db8::2 address-family ipv4-unicast route-map import 'AS65535-IN'
+ set protocols bgp neighbor 2001:db8::2 address-family ipv6-unicast route-map export 'AS65535-OUT'
+ set protocols bgp neighbor 2001:db8::2 address-family ipv6-unicast route-map import 'AS65535-IN'
**Node2:**
@@ -1189,6 +1195,7 @@ Route filter can be applied using a route-map:
set policy prefix-list6 AS65534-IN rule 10 prefix '2001:db8:1::/48'
set policy prefix-list6 AS65534-OUT rule 10 action 'deny'
set policy prefix-list6 AS65534-OUT rule 10 prefix '2001:db8:1::/48'
+
set policy route-map AS65534-IN rule 10 action 'permit'
set policy route-map AS65534-IN rule 10 match ip address prefix-list 'AS65534-IN'
set policy route-map AS65534-IN rule 10 match ipv6 address prefix-list 'AS65534-IN'
@@ -1197,10 +1204,12 @@ Route filter can be applied using a route-map:
set policy route-map AS65534-OUT rule 10 match ip address prefix-list 'AS65534-OUT'
set policy route-map AS65534-OUT rule 10 match ipv6 address prefix-list 'AS65534-OUT'
set policy route-map AS65534-OUT rule 20 action 'permit'
- set protocols bgp 65535 neighbor 2001:db8::1 address-family ipv4-unicast route-map export 'AS65534-OUT'
- set protocols bgp 65535 neighbor 2001:db8::1 address-family ipv4-unicast route-map import 'AS65534-IN'
- set protocols bgp 65535 neighbor 2001:db8::1 address-family ipv6-unicast route-map export 'AS65534-OUT'
- set protocols bgp 65535 neighbor 2001:db8::1 address-family ipv6-unicast route-map import 'AS65534-IN'
+
+ set protocols bgp local-as 65535
+ set protocols bgp neighbor 2001:db8::1 address-family ipv4-unicast route-map export 'AS65534-OUT'
+ set protocols bgp neighbor 2001:db8::1 address-family ipv4-unicast route-map import 'AS65534-IN'
+ set protocols bgp neighbor 2001:db8::1 address-family ipv6-unicast route-map export 'AS65534-OUT'
+ set protocols bgp neighbor 2001:db8::1 address-family ipv6-unicast route-map import 'AS65534-IN'
We could expand on this and also deny link local and multicast in the rule 20
action deny.
diff --git a/docs/configuration/protocols/rpki.rst b/docs/configuration/protocols/rpki.rst
index d9884296..cae66044 100644
--- a/docs/configuration/protocols/rpki.rst
+++ b/docs/configuration/protocols/rpki.rst
@@ -30,9 +30,9 @@ in :rfc:`8210`.
If you are new to these routing security technologies then there is an
`excellent guide to RPKI`_ by NLnet Labs which will get you up to speed
very quickly. Their documentation explains everything from what RPKI is to
- deploying it in production (albeit with a focus on using NLnet Labs'
- tools). It also has some `help and operational guidance`_ including
- "What can I do about my route having an Invalid state?"
+ deploying it in production. It also has some
+ `help and operational guidance`_ including "What can I do about my route
+ having an Invalid state?"
***************
Getting started
@@ -197,6 +197,6 @@ Test`_ experimental tool.
.. _RPKI analytics: https://www.nlnetlabs.nl/projects/rpki/rpki-analytics/
.. _RIPE Labs RPKI Test: https://sg-pub.ripe.net/jasper/rpki-web-test/
.. _excellent guide to RPKI: https://rpki.readthedocs.io/
-.. _help and operational guidance: https://rpki.readthedocs.io/en/latest/about/help.htm
+.. _help and operational guidance: https://rpki.readthedocs.io/en/latest/about/help.html
.. start_vyoslinter