From: Philippe Guibert <philippe.guibert@6wind.com>
Date: Tue, 16 Apr 2019 10:15:25 +0000 (+0200)
Subject: doc: add bfd check-control-plane-failure information
X-Git-Tag: base_7.2~337^2~2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=7b8ca2a83109d90e54f938929d69915552f36d56;p=matthieu%2Ffrr.git

doc: add bfd check-control-plane-failure information

this command is used when user wants to use the cbit value.
more information in the documentation.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
---

diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index a7c5cf28bc..33bc77049e 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -174,6 +174,21 @@ The following commands are available inside the BGP configuration node.
 
    Removes any notification registration for this neighbor.
 
+.. index:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
+.. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
+
+   Allow to write CBIT independence in BFD outgoing packets. Also allow to
+   read both C-BIT value of BFD and lookup BGP peer status. This command is
+   useful when a BFD down event is caught, while the BGP peer requested that
+   local BGP keeps the remote BGP entries as staled if such issue is detected.
+   This is the case when graceful restart is enabled, and it is wished to
+   ignore the BD event while waiting for the remote router to restart.
+
+.. index:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
+.. clicmd:: no neighbor <A.B.C.D|X:X::X:X|WORD> bfd check-control-plane-failure
+
+   Disallow to write CBIT independence in BFD outgoing packets. Also disallow
+   to ignore BFD down notification. This is the default behaviour.
 
 .. _bfd-ospf-peer-config: