summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorNathan Bahr <nbahr@atcorp.com>2024-10-30 22:33:09 +0100
committerNathan Bahr <nbahr@atcorp.com>2025-01-09 22:58:22 +0100
commitf75ec46dfb1f925824e9f6a8ca3a254485dd88f0 (patch)
treea95bee2869c0d079bc33209cdca7846fcb3a533d /doc
parenttests: Add tests for new RPF lookup group and source list features (diff)
downloadfrr-f75ec46dfb1f925824e9f6a8ca3a254485dd88f0.tar.xz
frr-f75ec46dfb1f925824e9f6a8ca3a254485dd88f0.zip
doc: Document rpf-lookup-mode changes
Signed-off-by: Nathan Bahr <nbahr@atcorp.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/user/pim.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/user/pim.rst b/doc/user/pim.rst
index ff45f21b5..c139e6488 100644
--- a/doc/user/pim.rst
+++ b/doc/user/pim.rst
@@ -217,7 +217,7 @@ PIM Routers
never do SM over. This command is vrf aware, to configure for a vrf, specify
the vrf in the router pim block.
-.. clicmd:: rpf-lookup-mode MODE
+.. clicmd:: rpf-lookup-mode MODE [group-list PREFIX_LIST] [source-list PREFIX_LIST]
MODE sets the method used to perform RPF lookups. Supported modes:
@@ -246,6 +246,18 @@ PIM Routers
configured to make the configuration immune against possible changes in
what the default behavior is.
+ If a group and/or source prefix list is provided, then the RPF lookup mode
+ will only apply to source, group addresses that match the given prefix list(s).
+ Not all RPF lookups have a valid group address when performing a lookup, e.g. RPF
+ to an RP only does a lookup to the RP address and has no specific group.
+ Lookups that do not have a specific group will only use lookup modes that do not
+ specify a group-list.
+ A global rpf lookup mode that does not have a group or source list is always installed
+ and, as documented above, uses the ``mrib-then-urib`` mode by default.
+ This can be changed with an rpf-lookup-mode MODE that does not specify group or source lists.
+ There can be any number of rpf lookup modes, as long as the combination of group and source
+ list is unique.
+
.. warning::
Unreachable routes do not receive special treatment and do not cause