From: Rafael Zalamena <rzalamena@opensourcerouting.org>
Date: Mon, 10 Aug 2020 20:26:24 +0000 (-0300)
Subject: doc: add BFD passive mode documentation
X-Git-Tag: base_7.5~85^2~4
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=abd1529680f42bb5857ca11b4d8ede251e3fe903;p=matthieu%2Ffrr.git

doc: add BFD passive mode documentation

Let the user know what the new command does.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
---

diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index 47792317ad..3b49a53793 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -171,6 +171,20 @@ BFD peers and profiles share the same BFD session configuration commands.
    'administrative down' message is sent to the remote peer.
 
 
+.. index:: [no] passive-mode
+.. clicmd:: [no] passive-mode
+
+   Mark session as passive: a passive session will not attempt to start
+   the connection and will wait for control packets from peer before it
+   begins replying.
+
+   This feature is useful when you have a router that acts as the
+   central node of a star network and you want to avoid sending BFD
+   control packets you don't need to.
+
+   The default is active-mode (or ``no passive-mode``).
+
+
 BFD Peer Specific Commands
 --------------------------