summaryrefslogtreecommitdiffstats
path: root/doc/user
diff options
context:
space:
mode:
authorRafael Zalamena <rzalamena@opensourcerouting.org>2023-03-28 20:41:56 +0200
committerRafael Zalamena <rzalamena@opensourcerouting.org>2023-04-19 16:17:55 +0200
commit5e69093713554f3e436a8adb817c8de8520dad0c (patch)
tree6f1f64790fa3f64f2061b804d158b4afcf71ee6f /doc/user
parenttopotests: RIP BFD integration topology test (diff)
downloadfrr-5e69093713554f3e436a8adb817c8de8520dad0c.tar.xz
frr-5e69093713554f3e436a8adb817c8de8520dad0c.zip
doc: RIP BFD integration documentation
Let users know about the RIP BFD integration commands and increment the used RFCs reference. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
Diffstat (limited to '')
-rw-r--r--doc/user/bfd.rst28
-rw-r--r--doc/user/overview.rst2
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index 1a4299677..776726f19 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -10,6 +10,7 @@ the following RFCs:
* :rfc:`5880`
* :rfc:`5881`
+* :rfc:`5882`
* :rfc:`5883`
Currently, there are two implementations of the BFD commands in FRR:
@@ -353,6 +354,33 @@ The following commands are available inside the interface configuration node.
that interface.
+.. _bfd-rip-peer-config:
+
+RIP BFD configuration
+---------------------
+
+The following commands are available inside the interface configuration node:
+
+.. clicmd:: ip rip bfd
+
+ Automatically create BFD session for each RIP peer discovered in this
+ interface. When the BFD session monitor signalize that the link is down
+ the RIP peer is removed and all the learned routes associated with that
+ peer are removed.
+
+
+.. clicmd:: ip rip bfd profile BFD_PROFILE_NAME
+
+ Selects a BFD profile for the BFD sessions created in this interface.
+
+
+The following command is available in the RIP router configuration node:
+
+.. clicmd:: bfd default-profile BFD_PROFILE_NAME
+
+ Selects a default BFD profile for all sessions without a profile specified.
+
+
.. _bfd-static-peer-config:
BFD Static Route Monitoring Configuration
diff --git a/doc/user/overview.rst b/doc/user/overview.rst
index 5ea33d62c..33a193462 100644
--- a/doc/user/overview.rst
+++ b/doc/user/overview.rst
@@ -465,6 +465,8 @@ BFD
:t:`Bidirectional Forwarding Detection (BFD), D. Katz, D. Ward. June 2010`
- :rfc:`5881`
:t:`Bidirectional Forwarding Detection (BFD) for IPv4 and IPv6 (Single Hop), D. Katz, D. Ward. June 2010`
+- :rfc:`5882`
+ :t:`Generic Application of Bidirectional Forwarding Detection (BFD), D. Katz, D. Ward. June 2010`
- :rfc:`5883`
:t:`Bidirectional Forwarding Detection (BFD) for Multihop Paths, D. Katz, D. Ward. June 2010`