Cisco IOS IP Command Reference, Volume 3 of 3: Multicast, Release 12.2
- Updated:
- February 12, 2014
Chapter: IP Multicast Tools Commands
IP Multicast Tools Commands
Use the commands in this chapter to configure and use IP multicast tools such as Multicast Routing Monitor (MRM), mrinfo, mstat, and mtrace. For configuration information and examples of IP multicast tools, refer to the "Using IP Multicast Tools" chapter of the Cisco IOS IP Configuration Guide.
beacon
To change the frequency, duration, or scope of beacon messages that the Manager sends to Test Senders and Test Receivers during a Multicast Routing Monitor (MRM) test, use the beacon command in MRM manager configuration mode. To restore the default settings, use the no form of this command.
beacon [interval seconds] [holdtime seconds] [ttl ttl-value]
no beacon [interval seconds] [holdtime seconds] [ttl ttl-value]
Syntax Description
Command Default
Beacon messages are sent at an interval of 60 seconds. The duration of a test period is 86400 seconds (1 day). The TTL for beacon messages is 32 hops.
Command Modes
MRM manager configuration
Command History
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.
Examples
The following example shows how to customize the Manager to send beacon messages every 30 minutes (1800 seconds), for a test period of 12 hours (43,200 seconds), with a TTL of 40 hops:
ip mrm manager test
beacon interval 1800 holdtime 43200 ttl 40
Related Commands
|
|
|
|---|---|
manager |
Specifies that an interface is the Manager for MRM, and specifies the multicast group address the Test Receiver will listen to. |
clear ip mrm status-report
To clear the Multicast Routing Monitor (MRM) status report cache, use the clear ip mrm status-report command in privileged EXEC mode.
clear ip mrm status-report [ip-address]
Syntax Description
ip-address |
(Optional) IP address of the Test Receiver for which to clear status reports from the MRM status report cache. |
Command Default
If no IP address is specified for the optional ip-address argument, all status reports are cleared from the MRM status report cache.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the clear ip mrm status-report command to clear the MRM status report cache.
Use the clear ip mrm status-report command with the ip-address argument to clear only the status reports sent by the Test Receiver at the specified IP address. If no IP address is specified for the optional ip-address argument, all status reports are cleared from the MRM status report cache.
Use the show ip mrm status-report to display the status reports in the MRM status report cache.
Examples
The following example shows how to clear status reports sent by a specific Test Receiver from the MRM status report cache. In this example, the status reports sent by the Test Receiver at 172.16.0.0 are cleared from the MRM status report cache.
Router# clear ip mrm status-report 172.16.0.0
Related Commands
|
|
|
|---|---|
show ip mrm status-report |
Displays the status reports in the MRM status report cache. |
ip mrm
To configure an interface to operate as a Test Sender or Test Receiver, or both, for Multicast Routing Monitor (MRM), use the ip mrm command in interface configuration mode. To remove the interface as a Test Sender or Test Receiver, use the no form of this command.
ip mrm {test-sender | test-receiver | test-sender-receiver}
no ip mrm
Syntax Description
Command Default
No interface is configured to operate as a Test Sender or a Test Receiver, or both, for MRM.
Command Modes
Interface configuration
Command History
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, however, cannot be the Test Sender and Test Receiver for the same group.
Examples
The following example shows how to configure an interface to operate as a Test Sender. In this example, Ethernet interface 0 is configured to operate as a Test Sender.
interface ethernet 0 ip mrm test-sender
Related Commands
|
|
|
|---|---|
receivers |
Establishes Test Receivers for MRM. |
senders |
Establishes Test Senders for MRM. |
ip mrm accept-manager
To configure a Test Sender or Test Receiver to accept requests only from Managers that pass an access list, use the ip mrm accept-manager command in global configuration mode. To remove the restriction, use the no form of this command.
ip mrm accept-manager access-list [test-sender | test-receiver]
no ip mrm accept-manager access-list
Syntax Description
Command Default
Test Senders and Test Receivers respond to all Managers.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to control which Managers a Test Sender or Test Receiver must respond to.
If neither the test-sender nor test-receiver keyword is configured, the access list applies to both.
Examples
The following example shows how to configure a Test Sender to respond only to Managers that pass an access list. In this example, the Test Sender is configured to respond only to the Managers that passed the ACL named supervisor.
ip mrm accept-manager supervisor
!
ip access-list standard supervisor
remark Permit only the Manager from the Central Office
permit 172.18.2.4
!
Related Commands
|
|
|
|---|---|
ip mrm |
Configures an interface to operate as a Test Sender or Test Receiver, or both, for MRM. |
ip mrm manager
To specify the Multicast Routing Monitor (MRM) test to be created or modified and enter MRM manager configuration mode, use the ip mrm manager command in global configuration mode. To remove the test, use the no form of this command.
ip mrm manager test-name
no ip mrm manager test-name
Syntax Description
test-name |
Name of the MRM test to be created or modified. |
Command Default
No MRM tests are configured.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the ip mrm manager command to specify the name of the MRM test to be created or modified and enter MRM manager configuration mode where you specify the parameters of the MRM test.
Examples
The following example shows how to enter MRM manager configuration mode for the MRM test named test1:
Router(config)# ip mrm manager test1
Router(config-mrm-manager)#
Related Commands
|
|
|
|---|---|
mrm |
Starts or stops an MRM test. |
show ip mrm manager |
Displays test information for MRM. |
manager
To specify that an interface is the Manager for Multicast Routing Monitor (MRM), and to specify the multicast group address the Test Receiver will listen to, use the manager command in MRM manager configuration mode. To remove the Manager or group address, use the no form of this command.
manager interface-type interface-number group ip-address
no manager interface-type interface-number group ip-address
Syntax Description
Defaults
There is no MRM Manager.
Command Modes
MRM manager configuration
Command History
Usage Guidelines
This command identifies the interface that acts as the Manager, and therefore is required in order to run MRM.
Examples
The following example shows how to configure Ethernet interface 0 as the Manager and 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
mrinfo
To query which neighboring multicast routers are "peering" with the local router, use the mrinfo command in EXEC mode.
mrinfo [host-name | host-address] [source-address | interface]
Syntax Description
Command Modes
EXEC
Command History
|
|
|
|---|---|
11.0 |
This command was introduced. |
Usage Guidelines
The mrinfo command is the original tool of the multicast backbone (MBONE) to determine which neighboring multicast routers are peering with a multicast router. Cisco routers have supported responding to mrinfo requests since Cisco IOS Release 10.2.
Now you can query a multicast router using this command. The output format is identical to the mrouted version of Distance Vector Multicast Routing Protocol (DVMRP). (The mrouted software is the UNIX software that implements DVMRP.)
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
mrm
To start or stop a Multicast Routing Monitor (MRM) test, use the mrm command in privileged EXEC mode.
mrm test-name {start | stop}
Syntax Description
test-name |
Name of the MRM test to start or stop. |
start |
Starts the MRM test specified for the test-name argument. |
stop |
Stops the MRM test specified for the test-name argument. |
Command Modes
Privileged EXEC
Command History
Usage Guidelines
You must use this command to run an MRM test. When the test runs, the Test Sender sends User Datagram Protocol (UDP) or UDP/Real-Time Transport Protocol (RTP) packets (depending on the senders command) to the Test Receiver.
Examples
The following example shows how to start an MRM test. In this example, the MRM test named test1 is started.
Router# mrm test1 start
Related Commands
mstat
To display IP multicast packet rate and loss information, use the mstat command in user EXEC mode.
mstat {source-name | source-address} [destination-name | destination-address] [group-name | group-address]
Syntax Description
Command Modes
User EXEC
Command History
|
|
|
|---|---|
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
Table 32 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
Traces the path from a source to a destination branch for a multicast distribution tree. |
mtrace
To trace the path from a source to a destination branch for a multicast distribution tree, use the mtrace user command in EXEC mode.
mtrace {source-name | source-address} [destination-name | destination-address] [group-name | group-address]
Syntax Description
Command Modes
User EXEC
Command History
|
|
|
|---|---|
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
Table 33 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
Displays IP multicast packet rate and loss information. |
receivers
To establish Test Receivers for Multicast Routing Monitor (MRM) tests or modify the parameters of Test Receivers, use the receivers command in MRM manager configuration mode. To restore the default values, use the no form of this command.
Form of the Command to Establish Test Receivers
receivers access-list sender-list access-list [packet-delay]
no receivers access-list
Form of the Command to Modify the Parameters of Test Receivers
receivers access-list [window seconds] [report-delay seconds] [loss percentage] [no-join] [monitor | poll]
no receivers access-list
Syntax Description
Command Default
No Test Receivers are configured for MRM tests.
Command Modes
MRM manager configuration
Command History
Usage Guidelines
This command is required for MRM to work; the receivers access-list and sender-list access-list keyword-argument pairs must be specified.
Note The Cisco IOS CLI parser accepts the command entered without the required sender-list access-list keyword-argument pair. This keyword-argument pair, however, is not optional. For an MRM test to work, you must specify the sources that the Test Receiver should monitor using the sender-list keyword and access-list argument.
Optionally, you can use the receivers command to modify the parameters for Test Receivers.
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
The following example shows how to establish a Test Receiver for an MRM test:
ip mrm manager test1
manager Ethernet0/0 group 239.1.1.1
senders 1
receivers 2 sender-list 1
!
access-list 1 permit 10.1.1.2
access-list 2 permit 10.1.4.2
!
Related Commands
|
|
|
|---|---|
senders |
Establishes Test Senders for MRM. |
senders
To configure Test Sender parameters used for a Multicast Routing Monitor (MRM) test, use the senders command in MRM manager configuration mode. To restore the default settings, use the no form of this command.
senders access-list [packet-delay milliseconds] [rtp | udp] [target-only | all-multicasts | all-test-senders] [proxy-src]
no senders access-list
Syntax Description
Command Default
No test senders are configured to be involved in MRM tests.
Command Modes
MRM manager configuration
Command History
Usage Guidelines
Use this command to specify which Test Senders are involved in the test and are affected by these parameters.
Examples
The following example shows how to configure a Test Sender for an MRM test:
ip mrm manager test1
manager Ethernet0/0 group 239.1.1.1
senders 1
receivers 2 sender-list 1
!
access-list 1 permit 10.1.1.2
access-list 2 permit 10.1.4.2
Related Commands
|
|
|
|---|---|
receivers |
Establishes Test Receivers for MRM. |
show ip mrm interface
To display Multicast Routing Monitor (MRM) information related to interfaces, use the show ip mrm interface command in user EXEC or privileged EXEC mode.
show ip mrm interface [type number]
Syntax Description
type number |
(Optional) Interface type and number for which to display MRM interface information. |
Command Default
If no interface is specified for the type and number arguments, information about all interfaces participating in MRM is displayed.
Command Modes
User EXEC
Privileged EXEC
Command History
Usage Guidelines
Use this command to display which interfaces are participating in MRM, in which roles, and whether the interfaces are up or down.
Examples
The following is sample output from the show ip mrm interface command:
Router# show ip mrm interface
Interface Address Mode Status
Ethernet0 10.0.0.1 Test-Sender Up
Ethernet1 10.0.0.10 Test-Receiver Up
Table 34 describes the fields shown in the display.
Related Commands
|
|
|
|---|---|
ip mrm |
Configures an interface to operate as a Test Sender or Test Receiver, or both, for MRM. |
show ip mrm manager
To display information about a Multicast Routing Monitor (MRM) test, use the show ip mrm manager command in user EXEC or privileged EXEC mode.
show ip mrm manager [test-name]
Syntax Description
test-name |
(Optional) Name of the MRM test for which to display information. |
Command Default
If no test name is specified for the test-name argument, information about all Managers is displayed.
Command Modes
User EXEC
Privileged EXEC
Command History
Usage Guidelines
Use this command to display status information and the parameters configured for an MRM test.
Examples
The following is sample output from the show ip mrm manager command executed at two different times:
Router# show ip mrm manager test
Manager:test/10.0.0.0 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:
10.0.0.1 /Ack
Test receivers:
10.0.0.2 /Ack
Router# show ip mrm manager test
Manager:test/10.0.0.0 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:
10.0.0.1
Test receivers:
10.0.0.2
Table 35 describes the fields shown in the display.
Related Commands
show ip mrm status-report
To display the status reports in the Multicast Routing Monitor (MRM) status report cache, use the show ip mrm status-report command in user EXEC or privileged EXEC mode.
show ip mrm status-report [ip-address]
Syntax Description
ip-address |
(Optional) IP address of a Test Receiver for which to display status reports. |
Command Default
If no IP address is specified for the optional ip-address argument, all status reports in the MRM status report cache are displayed.
Command Modes
User EXEC
Privileged EXEC
Command History
Usage Guidelines
Use the show ip mrm status-report command during your MRM test period to learn if any errors are reported. The Manager immediately displays error reports and sends error reports, if any, to the circular status report cache. The cache 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.
Use the show ip mrm status-report command with the optional ip-address argument to restrict the output to display only status reports sent by the Test Receiver at the specified IP address. If no IP address is specified for the optional ip-address argument, all status reports in the MRM status report cache are displayed.
Use the clear ip mrm status-report command to clear the MRM status report cache.
Examples
The following is sample output from 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 10.0.0.0 10.0.0.1 5 (20%) 0
*Apr 20 07:36:09 10.0.0.0 10.0.0.1 10 (40%) 0
*Apr 20 07:36:10 10.0.0.0 10.0.0.1 15 (60%) 0
Table 36 describes the fields shown in the display.
Related Commands
|
|
|
|---|---|
clear ip mrm status-report |
Clears the MRM status report cache. |
udp-port
To change the User Datagram Protocol (UDP) port numbers to which a Test Sender sends test packets or a Test Receiver sends status reports during Multicast Routing Monitor (MRM) tests, use the udp-port command in MRM manager configuration mode. To restore the default settings, use the no form of this command.
udp-port [test-packet port-number] [status-report port-number]
no udp-port
Syntax Description
Command Default
Test Senders use UDP port number 16834 to send test packets, and Test Receivers use UDP port number 65535 to send status reports.
Command Modes
MRM manager configuration
Command History
Examples
The following example shows how to change the UDP port to which test packets are sent by a Test Sender to UDP port number 20302:
ip mrm manager test
udp-port test-packet 20302
Related Commands
|
|
|
|---|---|
ip mrm |
Configures an interface to operate as a Test Sender or Test Receiver, or both, for MRM. |
Feedback