Cisco IOS IP Command Reference, Volume 3 of 4: Multicast, Release 12.3 T
IP Multicast Commands: ip cgmp through ip multicast rate-limit

Table Of Contents

ip cgmp

ip domain multicast

ip dvmrp accept-filter

ip dvmrp auto-summary

ip dvmrp default-information

ip dvmrp metric

ip dvmrp metric-offset

ip dvmrp output-report-delay

ip dvmrp reject-non-pruners

ip dvmrp routehog-notification

ip dvmrp route-limit

ip dvmrp summary-address

ip dvmrp unicast-routing

ip igmp access-group

ip igmp explicit-tracking

ip igmp helper-address

ip igmp helper-address (UDL)

ip igmp immediate-leave

ip igmp join-group

ip igmp last-member-query-count

ip igmp last-member-query-interval

ip igmp limit (global)

ip igmp limit (interface)

ip igmp mroute-proxy

ip igmp proxy-service

ip igmp query-interval

ip igmp query-max-response-time

ip igmp query-timeout

ip igmp snooping

ip igmp snooping vlan

ip igmp snooping vlan immediate-leave

ip igmp snooping vlan mrouter

ip igmp snooping vlan static

ip igmp ssm-map enable

ip igmp ssm-map query dns

ip igmp ssm-map static

ip igmp static-group

ip igmp unidirectional-link

ip igmp v3lite

ip igmp version

ip mrm

ip mrm accept-manager

ip mrm manager

ip mroute

ip mroute-cache

ip msdp border

ip msdp cache-rejected-sa

ip msdp cache-sa-state

ip msdp default-peer

ip msdp description

ip msdp filter-sa-request

ip msdp mesh-group

ip msdp originator-id

ip msdp peer

ip msdp redistribute

ip msdp rpf rfc3618

ip msdp sa-filter in

ip msdp sa-filter out

ip msdp sa-limit

ip msdp sa-request

ip msdp shutdown

ip msdp ttl-threshold

ip multicast boundary

ip multicast cache-headers

ip multicast default-rpf-distance

ip multicast heartbeat

ip multicast helper-map

ip multicast limit

ip multicast mrinfo-filter

ip multicast multipath

ip multicast rate-limit


ip cgmp

To enable Cisco Group Management Protocol (CGMP) on an interface of a router connected to a Cisco Catalyst 5000 family switch, use the ip cgmp command in interface configuration mode. To disable CGMP routing, use the no form of this command.

ip cgmp [proxy | router-only]

no ip cgmp

Syntax Description

proxy

(Optional) Enables CGMP and the CGMP proxy function.

router-only

(Optional) Enables the router to send only CGMP self-join and CGMP self-leave messages.


Defaults

CGMP is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

11.1

This command was introduced.

12.2

The router-only keyword was added.


Usage Guidelines

When enabled on an interface, this command triggers a CGMP join message. This command should be used only on 802 media (that is, Ethernet, FDDI, or Token Ring) or ATM. When a no ip cgmp command is issued, a triggered CGMP leave message is sent for the MAC address on the interface for group 0000.0000.0000 (all groups). CGMP can run on an interface only if Protocol Independent Multicast (PIM) is configured on the same interface.

A Cisco router will send CGMP join messages in response to receiving Internet Group Management Protocol (IGMP) reports from IGMP-capable members. Only the CGMP querier Cisco router sends these CGMP join messages on behalf of hosts.

The ip cgmp router-only command enables the routers in a VLAN to send only CGMP self-join and CGMP self-leave messages—no other types of CGMP messages will be sent. This feature allows other CGMP-capable routers to learn about multicast router ports. If the ip cgmp router-only command is not available on any of the external routers in the network, the ip cgmp command can be used instead. Issuing the ip cgmp command on a router enables that router to send CGMP self-join and CGMP self-leave messages as well as other types of CGMP messages.

When the proxy keyword is specified, the CGMP proxy function is also enabled. That is, any router that is not CGMP-capable will be advertised by the proxy router. The proxy router advertises the existence of other non-CGMP-capable routers by sending a CGMP join message with the MAC address of the non-CGMP-capable router and a group address of 0000.0000.0000.

Initially supported is Distance Vector Multicast Routing Protocol (DVMRP) proxying. If a DVMRP report is received from a router that is not a PIM router, a Cisco IGMP querier will advertise the MAC address of the DVMRP router in a CGMP join message with the group address 0000.0000.0000.

To perform CGMP proxy, a Cisco router must be the IGMP querier. If you configure the ip cgmp proxy command, you must manipulate the IP addresses so that a Cisco router will be the IGMP querier, which might be the highest or lowest IP address, depending on which version of IGMP is being run on the network. An IGMP Version 2 querier is selected based on the lowest IP addressed router on the interface. An IGMP Version 1 querier is selected based on the multicast routing protocol used on the interface.

When multiple Cisco routers are connected to a switched network and the ip cgmp proxy command is needed, we recommend that all routers be configured in the following manner:

With the same CGMP option.

To have precedence of becoming IGMP querier over non-Cisco routers.

Examples

The following example enables CGMP:

ip cgmp

The following example enables CGMP and CGMP proxy:

ip cgmp proxy

ip domain multicast

To change the domain prefix used by Cisco IOS for Domain Name Service (DNS)-based Source Specific Multicast (SSM) mapping, use the ip domain multicast command in global configuration mode. To revert to the default domain prefix, use the no form of this command.

ip domain multicast [vrf vrf-name] domain-prefix

no domain multicast [vrf vrf-name] domain-prefix

Syntax Description

vrf

(Optional) Supports the multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

domain-prefix

Name of the domain prefix to be used for DNS-based SSM mapping. The default is in-addr.arpa.


Defaults

domain-prefix: in-addr.arpa

Command Modes

Global configuration

Command History

Release
Modification

12.3(2)T

This command was introduced.


Usage Guidelines

Use this command to change the domain prefix used by Cisco IOS software when DNS-based SSM mapping is configured. When a router attempts DNS-based SSM mapping for an IP group address G = G1.G2.G3.G4, the router queries the domain name server for IP address resource records ("IP A" RRs) for the domain "G4.G3.G2.G1 domain-prefix".

Use the vrf vrf-name keyword and argument to enable SSM mapping for a particular VRF.

Examples

The following example shows how to change the domain prefix used for DNS-based SSM mapping to ssm-map.cisco.com:

ip domain multicast ssm-map.cisco.com

The following example shows how to change the domain prefix used for DNS-based SSM mapping to ssm-map.cisco.com or a VRF named vrf1:

ip domain multicast vrf vrf1 ssm-map.cisco.com

Related Commands

Command
Description

ip igmp ssm-map enable

Enables SSM mapping for groups in a configured SSM range.

ip name-server

Specifies the address of one or more name servers to use for name and address resolution.


ip dvmrp accept-filter

To configure an acceptance filter for incoming Distance Vector Multicast Routing Protocol (DVMRP) reports, use the ip dvmrp accept-filter command in interface configuration mode. To disable this filter, use the no form of this command.

ip dvmrp accept-filter access-list [distance | neighbor-list access-list]

no ip dvmrp accept-filter access-list [distance | neighbor-list access-list]

Syntax Description

access-list

Access list number or name. A value of 0 means that all sources are accepted with the configured distance.

distance

(Optional) Administrative distance to the destination.

neighbor-list access-list

(Optional) Number of a neighbor list. DVMRP reports are accepted only by those neighbors on the list.


Defaults

All destination reports are accepted with a distance of 0. Default settings accept reports from all neighbors.

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.

11.2

The neighbor-list keyword and access-list-number argument were added.


Usage Guidelines

Any sources that match the access list are stored in the DVMRP routing table with the distance argument.

The distance value is used to compare with the same source in the unicast routing table. The route with the lower distance (either the route in the unicast routing table or that in the DVMRP routing table) takes precedence when computing the Reverse Path Forwarding (RPF) interface for a source of a multicast packet.

By default, the administrative distance for DVMRP routes is 0, which means that they always take precedence over unicast routing table routes. If you have two paths to a source, one through unicast routing (using Protocol Independent Multicast [PIM] as the multicast routing protocol) and another path using DVMRP (unicast and multicast routing), and if you want to use the PIM path, use the ip dvmrp accept-filter command to increase the administrative distance for DVMRP routes.

Examples

The following example shows how to apply an access list such that the RPF interface used to accept multicast packets will be through an Enhanced Interior Gateway Routing Protocol (IGRP)/PIM path. The Enhanced IGRP unicast routing protocol has a default administrative distance of 90.

 ip dvmrp accept-filter 1 100
 access-list 1 permit 0.0.0.0 255.255.255.255

The following example applies access list 57 to the interface and sets a distance of 4:

access-list 57 permit 172.16.0.0 0.0.255.255
access-list 57 permit 192.168.0.0 0.0.0.255
access-list 57 deny 10.0.0.0 255.255.255.255
 ip dvmrp accept-filter 57 4

Related Commands

Command
Description

distance (IP)

Defines an administrative distance.

ip dvmrp metric

Configures the metric associated with a set of destinations for DVMRP reports.

show ip dvmrp route

Displays the contents of the DVMRP routing table.

tunnel mode

Sets the encapsulation mode for the tunnel interface.


ip dvmrp auto-summary

To enable Distance Vector Multicast Routing Protocol (DVMRP) automatic summarization if it was disabled, use the ip dvmrp auto-summary command in interface configuration mode. To disable the feature, use the no form of this command.

ip dvmrp auto-summary

no ip dvmrp auto-summary

Syntax Description

This command has no arguments or keywords.

Defaults

DVMRP automatic summarization is enabled.

Command Modes

Interface configuration

Command History

Release
Modification

11.2

This command was introduced.


Usage Guidelines

DVMRP automatic summarization occurs when a unicast subnet route is collapsed into a classful network number route. This situation occurs when the subnet is a different network number than the IP address of the interface (or tunnel) over which the advertisement is sent. If the interface is unnumbered, the network number of the numbered interface the unnumbered interface points to is compared to the subnet.

Disable this feature if the information you want to send using the ip dvmrp summary-address command is the same as the information that would be sent using DVMRP automatic summarization.

Examples

The following example disables DVMRP automatic summarization:

no ip dvmrp auto-summary

Related Commands

Command
Description

ip dvmrp summary-address

Configures a DVMRP summary address to be advertised out the interface.


ip dvmrp default-information

To advertise network 0.0.0.0 to Distance Vector Multicast Routing Protocol (DVMRP) neighbors on an interface, use the ip dvmrp default-information command in interface configuration mode. To prevent the advertisement, use the no form of this command.

ip dvmrp default-information {originate | only}

no ip dvmrp default-information {originate | only}

Syntax Description

originate

Specifies that other routes more specific than 0.0.0.0 may be advertised.

only

Specifies that no DVMRP routes other than 0.0.0.0 are advertised.


Defaults

Network 0.0.0.0 is not advertised to DVMRP neighbors on an interface.

Command Modes

Interface configuration

Command History

Release
Modification

10.3

This command was introduced.


Usage Guidelines

This command should be used only when the router is a neighbor to mrouted version 3.6 devices. The mrouted protocol is a public domain implementation of DVMRP.

You can use the ip dvmrp metric command with the ip dvmrp default-information command to tailor the metric used when advertising the default route 0.0.0.0. By default, metric 1 is used.

Examples

The following example configures the Cisco IOS software to advertise network 0.0.0.0, in addition to other networks, to DVMRP neighbors:

ip dvmrp default-information originate

Related Commands

Command
Description

ip dvmrp metric

Configures the metric associated with a set of destinations for DVMRP reports.


ip dvmrp metric

To configure the metric associated with a set of destinations for Distance Vector Multicast Routing Protocol (DVMRP) reports, use the ip dvmrp metric command in interface configuration mode. To disable this function, use the no form of this command.

ip dvmrp metric metric [route-map map-name] [mbgp] [mobile] [list access-list-number] [protocol process-id] | dvmrp]

no ip dvmrp metric metric [route-map map-name] [mbgp] [mobile] [list access-list-number] [protocol process-id] | dvmrp]

Syntax Description

metric

Metric associated with a set of destinations for DVMRP reports. It can be a value from 0 to 32. A value of 0 means that the route is not advertised. A value of 32 is equivalent to infinity (unreachable).

route-map map-name

(Optional) Names a route map. If you specify this keyword and argument, only the destinations that match the route map are reported with the configured metric. Unicast routes are subject to route map conditions before being injected into DVMRP. Route maps cannot be used for DVMRP routes.

mbgp

(Optional) Configures redistribution of only IP version 4 (IPv4) multicast routes into DVMRP.

mobile

(Optional) Configures redistribution of only mobile routes into DVMRP.

list access-list-number

(Optional) Names an access list. If you specify this keyword and argument, only the multicast destinations that match the access list are reported with the configured metric. Any destinations not advertised because of split horizon do not use the configured metric.

protocol

(Optional) Name of a unicast routing protocol. Available protocols are: bgp, dvmrp, eigrp, isis, mobile, odr, ospf, rip, or static.

If you specify these values, only routes learned by the specified routing protocol are advertised in DVMRP report messages.

process-id

(Optional) Process ID number of the unicast routing protocol.

dvmrp

(Optional) Allows routes from the DVMRP routing table to be advertised with the configured metric value, or filtered.


Defaults

No metric value is preconfigured. Only directly connected subnets and networks are advertised to neighboring DVMRP routers.

Command Modes

Interface configuration

Command History

Release
Modification

10.2

This command was introduced.

11.1

The route-map keyword was added.

11.1(20)CC

This mbgp keyword was added.

12.0(7)T

This mbgp keyword was added.


Usage Guidelines

When Protocol Independent Multicast (PIM) is configured on an interface and DVMRP neighbors are discovered, the Cisco IOS software sends DVMRP report messages for directly connected networks. The ip dvmrp metric command enables DVMRP report messages for multicast destinations that match the access list. Usually, the metric for these routes is 1. Under certain circumstances, you might want to tailor the metric used for various unicast routes. This command lets you configure the metric associated with a set of destinations for report messages sent out this interface.

You can use the access-list-number argument in conjunction with the protocol and process-id arguments to selectively list the destinations learned from a given routing protocol.

To display DVMRP activity, use the debug ip dvmrp command.

Examples

The following example connects a PIM cloud to a DVMRP cloud. Access list 1 permits the sending of DVMRP reports to the DVMRP routers advertising all sources in the 172.16.35.0 network with a metric of 1. Access list 2 permits all other destinations, but the metric of 0 means that no DVMRP reports are sent for these destinations.

access-list 1 permit 172.16.35.0 0.0.0.255
access-list 1 deny 0.0.0.0 255.255.255.255
access-list 2 permit 0.0.0.0 255.255.255.255
interface tunnel 0
 ip dvmrp metric 1 list 1
 ip dvmrp metric 0 list 2

The following example redistributes IPv4 multicast routes into DVMRP neighbors with a metric of 1:

interface tunnel 0
 ip dvmrp metric 1 mbgp

Related Commands

Command
Description

debug ip dvmrp

Displays information on DVMRP packets received and sent.

ip dvmrp accept-filter

Configures an acceptance filter for incoming DVMRP reports.


ip dvmrp metric-offset

To change the metrics of advertised Distance Vector Multicast Routing Protocol (DVMRP) routes and thus favor or not favor a certain route, use the ip dvmrp metric-offset command in interface configuration mode. To restore the default values, use the no form of this command.

ip dvmrp metric-offset [in | out] increment

no ip dvmrp metric-offset

Syntax Description

in

(Optional) Adds the increment value to incoming DVMRP reports and is reported in mrinfo replies. The default for in is 1.

out

(Optional) Adds the increment value to outgoing DVMRP reports for routes from the DVMRP routing table. The default for out is 0.

increment

Value added to the metric of a DVMRP route advertised in a report message.


Defaults

If neither in nor out is specified, in is the default.
in: 1
out: 0

Command Modes

Interface configuration

Command History

Release
Modification

11.0

This command was introduced.


Usage Guidelines

Use this command to influence which routes are used, as you prefer. The DVMRP metric is in hop count.

Examples

The following example adds 10 to the incoming DVMRP reports:

ip dvmrp metric-offset 10

ip dvmrp output-report-delay

To configure an interpacket delay of a Distance Vector Multicast Routing Protocol (DVMRP) report, use the ip dvmrp output-report-delay command in interface configuration mode. To restore the default values, use the no form of this command.

ip dvmrp output-report-delay milliseconds [burst]

no ip dvmrp output-report-delay milliseconds [burst]

Syntax Description

milliseconds

Number of milliseconds that elapse between transmissions of a set of DVMRP report packets. The number of packets in the set is determined by the burst argument. The default number of milliseconds is 100 milliseconds.

burst

(Optional) The number of packets in the set being sent. The default is 2 packets.


Defaults

milliseconds: 100 milliseconds
burst: 2 packets

Command Modes

Interface configuration

Command History

Release
Modification

11.3

This command was introduced.


Usage Guidelines

The delay is the number of milliseconds that elapse between transmissions of sets of packets that constitute a report. The number of packets in the set is determined by the burst value.

You might want to change the default values, depending on the CPU and buffering of the mrouted machine.

Examples

The following example sets the interpacket delay to 200 milliseconds and the burst size to 3 packets. Therefore, at the periodic DVMRP report interval, if six packets are built, three packets will be sent, then a delay of 200 milliseconds will occur, and then the next three packets will be sent.

ip dvmrp output-report-delay 200 3

ip dvmrp reject-non-pruners

To configure the router so that it will not peer with a Distance Vector Multicast Routing Protocol (DVMRP) neighbor if that neighbor does not support DVMRP pruning or grafting, use the ip dvmrp reject-non-pruners command in interface configuration mode. To disable the function, use the no form of this command.

ip dvmrp reject-non-pruners

no ip dvmrp reject-non-pruners

Syntax Description

This command has no arguments or keywords.

Defaults

Routers peer with DVMRP neighbors that do not support DVMRP pruning or grafting.

Command Modes

Interface configuration

Command History

Release
Modification

11.0

This command was introduced.


Usage Guidelines

By default, the router accepts all DVMRP neighbors as peers, regardless of their DVMRP capability or lack thereof.

Use this command to prevent a router from peering with a DVMRP neighbor if that neighbor does not support DVMRP pruning or grafting. If the router receives a DVMRP probe or report message without the Prune-Capable flag set, the router logs a syslog message and discards the message.

Note that this command prevents peering with neighbors only. If there are any nonpruning routers multiple hops away (downstream toward potential receivers) that are not rejected, then a nonpruning DVMRP network might still exist.

Examples

The following example configures the router not to peer with DVMRP neighbors that do not support pruning or grafting:

ip dvmrp reject-non-pruners

ip dvmrp routehog-notification

To change the number of Distance Vector Multicast Routing Protocol (DVMRP) routes allowed before a syslog warning message is issued, use the ip dvmrp routehog-notification command in global configuration mode. To restore the default value, use the no form of this command.

ip dvmrp routehog-notification route-count

no ip dvmrp routehog-notification

Syntax Description

route-count

Number of routes allowed before a syslog message is triggered. The default is 10,000 routes.


Defaults

10,000 routes

Command Modes

Global configuration

Command History

Release
Modification

10.2

This command was introduced.


Usage Guidelines

This command configures how many DVMRP routes are accepted on each interface within an approximate 1-minute period before a syslog message is issued, warning that a route surge might be occurring. The warning is typically used to detect quickly when routers have been misconfigured to inject a large number of routes into the multicast backbone (MBONE).

The show ip igmp interface command displays a running count of routes. When the count is exceeded, an "*** ALERT ***" is appended to the line.

Examples

The following example lowers the threshold to 8000 routes:

ip dvmrp routehog-notification 8000

Related Commands

Command
Description

show ip igmp interface

Displays multicast-related information about an interface.


ip dvmrp route-limit

To change the limit on the number of Distance Vector Multicast Routing Protocol (DVMRP) routes that can be advertised over an interface enabled to run DVMRP, use the ip dvmrp route-limit command in global configuration mode. To configure no limit, use the no form of this command.

ip dvmrp route-limit count

no ip dvmrp route-limit

Syntax Description

count

Number of DVMRP routes that can be advertised. The default is 7000 routes.


Defaults

count: 7000 routes

Command Modes

Global configuration

Command History

Release
Modification

11.0

This command was introduced.


Usage Guidelines

Interfaces enabled to run DVMRP include a DVMRP tunnel, an interface where a DVMRP neighbor has been discovered, and an interface configured to run the ip dvmrp unicast-routing command.

The ip dvmrp route-limit command is automatically generated to the configuration file when at least one interface is enabled for multicast routing. This command is necessary to prevent misconfigured ip dvmrp metric commands from causing massive route injection into the multicast backbone (MBONE).

Examples

The following example changes the limit to 5000 DVMRP routes allowed to be advertised:

ip dvmrp route-limit 5000

Related Commands

Command
Description

ip dvmrp metric

Configures the metric associated with a set of destinations for DVMRP reports.

ip dvmrp unicast-routing

Enables DVMRP unicast routing on an interface.


ip dvmrp summary-address

To configure a Distance Vector Multicast Routing Protocol (DVMRP) summary address to be advertised out the interface, use the ip dvmrp summary-address command in interface configuration mode. To remove the summary address, use the no form of this command.

ip dvmrp summary-address summary-address mask [metric value]

no ip dvmrp summary-address summary-address mask [metric value]

Syntax Description

summary-address

Summary IP address that is advertised instead of the more specific route.

mask

Mask on the summary IP address.

metric value

(Optional) Metric that is advertised with the summary address. The default is 1.


Defaults

metric value: 1

Command Modes

Interface configuration

Command History

Release
Modification

11.2

This command was introduced.


Usage Guidelines

If there is at least a single, more specific route in the unicast routing table that matches the specified address and mask arguments, the summary is advertised. Routes in the DVMRP routing table are not candidates for summarization.

When the metric keyword is specified, the summary is advertised with that metric value.

Multiple summary addresses can be configured on an interface. When multiple overlapping summary addresses are configured on an interface, the one with the longest mask takes preference.

Examples

The following example configures the DVMRP summary address 172.16.0.0 to be advertised out the interface:

ip dvmrp summary-address 172.16.0.0 255.255.0.0 metric 1

Related Commands

Command
Description

ip dvmrp auto-summary

Enables DVMRP automatic summarization if it was disabled.


ip dvmrp unicast-routing

To enable Distance Vector Multicast Routing Protocol (DVMRP) unicast routing on an interface, use the ip dvmrp unicast-routing command in interface configuration mode. To disable the feature, use the no form of this command.

ip dvmrp unicast-routing

no ip dvmrp unicast-routing

Syntax Description

This command has no arguments or keywords.

Defaults

DVMRP unicast routing on an interface is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

10.3

This command was introduced.


Usage Guidelines

Enabling DVMRP unicast routing means that routes in DVMRP report messages are cached by the router in a DVMRP routing table. When Protocol Independent Multicast (PIM) is running, these routes may get preference over routes in the unicast routing table. This capability allows PIM to run on the multicast backbone (MBONE) topology when it is different from the unicast topology.

DVMRP unicast routing can run on all interfaces, including generic routing encapsulation (GRE) tunnels. On DVMRP tunnels, it runs by virtue of DVMRP multicast routing. This command does not enable DVMRP multicast routing among Cisco routers. However, if there is a DVMRP-capable multicast router, the Cisco router will do PIM and DVMRP multicast routing interaction.

Examples

The following example enables DVMRP unicast routing:

ip dvmrp unicast-routing

Related Commands

Command
Description

ip dvmrp route-limit

Changes the limit on the number of DVMRP routes that can be advertised over an interface enabled to run DVMRP.




ip igmp access-group

To control the multicast groups that hosts on the subnet serviced by an interface can join, use the ip igmp access-group command in interface configuration mode. To disable this control, use the no form of this command.

ip igmp access-group access-list

no ip igmp access-group access-list

Syntax Description

access-list

Number or name of a standard or extended IP access list. The access list can be a number from 1 to 99 for a standard access list, and 100 to 199 for an extended access list.


Defaults

All groups are allowed on an interface.

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.

12.3(7)T

Extended access list support was added.


Examples

In the following example, hosts serviced by Ethernet interface 0 can join the group 225.2.2.2 only:

access-list 1 225.2.2.2 0.0.0.0
interface ethernet 0
 ip igmp access-group 1

The following are examples of extended access lists.

The first part of the extended access list clause controls the source (multicast sender), and the second part of the extended access list clause controls the multicast group.

Deny all state for a group G

deny igmp any host G
permit igmp any any

Deny all state for a source S

deny igmp host S any
permit igmp any any

Permit all state for a group G

permit igmp any host G

Permit all state for a source S

permit igmp host S any

Filter a particular source for a group G

deny igmp host S host G
permit igmp any host G

ip igmp explicit-tracking

To enable explicit tracking of hosts, groups, and channels for IGMP Version 3 (IGMPv3), use the ip igmp explicit-tracking command in interface configuration mode. To disable this feature, use the no form of this command.

ip igmp explicit-tracking

no ip igmp explicit-tracking

Syntax Description

This command has no arguments or keywords.

Defaults

Explicit tracking of hosts, groups and channels for IGMPv3 is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.0(19)S

This command was introduced.

12.2(8)T

This command was integrated into Cisco IOS Release 12.2(8)T.


Usage Guidelines

This command can be configured on an interface only if IGMPv3 is first configured on the same interface. To configure IGMPv3, use the ip igmp version 3 command in interface configuration mode.

When explicit tracking is enabled on a router, the router can individually track the Internet Group Management Protocol (IGMP) membership state of all reporting hosts. This feature allows the router to achieve minimal leave latencies when hosts leave a multicast group or channel. To monitor IGMP membership of hosts, use the show ip igmp membership command in user EXEC or privileged EXEC mode.

When explicit tracking is enabled, the router uses more memory than if explicit tracking is disabled because the router must store the membership state of all hosts on the interface.

Examples

The following example shows a basic configuration for enabling IP multicast with Source Specific Multicast (SSM), IGMPv3, and explicit tracking:

ip multicast routing

interface ethernet 0
 description access network to desktop systems
 ip address 10.1.0.1 255.255.255.0
 ip pim sparse-dense-mode
 ip mroute-cache
 ip igmp version 3
 ip igmp explicit-tracking
 ip igmp v3lite
 ip urd

interface ethernet 1
 description backbone interface !No hosts connected
 ip address 10.10.0.1 255.255.255.0
 ip pim sparse-dense-mode
 ip mroute-cache

ip pim ssm default

Related Commands

Command
Description

ip igmp version

Configures the version of IGMP that the router uses.

show ip igmp membership

Displays the IGMP membership information for multicast groups and (S, G) channels.


ip igmp helper-address

To cause the system to forward all Internet Group Management Protocol (IGMP) host reports and leave messages received on the interface to the specified IP address, use the ip igmp helper-address command in interface configuration mode. To disable such forwarding, use the no form of this command.

ip igmp helper-address ip-address

no ip igmp helper-address

Syntax Description

ip-address

IP address to which IGMP host reports and leave messages are forwarded. Specify the IP address of an interface on the central router.


Defaults

IGMP host reports and leave messages are not forwarded.

Command Modes

Interface configuration

Command History

Release
Modification

11.2 F

This command was introduced.


Usage Guidelines

This command and the ip pim neighbor-filter command together enable stub multicast routing. The IGMP host reports and leave messages are forwarded to the IP address specified. The reports are re-sent out the next hop interface toward the IP address, with the source address of that interface. This command enables a type of "dense-mode" join, allowing stub sites not participating in Protocol Independent Multicast (PIM) to indicate membership in IP multicast groups.

Examples

The following example enables stub multicast routing on Router A, which has an outgoing interface with IP address 10.0.0.1. Router B is a central router with an incoming interface with address 10.0.0.2. Access list 1 filters PIM messages from the source (stub Router A).

Router A Configuration

ip multicast-routing
 ip pim dense-mode
 ip igmp helper-address 10.0.0.2

Router B Configuration

ip multicast-routing
 ip pim dense-mode : or ip pim sparse-mode
 ip pim neighbor-filter 1
access-list 1 deny 10.0.0.1

Related Commands

Command
Description

ip pim neighbor-filter

Prevents a router from participating in PIM (for example, to configure stub multicast routing).


ip igmp helper-address (UDL)

To configure Internet Group Management Protocol (IGMP) helpering as required for IGMP unidirectional link routing (UDLR), use the ip igmp helper-address command in interface configuration mode. To disable such report forwarding, use the no form of this command.

ip igmp helper-address udl interface-type interface-number

no ip igmp helper-address

Syntax Description

udl interface-type interface-number

Specifies the interface type and number of a unidirectional interface.


Defaults

No forwarding occurs.

Command Modes

Interface configuration

Command History

Release
Modification

12.0(3)T

This command was introduced.


Usage Guidelines

This command is required on a downstream router on each interface connected to a potential multicast receiver. The command allows the downstream router to helper IGMP reports received from hosts to an upstream router connected to a unidirectional link (UDL) associated with the configured interface-type and interface-number arguments.

Examples

The following example configures a helper address on a downstream router:

ip multicast-routing
!
! Interface that receiver is attached to, configure for IGMP reports to be 
! helpered for the unidirectional interface.
!
interface ethernet 0
 description Forward IGMP reports from this interface to UDL querier
 ip address 10.0.0.2 255.0.0.0
 ip pim sparse-dense-mode
 ip igmp helper-address udl serial 0

Related Commands

Command
Description

ip igmp proxy-service

Enables the mroute proxy service.

ip igmp unidirectional-link

Configures an interface to be unidirectional and enables it for IGMP UDLR.


ip igmp immediate-leave

To minimize the leave latency of Internet Group Management Protocol (IGMP) memberships when IGMP Version 2 is used and only one receiver host is connected to each interface, use the ip igmp immediate-leave command in global or interface configuration mode. To disable this feature, use the no form of this command.

ip igmp immediate-leave group-list access-list

no ip igmp immediate-leave

Syntax Description

group-list access-list

Specifies a standard access list number or name that defines multicast groups in which the immediate leave feature is enabled.


Defaults

This command is disabled.

Command Modes

Global configuration
Interface configuration

Command History

Release
Modification

12.2(4)

This command was introduced.


Usage Guidelines

You cannot configure this command in both interface and global configuration mode.

When this command is not configured, the router will send an IGMP group-specific query message upon receipt of an IGMP Version 2 (IGMPv2) group leave message. The router will stop forwarding traffic for that group only if no host replies to the query within the timeout period. The timeout period is determined by the ip igmp last-member-query-interval command and the IGMP robustness variable, which is defined by the IGMP specification. By default, the timeout period in Cisco IOS software is approximately 2.5 seconds.

If this command is configured, the router assumes that only one host has joined the group and stops forwarding the group's traffic immediately upon receipt of an IGMPv2 group leave message.

Global Configuration Mode

When this command is configured in global configuration mode, it applies to all IGMP-enabled interfaces. Any existing configuration of this command in interface configuration mode will be removed from the configuration. Also, any new configuration of this command in interface configuration mode will be ignored.

Interface Configuration Mode

When this command is configured in interface configuration mode, it applies to an individual interface. Configure this command on an interface if only one IGMP-enabled neighbor is connected to the interface. The neighbor can be either a host or switch running IGMP Snooping. When the ip igmp immediate-leave command is enabled on an interface, the router will not send IGMP group-specific host queries when an IGMP Version 2 leave group message is received from that interface. Instead, the router will immediately remove the interface from the IGMP cache for that group and send Protocol Independent Multicast (PIM) prune messages toward sources if this interface was the last one to join that group.

Examples

The following example shows how to enable the immediate leave feature on all interfaces for all multicast groups:

Router(config)# ip multicast-routing
Router(config)# ip igmp immediate-leave group-list all-groups

Router(config)# interface ethernet 0
Router(config-if)# ip address 10.0.10.1 255.255.255.0
Router(config-if)# ip pim sparse-dense mode
Router(config-if)# exit
Router(config)# ip access-list standard all-groups
Router(config)# permit 224.0.0.0 15.255.255.255

The following example shows how to enable the immediate leave feature on an interface for a specific range of multicast groups. In this example, the router assumes that the tv-groups access list consists of groups that have only one host membership at a time per interface:

Router(config)# ip multicast-routing
Router(config)# interface ethernet 0
Router(config-if)# ip address 10.0.10.1 255.255.255.0
Router(config-if)# ip pim sparse-dense-mode
Router(config-if)# ip igmp immediate-leave group-list tv-groups
Router(config-if)# exit
Router(config)# ip access-list standard tv-groups
Router(config)# permit 239.192.20.0 0.0.0.255 

Related Commands

Command
Description

ip igmp last-member-query-interval

Configures the frequency at which the router sends IGMP group-specific host query messages.


ip igmp join-group

To have the router join a multicast group, use the ip igmp join-group command in interface configuration mode. To cancel membership in a multicast group, use the no form of this command.

ip igmp join-group group-address [Source source-address]

no ip igmp join-group group-address [source source-address]

Syntax Description

group-address

Address of the multicast group. This is a multicast IP address in four-part dotted-decimal notation.

source source-address

(Optional) IP Source address.


Defaults

No multicast group memberships are predefined.

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.

12.3(14)T

The source keyword and source-address argument were added.


Usage Guidelines

IP packets that are addressed to the group address are passed to the IP client process in the Cisco IOS software.

If all the multicast-capable routers and access servers that you administer are members of a multicast group, pinging that group causes all routers to respond, which can be a useful administrative and debugging tool.

Another reason to have a router join a multicast group is when other hosts on the network have an Interior Gateway Routing Protocol (IGRP) configuration that prevents them from correctly answering Internet Group Management Protocol (IGMP) queries. Having the router join the multicast group causes upstream routers to maintain multicast routing table information for that group and keep the paths for that group active.

Examples

In the following example, the router joins multicast group 225.2.2.2:

ip igmp join-group 225.2.2.2

In the following example, the router joins multicast group 225.2.2.2 and includes the IP source address 1.1.1.1:

ip igmp join-group 225.2.2.2 source 1.1.1.1

Related Commands

Command
Description

ip igmp access-group

Controls the multicast groups that hosts on the subnet serviced by an interface can join.

ping

Diagnoses basic network connectivity on Apollo, AppleTalk, CLNS, DECnet, IP, Novell IPX, or source-route bridgins (SRB) networks.


ip igmp last-member-query-count

To configure the number of times that the router sends Internet Group Management Protocol (IGMP) group-specific or group-source-specific (with IGMP version 3) query messages in response to receiving a group-specific or group-source-specific leave message, use the ip igmp last-member-query-count command in interface configuration mode. To set this interval to the default value, use the no form of this command.

ip igmp last-member-query-count lmqc

no ip igmp last-member-query-count lmqc

Syntax Description

lmqc

Last member query count. The number of times, from 1 through 7, that the router sends group- or group-source-specific queries upon receipt of a message indicating a leave.


Defaults

LMQC is 2

Command Modes

Interface configuration

Command History

Release
Modification

12.1

This command was introduced.


Usage Guidelines

When a router receives an IGMP version 2 (IGMPv2) or IGMP version 3 (IGMPv3) message indicating that a host wants to leave a group, source, or channel, it sends last-member-query-count group- or group-source-specific IGMP query messages at intervals of igmp-last-member-interval milliseconds. If no response is received after this period, the router stops forwarding for the group, source, or channel.


Caution Do not set the LMQC to 1, because in this situation the loss of a single packet—the query packet from the router to the host or the report packet from the host to the router—may result in traffic forwarding being stopped, even there is still a receiver. Traffic will continue to be forwarded after the next general query sent by the router, but the interval during which a receiver may not receive the query could be as long as 1 minute (with the default query interval).

The leave latency in Cisco IOS software may increase by up to one last member query interval (LMQI) value when the router is processing more than one leave within a LMQI. In this case, the average leave latency is determined by the (LMQC + 0.5) * LMQI. The result is that the default leave latency can range from 2.0 to 3.0 seconds with an average of 2.5 seconds under a higher load of IGMP leave processing. The leave latency under load for the minimum LMQI value of 100 msec and a LMQC of 1 is from 100 to 200 milliseconds, with an average of 150 milliseconds. This is done to limit the impact of higher rates of IGMP leave messages.

If no response is received after this period, the router will stop forwarding traffic for that group, source, or channel only if no host replies to the query within the timeout period. The timeout period is determined by the ip igmp last-member-query-interval and the ip igmp last-member-query-count commands.

Examples

The following example changes the number of times that the router sends group-specific or group-source-specific query messages to 5:

interface tunnel 0

 ip igmp last-member-query-count 5:

Related Commands

Command
Description

ip igmp explicit-tracking

Enables explicit tracking of hosts, groups, and channels for IGMPv3.

ip igmp immediate-leave

Minimizes the leave latency of IGMP memberships when IGMPv2 is used and only one receiver host is connected to each interface.

ip igmp last-member-query-
interval

Configures the interval at which the router sends IGMP group-specific or group-source-specific (with IGMPv3) query messages


ip igmp last-member-query-interval

To configure the interval at which the router sends Internet Group Management Protocol (IGMP) group-specific or group-source-specific (with IGMP Version 3) query messages, use the ip igmp last-member-query-interval command in interface configuration mode. To set this interval to the default value, use the no form of this command.

ip igmp last-member-query-interval interval

no ip igmp last-member-query-interval interval

Syntax Description

interval

Interval, in milliseconds, at which IGMP group-specific host query messages are sent. The interval value is an integer from 100 to 25,500.

The interval argument in 12.0 S, 12.1 E, 12.2, and 12.2 S releases is an integer from 100 through 65,535.


Defaults

interval: 1000 milliseconds (1 second)

Command Modes

Interface configuration

Command History

Release
Modification

12.1

This command was introduced.

12.2(4)T

The highest interval integer value accepted was changed from 65,535 to 25,500.


Usage Guidelines

When a router receives an IGMP Version 2 (IGMPv2) or IGMP Version 3 (IGMPv3) message indicating that a host wants to leave a group, source, or channel, it sends last-member-query-count group, group-specific, or source-specific IGMP query messages at intervals set by the ip igmp last-member-query-interval command. If no response is received after this period, the router stops forwarding for the group, source, or channel.

The leave latency in Cisco IOS software may increase by up to one last member query interval (LMQI) value when the router is processing more than one leave within a LMQI. In this case, the average leave latency is determined by the (last member query count + 0.5) * LMQI. The result is that the default leave latency can range from 2.0 to 3.0 seconds with an average of 2.5 seconds under a higher load of IGMP leave processing. The leave latency under load for the minimum LMQI value of 100 msec and a last member query count of 1 is from 100 to 200 milliseconds, with an average of 150 milliseconds. This is done to limit the impact of higher rates of IGMP leave messages.

If no response is received after this period, the router will stop forwarding traffic for that group, source, or channel only if no host replies to the query within the timeout period. The timeout period is determined by the ip igmp last-member-query-interval and the ip igmp last-member-query-count commands.

Examples

The following example changes the IGMP group-specific host query message interval to 2000 milliseconds (2 seconds):

interface tunnel 0
 ip igmp last-member-query-interval 2000

Related Commands

Command
Description

ip igmp explicit-tracking

Enables explicit tracking of hosts, groups, and channels for IGMPv3.

ip igmp immediate-leave

Minimizes the leave latency of IGMP memberships when IGMPv2 is used and only one receiver host is connected to each interface.

ip igmp last-member-query-count

Configures the number of times that the router sends IGMP group-specific or group-source-specific (with IGMP version 3) query messages.


ip igmp limit (global)

To globally limit the number of Internet Group Management Protocol (IGMP) states resulting from IGMP, IGMP Version 3 lite (IGMP v3lite), and URL Rendezvous Directory (URD) membership states, use the ip igmp limit command in global configuration mode. To disable a configured IGMP state limit, use the no form of this command.

ip igmp limit number

no ip igmp limit number

Syntax Description

number

Maximum number of IGMP states allowed on a router. The valid range is from 1 to 64000.


Defaults

This command is not configured by default. There is no default number of IGMP limits configured. You must configure the number of maximum IGMP states allowed globally on a router when you configure this command.

Command Modes

Global configuration

Command History

Release
Modification

12.2(15)T

This command was introduced.


Usage Guidelines

Use this command to configure a limit on the number of IGMP states resulting from IGMP, IGMP v3lite, and URD membership reports on a global basis. Membership reports sent after the configured limits have been exceeded are not entered in the IGMP cache and traffic for the excess membership reports is not forwarded.

Use the ip igmp limit (interface) command to configure the per-interface IGMP state limit.

Per-interface and per-system limits operate independently of each other and can enforce different configured limits. A membership state will be ignored if it exceeds either the per-interface limit or global limit.

Examples

The following example shows how to limit the number of IGMP states on a router to 300:

ip igmp limit 300

Related Commands

Command
Description

ip igmp access-group

Controls the multicast groups that hosts on the subnet serviced by an interface can join.

ip igmp limit (interface)

Limits the number of IGMP states resulting from IGMP, IGMP v3lite, and URD membership states on a per-interface basis.

ip multicast rate-limit

Controls the rate a sender from the source list can send to a multicast group in the group list.


ip igmp limit (interface)

To limit the number of Internet Group Management Protocol (IGMP) states resulting from IGMP, IGMP Version 3 lite (IGMP v3lite), and URL Rendezvous Directory (URD) membership states on a per-interface basis, use the ip igmp limit command in interface configuration mode. To disable a configured IGMP state limit, use the no form of this command.

ip igmp limit number [except access-list]

no ip igmp limit number [except access-list]

Syntax Description

number

Maximum number of IGMP states allowed on a router or interface. Range is from 1 to 64000.

except

(Optional) Excludes an access list from the configured IGMP state limit.

access-list

(Optional) Extended access list to exclude from the configured IGMP state limit.


Defaults

This command is not configured by default. There is no default number of IGMP limits configured. You must configure the number of maximum IGMP states allowed per interface on a router when you configure this command.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(15)T

This command was introduced.


Usage Guidelines

Use this command to configure a limit on the number of IGMP states resulting from IGMP, IGMP v3lite, and URD membership reports on a per-interface basis. Membership reports sent after the configured limits have been exceeded are not entered in the IGMP cache and traffic for the excess membership reports is not forwarded.

Use the ip igmp limit (global) command to configure the global IGMP state limit.

Per-interface and per-system limits operate independently of each other and can enforce different configured limits. A membership state will be ignored if it exceeds either the per-interface limit or global limit.

If you do not configure the except access-list keyword and argument, all IGMP states resulting from IGMP, IGMP v3lite, or URD are counted toward the configured cache limit on an interface. Use the except access-list keyword and argument to exclude particular groups or channels from counting toward the IGMP cache limit. An IGMP membership report is counted against the per-interface limit if it is permitted by the extended access list specified by the except access-list keyword and argument.

Examples

The following example shows how to limit the number of IGMP membership reports on Ethernet interface 0:

interface ethernet 0
 ip igmp limit 100

The following example shows how to limit the number of IGMP membership reports on Ethernet interface 0. In this example, any IGMP membership reports from access list 0.0.0.1 do not count toward the configured state limit:

interface ethernet 0
 ip igmp limit 100 except 0.0.0.1 

Related Commands

Command
Description

ip igmp access-group

Controls the multicast groups that hosts on the subnet serviced by an interface can join.

ip igmp limit (global)

Globally limits the number of IGMP states resulting from IGMP, IGMP v3lite, and URD membership states.

ip multicast rate-limit

Controls the rate a sender from the source list can send to a multicast group in the group list.


ip igmp mroute-proxy

To enable Internet Group Management Protocol (IGMP) report forwarding of proxied (*, G) multicast static route (mroute) entries, use the ip igmp mroute-proxy command in interface configuration mode. To disable this service, use the no form of this command.

ip igmp mroute-proxy interface-type interface-number

no ip igmp mroute-proxy interface-type interface-number

Syntax Description

interface-type interface-number

Interface type and number.


Defaults

The command is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(5)T

This command was introduced.


Usage Guidelines

When used with the ip igmp proxy-service interface command, this command enables forwarding of IGMP reports to a proxy service interface for all (*, G) forwarding entries for this interface in the multicast forwarding table.

Examples

The following example shows how to configure the ip igmp mroute-proxy command on Ethernet interface 1 to request that IGMP reports be sent to loopback interface 0 for all groups in the mroute table that are forwarded to Ethernet interface 1. This example also shows how to configure the ip igmp proxy-service command on loopback interface 0 to enable the forwarding of IGMP reports out the interface for all groups on interfaces registered through the ip igmp mroute-proxy command.

interface loopback 0
ip address 10.7.1.1 255.255.255.0
ip pim dense-mode
ip igmp helper-address udl ethernet 0
ip igmp proxy-service
!
interface ethernet 0
ip address 10.2.1.1 255.255.255.0
ip pim dense-mode
ip igmp unidirectional link
!
interface ethernet 1
ip address 10.1.1.1 255.255.255.0
ip pim sparse-mode
ip igmp mroute-proxy loopback 0

Related Commands

Command
Description

ip igmp proxy-service

Enables the mroute proxy service.

ip igmp unidirectional-link

Configures an interface to be unidirectional and enables it for IGMP UDLR.


ip igmp proxy-service

To enable the mroute proxy service, use the ip igmp proxy-service command in interface configuration mode. To disable forwarding, use the no form of this command.

ip igmp proxy-service

no ip igmp proxy-service

Syntax Description

This command has no arguments or keywords.

Defaults

The command is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(5)T

This command was introduced.


Usage Guidelines

Based on the Internet Group Management Protocol (IGMP) query interval, the router periodically checks the multicast static route (mroute) table for (*, G) forwarding entries that match interfaces configured with the ip igmp mroute-proxy command. Where there is a match, one IGMP report is created and received on this interface. The ip igmp proxy-service command is intended to be used with the ip igmp helper-address (UDL) command, in which case the IGMP report would be forwarded to an upstream router.

Examples

The following example shows how to configure the ip igmp mroute-proxy command on Ethernet interface 1 to request that IGMP reports be sent to loopback interface 0 for all groups in the mroute table that are forwarded to Ethernet interface 1. This example also shows how to configure the ip igmp proxy-service command on loopback interface 0 to enable the forwarding of IGMP reports out the interface for all groups on interfaces registered through the ip igmp mroute-proxy command.

interface loopback 0
ip address 10.7.1.1 255.255.255.0
ip pim dense-mode
ip igmp helper-address udl ethernet 0
ip igmp proxy-service
!
interface ethernet 0
ip address 10.2.1.1 255.255.255.0
ip pim dense-mode
ip igmp unidirectional link
!
interface ethernet 1
ip address 10.1.1.1 255.255.255.0
ip pim sparse-mode
ip igmp mroute-proxy loopback 0

Related Commands

Command
Description

ip igmp helper-address (UDL)

Configures IGMP helpering as required for IGMP UDLR.

ip igmp mroute-proxy

Enables IGMP report forwarding of proxied (*, G) mroute entries.

ip igmp unidirectional-link

Configures an interface to be unidirectional and enables it for IGMP UDLR.


ip igmp query-interval

To configure the frequency at which Cisco IOS software sends Internet Group Management Protocol (IGMP) host query messages, use the ip igmp query-interval command in interface configuration mode. To return to the default frequency, use the no form of this command.

ip igmp query-interval seconds

no ip igmp query-interval

Syntax Description

seconds

Frequency, in seconds, at which to send IGMP host query messages. It can be a number from 0 to 65535. The default is 60 seconds.


Defaults

seconds: 60 seconds

Command Modes

Interface configuration

Command History

Release
Modification

10.2

This command was introduced.


Usage Guidelines

Multicast routers send host membership query messages (host query messages) to discover which multicast groups have members on the attached networks of the router. Hosts respond with IGMP report messages indicating that they want to receive multicast packets for specific groups (that is, indicating that the host wants to become a member of the group). Host query messages are addressed to the all-hosts multicast group, which has the address 224.0.0.1, and has an IP time-to-live (TTL) value of 1.

The designated router for a LAN is the only router that sends IGMP host query messages:

For IGMP Version 1, the designated router is elected according to the multicast routing protocol that runs on the LAN.

For IGMP Version 2, the designated querier is the lowest IP-addressed multicast router on the subnet.

If the router hears no queries for the timeout period (controlled by the ip igmp query-timeout command), it becomes the querier.


Caution Changing this value may severely impact multicast forwarding.

Examples

The following example changes the frequency at which the designated router sends IGMP host-query messages to 2 minutes:

interface tunnel 0
 ip igmp query-interval 120

Related Commands

Command
Description

ip igmp query-timeout

Configures the timeout period before the router takes over as the querier for the interface after the previous querier has stopped querying.

ip pim query-interval

Configures the frequency of PIM router query messages.

show ip igmp groups

Displays the multicast groups that are directly connected to the router and that were learned through IGMP.


ip igmp query-max-response-time

To configure the maximum response time advertised in Internet Group Management Protocol (IGMP) queries, use the ip igmp query-max-response-time command in interface configuration mode. To restore the default value, use the no form of this command.

ip igmp query-max-response-time seconds

no ip igmp query-max-response-time

Syntax Description

seconds

Maximum response time, in seconds, advertised in IGMP queries. The default value is 10 seconds.


Defaults

seconds: 10 seconds

Command Modes

Interface configuration

Command History

Release
Modification

11.1

This command was introduced.


Usage Guidelines

This command is valid only when IGMP Version 2 is running.

This command controls the period during which the responder can respond to an IGMP query message before the router deletes the group.

Examples

The following example configures a maximum response time of 8 seconds:

ip igmp query-max-response-time 8

Related Commands

Command
Description

ip pim query-interval

Configures the frequency of PIM router query messages.

show ip igmp groups

Displays the multicast groups that are directly connected to the router and that were learned through IGMP.


ip igmp query-timeout

To configure the timeout period before the router takes over as the querier for the interface after the previous querier has stopped querying, use the ip igmp query-timeout command in interface configuration mode. To restore the default value, use the no form of this command.

ip igmp query-timeout seconds

no ip igmp query-timeout

Syntax Description

seconds

Number of seconds that the router waits after the previous querier has stopped querying and before it takes over as the querier.


Defaults

The default timeout period is two times the query interval. The default query interval is 120 seconds.

Command Modes

Interface configuration

Command History

Release
Modification

11.1

This command was introduced.


Usage Guidelines

This command requires IGMP Version 2.

By default, the router waits twice the query interval specified by the ip igmp query-interval command, after which, if it has heard no queries, it becomes the querier. By default, the ip igmp query-interval defaults to 60 seconds, which means the ip igmp query-timeout defaults to 120 seconds.

Examples

The following example configures the router to wait 30 seconds from the time it received the last query before it takes over as the querier for the interface:

ip igmp query-timeout 30

Related Commands

Command
Description

ip igmp query-interval

Configures the frequency at which Cisco IOS software sends IGMP host query messages.


ip igmp snooping

To globally enable Internet Group Management Protocol (IGMP) snooping, use the ip igmp snooping command in global configuration mode. To disable IGMP snooping, use the no form of this command.

ip igmp snooping

no ip igmp snooping

Syntax Description

This command has no arguments or keywords.

Defaults

By default, IGMP snooping is globally enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.2(15)ZJ

This command was implemented on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.


Usage Guidelines

When IGMP snooping is globally enabled, it enables IGMP snooping on all the existing VLAN interfaces. When IGMP snooping is globally disabled, it disables IGMP snooping on all the existing VLAN interfaces.

Use the show ip igmp snooping privileged EXEC command to verify your IGMP settings.

The configuration is saved in NVRAM.

Examples

The following example shows how to globally enable IGMP snooping:

Router(config)# ip igmp snooping

The following example shows how to globally disable IGMP snooping:

Router(config)# no ip igmp snooping

Related Commands

Command
Description

ip igmp snooping vlan

Enables IGMP snooping on a VLAN interface.

ip igmp snooping vlan immediate-leave

Enables IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping

Displays the IGMP snooping configuration.


ip igmp snooping vlan

To enable Internet Group Management Protocol (IGMP) snooping on a specific VLAN, use the ip igmp snooping vlan command in global configuration mode. To disable IGMP snooping on a VLAN interface, use the no form of this command.

ip igmp snooping vlan vlan-id

no ip igmp snooping vlan vlan-id

Syntax Description

vlan-id

VLAN ID value. The range is from 1 to 1001. Do not enter leading zeroes.


Defaults

By default, IGMP snooping is enabled when each VLAN is created.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.2(15)ZJ

This command was implemented on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.


Usage Guidelines

This command automatically configures the VLAN if it is not already configured. The configuration is saved in NVRAM.

Examples

The following example shows how to enable IGMP snooping on VLAN 2:

Router(config)# ip igmp snooping vlan 2

The following example shows how to disable IGMP snooping on VLAN 2:

Router(config)# no ip igmp snooping vlan 2

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

ip igmp snooping vlan immediate-leave

Enables IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping

Displays the IGMP snooping configuration.


ip igmp snooping vlan immediate-leave

To enable Internet Group Management Protocol (IGMP) Immediate-Leave processing on a VLAN interface, use the ip igmp snooping vlan immediate-leave command in global configuration mode. To disable Immediate-Leave processing on the VLAN interface, use the no form of this command.

ip igmp snooping vlan vlan-id immediate-leave

no ip igmp snooping vlan vlan-id immediate-leave

Syntax Description

vlan-id

VLAN ID value. The range is between 1 to 1001. Do not enter leading zeroes.


Defaults

By default, IGMP Immediate-Leave processing is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.2(15)ZJ

This command was implemented on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.


Usage Guidelines

Use Immediate-Leave processing only when there is only one IP multicast receiver present on every port in the VLAN. The Immediate-Leave configuration is saved in NVRAM.

Immediate-Leave processing is supported only with IGMP version 2 hosts.

Examples

The following example shows how to enable IGMP Immediate-Leave processing on VLAN 1:

Router(config)# ip igmp snooping vlan 1 immediate-leave

The following example shows how to disable IGMP Immediate-Leave processing on VLAN 1:

Router(config)# no ip igmp snooping vlan 1 immediate-leave

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping

Displays the IGMP snooping configuration.

show mac-address-table multicast

Displays the Layer 2 multicast entries for a VLAN.


ip igmp snooping vlan mrouter

To add a multicast router port and to configure the multicast router learning method, use the ip igmp snooping vlan mrouter command in global configuration mode. To remove the configuration, use the no form of this command.

ip igmp snooping vlan vlan-id mrouter {interface interface-id | learn pim-dvmrp}

no ip igmp snooping vlan vlan-id mrouter {interface interface-id | learn pim-dvmrp}

Syntax Description

vlan-id

Specifies the VLAN ID. The range is from 1 to 1001. Do not enter leading zeroes.

interface interface-id

Specifies the interface of the member port that is configured to a static router port.

learn pim-dvmrp

Specifies the multicast router snooping PIM-DVMRP packets multicast router learning method.


Defaults

The default learning method is pim-dvmrp.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.2(15)ZJ

This command was implemented on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.


Usage Guidelines

The configured learning method is saved in NVRAM.

Static connections to multicast routers are supported only on switch ports.

Examples

The following example shows how to configure Fast Ethernet interface 0/6 as a multicast router port:

Router(config)# ip igmp snooping vlan 1 mrouter interface fastethernet0/6

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

ip igmp snooping vlan

Enables IGMP snooping on the VLAN interface.

ip igmp snooping vlan immediate-leave

Configures IGMP Immediate-Leave processing.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping mrouter

Displays the statically and dynamically learned multicast router ports.


ip igmp snooping vlan static

To add a Layer 2 port as a member of a multicast group, use the ip igmp snooping vlan static command in global configuration mode. To remove the configuration, use the no form of this command.

ip igmp snooping vlan vlan-id static mac-address interface interface-id

no ip igmp snooping vlan vlan-id static mac-address interface interface-id

Syntax Description

vlan-id

Specifies the VLAN ID. The range is 1 to 1001. Do not enter leading zeroes.

mac-address

Specifies the static group MAC address.

interface interface-id

Specifies the interface configured to a static router port.


Defaults

No Layer 2 ports are configured.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.2(15)ZJ

This command was implemented on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series routers.


Usage Guidelines

This command is used to statically configure the IP multicast group member ports.

The static ports and groups are saved in NVRAM.

Static connections to multicast routers are supported only on switch ports.

Use the show mac-address-table multicast privileged EXEC command to verify your Layer 2 multicast entries.

Examples

The following example shows how to statically configure a host on an interface:

Router(config)# ip igmp snooping vlan 1 static 0100.5e02.0203 interface fastethernet0/6
Configuring port FastEthernet 0/6 on group 0100.5e02.0203

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

ip igmp snooping vlan

Enables IGMP snooping on the VLAN interface.

ip igmp snooping vlan immediate-leave

Configures IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

show mac-address-table multicast

Displays the Layer 2 multicast entries for a VLAN.


ip igmp ssm-map enable

To enable Source Specific Multicast (SSM) mapping for groups in a configured SSM range, use the ip igmp ssm-map enable command in global configuration mode. To disable SSM mapping, use the no form of this command.

ip igmp [vrf vrf-name] ssm-map enable

no ip igmp [vrf vrf-name] ssm-map enable

Syntax Description

vrf

(Optional) Supports the multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.


Defaults

This command is not enabled by default. If this command is enabled, Domain Name System (DNS)-based SSM mapping is the default.

Command Modes

Global configuration

Command History

Release
Modification

12.3(2)T

This command was introduced.


Usage Guidelines

Use this command to enable SSM mapping for groups in the configured SSM range. SSM mapping is applied only to received Internet Group Management Protocol (IGMP) version 1 or IGMP version 2 membership reports.

SSM mapping is compatible with URL Rendezvous Directory (URD) and IGMP v3 lite. SSM mapping is needed only in the router connecting to the receivers. No support is needed in any other routers in the network. SSM mapping can be configured only globally and cannot be configured per interface.

Use the vrf vrf-name keyword and argument to enable SSM mapping for a particular VRF.

Examples

The following example shows how to enable SSM mapping:

ip igmp ssm-map enable

The following example shows how to enable SSM mapping for the VRF named vrf1:

ip igmp vrf vrf1 ssm-map enable

Related Commands

Command
Description

ip domain multicast

Changes the domain prefix used by Cisco IOS software for DNS-based SSM mapping.

ip igmp ssm-map query dns

Configures DNS-based SSM mapping.

ip name-server

Specifies the address of one or more name servers to use for name and address resolution.

ip pim ssm

Defines the SSM range of IP multicast addresses.


ip igmp ssm-map query dns

To configure Domain Name System (DNS)-based Source Specific Multicast (SSM) mapping, use the ip igmp ssm-map query dns command in global configuration mode. To disable DNS-based SSM mapping, use the no form of this command.

ip igmp [vrf vrf-name] ssm-map query dns

no ip igmp [vrf vrf-name] ssm-map query dns

Syntax Description

vrf

(Optional) Supports the multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.


Defaults

This command is enabled by default when the ip igmp ssm-map enable command is enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.3(2)T

This command was introduced.


Usage Guidelines

Use this command to enable DNS-based SSM mapping. Disable DNS-based SSM mapping if you only want to rely only on statically configured SSM mapping. By default, the router will use both DNS-based SSM mapping and statically configured SSM mapping. If DNS-based SSM mapping is not explicitly disabled, the router will first try to find any statically mapped sources for the group and, if it does not find any, will use DNS-based SSM mapping.

This command is enabled by default when the ip igmp ssm-map enable command is configured. Use the no ip igmp ssm-map query dns command to disable DNS-based SSM mapping. When DNS-based SSM mapping is disabled, SSM mapping is performed only on SSM sources mapped by the ip igmp ssm-map static command.

To configure DNS-based SSM mapping, the router needs to find at least one correctly configured DNS server. The router can discover the DNS server by configuring the ip name-server global configuration command or by being directly connected to the DNS server.


Note It is recommended to always configure the IP addresses of the DNS servers with the ip name-server command to prevent the router from sending each DNS query broadcast to all connected interfaces.


Only the no form of this command is nvgened and will appear in the output of a show running-config command.

Use the vrf vrf-name keyword and argument to enable DNS-based SSM mapping for a particular VRF.

Examples

The following example shows how to configure DNS-based SSM mapping:

ip name-server 10.0.0.0
ip igmp ssm-map enable
ip igmp ssm-map query dns

The following example shows how to configure DNS-based SSM mapping for a VRF named vrf1:

ip name-server 10.0.0.0
ip igmp ssm-map enable
ip igmp vrf vrf1 ssm-map query dns

Related Commands

Command
Description

ip domain multicast

Changes the domain prefix used by Cisco IOS software for DNS-based SSM mapping.

ip igmp ssm-map enable

Enables SSM mapping for groups in a configured SSM range.

ip igmp ssm-map static

Enables static SSM mapping.

ip igmp static-group

Configures the router to be a statically connected member of the specified group on the interface.

ip name-server

Specifies the address of one or more name servers to use for name and address resolution.


ip igmp ssm-map static

To enable static Source Specific Multicast (SSM) mapping, use the ip igmp ssm-map static command in global configuration mode. To disable a static SSM mapping, use the no form of this command.

ip igmp ssm-map [vrf vrf-name] static access-control-list source-address

no ip igmp ssm-map [vrf vrf-name] static access-control-list source-address

Syntax Description

vrf

(Optional) Supports the multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

access-control-list

Access control list to apply to the static SSM mapping.

source-address

Source address to use for static map group specified by the access-control-list argument.


Defaults

No default behavior or values

Command Modes

Global configuration

Command History

Release
Modification

12.3(2)T

This command was introduced.


Usage Guidelines

Use this command to configure static SSM mappings. Globally enable SSM mapping with the ip igmp ssm-map enable command. The order of the configured static SSM mappings is important. The first configured static SSM map where the group is permitted by the access control list is used to define the source. When a static SSM mapping is configured and the router receives an Internet Group Management Protocol (IGMP) membership for group G in the configured SSM range, the router tries to determine the source address or addresses associated with group G in the configured SSM range, the router tries to determine the source address or addresses associated with group G by looking up the access control lists configured by the ip igmp ssm-map enable command. If G is permitted by a configured access control list, then the source specified by the source-address argument is accepted.

If multiple static SSM mappings are configured, and G is permitted by multiple access control lists, then the source-address arguments of all matching access control lists are used. The maximum number of configured static SSM mappings is 20.

When no static SSM mappings are configured, and SSM mapping is enabled, SSM mapping queries the Domain Name System (DNS) for address mapping.

Use the vrf vrf-name keyword and argument to configure SSM static mapping for a particular VRF.

Examples

The following example shows how to enable static SSM mapping. In this example, SSM mapping is configured to create static map groups in access control list 11 to use source address 172.16.8.11 and static map groups in access control list 10 to use source address 172.16.8.10:

ip igmp ssm-map enable
ip igmp ssm-map static 11 172.16.8.11
ip igmp ssm-map static 10 172.16.8.10

The following example shows how to enable static SSM mapping for a VRF named vrf1:

ip igmp ssm-map enable
ip igmp ssm-map vrf vrf1 static 12 172.16.8.12

Related Commands

Command
Description

ip igmp ssm-map enable

Enables SSM mapping for groups in a configured SSM range.

ip igmp ssm-map query dns

Configures DNS-based SSM mapping.

ip igmp static-group

Configures the router to be a statically connected member of the specified group on the interface, or to statically forward for a multicast group onto the interface.

ip pim ssm

Defines the SSM range of IP multicast addresses.


ip igmp static-group

To configure the router to be a statically connected member of the specified group on the interface, or to statically forward for a multicast group onto the interface, use the ip igmp static-group command in interface configuration mode. To remove the router as a member of the group, use the no form of this command.

ip igmp static-group {* | group-address [source {source-address | ssm-map}]}

no ip igmp static-group {* | group-address [source {source-address | ssm-map}]}

Syntax Description

*

Places the interface into all newly created multicast route (mroute) entries.

group-address

IP multicast group address of a group to which the router belongs.

source

(Optional) Statically forwards a (S, G) channel out of the interface.

source-address

(Optional) IP address of a system where multicast data packets originate.

ssm-map

(Optional) Configures Source Specific Multicast (SSM) mapping to be used to determine the source associated with this group. The resulting (S, G) channels are statically forwarded.


Defaults

A router is not a statically connected member of an IP multicast group.

Command Modes

Interface configuration

Command History

Release
Modification

11.2

This command was introduced.

12.3(2)T

The source and the ssm-map keywords were added.

12.2(27)SBC

This command was integrated into Cisco IOS Release 12.2(27)SBC.


Usage Guidelines

When you configure the ip igmp static-group command, packets to the group are fast-switched out the interface, provided that packets were received on the correct reverse path forwarding (RPF) interface.

Configuring the ip igmp static-group command is unlike configuring the ip igmp join-group command, which allows the router to join the multicast group. This configuration of the ip igmp static-group command would cause the upstream routers to maintain the multicast routing table information for that group, which would ensure that all the paths to that multicast group are active.

If you configure the ip igmp join-group command for the same group address as the ip igmp static-group command, the ip igmp join-group command takes precedence, and the group behaves like a locally joined group.

The use of SSM mapping determines the source or sources associated with a specific source (S) and group (G) combination and puts the particular interface in the outging interface list (OIL) for that (S, G) entry. Traffic coming from source S destined toward group G will be forwarded out that interface regardless of a receiver joining the group on that interface.

Examples

The following example configures group address 192.168.2.2 on Ethernet interface 0:

interface ethernet 0
 ip igmp static-group 192.168.2.2

The following example shows how to configure group address 192.168.2.3 to use SSM mapping for statically forwarded groups on Ethernet interface 0:

interface ethernet 0
 ip igmp static-group 192.168.2.3 source ssm-map

Related Commands

Command
Description

ip igmp join-group

Causes the router to join a multicast group.

ip igmp ssm-map enable

Enables SSM mapping for groups in a configured SSM range.

ip igmp ssm-map query dns

Configures DNS-based SSM mapping.

ip igmp ssm-map static

Enables static SSM mapping.

ip pim ssm

Defines the SSM range of IP multicast addresses.


ip igmp unidirectional-link

To configure an interface to be unidirectional and enable it for Internet Group Management Protocol (IGMP) unidirectional link routing (UDLR), use the ip igmp unidirectional-link command in interface configuration mode. To disable the unidirectional link (UDL), use the no form of this command.

ip igmp unidirectional-link

no ip igmp unidirectional-link

Syntax Description

This command has no arguments or keywords.

Defaults

No UDLR occurs.

Command Modes

Interface configuration

Command History

Release
Modification

12.0(3)T

This command was introduced.


Usage Guidelines

One example of when you might configure this command is if you have traffic traveling via a satellite.

If you have a small number of receivers, another way to achieve UDLR is to configure a UDLR tunnel. See the descriptions of the tunnel udlr receive-only and tunnel udlr send-only commands.

Examples

The following example configures an upstream router with UDLR on serial interface 0:

ip multicast-routing
!
! Unidirectional link
!
interface serial 0
 description Unidirectional to downlink-rtr
 ip address 10.0.0.1 255.0.0.0
 ip pim sparse-dense-mode
 ip igmp unidirectional-link
 no keepalive

Related Commands

Command
Description

ip igmp helper-address (UDL)

Configures IGMP helpering as required for IGMP UDLR.

ip igmp mroute-proxy

Enables IGMP report forwarding of proxied (*, G) mroute entries.

ip igmp proxy-service

Enables the mroute proxy service.

ip multicast default-rpf-distance

Changes the distance given to the default RPF interface when configuring IGMP UDLR.

show ip igmp udlr

Displays UDLR information for directly connected multicast groups on interfaces that have a UDL helper address configured.

tunnel udlr receive-only

Configures a unidirectional, GRE tunnel to act as a back channel that can receive messages, when another interface is configured for UDLR to send messages.

tunnel udlr send-only

Configures a unidirectional, GRE tunnel to act as a back channel that can send messages, when another interface is configured for UDLR to receive messages.


ip igmp v3lite

To enable acceptance and processing of Internet Group Management Protocol Version 3 lite (IGMP v3lite) membership reports on an interface, use the ip igmp v3lite command in interface configuration mode. To disable IGMP v3lite, use the no form of this command.

ip igmp v3lite

no ip igmp v3lite

Syntax Description

This command has no arguments or keywords.

Defaults

IGMPv3 lite membership reports are not accepted and processed.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(3)T

This command was introduced.


Usage Guidelines

To use this command, you must define a Source Specific Multicast (SSM) range of IP addresses using the ip pim ssm global configuration command. When IGMP v3lite is enabled, it is supported in the SSM range of addresses only.

Examples

The following example shows how to configure IGMP v3lite on Ethernet interface 3/1:

interface ethernet 3/1
ip igmp v3lite

Related Commands

Command
Description

ip pim ssm

Defines the SSM range of IP multicast addresses.


ip igmp version

To configure which version of Internet Group Management Protocol (IGMP) the router uses, use the ip igmp version command in interface configuration mode. To restore the default value, use the no form of this command.

ip igmp version {1 | 2 | 3}

no ip igmp version

Syntax Description

1

IGMP Version 1.

2

IGMP Version 2. This is the default.

3

IGMP Version 3.


Defaults

Version 2

Command Modes

Interface configuration

Command History

Release
Modification

11.1

This command was introduced.

12.1(5)T

The 3 keyword was added.


Usage Guidelines

All routers on the subnet must support the same version. The router does not automatically detect Version 1 routers and switch to Version 1 as did earlier releases of the Cisco IOS software. Hosts can have any IGMP version (1, 2, or 3) and the router will correctly detect their presence and query them appropriately.

Some commands require IGMP Version 2 or 3, such as the ip igmp query-max-response-time and ip igmp query-timeout commands.

Examples

The following example configures the router to use IGMP Version 3:

ip igmp version 3

Related Commands

Command
Description

ip igmp query-max-response-time

Configures the maximum response time advertised in IGMP queries.

ip igmp query-timeout

Configures the timeout time before the router takes over as the querier for the interface, after the previous querier has stopped querying.

show ip igmp groups

Displays the multicast groups that are directly connected to the router and that were learned through IGMP.

show ip igmp interface

Displays multicast-related information about an interface.


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 {test-sender | test-receiver | test-sender-receiver}

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

Establishes Test Receivers for MRM.

senders

Configures Test Sender parameters used in 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

access-list

Number or name of IP access list applied to the Managers.

test-sender

(Optional) Applies the access list only to the Test Sender.

test-receiver

(Optional) Applies the access list only to the Test Receiver.


Defaults

If neither the test-sender nor test-receiver keyword 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.


ip mrm manager

To identify a Multicast Routing Monitor (MRM) test and enter the mode in which you specify the test parameters, 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 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 argument 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.


ip mroute

To configure a multicast static route (mroute), use the ip mroute command in global configuration mode. To remove the route, use the no form of this command.

ip mroute [vrf vrf-name] source-address mask [protocol as-number] {rpf-address | interface-type interface-number} [distance]

no ip mroute [vrf vrf-name] source mask [protocol as-number] {rpf-address | interface-type interface-number} [distance]

Syntax Description

vrf

(Optional) Supports the Multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

source-address

IP address of the multicast source.

mask

Mask on the IP address of the multicast source.

protocol

(Optional) Unicast routing protocol that you are using.

as-number

(Optional) Autonomous system number of the routing protocol you are using, if applicable.

rpf-address

Incoming interface for the mroute. If the Reverse Path Forwarding (RPF) address rpf-address is a Protocol Independent Multicast (PIM) neighbor, PIM join, graft, and prune messages are sent to it. The rpf-address argument can be a host IP address of a directly connected system or a network/subnet number. When it is a route, a recursive lookup is done from the unicast routing table to find a directly connected system. If the rpf-address argument is not specified, the interface interface-type interface-number value is used as the incoming interface.

interface-type interface-number

Interface type and number for the mroute. A space is not needed between the values.

distance

(Optional) Determines whether a unicast route, a Distance Vector Multicast Routing Protocol (DVMRP) route, or a static mroute should be used for the RPF lookup. The lower distances have better preference. If the static mroute has the same distance as the other two RPF sources, the static mroute will take precedence. The default is 0.


Defaults

distance: 0

Command Modes

Global configuration

Command History

Release
Modification

11.0

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

This command allows you to statically configure where multicast sources are located (even though the unicast routing table shows something different).

When a source range is specified, the rpf-address argument applies only to those sources.

Examples

The following example configures all sources via a single interface (in this case, a tunnel):

ip mroute 224.0.0.0 255.255.255.255 tunnel0

The following example configures all specific sources within a network number to be reachable through 172.30.10.13:

ip mroute 172.16.0.0 255.255.0.0 172.30.10.13

The following example causes this multicast static route to take effect if the unicast routes for any given destination go away:

ip mroute 224.0.0.0 255.255.255.255 serial0 200

ip mroute-cache

To configure IP multicast fast switching or multicast distributed switching (MDS), use the ip mroute-cache command in interface configuration mode. To disable either of these features, use the no form of this command.

ip mroute-cache [distributed]

no ip mroute-cache [distributed]

Syntax Description

distributed

(Optional) Enables MDS on the interface. In the case of Cisco 7500 series routers, this keyword is optional; if it is omitted, fast switching occurs. On the Cisco 12000 series, this keyword is required because the Cisco 12000 series does only distributed switching.


Defaults

On the Cisco 7500 series, IP multicast fast switching is enabled; MDS is disabled.
On the Cisco 12000 series, MDS is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.

11.2(11)GS

The distributed keyword was added.


Usage Guidelines

On the Cisco 7500 Series

If multicast fast switching is disabled on an incoming interface for a multicast routing table entry, the packet will be sent at process level for all interfaces in the outgoing interface list.

If multicast fast switching is disabled on an outgoing interface for a multicast routing table entry, the packet is process-level switched for that interface, but may be fast switched for other interfaces in the outgoing interface list.

When multicast fast switching is enabled (like unicast routing), debug messages are not logged. If you want to log debug messages, disable fast switching.

If MDS is not enabled on an incoming interface that is capable of MDS, incoming multicast packets will not be distributed switched; they will be fast switched at the Route Processor (RP). Also, if the incoming interface is not capable of MDS, packets will get fast switched or process-switched at the RP.

If MDS is enabled on the incoming interface, but at least one of the outgoing interfaces cannot fast switch, packets will be process switched. We recommend that you disable fast switching on any interface when MDS is enabled.

On the Cisco 12000 Series

On the GSR, all interfaces should be configured for MDS because that is the only switching mode.

Examples

The following example enables IP multicast fast switching on the interface:

ip mroute-cache

The following example disables IP multicast fast switching on the interface:

no ip mroute-cache

The following example enables MDS on the interface:

ip mroute-cache distributed

The following example disables MDS and IP multicast fast switching on the interface:

no ip mroute-cache distributed

ip msdp border

To configure a router that borders a Protocol Independent Multicast (PIM) sparse mode region and dense mode region to use Multicast Source Discovery Protocol (MSDP), use the ip msdp border command in global configuration mode. To prevent this action, use the no form of this command.

ip msdp [vrf vrf-name] border sa-address interface-type interface-number

no ip msdp [vrf vrf-name] border sa-address interface-type interface-number

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

sa-address

Specifies the active source IP address.

interface-type interface-number

Interface type and number from which the IP address is derived and used as the rendezvous point (RP) address in Source-Active (SA) messages. Thus, MSDP peers can forward SA messages away from this border. The IP address of the interface is used as the originator ID, which is the RP field in the MSDP SA message. No space is needed between the values.


Defaults

The active sources in the dense mode region will not participate in MSDP.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

Use this command if you want the router to send SA messages for sources active in the PIM dense mode region to MSDP peers.


Note We recommend configuring the border router in the sparse mode domain to proxy-register sources in the dense mode domain, and have the sparse mode domain use standard MSDP procedures to advertise these sources.



Note If you use this command, you must constrain the sources advertised by using the ip msdp redistribute command. Configure the ip msdp redistribute command to apply to only local sources. Be aware that this configuration can result in (S, G) state remaining long after a source in the dense mode domain has stopped sending.



Note The ip msdp originator-id command also identifies an interface type and number to be used as the RP address. If both the ip msdp border and ip msdp originator-id commands are configured, the address derived from the ip msdp originator-id command determines the address of the RP.


Examples

In the following example, the local router is not an RP. It borders a PIM sparse mode region with a dense mode region. It uses the IP address of Ethernet interface 0 as the "RP" address in SA messages.

ip msdp border sa-address ethernet0

Related Commands

Command
Description

ip msdp originator-id

Allows an MSDP speaker that originates an SA message to use the IP address of its interface as the RP address in the SA message.

ip msdp redistribute

Configures which (S, G) entries from the multicast routing table are advertised in SA messages originated to MSDP peers.


ip msdp cache-rejected-sa

To cache Source-Active (SA) request messages rejected from Multicast Source Discovery Protocol (MSDP) peers, use the ip msdp cache-rejected-sa command in global configuration mode. To stop tracking SA request messages, use the no form of this command.

ip msdp cache-rejected-sa number-of-entries

no ip msdp cache-rejected-sa number-of-entries

Syntax Description

number-of-entries

Number of entries to be cached. The range is from 1 to 32766.


Defaults

Rejected SA request messages are not stored.

Command Modes

Global configuration

Command History

Release
Modification

12.0(22)S

This command was introduced.

12.1E

This command was integrated into Cisco IOS Release 12.1E.

12.2

This command was integrated into Cisco IOS Release 12.2.


Usage Guidelines

Use the ip msdp cache-rejected-sa command to configure the router to store SA messages that have been recently received from an MSDP peer but were rejected. Once this command is enabled, the router will maintain a rejected SAcache that stores the most recent rejected SA messages. The number of rejected SA message entries to be stored in the rejected SA cache is configured with the number-of-entries argument. If the rejected SA cache overflows, entries are overwritten, starting from the first entry.


Note Enabling the ip msdp cache-rejected-sa command will not impact the performance of MSDP.


Use the show ip msdp sa-cache command with the rejected-sa keyword to display SA messages rejected from MSDP peers.

Examples

The following example shows how to enable the router to store a maximum of 200 messages rejected from MSDP peers:

Router(config)# ip msdp cache-rejected-sa 200

Related Commands

Command
Description

show ip msdp sa-cache

Displays the (S, G) state learned from MSDP peers.


ip msdp cache-sa-state

To have the router create Source-Active (SA) state, use the ip msdp cache-sa-state command in global configuration mode.

ip msdp cache-sa-state [vrf vrf-name]

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.


Defaults

The router creates SA state for all Multicast Source Discovery Protocol (MSDP) SA messages it receives.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.1(7)

This command was modified such that it is enabled by default and cannot be disabled.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

This command is automatically configured if at least one MSDP peer is configured. It cannot be disabled.

If you are running a version of Cisco IOS software prior to Release 12.1(7), we recommend enabling the ip msdp cache-sa-state command.

Examples

The following example shows how the ip msdp cache-sa-state command is enabled when an MSDP peer is configured.

.
.
.
ip classless
ip msdp peer 192.168.1.2 connect-source Loopback0
ip msdp peer 192.169.1.7
ip msdp mesh-group outside-test 192.168.1.2
ip msdp cache-sa-state
ip msdp originator-id Loopback0
.
.

Related Commands

Command
Description

clear ip msdp sa-cache

Clears MSDP SA cache entries.

ip msdp sa-request

Configures the router to send SA request messages to the MSDP peer when a new joiner from the group becomes active.

show ip msdp sa-cache

Displays (S, G) state learned from MSDP peers.


ip msdp default-peer

To define a default peer from which to accept all Multicast Source Discovery Protocol (MSDP) Source-Active (SA) messages, use the ip msdp default-peer command in global configuration mode. To remove the default peer, use the no form of this command.

ip msdp [vrf vrf-name] default-peer {peer-address | peer-name} [prefix-list list]

no ip msdp [vrf vrf-name] default-peer

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or Domain Name System (DNS) name of the MSDP default peer.

prefix-list list

(Optional) Specifies the Border Gateway Protocol (BGP) prefix list that specifies that the peer will be a default peer only for the prefixes listed in the list specified by the list argument. A BGP prefix list must be configured for this prefix-list list keyword and argument to have any effect.


Defaults

No default MSDP peer exists.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

Use the ip msdp default-peer command if you do not want to configure your MSDP peer to be a BGP peer also.

If only one MSDP peer is configured (with the ip msdp peer command), it will be used as a default peer. Therefore, you need not configure a default peer with this command.

If the prefix-list list keyword and argument are not specified, all SA messages received from the configured default peer are accepted.

Remember to configure a BGP prefix list if you intend to configure the prefix-list list keyword and argument with the ip msdp default-peer command.

If the prefix-list list keyword and argument are specified, SA messages originated from rendezvous points (RPs) specified by the prefix-list list keyword and argument will be accepted from the configured default peer. If the prefix-list list keyword and argument are specified but no prefix list is configured, the default peer will be used for all prefixes.

You can enter multiple ip msdp default-peer commands, with or without the prefix-list keyword, as follows. However, all commands must either have the keyword or all must not have the keyword.

When you use multiple ip msdp default-peer commands with the prefix-list keyword, all the default peers are used at the same time for different RP prefixes. This syntax is typically used in a service provider cloud that connects stub site clouds.

When you use multiple ip msdp default-peer commands without the prefix-list keyword, a single active peer is used to accept all SA messages. If that peer goes down, then the next configured default peer accepts all SA messages. This syntax is typically used at a stub site.

Examples

The following example configures the router at IP address 192.168.1.3 as the default peer to the local router:

ip msdp peer 192.168.1.3
ip msdp peer 192.168.3.5
ip msdp default-peer 192.168.1.3

The following example configures two default peers:

ip msdp peer 172.18.2.3
ip msdp peer 172.19.3.5
ip msdp default-peer 172.18.2.3 prefix-list site-c
ip prefix-list site-a permit 172.18.0.0/16
ip msdp default-peer 172.19.3.5 prefix-list site-a
ip prefix-list site-c permit 172.19.0.0/16

Related Commands

Command
Description

ip msdp peer

Configures an MSDP peer.

ip prefix-list

Creates a prefix list.


ip msdp description

To add descriptive text to the configuration for a Multicast Source Discovery Protocol (MSDP) peer, use the ip msdp description command in global configuration mode. To remove the description, use the no form of this command.

ip msdp [vrf vrf-name] description {peer-name | peer-address} text

no ip msdp [vrf vrf-name] description {peer-name | peer-address}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-name | peer-address

Peer name or address to which this description applies.

text

Description of the MSDP peer.


Defaults

No description is associated with an MSDP peer.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

Configure a description to make the MSDP peer easier to identify. This description is displayed in the output of the show ip msdp peer command.

Examples

The following example configures the router at the IP address 172.17.1.2 with a description indicating it is a router at customer A:

ip msdp description 172.17.1.2 router at customer a

Related Commands

Command
Description

show ip msdp peer

Displays detailed information about the MSDP peer.


ip msdp filter-sa-request

To configure the router to send Source-Active (SA) request messages to the Multicast Source Discovery Protocol (MSDP) peer when a new joiner from a group becomes active, use the ip msdp filter-sa-request command in global configuration mode. To prevent this action, use the no form of this command.

ip msdp [vrf vrf-name] filter-sa-request {peer-address | peer-name} [list access-list]

no ip msdp [vrf vrf-name] filter-sa-request {peer-address | peer-name}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or name of the MSDP peer from which the local router requests SA messages when a new joiner for the group becomes active.

list access-list

(Optional) Specifies the standard IP access list number or name that describes a multicast group address. If no access list is specified, all SA request messages are ignored.


Defaults

If this command is not configured, all SA request messages are honored. If this command is configured but no access list is specified, all SA request messages are ignored.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

By default, the router honors all SA request messages from peers. Use this command if you want to control exactly which SA request messages the router will honor.

If no access list is specified, all SA request messages are ignored. If an access list is specified, only SA request messages from those groups permitted will be honored, and all others will be ignored.

Examples

The following example configures the router to filter SA request messages from the MSDP peer at 172.16.2.2. SA request messages from sources on the network 192.168.22.0 pass access list 1 and will be honored; all others will be ignored.

ip msdp filter sa-request 172.16.2.2 list 1
access-list 1 permit 192.4.22.0 0.0.0.255

Related Commands

Command
Description

ip msdp peer

Configures an MSDP peer.


ip msdp mesh-group

To configure a Multicast Source Discovery Protocol (MSDP) peer to be a member of a mesh group, use the ip msdp mesh-group command in global configuration mode. To remove an MSDP peer from a mesh group, use the no form of this command.

ip msdp [vrf vrf-name] mesh-group mesh-name {peer-address | peer-name}

no ip msdp [vrf vrf-name] mesh-group mesh-name {peer-address | peer-name}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

mesh-name

Name of the mesh group.

peer-address | peer-name

IP address or name of the MSDP peer to be a member of the mesh group.


Defaults

The MSDP peers do not belong to a mesh group.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

A mesh group is a group of MSDP speakers that have fully meshed MSDP connectivity among themselves. Source-Active (SA) messages received from a peer in a mesh group are not forwarded to other peers in the same mesh group.

Mesh groups can be used to achieve two goals:

To reduce SA message flooding

To simplify peer-Reverse Path Forwarding (RPF) flooding (no need to run Border Gateway Protocol [BGP] or multiprotocol BGP among MSDP peers)

Examples

The following example configures the MSDP peer at address 192.168.1.3 to be a member of the mesh group named internal:

ip msdp mesh-group internal 192.168.1.3

ip msdp originator-id

To allow a Multicast Source Discovery Protocol (MSDP) speaker that originates a Source-Active (SA) message to use the IP address of the interface as the rendezvous point (RP) address in the SA message, use the ip msdp originator-id command in global configuration mode. To prevent the RP address from being derived in this way, use the no form of this command.

ip msdp [vrf vrf-name] originator-id interface-type interface-number

no ip msdp [vrf vrf-name] originator-id interface-type interface-number

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

interface-type interface-number

Interface type and number on the local router whose IP address is used as the RP address in SA messages. No space is needed between the values.


Defaults

The RP address is used as the originator ID.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

The ip msdp originator-id command identifies an interface type and number to be used as the RP address in an SA message.

Use this command if you want to configure a logical RP. Because only RPs and MSDP border routers originate SAs, there are times when it is necessary to change the ID used for this purpose.

If both the ip msdp border sa-address and ip msdp originator-id commands are configured the address derived from the ip msdp originator-id command determines the address of the RP to be used in the SA message.

Examples

The following example configures the IP address of Ethernet interface 1 as the RP address in SA messages:

ip msdp originator-id ethernet1

Related Commands

Command
Description

ip msdp border

Configures a router that borders a PIM sparse mode region and dense mode region to use MSDP.


ip msdp peer

To configure a Multicast Source Discovery Protocol (MSDP) peer, use the ip msdp peer command in global configuration mode. To remove the peer relationship, use the no form of this command.

ip msdp [vrf vrf-name] peer {peer-name | peer-address} [connect-source interface-type interface-number] [remote-as as-number]

no ip msdp [vrf vrf-name] peer {peer-name | peer-address}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-name | peer-address

Domain Name System (DNS) name or IP address of the router that is to be the MSDP peer.

connect-source interface-type interface-number

(Optional) Specifies the interface type and number whose primary address becomes the source IP address for the TCP connection. This interface is on the router being configured.

remote-as as-number

(Optional) Specifies the autonomous system number of the MSDP peer. This is used for display purposes only.

There are cases where a peer might appear to be in another autonomous system (other than the one it really resides in) when you have an MSDP peering session but do not have a Border Gateway Protocol (BGP) peer session with that peer. In this case, if the prefix of the peer is injected by another autonomous system, it is displayed as the autonomous system number of the peer (and is misleading).


Defaults

No MSDP peer is configured.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

The router specified should also be configured as a BGP neighbor.

If you are also BGP peering with this MSDP peer, you should use the same IP address for MSDP as you do for BGP. However, you are not required to run BGP or multiprotocol BGP with the MSDP peer, as long as there is a BGP or MBGP path between the MSDP peers. If there is no path, you must configure the ip msdp default-peer command.

Examples

The following example configures the router at the IP address 192.168.1.2 as an MSDP peer to the local router. The neighbor belongs to autonomous system 109.

ip msdp peer 192.168.1.2 connect-source ethernet 0/0
router bgp 110
 network 192.168.0.0
 neighbor 192.168.1.2 remote-as 109
 neighbor 192.168.1.2 update-source ethernet 0/0

The following example configures the router at the IP address 192.168.1.3 as an MSDP peer to the local router:

ip msdp peer 192.168.1.3

The following example configures the router at the IP address 192.168.1.4 to be an MSDP peer in autonomous system 109. The primary address of Ethernet interface 0/0 is used as the source address for the TCP connection.

ip msdp peer 192.168.1.4 connect-source ethernet 0/0 remote-as 109

Related Commands

Command
Description

ip msdp default-peer

Defines a default peer from which to accept all MSDP SA messages.

neighbor remote-as

Adds an entry to the BGP neighbor table.


ip msdp redistribute

To configure which (S, G) entries from the multicast routing table are advertised in Source-Active (SA) messages originated to Multicast Source Discovery Protocol (MSDP) peers, use the ip msdp redistribute command in global configuration mode. To remove the filter, use the no form of this command.

ip msdp [vrf vrf-name] redistribute [list access-list-name] [asn as-access-list-number] [route-map map-name]

no ip msdp [vrf vrf-name] redistribute

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

list access-list-name

(Optional) Specifies the standard or extended IP access list number or name that controls which local sources are advertised and to which groups they send.

asn as-access-list-number

(Optional) Specifies the standard or extended IP access list number in the range from 1 to 199. This access list number must also be configured in the ip as-path command.

route-map map-name

(Optional) Defines the route map.


Defaults

If no portion of this command is configured, only local sources are advertised, provided they send to groups for which the router is a rendezvous point (RP).
If no portion of this command is configured and if the ip msdp border sa-address command is configured, all local sources are advertised.
If the ip msdp redistribute command is configured with no keywords, no multicast sources are advertised.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

This command affects SA message origination, not SA message forwarding. If you want to filter which SA messages are forwarded to MSDP peers, use the ip msdp sa-filter in or ip msdp sa-filter out command.

The ip msdp redistribute command controls which (S, G) pairs the router advertises from the multicast routing table. By default, only sources within the local domain are advertised. Use the following guidelines for the ip msdp redistribute command:

If you specify the list access-list-name keyword and argument only, you filter which local sources are advertised and to which groups they send. The access list specifies a source address, source mask, group address, and group mask.

If you specify the asn as-access-list-number keyword and argument only, you advertise all sources sending to any group that pass through the autonomous system path access list. The autonomous system path access list number refers to the ip as-path command, which specifies an access list. If the asn 0 keywords are specified, sources from all autonomous systems are advertised. The asn 0 keywords are useful when connecting dense mode domains to a sparse mode domain running MSDP, or when using MSDP in a router that is not configured with Border Gateway Protocol (BGP). In these cases, you do not know if a source is local.

If you specify the route-map map-name keyword and argument only, you advertise all sources that satisfy the match criteria in the route map map-name argument.

If you specify all three keywords (list, asn, and route-map), all conditions specified by these keywords must be true before any multicast source is advertised in an SA message.

If you specify the ip multicast redistribute command with no other keywords or arguments, no multicast sources are advertised.

Examples

The following example configures which (S, G) entries from the multicast routing table are advertised in SA messages originated to MSDP peers:

ip msdp redistribute route-map customer-sources

route-map customer-sources permit
match as-path customer-as

ip as-path access-list ^109$

Related Commands

Command
Description

ip as-path

Defines a BGP-related access list.

ip msdp border

Configures a router that borders a PIM sparse mode region and dense mode region to use MSDP.

ip msdp sa-filter in

Configures an incoming filter list for SA messages received from the specified MSDP peer.

ip msdp sa-filter out

Configures an outgoing filter list for SA messages sent to the MSDP peer.


ip msdp rpf rfc3618

