summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2023-05-19 10:10:41 +0200
committerGitHub <noreply@github.com>2023-05-19 10:10:41 +0200
commit9cf0c14e7110d6a1c90de139bb81efeca84122d4 (patch)
tree42151742724b3a82753d0ff7b66cc763a983cbf8
parent446a7f09f6df88c6912c9c99cff9b40c27fe92f0 (diff)
parentfd9176254fb3cfaea957c505e4b23fd1251c1d56 (diff)
downloadvyos-documentation-9cf0c14e7110d6a1c90de139bb81efeca84122d4.tar.gz
vyos-documentation-9cf0c14e7110d6a1c90de139bb81efeca84122d4.zip
Merge pull request #1012 from fett0/bfd-m-documentation
BFD : add static monitoring documentation
-rw-r--r--docs/configuration/protocols/bfd.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/configuration/protocols/bfd.rst b/docs/configuration/protocols/bfd.rst
index faec71bc..260e86fb 100644
--- a/docs/configuration/protocols/bfd.rst
+++ b/docs/configuration/protocols/bfd.rst
@@ -132,4 +132,58 @@ Operational Commands
Transmission interval: 300ms
Echo transmission interval: 0ms
+BFD Static Route Monitoring
+===========================
+A monitored static route conditions the installation to the RIB on the BFD
+session running state: when BFD session is up the route is installed to RIB,
+but when the BFD session is down it is removed from the RIB.
+
+Configuration
+-------------
+
+.. cfgcmd:: set protocols static route <subnet> next-hop <address>
+ bfd profile <profile>
+
+ Configure a static route for <subnet> using gateway <address>
+ and use the gateway address as BFD peer destination address.
+
+.. cfgcmd:: set protocols static route <subnet> next-hop <address>
+ bfd multi-hop source <address> profile <profile>
+
+ Configure a static route for <subnet> using gateway <address>
+ , use source address to indentify the peer when is multi-hop session
+ and the gateway address as BFD peer destination address.
+
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address>
+ bfd profile <profile>
+
+ Configure a static route for <subnet> using gateway <address>
+ and use the gateway address as BFD peer destination address.
+
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address>
+ bfd multi-hop source <address> profile <profile>
+
+ Configure a static route for <subnet> using gateway <address>
+ , use source address to indentify the peer when is multi-hop session
+ and the gateway address as BFD peer destination address.
+
+Operational Commands
+====================
+
+.. opcmd:: show bfd static routes
+
+ Showing BFD monitored static routes
+
+ .. code-block:: none
+
+ Showing BFD monitored static routes:
+
+ Next hops:
+ VRF default IPv4 Unicast:
+ 10.10.13.3/32 peer 192.168.2.3 (status: installed)
+ 172.16.10.3/32 peer 192.168.10.1 (status: uninstalled)
+
+ VRF default IPv4 Multicast:
+
+ VRF default IPv6 Unicast: