IP Multicast Tools Commands

Syntax Description

interval seconds	(Optional) Frequency of beacon messages in seconds. The default value is 60 seconds, meaning one beacon message every 60 seconds.
holdtime seconds	(Optional) Length of the test period in seconds. The Test Sender and Test Receiver are respectively sending and receiving test data constantly during the hold time. The default value is 1 day (86400 seconds).
ttl hops	(Optional) Time-to-live (TTL) of the beacon messages. The default value is 32 hops.

Defaults

interval seconds is 60.

holdtime seconds is 86400 (1 day).

ttl hops is 32.

Command Modes

Manager configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

The beacon message functions like a keepalive message. The Manager multicasts beacon messages to the Test Sender and Test Receiver. Beacon messages include the sender requests and receiver requests to start the test, thus providing redundancy in case the Test Sender or Test Receiver goes down.

You can increase the default interval keyword to reduce beacon traffic.

You can decrease the holdtime keyword to shorten the test time.

You can change the default number of TTL hops if your network were large and the beacon needed more than 32 hops to get from the Manager to the Test Sender or Test Receiver.

Examples

The following example customizes the Manager to send beacon messages every 30 minutes (1800 seconds), for a test period of 12 hours (43200 seconds), with a TTL of 40 hops:

beacon interval 1800 holdtime 43200 ttl 40

Related Commands

Command	Description
manager	Specifies that an interface is the Manager for MRM, and specifies the multicast group address the Test Receiver will listen to.

Syntax Description

ip-address

(Optional) Address of the Test Receiver. Clears only those status reports received from the Test Receiver having this IP address. If no address is specified, all status reports are cleared from the cache buffer.

Command Modes

EXEC

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

You typically need not clear this circular cache buffer.

Examples

The following example clears status reports from the Test Receiver at 175.2.3.4:

clear ip mrm status-report 175.2.3.4

Related Commands

Command	Description
show ip mrm status-report	Displays MRM status reports of errors in the circular cache buffer.

Syntax Description

test-sender	Configures the interface to be a Test Sender.
test-receiver	Configures the interface to be a Test Receiver.
test-sender-receiver	Configures the interface to be both a Test Sender and Test Receiver (for different groups).

Defaults

The interface is neither a Test Sender nor a Test Receiver.

Command Modes

Interface configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

The Test Sender and Test Receiver can be either a router or a host.

If a router (or host) belongs to more than one test group, it can be a Test Sender for one group and a Test Receiver for the other group. It cannot be the Test Sender and Test Receiver for the same group.

Examples

The following example configures Ethernet interface 0 to be a Test Sender:

interface ethernet 0
 ip mrm test-sender

Related Commands

Command	Description
receivers	Configures the following: (1) establishes Test Receivers for MRM; (2) specifies which Test Senders the Test Receivers will listen to; (3) specifies which sources the Test Receivers monitor; (4) specifies the packet delay; or (5) changes Test Receiver parameters.
senders	Configures Test Sender parameters used in MRM.

Syntax Description

access-list-name	Named IP access list applied to the Managers.
access-list-number	Numbered IP access list applied to the Managers.
test-sender	(Optional) The access list applies only to the Test Sender.
test-receiver	(Optional) The access list applies only to the Test Receiver.

Defaults

If neither test-sender nor test-receiver is configured, the access list applies to both.

Command Modes

Global configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Use this command to control which Managers a Test Sender or Test Receiver must respond to.

Examples

The following example configures the Test Sender to respond only to Managers that pass the access list named supervisor:

ip access-list standard supervisor
remark Permit only the Manager from Central Office
 permit 172.18.2.4 
ip mrm accept-manager supervisor test-sender

Related Commands

Command	Description
ip mrm	Configures an interface to operate as a Test Sender or Test Receiver, or both, for MRM.

Syntax Description

test-name

Name of the group of MRM test parameters that follow.

Defaults

There is no MRM test.

Command Modes

Global configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

The test-name identifies a test so that you can start, stop, or monitor the test.

After you enter this command, the router is in manager configuration mode and you must set the test parameters.

Examples

The following example identifies an MRM test named test1 and causes the system to enter manager configuration mode:

ip mrm manager test1
 manager ethernet 0 group 239.1.1.1
 senders 1

Related Commands

Command	Description
mrm	Starts or stops an MRM test.
show ip mrm manager	Displays test information for MRM.

Syntax Description

type number	Interface type and number of the Manager. The IP address associated with this interface is the source address of the Manager.
group ip-address	IP multicast group address that the Test Receiver will listen to.

Defaults

There is no MRM Manager.

Command Modes

Manager configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

This command identifies the interface that acts as the Manager, and therefore is required in order to run the Multicast Routing Monitor feature.

Examples

The following example configures Ethernet interface 0 as the Manager. It also configures the Test Receiver to listen to multicast group 239.1.1.1.

ip mrm manager test1
 manager ethernet 0 group 239.1.1.1

Related Commands

Command	Description
beacon	Changes the frequency, duration, or scope of beacon messages that the Manager sends to Test Senders and Test Receivers during an MRM test.
ip mrm accept-manager	Configures a Test Sender or Test Receiver to accept requests only from Managers that pass an access list.
show ip mrm manager	Displays test information for MRM.

Syntax Description

hostname | address	(Optional) Queries the DNS name or IP address of the multicast router. If omitted, the router queries itself.
source-address	(Optional) Source address used on mrinfo requests. If omitted, the source address is based on the outbound interface for the destination.
interface	(Optional) Source interface used on mrinfo requests. If omitted, the source is based on the outbound interface for the destination.

Command Modes

EXEC

Command History

Release	Modification
11.0	This command was introduced.

Usage Guidelines

Examples

The following is sample output of the mrinfo command:

Router # mrinfo
 
192.31.7.37 (barrnet-gw.cisco.com) [version cisco 11.1] [flags: PMSA]:
  192.31.7.37 -> 192.31.7.34 (sj-wall-2.cisco.com) [1/0/pim]
  192.31.7.37 -> 192.31.7.47 (dirtylab-gw-2.cisco.com) [1/0/pim]
  192.31.7.37 -> 192.31.7.44 (dirtylab-gw-1.cisco.com) [1/0/pim]
  131.119.26.10 -> 131.119.26.9 (su-pr2.bbnplanet.net) [1/32/pim]
 

The flags indicate the following:

• P = prune-capable

• M = mtrace-capable

• S = SNMP-capable

• A = Auto-RP-capable

Syntax Description

test-name	Name of the MRM test, as defined by the ip mrm manager command.
start	Starts the MRM test specified by test-name.
stop	Stops the MRM test specified by test-name.

Command Modes

EXEC

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Syntax Description

source	DNS name or the IP address of the multicast-capable source.
destination	(Optional) DNS name or address of the destination. If omitted, the command uses the system at which the command is typed.
group	(Optional) DNS name or multicast address of the group to be displayed. Default address is 224.2.0.1 (the group used for MBONE Audio).

Command Modes

User EXEC

Command History

Release	Modification
11.0	This command was introduced.

Usage Guidelines

If no arguments are entered, the router will interactively prompt you for them.

This command is a form of UNIX mtrace that reports packet rate and loss information.

Examples

The following is sample output from the mstat command:

Router# mstat lwei-home-ss2 171.69.58.88 224.0.255.255
 
Type escape sequence to abort.
Mtrace from 171.69.143.27 to 171.69.58.88 via group 224.0.255.255
>From source (lwei-home-ss2.cisco.com) to destination (lwei-ss20.cisco.com)
Waiting to accumulate statistics......
Results after 10 seconds:
 
  Source        Response Dest    Packet Statistics For    Only For Traffic
171.69.143.27    171.69.62.144    All Multicast Traffic     From 171.69.143.27
     |       __/  rtt 48   ms   Lost/Sent = Pct  Rate     To 224.0.255.255
     v      /     hop 48   ms   ---------------------     --------------------
171.69.143.25   lwei-cisco-isdn.cisco.com  
     |     ^      ttl   1   
     v     |      hop 31   ms    0/12 = 0%      1 pps    0/1 = --%  0 pps
171.69.121.84   
171.69.121.45   eng-frmt12-pri.cisco.com  
     |     ^      ttl   2   
     v     |      hop -17  ms    -735/12 = --%      1 pps    0/1 = --%  0 pps
171.69.121.4    
171.69.5.27     eng-cc-4.cisco.com  
     |     ^      ttl   3   
     v     |      hop -21  ms    -678/23 = --%      2 pps    0/1 = --%  0 pps
171.69.5.21     
171.69.62.130   eng-ios-2.cisco.com  
     |     ^      ttl   4   
     v     |      hop 5    ms    605/639 = 95%      63 pps    1/1 = --%  0 pps
171.69.62.144   
171.69.58.65    eng-ios-f-5.cisco.com  
     |      \__   ttl   5   
     v         \  hop 0    ms        4         0 pps           0    0 pps
171.69.58.88    171.69.62.144   
  Receiver      Query Source
 

Related Commands

Command	Description
mtrace	Traces the path from a source to a destination branch for a multicast distribution tree.

Syntax Description

source	DNS name or the IP address of the multicast-capable source. This is a unicast address of the beginning of the path to be traced.
destination	(Optional) DNS name or address of the unicast destination. If omitted, the mtrace starts from the system at which the command is typed.
group	(Optional) DNS name or multicast address of the group to be traced. Default address is 224.2.0.1 (the group used for MBONE Audio). When address 0.0.0.0 is used, the software invokes a weak mtrace. A weak mtrace is one that follows the RPF path to the source, regardless of whether any router along the path has multicast routing table state.

Command Modes

User EXEC

Command History

Release	Modification
11.0	This command was introduced.

Usage Guidelines

The trace request generated by the mtrace command is multicast to the multicast group to find the last hop router to the specified destination. The trace then follows the multicast path from destination to source by passing the mtrace request packet via unicast to each hop. Responses are unicast to the querying router by the first hop router to the source. This command allows you to isolate multicast routing failures.

If no arguments are entered, the router will interactively prompt you for them.

This command is identical in function to the UNIX version of mtrace.

Examples

The following is sample output from the mtrace command:

Router# mtrace 171.69.215.41 171.69.215.67 239.254.254.254
 
Type escape sequence to abort.
Mtrace from 171.69.215.41 to 171.69.215.67 via group 239.254.254.254
From source (?) to destination (?)
Querying full reverse path... 
 0  171.69.215.67
-1  171.69.215.67 PIM  thresh^ 0  0 ms  
-2  171.69.215.74 PIM  thresh^ 0  2 ms  
-3  171.69.215.57 PIM  thresh^ 0  894 ms  
-4  171.69.215.41 PIM  thresh^ 0  893 ms  
-5  171.69.215.12 PIM  thresh^ 0  894 ms  
-6  171.69.215.98 PIM  thresh^ 0  893 ms 
 

Related Commands

Command	Description
mstat	Displays IP multicast packet rate and loss information.

To restore the default values, use the no form of the command.

Syntax Description

access-list name | access-list number	IP named or numbered access list that establishes who the Test Receivers are. Only these Test Receivers are subject to the other keywords and arguments specified in this command.
sender-list access-list name | access-list number	(Optional) Specifies the sources that the Test Receiver should monitor. If the access list matches any access list specified in the senders command, the associated packet-delay milliseconds keyword and argument of that senders command is used in this command. Otherwise, packet-delay is required in this receivers command.
packet-delay	(Optional) Specifies the delay between test packets (in milliseconds). If the sender-list access list matches any access list specified in the senders command, the associated packet-delay milliseconds keyword and argument of that senders command is used in this command. Otherwise, the packet-delay argument is required in this receivers command.
window seconds	(Optional) Duration (in seconds) of a test period. This is a sliding window of time in which packet count is collected, so that the loss percentage can be calculated. Default is 5 seconds.
report-delay seconds	(Optional) Delay (in seconds) between staggered status reports from multiple Test Receivers to the Manager. The delay prevents multiple receivers from sending status reports to the Manager at the same time for the same failure. Receiver 1 sends status, seconds later Receiver 2 sends status, seconds later Receiver 3 sends status, and so on. This value is relevant only if there are multiple Test Receivers. The default is 1 second.
loss percentage	(Optional) Threshold percentage of packet loss required before a status report is triggered. The default is 0%, which means that a status report is sent for any packet loss. (This value is not applied to packet duplication; a fault report is sent for any duplicated packets.) Loss percentage calculation is explained in the "Usage Guidelines" section of this command.
no-join	(Optional) Specifies that the Test Receiver does not join the monitored group. The default is that the Test Receiver joins the monitored group.
monitor | poll	(Optional) Specifies whether the Test Receiver monitors the test group or polls for receiver statistics. The monitor keyword means the Test Receiver reports only if the test criteria are met. Poll means the Test Receiver sends status reports regularly, whether test criteria are met or not. The default is the monitor keyword.

Defaults

window seconds is 5 seconds

report-delay seconds is 1 second

loss percentage is 0 percent

monitor

Command Modes

Manager configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

This command is required for the Multicast Routing Monitor feature to work; the receivers keyword and the first access list must be specified. The rest of the command is optional.

Loss percentage is calculated based on the packet-delay value of the senders command, which defaults to 200 milliseconds, or 5 packets per second. If the window keyword defaults to 5 seconds, then the Test Receiver expects 5 packets per second for 5 seconds = 25 packets. If the Test Receiver receives only 15 packets, then 25 - 15 = 10 lost packets. Lost packets divided by packets expected equals loss percentage. 10/25 equals a loss percentage of 40 percent.

Examples

In the following example, test2 has the proxy-sender address 10.1.1.10, and the corresponding receiver command has an explicit packet delay configured to match the default packet delay of the sender:

ip mrm manager test1
 manager e4/0/1 group 239.1.1.1
 senders 1
 receivers 2 sender-list 1
ip mrm manager test2
 manager e4/0/1 group 239.1.1.1
 senders 1 10.1.1.10
 receivers 2 sender-list 3  200
 udp-port test-packet 16386 status-report 65533
!
access-list 1 permit 10.1.1.2
access-list 2 permit 10.1.4.2
access-list 3 permit 10.1.1.10

Related Commands

Command	Description
senders	Configures Test Sender parameters used in MRM.

Syntax Description

access-list name | access-list number	IP named or numbered access list that defines which Test Senders are involved in the test and which Test Senders these parameters apply to.
packet-delay milliseconds	(Optional) Specifies the delay between test packets (in milliseconds). The default is 200 milliseconds, which results in 5 packets per second.
rtp | udp	(Optional) Encapsulation of test packets, either RTP-encapsulated or UDP-encapsulated. The default is RTP-encapsulated.
target-only	(Optional) Specifies that test packets are sent out on the targeted interface only (that is, the interface with the IP address that is specified in the Test Sender request target field). By default, test packets are sent as described in the all-multicasts keyword.
all-multicasts	(Optional) Specifies that the test packets are sent out on all interfaces that are enabled with IP multicast. This is the default way that test packets are sent.
all-test-senders	(Optional) Specifies that test packets are sent out on all interfaces that have test-sender mode enabled. By default, test packets are sent as described in the all-multicasts keyword.
proxy_src	(Optional) Source IP address for which the Test Sender will proxy test packets. Use this if you want to test, for a specific source, whether the multicast distribution tree is working.

Defaults

packet-delay milliseconds is 200 milliseconds (that is, 5 packets per second)

rtp

all-multicasts

Command Modes

Manager configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Use this command to specify which Test Senders are involved in the test and are affected by these parameters.

Examples

In the following example, test2 has the proxy-sender address 10.1.1.10, and the corresponding receivers command has an explicit packet delay configured to match the default packet delay of the sender:

ip mrm manager test1
 manager e4/0/1 group 239.1.1.1
 senders 1
 receivers 2 sender-list 1
ip mrm manager test2
 manager e4/0/1 group 239.1.1.1
 senders 1 10.1.1.10
 receivers 2 sender-list 3  200
 udp-port test-packet 16386 status-report 65533
!
access-list 1 permit 10.1.1.2
access-list 2 permit 10.1.4.2
access-list 3 permit 10.1.1.10