To enable Internet Engineering Task Force (IETF) RFC 3618-compliant MSDP Peer-RPF forwarding rules, use the ip msdp rpf rfc3618 command in global configuration mode. To revert to non-IETF compliant rules, use the no form of this command.

ip msdp [vrf vrf-name] rpf rfc3618

no ip msdp [vrf vrf-name] rpf rfc3618

Syntax Description

vrf

(Optional) Supports the multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.


Defaults

The peer-RPF forwarding rules that are compliant with IETF MSDP RFC 3618 are not enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.3(4)T

This command was introduced.

12.2(25)S

This command was integrated into Cisco IOS Release 12.2(25)S.


Usage Guidelines

Use this command to be compliant with IETF MSDP RFC 3618. Such compliance allows you to use BGP route reflectors without running MSDP on them. It also allows you to use an IGP for the RPF check and thereby run peerings without BGP or MBGP.

Examples

The following example enables MSDP peer-RPF forwarding rules that are compliant with IETF MSDP RFC 3618:

ip msdp rpf rfc3618

Related Commands

Command
Description

show ip msdp rpf

Displays the unique MSDP peer information from which the router will accept SA messages originating from the specified RP.


ip msdp sa-filter in

To configure an incoming filter list for Source-Active (SA) messages received from the specified Multicast Source Discovery Protocol (MSDP) peer, use the ip msdp sa-filter in command in global configuration mode. To remove the filter, use the no form of this command.

ip msdp [vrf vrf-name] sa-filter in {peer-address | peer-name} [list access-list-name] [route-map map-name]

no ip msdp [vrf vrf-name] sa-filter in {peer-address | peer-name} [list access-list-name] [route-map map-name]

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or name of the MSDP peer from which the SA messages are filtered.

list access-list-name

(Optional) Specifies the IP access list number or name. If no access list is specified, all source/group pairs from the peer are filtered.

route-map map-name

(Optional) Specifies the route map name. From the specified MSDP peer, passes only those SA messages that meet the match criteria in the route map map-name argument.

If all match criteria are true, a permit keyword from the route map will pass routes through the filter. A deny keyword will filter routes.


Defaults

If this command is not configured, no incoming messages are filtered; all SA messages are accepted from the peer.
If the command is configured, but no access list or route map is specified, all source/group pairs from the peer are filtered.
If both the list and route-map keywords are used, all conditions specified by these keywords must be true to pass any (S, G) pair in incoming SA messages.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Examples

The following example configures the router to filter all SA messages from the peer at 192.168.1.3:

ip msdp peer 192.168.1.3 connect-source Ethernet0/0
ip msdp sa-filter in 192.168.1.3

Related Commands

Command
Description

ip msdp peer

Configures an MSDP peer.

ip msdp sa-filter out

Configures an outgoing filter list for SA messages sent to the specified MSDP peer.


ip msdp sa-filter out

To configure an outgoing filter list for Source-Active (SA) messages sent to the specified Multicast Source Discovery Protocol (MSDP) peer, use the ip msdp sa-filter out command in global configuration mode. To remove the filter, use the no form of this command.

ip msdp [vrf vrf-name] sa-filter out {peer-address | peer-name} [list access-list-name] [route-map map-name]

no ip msdp [vrf vrf-name] sa-filter out {peer-address | peer-name} [list access-list-name] [route-map map-name]

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or Domain Name System (DNS) name of the MSDP peer to which the SA messages are filtered.

list access-list-name

(Optional) Specifies the extended IP access list number or name. If no access list is specified, all source/group pairs are filtered. To the specified MSDP peer, passes only those SA messages that pass the extended access list.

If both the list and route-map keywords are used, all conditions specified by these keywords must be true to pass any (S, G) pairs in outgoing SA messages.

route-map map-name

(Optional) Specifies the route map name. To the specified MSDP peer, passes only those SA messages that meet the match criteria in the route map map-name argument.

If all match criteria are true, a permit keyword from the route map will pass routes through the filter. A deny keyword will filter routes.


Defaults

If this command is not configured, no outgoing messages are filtered; all SA messages received are forwarded to the peer.
If the command is configured, but no access list or route map is specified, all source/group pairs are filtered.
If both the list and route-map keywords are used, all conditions specified by these keywords must be true to pass any (S, G) pairs in outgoing SA messages.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Examples

The following example allows only (S, G) pairs that pass access list 100 to be forwarded in an SA message to the peer at the IP address 192.168.1.5:

ip msdp peer 192.168.1.5 connect-source ethernet 0/0
ip msdp sa-filter out 192.168.1.5 list 100
access-list 100 permit ip 172.1.0.0 0.0.255.255 224.2.0.0 0.0.255.255

Related Commands

Command
Description

ip msdp peer

Configures an MSDP peer.

ip msdp sa-filter in

Configures an incoming filter list for SA messages received from the specified MSDP peer.


ip msdp sa-limit

To limit the number of Source-Active (SA) messages from a Multicast Source Discovery Protocol (MSDP) peer that the router will allow in the SA cache, use the ip msdp sa-limit command in global configuration mode. To remove this limit, use the no form of this command.

ip msdp sa-limit {peer-name | peer-address} sa-limit

no ip msdp sa-limit {peer-name | peer-address} sa-limit

Syntax Description

peer-name | peer-address

Domain Name System (DNS) name or IP address of the router that is to be the MSDP peer.

sa-limit

Maximum number of SA messages from an MSDP peer allowed in the SA cache.


Defaults

By default, no SA message limit is set.

Command Modes

Global configuration

Command History

Release
Modification

12.1(7)

This command was introduced.


Usage Guidelines

Use this command to prevent distributed denial of service attacks. We recommend configuring this command on all MSDP peer connections.

The output of the show ip msdp count, show ip msdp peer, and show ip msdp summary commands will display the number of SA messages from each MSDP peer that is in the SA cache. If the ip msdp sa-limit command is configured, the output of the show ip msdp peer command will also display the value of the SA message limit for each MSDP peer.

Examples

The following example configures the SA message limit to 100 for the MSDP peer with IP address 172.16.0.0:

ip msdp sa-limit 172.16.0.0 100

Related Commands

Command
Description

show ip msdp count

Displays the number of sources and groups originated in MSDP SA messages.

show ip msdp peer

Displays detailed information about the MSDP peer.

show ip msdp summary

Displays MSDP peer status.


ip msdp sa-request


Note Effective with Cisco IOS Release 12.3(4)T, the ip msdp sa-request is not available in Cisco IOS software.


To configure the router to send Source-Active (SA) request messages to the Multicast Source Discovery Protocol (MSDP) peer when a new joiner from the group becomes active, use the ip msdp sa-request command in global configuration mode. To prevent this action, use the no form of this command.

ip msdp [vrf vrf-name] sa-request {peer-address | peer-name}

no ip msdp [vrf vrf-name] sa-request {peer-address | peer-name}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or name of the MSDP peer from which the local router requests SA messages when a new joiner for the group becomes active.


Defaults

The router does not send SA request messages to the MSDP peer.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.0(26)S

This command was removed.

12.2(13)T

The vrf keyword and vrf-name argument were added.

12.2(20)S

This command was removed.

12.3(4)T

This command was removed.


Usage Guidelines

By default, the router does not send any SA request messages to its MSDP peers when a new member joins a group and wants to receive multicast traffic. The new member waits to receive any SA messages that eventually arrive.

Use this command if you want a new member of a group to learn the current, active multicast sources in a connected Protocol Independent Multicast sparse mode (PIM-SM) domain that are sending to a group. The router will send SA request messages to the specified MSDP peer when a new member joins a group. The peer replies with the information in its SA cache. If the peer does not have a cache configured, this command provides nothing.

An alternative to this command is using the ip msdp cache-sa-state command to have the router cache messages.

Examples

The following example configures the router to send SA request messages to the MSDP peer at the IP address 192.168.10.1:

ip msdp sa-request 192.168.10.1

Related Commands

Command
Description

ip msdp cache-sa-state

Enables the router to create SA state.

ip msdp peer

Configures an MSDP peer.


ip msdp shutdown

To administratively shut down a configured Multicast Source Discovery Protocol (MSDP) peer, use the ip msdp shutdown command in global configuration mode. To bring the peer back up, use the no form of this command.

ip msdp [vrf vrf-name] shutdown {peer-address | peer-name}

no ip msdp [vrf vrf-name] shutdown {peer-address | peer-name}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or name of the MSDP peer to shut down.


Defaults

No action is taken to shut down an MSDP peer.

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Examples

The following example shuts down the MSDP peer at IP address 192.168.7.20:

ip msdp shutdown 192.168.7.20

Related Commands

Command
Description

ip msdp peer

Configures an MSDP peer.


ip msdp ttl-threshold

To limit which multicast data packets are sent in Source-Active (SA) messages to a Multicast Source Discovery Protocol (MSDP) peer, use the ip msdp ttl-threshold command in global configuration mode. To restore the default value, use the no form of this command.

ip msdp [vrf vrf-name] ttl-threshold {peer-address | peer-name} ttl-value

no ip msdp [vrf vrf-name] ttl-threshold {peer-address | peer-name}

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

peer-address | peer-name

IP address or name of the MSDP peer to which the ttl-value argument value applies.

ttl-value

Time-to-live (TTL) value. The default value of the ttl-value argument is 0, meaning all multicast data packets are forwarded to the peer until the TTL is exhausted.


Defaults

ttl-value: 0

Command Modes

Global configuration

Command History

Release
Modification

12.0(7)T

This command was introduced.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

This command limits which multicast data packets are sent in data-encapsulated SA messages. Only multicast packets with an IP header TTL greater than or equal to the ttl-value argument are sent to the MSDP peer specified by the IP address or name.

Use this command if you want to use TTL to scope your multicast data traffic. For example, you could limit internal traffic to a TTL of 8. If you want other groups to go to external locations, you would need to send those packets with a TTL greater than 8.

Examples

The following example configures a TTL threshold of 8 hops:

ip msdp ttl-threshold 192.168.1.5 8

Related Commands

Command
Description

ip msdp peer

Configures an MSDP peer.


ip multicast boundary

To configure an administratively scoped boundary, use the ip multicast boundary command in interface configuration mode. To remove the boundary, use the no form of this command.

ip multicast boundary access-list [filter-autorp | in | out]

no ip multicast boundary access-list [filter-autorp | in | out]

Syntax Description

access-list

Number or name identifying an access list that controls the range of group addresses affected by the boundary.

filter-autorp

(Optional) Filters Auto RP messages denied by the boundary access control list (ACL).

in

(Optional) Indicates that the boundary only applies to the (S,G) creation checks that use Reverse Path forwarding (RPF) to the interface.

out

(Optional) Indicates that the boundary is only applied for the outgoing interface.


Defaults

There is no boundary.

Command Modes

Interface configuration

Command History

Release
Modification

11.1

This command was introduced.

12.0(22)S

The filter-autorp keyword was added.

12.1(12c)E

The filter-autorp keyword was integrated into Cisco IOS Release 12.1(12c)E.

12.2(11)

The filter-autorp keyword was integrated into Cisco IOS Release 12.2(11).

12.2(13)T

The filter-autorp keyword was integrated into Cisco IOS Release 12.2(13)T.

12.3(11)T

The in and out keywords were added.


Usage Guidelines

Use this command to configure an administratively scoped boundary on an interface to filter multicast group addresses in the range defined by the access-list argument. A standard access list defines the range of addresses affected. When this command is configured, no multicast data packets are allowed to flow across the boundary from either direction. Restricting multicast data packet flow enables reuse of the same multicast group address in different administrative domains.


Note Extended access lists are not allowed with the filter-autorp keyword or the use of no keywords.


If you configure the filter-autorp keyword, the administratively scoped boundary also examines Auto-RP discovery and announcement messages and removes any Auto-RP group range announcements from the Auto-RP packets that are denied by the boundary ACL. An Auto-RP group range announcement is permitted and passed by the boundary only if all addresses in the Auto-RP group range are permitted by the boundary ACL. If any address is not permitted, the entire group range is filtered and removed from the Auto-RP message before the Auto-RP message is forwarded.

The following rules govern the ip multicast boundary command:

The in and out keywords support standard or extended access lists for directional SSM filtering.

One instance of the in and out keywords can be configured on an interface.

The in and out keywords can be used for standard or extended access lists.

Only standard access lists are permitted with the use of the filter-autorp keyword or no keyword.

A maximum of three instances of a command will be allowed on an interface: one instance of in, one instance of out, and one instance of filter-autorp or no keyword.

When multiple instances of the command are used, the filtering will be cumulative. If a boundary statement with no keyword exists with a boundary statement with the in keyword, both access lists will be applied on the in direction and a match on either one will be sufficient.

All instances of the command apply to both control and data plane traffic.

Protocol information on the extended access list is parsed to allow reuse and filtering for IOS consistency. An (S,G) operation will be filtered by an extended access list under all conditions stated above for keywords if the access list filters (S,G) traffic for all protocols.

Examples

The following example sets up a boundary for all administratively scoped addresses:

access-list 1 deny 239.0.0.0 0.255.255.255
access-list 1 permit 224.0.0.0 15.255.255.255
interface ethernet 0
 ip multicast boundary 1

The following example sets up a boundary for an extended ACL:

access-list 101 permit ip host 161.10.10.200 232.1.1.0 0.0.0.255
access-list 101 permit ip host 0.0.0.0 232.1.1.0 0.0.0.255
interface ethernet 0
 ip multicast boundary 101

The following example permits outgoing traffic for (181.1.2.201, 232.1.1.1) and (181.1.2.202, 232.1.1.1) and denies all other (S,G)s.

ip access-list extended acc_grp1
permit ip host 0.0.0.0 232.1.1.1 0.0.0.255
permit ip host 181.1.2.201 host 232.1.1.1
permit udp host 181.1.2.202 host 232.1.1.1
permit ip host 181.1.2.202 host 232.1.1.1
deny igmp host 181.2.3.303 host 232.1.1.1
interface ethernet 2/3
 ip multicast boundary acc_grp1 out

The following example permits outgoing traffic for (181.1.2.201, 232.1.1.5) and 181.1.2.202, 232.1.1.5).

ip access-list extended acc_grp6
permit ip host 0.0.0.0 232.1.1.1 5.0.0.255
deny udp host 181.1.2.201 host 232.1.1.5
permit ip host 181.1.2.201 host 232.1.1.5
deny pim host 181.1.2.201 host 232.1.1.5
permit ip host 181.1.2.202 host 232.1.1.5
deny igmp host 181.2.3.303 host 232.1.1.1
interface ethernet 2/3
 ip multicast boundary acc_grp6 out

The following example denies a group-range that is being announced by the candidate RP. Since the group range is denied, there will be no pim auto rp mappings created. 255.9,9,9/8 is denied by the filter-autorp command and the entry does not exist in the RP mapping cache.

ip access-list standard acc_grp10
deny 225.0.0.0 0.255.255.255
permit any
access-list extended acc_grp12
permit pim host 181.1.2.201 host 232.1.1.8
deny udp host 181.1.2.201 host 232.1.1.8
permit pim host 181.1.2.203 0.0.0.255 host 227.7.7.7
permit ip host 0.0.0.0 host 227.7.7.7
permit ip 181.1.2.203 0.0.0.255 host 227.7.7.7
permit ip host 181.1.2.201 host 232.1.1.7
ip access-list extended acc_grp13
deny ip host 181.1.2.201 host 232.1.1.8
permit ip any any
interface ethernet 2/3
 ip multicast boundary acc_grp10 filter-autorp
 ip multicast boundary acc_grp12 out
 ip multicast boundary acc_grp13 in

