From a03409893a5a1e5bd76b3b6cf772fdf87653db9d Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Sat, 14 Dec 2024 10:14:48 +0100
Subject: static: T6746: document BFD for static routes

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

(limited to 'docs/configuration')

diff --git a/docs/configuration/protocols/static.rst b/docs/configuration/protocols/static.rst
index 9b1719f0..3e3eb47b 100644
--- a/docs/configuration/protocols/static.rst
+++ b/docs/configuration/protocols/static.rst
@@ -62,6 +62,26 @@ IPv4 Interface Routes
 
    Range is 1 to 255, default is 1.
 
+IPv4 BFD
+========
+
+.. cfgcmd:: set protocols static route <subnet> next-hop <address> bfd
+
+   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 profile <profile>
+
+   Configure a static route for `<subnet>` using gateway `<address>` and use the
+   gateway address as BFD peer destination address with BFD profile `<profile>`.
+
+.. cfgcmd:: set protocols static route <subnet> next-hop <address> bfd multi-hop
+   source-address <source-address>
+
+   Configure a static route for `<subnet>` using gateway `<address>` and use the
+   gateway address as BFD peer destination address with source address
+   `<source>` but initiate a multi-hop session.
+
 DHCP Interface Routes
 =====================
 
@@ -191,6 +211,26 @@ IPv6 Interface Routes
 
      set protocols static route6 2001:db8:1000::/36 interface eth0 segments '2001:db8:aaaa::7/2002::4/2002::3/2002::2'
 
+IPv6 BFD
+========
+
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> bfd
+
+   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 profile <profile>
+
+   Configure a static route for `<subnet>` using gateway `<address>` and use the
+   gateway address as BFD peer destination address with BFD profile `<profile>`.
+
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> bfd multi-hop
+   source-address <source>
+
+   Configure a static route for `<subnet>` using gateway `<address>` and use the
+   gateway address as BFD peer destination address with source address
+   `<source>` but initiate a multi-hop session.
+
 IPv6 Reject Routes
 ==================
 
-- 
cgit v1.2.3