From ac0c578b52f276da92786c5925f3d7b5980ad42e Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Sat, 14 Dec 2024 10:23:59 +0100
Subject: multicast: T6746: add "protocols static mroute" documentation

---
 docs/configuration/protocols/index.rst     |  1 +
 docs/configuration/protocols/multicast.rst | 34 ++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 docs/configuration/protocols/multicast.rst

(limited to 'docs')

diff --git a/docs/configuration/protocols/index.rst b/docs/configuration/protocols/index.rst
index b48954fa..f95c1cf6 100644
--- a/docs/configuration/protocols/index.rst
+++ b/docs/configuration/protocols/index.rst
@@ -14,6 +14,7 @@ Protocols
    igmp-proxy
    isis
    mpls
+   multicast
    segment-routing
    openfabric
    ospf
diff --git a/docs/configuration/protocols/multicast.rst b/docs/configuration/protocols/multicast.rst
new file mode 100644
index 00000000..61a04e5e
--- /dev/null
+++ b/docs/configuration/protocols/multicast.rst
@@ -0,0 +1,34 @@
+.. _routing-static:
+
+#########
+Multicast
+#########
+
+In order to influence Multicast :abbr:`RPF (Reverse Path Forwarding)` lookup,
+it is possible to insert into zebra routes for the Multicast
+:abbr:`RIB (Routing Information Base)`. These routes are only used for RPF
+lookup and will not be used by ZEBRA for insertion into the kernel or for
+normal RIB processing. As such it is possible to create weird states with
+these commands.
+
+Use with caution. Most of the time this will not be necessary.
+
+.. cfgcmd:: set protocols static mroute <subnet> next-hop <address>
+    [distance <distance>]
+
+   Insert into the Multicast RIB Route `<subnet>` with specified next-hop.
+   The distance can be specified as well if desired.
+
+.. cfgcmd:: set protocols static mroute <subnet> next-hop <address> disable
+
+   Do not install route for `<subnet>` into the Multicast RIB.
+
+.. cfgcmd:: set protocols static mroute <subnet> interface <interface>
+   [distance <distance>]
+
+   Insert into the Multicast RIB Route `<subnet>` with specified `<interface>`.
+   The distance can be specified as well if desired.
+
+.. cfgcmd:: set protocols static mroute <subnet> interface <interface> disable
+
+   Do not install route for `<subnet>` into the Multicast RIB.
-- 
cgit v1.2.3