summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMladen Sablic <mladen.sablic@gmail.com>2018-04-12 13:24:21 +0200
committerMladen Sablic <mladen.sablic@gmail.com>2018-04-24 18:47:50 +0200
commit71e55fb257a1849523d8de382f5c7ab4c429afd9 (patch)
treea412db1ef4b9d87b4b1a273b9ac196546b9aaeaf /doc
parentMerge pull request #2080 from qlyoung/docuser (diff)
downloadfrr-71e55fb257a1849523d8de382f5c7ab4c429afd9.tar.xz
frr-71e55fb257a1849523d8de382f5c7ab4c429afd9.zip
pimd: adding querying of state to mtrace
Adding to mtracebis querying with group address. Same change to vtysh mtrace command. Support for querying (S,G) and (*,G) state in mtrace router code. Further improvments to mtrace router code with closer complience to IETF draft. More references in comments to the draft. Man page has been updated accordingly. Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/manpages/mtracebis.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/manpages/mtracebis.rst b/doc/manpages/mtracebis.rst
index b4d57c1b9..d3ba8036d 100644
--- a/doc/manpages/mtracebis.rst
+++ b/doc/manpages/mtracebis.rst
@@ -9,17 +9,22 @@ SYNOPSIS
========
|PROGRAM| |synopsis-options-hv|
-|PROGRAM| <multicast source>
+|PROGRAM| <multicast source> [<multicast group>]
DESCRIPTION
===========
-|PROGRAM| is a program to initiate multicast traceroute, or "mtrace", queries.
+|PROGRAM| is a program for initiating multicast traceroute, or "mtrace", queries.
-The initial version of the program requires multicast source IP address and
-initiates a weak traceroute across the network. This tests whether the
-interfaces towards the source are multicast enabled. The first query sent is a
-full query, capable of crossing the network all the way to the source. If this
-fails, hop-by-hop queries are initiated.
+It can initiate two types of mtrace queries: weak and group.
+
+Weak tests whether the interfaces towards the source are multicast enabled and is
+initiated by supplying only the multicast source address.
+
+Group tests whether there is multicast routing protocol state for particular
+multicast group and is initiated by supplying mutlicast source and group.
+
+The first query sent is a full query, capable of crossing the network all the way
+to the source. If this fails, hop-by-hop queries are initiated.
Hop-by-hop queries start by requesting only a response from the nearest router.
Following that, next query is extended to the next two routers, and so on...