summaryrefslogtreecommitdiff
path: root/doc/user/bfd.rst
diff options
context:
space:
mode:
authorRafael Zalamena <rzalamena@opensourcerouting.org>2020-08-10 17:26:24 -0300
committerRafael Zalamena <rzalamena@opensourcerouting.org>2020-08-11 16:46:10 -0300
commitabd1529680f42bb5857ca11b4d8ede251e3fe903 (patch)
treeb5f119ec20a75bc6bf78d6211b5d209ea96ef9a1 /doc/user/bfd.rst
parent4e38f82a0ad11891d08147b32d4a6b65daa02a94 (diff)
doc: add BFD passive mode documentation
Let the user know what the new command does. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
Diffstat (limited to 'doc/user/bfd.rst')
-rw-r--r--doc/user/bfd.rst14
1 files changed, 14 insertions, 0 deletions
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
--------------------------