Related Commands

Command	Description
receivers	Configures the following: (1) establishes Test Receivers for MRM; (2) specifies which Test Senders the Test Receivers will listen to; (3) specifies which sources the Test Receivers monitor; (4) specifies the packet delay; or (5) changes Test Receiver parameters.

Syntax Description

interface-unit

(Optional) Interface about which to display Test Sender or Test Receiver information. If no interface is specified, information about all Test Senders and Test Receivers is displayed.

Command Modes

EXEC

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Use this command to see which interfaces are participating in MRM in which roles, and whether the interfaces are up or down.

Examples

The following example is sample output for the show ip mrm interface command:

Router# show ip mrm interface
 
Interface           Address          Mode                  Status
Ethernet0           1.1.1.1          Test-Sender           Up
Ethernet1           2.2.2.2          Test-Receiver         Up

Related Commands

Command	Description
ip mrm	Configures an interface to operate as a Test Sender or Test Receiver, or both, for MRM.

Syntax Description

test-name

(Optional) Name of the MRM test (as specified in the ip mrm manager command) for which to display information. If no name is specified, information about all Managers is displayed.

Command Modes

EXEC

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Use this command to see information about the Manager.

Examples

The following example is sample output for the show ip mrm manager command executed at two different times:

Router# show ip mrm manager test
 
Manager:test/1.1.1.1 is running, expire:1d00h
  Beacon interval/holdtime/ttl:60/86400/32
  Group:239.1.2.3, UDP port test-packet/status-report:16384/65535
  Test senders: 
    2.2.2.2          /Ack
  Test receivers: 
    3.3.3.3          /Ack
 
Router# show ip mrm manager test
 
Manager:test/1.1.1.1 is not running
  Beacon interval/holdtime/ttl:60/86400/32
  Group:239.1.2.3, UDP port test-packet/status-report:16384/65535
  Test senders: 
    2.2.2.2
  Test receivers: 
    3.3.3.3

Related Commands

Command	Description
ip mrm manager	Identifies an MRM test and enters the mode in which you specify the test parameters.
manager	Specifies that an interface is the Manager for MRM, and specifies the multicast group address the Test Receiver will listen to.

Syntax Description

ip-address

(Optional) Displays information received from this IP address only. If no address is specified, all status reports in the cache buffer are displayed.

Command Modes

EXEC

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Use this command during your MRM test period to see if any errors are reported. The Manager immediately displays error reports and sends error reports, if any, to the circular cache buffer. The buffer holds up to 1024 lines, with one line for each error report.

No errors reported indicates that the Test Receiver is receiving test packets without loss or duplicates from the Test Sender.

Examples

The following example is sample output for the show ip mrm status-report command:

Router# show ip mrm status-report
 
IP MRM status report cache:
Timestamp        Manager         Test Receiver   Pkt Loss/Dup (%)      Ehsr
*Apr 20 07:36:08 1.1.1.1         3.3.3.3         5            (20%)    0
*Apr 20 07:36:09 1.1.1.1         3.3.3.3         10           (40%)    0
*Apr 20 07:36:10 1.1.1.1         3.3.3.3         15           (60%)    0

Related Commands

Command	Description
clear ip mrm status-report	Clears the status report cache buffer.

Syntax Description

test-packet port-number	(Optional) UDP port number to which test packets are sent by a Test Sender. The port number must be even if the packets are RTP-encapsulated. The default port number is 16384.
status-report port-number	(Optional) UDP port number to which status reports are sent by a Test Receiver. The port number must be odd if the packets are RTCP-encapsulated. The default port number is 65535.

Defaults

test-packet port-number is 16384, the minimum value of an audio port.

status-report port-number is 65535, the maximum value of a video port.

Command Modes

Manager configuration

Command History

Release	Modification
12.0(5)S	This command was introduced.

Usage Guidelines

Change the default values if you want to listen to a different port.

Examples

The following example changes the UDP port number to which test packets are targeted to 20000:

udp-port test-packet 20000

Related Commands

Command	Description
ip mrm	Configures an interface to operate as a Test Sender or Test Receiver, or both, for MRM.