From fd9176254fb3cfaea957c505e4b23fd1251c1d56 Mon Sep 17 00:00:00 2001
From: fett0 <fernando.gmaidana@gmail.com>
Date: Thu, 18 May 2023 17:07:49 -0300
Subject: BFD : add static monitoring documentation

---
 docs/configuration/protocols/bfd.rst | 54 ++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

(limited to 'docs/configuration')

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:
-- 
cgit v1.2.3