[quagga-dev 11996] [PATCH 15/15] doc: zebra multicast RIB commands

David Lamparter equinox at opensourcerouting.org
Fri Jan 30 00:54:33 GMT 2015

Signed-off-by: David Lamparter <equinox at opensourcerouting.org>
 doc/main.texi | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)

diff --git a/doc/main.texi b/doc/main.texi
index a6bf0d1..810866a 100644
--- a/doc/main.texi
+++ b/doc/main.texi
@@ -10,6 +10,7 @@ different routing protocols.
 * Invoking zebra::              Running the program
 * Interface Commands::          Commands for zebra interfaces
 * Static Route Commands::       Commands for adding static routes
+* Multicast RIB Commands::      Commands for controlling MRIB behavior
 * zebra Route Filtering::       Commands for zebra route filtering
 * zebra FIB push interface::    Interface to optional FPM component
 * zebra Terminal Mode Commands::  Commands for zebra's VTY
@@ -185,6 +186,81 @@ and later).  After setting @var{tableno} with this command,
 static routes defined after this are added to the specified table.
 @end deffn
+ at node Multicast RIB Commands
+ at section Multicast RIB Commands
+The Multicast RIB provides a separate table of unicast destinations which
+is used for Multicast Reverse Path Forwarding decisions.  It is used with
+a multicast source's IP address, hence contains not multicast group
+addresses but unicast addresses.
+This table is fully separate from the default unicast table.  However,
+RPF lookup can include the unicast table.
+WARNING: RPF lookup results are non-responsive in this version of Quagga,
+i.e. multicast routing does not actively react to changes in underlying
+unicast topology!
+ at deffn Command {ip multicast rpf-lookup-mode @var{mode}} {}
+ at deffnx Command {no ip multicast rpf-lookup-mode [@var{mode}]} {}
+ at var{mode} sets the method used to perform RPF lookups.  Supported modes:
+ at table @samp
+ at item urib-only
+Performs the lookup on the Unicast RIB.  The Multicast RIB is never used.
+ at item mrib-only
+Performs the lookup on the Multicast RIB.  The Unicast RIB is never used.
+ at item mrib-then-urib
+Tries to perform the lookup on the Multicast RIB.  If any route is found,
+that route is used.  Otherwise, the Unicast RIB is tried.
+ at item lower-distance
+Performs a lookup on the Multicast RIB and Unicast RIB each.  The result
+with the lower administrative distance is used;  if they're equal, the
+Multicast RIB takes precedence.
+ at item longer-prefix
+Performs a lookup on the Multicast RIB and Unicast RIB each.  The result
+with the longer prefix length is used;  if they're equal, the
+Multicast RIB takes precedence.
+ at end table
+WARNING: Unreachable routes do not receive special treatment and do not
+cause fallback to a second lookup.
+ at end deffn
+ at deffn Command {show ip rpf @var{addr}} {}
+Performs a Multicast RPF lookup, as configured with
+ at command{ip multicast rpf-lookup-mode @var{mode}}.  @var{addr} specifies
+the multicast source address to look up.
+ at example
+> show ip rpf
+Routing entry for using Unicast RIB
+  Known via "kernel", distance 0, metric 0, best
+  *, via eth0
+ at end example
+Indicates that a multicast source lookup for would use an
+Unicast RIB entry for with a gateway of
+ at end deffn
+ at deffn Command {show ip rpf} {}
+Prints the entire Multicast RIB.  Note that this is independent of the
+configured RPF lookup mode, the Multicast RIB may be printed yet not
+used at all.
+ at end deffn
+ at deffn Command {ip mroute @var{prefix} @var{nexthop} [@var{distance}]} {}
+ at deffnx Command {no ip mroute @var{prefix} @var{nexthop} [@var{distance}]} {}
+Adds a static route entry to the Multicast RIB.  This performs exactly as
+the @command{ip route} command, except that it inserts the route in the
+Multicast RIB instead of the Unicast RIB.
+ at end deffn
 @node zebra Route Filtering
 @section zebra Route Filtering
 Zebra supports @command{prefix-list} and @command{route-map} to match

More information about the Quagga-dev mailing list