Related Commands

Command
Description

access-list (IP standard)

Defines a standard IP access list.


ip multicast cache-headers

To allocate a circular buffer to store IP multicast packet headers that the router receives, use the ip multicast cache-headers command in global configuration mode. To remove the buffer, use the no form of this command.

ip multicast [vrf vrf-name] cache-headers [rtp]

no ip multicast [vrf vrf-name] cache-headers

Syntax Description

vrf

(Optional) Supports the multicast Virtual Private Network (VPN) routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.

rtp

(Optional) Caches Real-Time Transport Protocol (RTP) headers.


Defaults

The command is disabled.

Command Modes

Global configuration

Command History

Release
Modification

11.1

This command was introduced.

12.1

The rtp keyword was added.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

You can store IP multicast packet headers in a cache and then display them to determine the following information:

Who is sending IP multicast packets to which groups

Interpacket delay

Duplicate IP multicast packets (if any)

Multicast forwarding loops in your network (if any)

Scope of the group

User Datagram Protocol (UDP) port numbers

Packet length


Note This command allocates a circular buffer of approximately 32 KB. Do not configure this command if you are low on memory.


Use the show ip mpacket command to display the buffer.

ip multicast default-rpf-distance

When configuring Internet Group Management Protocol (IGMP) unidirectional link routing (UDLR), to change the distance given to the default Reverse Path Forwarding (RPF) interface, use the ip multicast default-rpf-distance command in global configuration mode. To restore the default value, use the no form of this command.

ip multicast default-rpf-distance distance

no ip multicast default-rpf-distance distance

Syntax Descriptionno ip multicast default-rpf-distance

distance

Distance given to the default RPF interface. The default value is 15.


Defaults

distance: 15

Command Modes

Global configuration

Command History

Release
Modification

12.0(3)T

This command was introduced.


Usage Guidelines

This command is optional. If you want to receive all multicast traffic from all sources on the unidirectional link (UDL), as long as 15 is the lowest distance, you need not change the value of 15.

The default RPF interface is selected when an IGMP query message is received on a UDL and indicates to the router that all sources will use RPF to reach the UDL interface.

Any explicit sources learned by routing protocols will take preference as long as their distance is less than the distance argument configured with the ip multicast default-rpf-distance command.

You might consider changing the default value for one of the following reasons:

To make IGMP prefer the UDL.

To configure a value less than existing routing protocols.

If you want to receive multicast packets from sources on interfaces other than the UDL interface. Configure a value greater than the distances of the existing routing protocols to make IGMP prefer the nonunidirectional link.

Examples

The following example configures a distance of 20:

ip multicast default-rpf-distance 20

Related Commands

Command
Description

ip igmp unidirectional-link

Configures an interface to be unidirectional and enables it for IGMP UDLR.


ip multicast heartbeat

To monitor the health of multicast delivery and be alerted when the delivery fails to meet certain parameters, use the ip multicast heartbeat command in global configuration mode. To disable the heartbeat, use the no form of this command.

ip multicast heartbeat group-address minimum-number window-size interval

no ip multicast heartbeat group-address minimum-number window-size interval

Syntax Description

group-address

A multicast group address (Class D address, from 224.0.0.0 to 239.255.255.255)

minimum-number

Minimal number of intervals where the heartbeats must be seen. The number must be less than or equal to the window size.

window-size

Number of intervals to monitor for the heartbeat.

interval

Number of seconds in which to receive a packet. Value must be a multiple of 10.


Defaults

This command is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(3)T

This command was introduced.


Usage Guidelines

The subject group is joined at the subject interface so that multicast data for the subject group will be attracted toward the subject router.

The router monitors multicast packets destined to the group address at the interval value. This is a binary decision. That is, the number of packets seen in this period is not as important as whether any packet for the group is seen.

If multicast packets were observed in less than the minimum-number value out of the last window-size value intervals, a Simple Network Management Protocol (SNMP) trap would be sent from this router to a network management station to indicate a loss of heartbeat exception. This trap will be defined in CISCO-IPMROUTE-MIB.my.

The interval value must be a multiple of 10. In multicast distributed switching (MDS), statistics from the Versatile Interface Processor (in the Route Switch Processor) or the Label Controller (in the Cisco 12000 series) are passed to the routing processor once every 10 seconds. Monitoring packets not in intervals of multiple of 10 seconds may lead to incorrect decisions.

This command does not create any multicast routing entries that are necessary for the monitoring of the heartbeat packets. These entries can be created by either the downstream members of the group, or with the ip pim join-group or ip pim static-group command. If a multicast routing entry corresponding to a group address expires due to lack of interest from the downstream members, the monitoring for the subject group would not work; that is, no more SNMP traps would be sent.

Examples

The following is an example configuration of the ip multicast heartbeat command:

snmp-server enable traps ipmulticast-heartbeat
ip multicast heartbeat 224.0.1.53 1 1 10

In this example, multicast packets forwarded through this router to group address 224.0.1.53 will be monitored. If no packet for this group is received in a 10-second interval, an SNMP trap will be sent to a designated SNMP management station.


Note It may take about 20 seconds of losing the multicast feed before the SNMP trap is sent.


Related Commands

Command
Description

debug ip mhbeat

Monitors the action of the heartbeat trap.

snmp-server enable traps

Enables the router to send SNMP traps.


ip multicast helper-map

To allow IP multicast routing in a multicast-capable internetwork between two broadcast-only internetworks, use the ip multicast helper-map command in interface configuration mode. To disable this function, use the no form of this command.

ip multicast helper-map {group-address broadcast-address | broadcast multicast-address} access-list

no ip multicast helper-map {group-address broadcast-address | broadcast multicast-address} access-list

Syntax Description

group-address

Multicast group address of traffic to be converted to broadcast traffic. Use this with the broadcast-address value.

broadcast-address

Address to which broadcast traffic is sent. Use this with the group-address value.

broadcast

Specifies the traffic is being converted from broadcast to multicast. Use this with the multicast-address value.

multicast-address

IP multicast address to which the converted traffic is directed. Use this with the broadcast keyword.

access-list

IP extended access list number or name that controls which broadcast packets are translated, based on the User Datagram Protocol (UDP) port number.


Defaults

No conversion between broadcast and multicast occurs.

Command Modes

Interface configuration

Command History

Release
Modification

11.1

This command was introduced.


Usage Guidelines

When a multicast-capable internetwork is between two broadcast-only internetworks, you can convert broadcast traffic to multicast at the first hop router, and convert it back to broadcast at the last hop router before delivering the packets to the broadcast clients. However, broadcast packets with the IP source address of 0.0.0.0 (such as a Dynamic Host Configuration Protocol [DHCP] request) will not be translated to any multicast group.

Thus, you can take advantage of the multicast capability of the intermediate multicast internetwork. This feature prevents unnecessary replication at the intermediate routers and allows multicast fast switching in the multicast internetwork.

If you need to send a directed broadcast to the subnet, the outgoing interface of the last hop router can be configured with an IP broadcast address of x.x.x.255, where x.x.x.0 is the subnet that you are trying to reach; otherwise the packet will be converted to 255.255.255.255.

Examples

The following example illustrates how a helper address on two routers converts from broadcast to multicast and back to broadcast.

The configuration on the first hop router converts a broadcast stream arriving at incoming interface Ethernet interface 0 destined to UDP port 4000 to a multicast stream. The access list denies other traffic from being forwarded into the multicast cloud. The traffic is sent to group address 224.5.5.5. Because fast switching does not perform such a conversion, the ip forward-protocol command causes the proper process level to perform the conversion.

The configuration on the last hop router converts the multicast stream at incoming interface Ethernet interface 1 back to broadcast. All multicast traffic emerging from the multicast cloud should not be converted to broadcast, only the traffic destined for UDP port 4000.

First Hop Router Configuration

interface ethernet 0
 ip directed-broadcast
 ip multicast helper-map broadcast 224.5.5.5 120
 ip pim dense-mode
!
access-list 120 permit any any udp 4000
access-list 120 deny any any udp
 ip forward-protocol udp 4000

Last Hop Router Configuration

interface ethernet 1
 ip directed-broadcast
 ip broadcast-address 172.16.0.0
 ip multicast helper-map 224.5.5.5 172.16.0.0
 ip pim dense-mode
!
access-list 135 permit any any udp 4000
access-list 135 deny any any udp
 ip forward-protocol udp 4000

Related Commands

Command
Description

ip directed-broadcast

Enables the translation of directed broadcast to physical broadcasts.

ip forward-protocol

Specifies which protocols and ports the router forwards when forwarding broadcast packets.


ip multicast limit

To configure an interface to be limited to a maximum number of entries in the multicast state for all groups and channels permitted by an access list, use the ip multicast limit command in interface configuration mode. To remove the limit, use the no form of this command.

ip multicast limit [connected | rpf | out out-list] access-list max-entries

no ip multicast limit [connected | rpf | out out-list] access-list max-entries

Syntax Description

connected

(Optional) Specifies (S,G) multicast routes that use Reverse Path Forwarding (RPF) to the interface, where S is directly connected to the interface.

rpf

(Optional) Indicates multicast routes that use RPF to the interface.

out out-list

(Optional) Indicates multicast routes having the interface as an entry in their outgoing interface (OIF) list.

access-list

Number or name identifying an access list that controls the multicast group addresses and sender source addresses affected by the limit.

max-entries

Maximum number of entries permitted by an access list.


Defaults

Multicast limit is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.3(14)T

This command was introduced.


Usage Guidelines

Use the ip multicast limit command to configure an interface to be limited to a maximum number of entries in the multicast state for all groups and channels permitted by the access list.

The following rules govern the ip multicast limit command:

When rpf is specified, the command only applies to the multicast routes that use Reverse Path Forwarding (RPF) to the interface.

When out is specified, the command only applies to the multicast routes that have the interface as an entry in their outgoing interface (OIF) list.

When connected is specified, the command only applies to the single source address and destination multicast group address (S,G) multicast routes that use RPF to the interface and where S is directly connected.

If none of the above keywords are specified, rpf plus out is assumed.

If the ip multicast limit command is configured on a main interface that has subinterfaces, or on a virtual template interface, it establishes another limiter that counts against all subinterfaces or access interfaces associated with the main interface.

Examples

The following example shows how to set up a limit for directly connected sources on an interface:

interface FastEthernet 1
ip multicast limit connected 3 2
end

Related Commands

Command
Description

clear ip multicast limit

Defines a standard IP access list.

debug ip mrouting limit

Debugs mroute limiting and the reason for the limiting.

show ip multicast limit

Displays IP multicast limit information.


ip multicast mrinfo-filter

To filter multicast router information (mrinfo) request packets, use the ip multicast mrinfo-filter command in global configuration mode. To remove the filter on mrinfo requests, use the no form of this command.

ip multicast mrinfo-filter access-list

no ip multicast mrinfo-filter access-list

Syntax Descriptionno ip multicast mrinfo-filter access-list

access-list

IP standard numbered or named access list that determines which network or hosts can query the local multicast router with the mrinfo command.


Defaults

No default behavior or values

Command Modes

Global configuration

Command History

Release
Modification

12.0(23)S

This command was introduced.

12.2(13)T

This command was integrated into Cisco IOS Release 12.2(13)T.


Usage Guidelines

The ip multicast mrinfo-filter command filters the mrinfo request packets from all of the sources permitted by the specified access list. That is, if the access list permits a source, that source's mrinfo requests are filtered. For all sources that the access list explicitly or implicitly denies, the mrinfo requests are allowed to proceed.

Examples

The following example specifies that mrinfo request packets from all hosts on network 192.178.1.0 are not allowed to be processed by the router:

ip multicast mrinfo-filter 4
access-list 4 permit 192.178.1.0 0.0.0.255

Command
Description

mrinfo

Queries a multicast router about which neighboring multicast routers are peering with it.


ip multicast multipath

To enable load splitting of IP multicast traffic across multiple equal-cost paths, use the ip multicast multipath command in global configuration mode. To disable this configuration, use the no form of this command.

ip multicast [vrf vrf-name] multipath

no ip multicast [vrf vrf-name] multipath

Syntax Description

vrf

(Optional) Supports the multicast VPN routing and forwarding (VRF) instance.

vrf-name

(Optional) Name assigned to the VRF.


Defaults

By default, if multiple equal-cost paths exist, multicast traffic will not be load split across these paths.

Command Modes

Global configuration

Command History

Release
Modification

12.0(8)T

This command was introduced.

12.0(5)S

This command was integrated into Cisco IOS Release 12.0(5)S.

12.0(23)S

The vrf keyword and vrf-name argument were added.

12.2(13)T

The vrf keyword and vrf-name argument were added.


Usage Guidelines

If the ip multicast multipath command is configured and multiple equal-cost paths exist, load splitting will occur across the equal-cost paths for multicast traffic from different sources to the same multicast group, but not for traffic from the same source to different multicast groups. Because this command changes the way a Reverse Path Forwarding (RPF) neighbor is selected, it must be configured consistently on all routers in a redundant topology to avoid looping.

Examples

The following example shows how to configure the ip multicast multipath command:

ip multicast multipath

Related Commands

Command
Description

show ip rpf

Displays how IP multicast routing does RPF.


ip multicast rate-limit

To control the rate a sender from the source list can send to a multicast group in the group list, use the ip multicast rate-limit command in interface configuration mode. To remove the control, use the no form of this command.

ip multicast rate-limit {in | out} [video | whiteboard] [group-list access-list] [source-list access-list] kbps

no ip multicast rate-limit {in | out} [video | whiteboard] [group-list access-list] [source-list access-list] kbps

Syntax Description

in

Accepts only packets at the rate of the kbps value or slower on the interface.

out

Sends only a maximum of the kbps value on the interface.

video

(Optional) Performs rate limiting based on the User Datagram Protocol (UDP) port number used by video traffic. Video traffic is identified by consulting the Session Announcement Protocol (SAP) cache.

whiteboard

(Optional) Performs rate limiting based on the UDP port number used by whiteboard traffic. Whiteboard traffic is identified by consulting the SAP cache.

group-list access-list

(Optional) Specifies the access list number or name that controls which multicast groups are subject to the rate limit.

source-list access-list

(Optional) Specifies the access list number or name that controls which senders are subject to the rate limit.

kbps

Transmission rate (in kbps). Any packets sent at greater than this value are silently discarded. The default value is 0, meaning that no traffic is permitted. Therefore, set this to a positive value.


Defaults

If this command is not configured, there is no rate limit.
If this command is configured, the kbps value defaults to 0, meaning that no traffic is permitted.

Command Modes

Interface configuration

Command History

Release
Modification

11.0

This command was introduced.


Usage Guidelines

If a router receives a packet the user has sent over the limit, the packet is dropped; otherwise, it is forwarded.

For the video or whiteboard keyword to work, the ip sap listen command must be enabled so that the port number can be obtained from the SAP cache. If the ip sap listen command is not enabled, or the group address is not in the SAP cache, no rate-limiting is done for the group.

Examples

In the following example, packets to any group from sources in network 172.16.0.0 will have their packets rate-limited to 64 kbps:

interface serial 0
 ip multicast rate-limit out group-list 1 source-list 2 64
access-list 1 permit 0.0.0.0 255.255.255.255
access-list 2 permit 172.16.0.0 0.0.255.255

Related Commands

Command
Description

ip sap listen

Enables the Cisco IOS software to listen to session directory advertisements.