C H A P T E R  6

IP Multicast Commands

This chapter describes the IP Multicast commands available in the FASTPATH® CLI.

The commands in this chapter are in one of two groups:

This chapter contains the following sections:


Multicast Commands

This section describes the commands you use to configure IP Multicast and to view IP Multicast settings and statistics.

ip mcast boundary

This command adds an administrative scope multicast boundary specified by <groupipaddr> and <mask> for which this multicast administrative boundary is applicable. <groupipaddr> is a group IP address and <mask> is a group IP mask.


Format

ip mcast boundary <groupipaddr> <mask>

Mode

Interface Config


no ip mcast boundary

This command deletes an administrative scope multicast boundary specified by <groupipaddr> and <mask> for which this multicast administrative boundary is applicable. <groupipaddr> is a group IP address and <mask> is a group IP mask.


Format

no ip mcast boundary <groupipaddr> <mask>

Mode

Interface Config


ip multicast

This command sets the administrative mode of the IP multicast forwarder in the router to active. For multicast routing to become operational, IGMP must be currently enabled. An error message will be displayed on the CLI if multicast routing is enabled while IGMP is disabled. However, the IP multicast mode configuration is stored in the multicast configuration file and is automatically enabled once IGMP is enabled.


Default

disabled

Format

ip multicast

Mode

Global Config


no ip multicast

This command sets the administrative mode of the IP multicast forwarder in the router to inactive. For multicast routing to become operational, IGMP must be currently enabled. An error message will be displayed on the CLI if multicast routing is enabled while IGMP is disabled. However, the IP multicast mode configuration is stored in the multicast configuration file and is automatically enabled once IGMP is enabled.


Format

no ip multicast

Mode

Global Config


ip multicast staticroute

This command creates a static route which is used to perform RPF checking in multicast packet forwarding. The combination of the <sourceipaddr> and the <mask> fields specify the network IP address of the multicast packet source. The <rpfipaddr> is the IP address of the next hop toward the source. The <metric> is the cost of the route entry for comparison with other routes to the source network and is a value in the range of 0 and 255. The current incoming interface is used for RPF checking for multicast packets matching this multicast static route entry.


Default

none

Format

ip multicast staticroute <sourceipaddr> <mask> <rpfipaddr> <metric> <slot/port>

Mode

Global Config


no ip multicast staticroute

This command add deletes a static route in the static mcast table. The <sourceipaddr> is the IP address of the multicast packet source.


Format

no ip multicast staticroute <sourceipaddr>

Mode

Global Config


ip multicast ttl-threshold

This command applies the given <ttlthreshold> to a routing interface. The <ttlthreshold> is the TTL threshold which is to be applied to the multicast Data packets which are to be forwarded from the interface. The value for <ttlthreshold> has range from 0 to 255.


Default

1

Format

ip multicast ttl-threshold <ttlvalue>

Mode

Interface Config


no ip multicast ttl-threshold

This command applies the default <ttlthreshold> to a routing interface. The <ttlthreshold> is the TTL threshold which is to be applied to the multicast Data packets which are to be forwarded from the interface.


Format

no ip multicast ttl-threshold

Mode

Interface Config


disable ip multicast mdebug mtrace

This command is used to disable the processing capability of mtrace query on this router. If the mode is enable, the mtrace queries received by the router are processed and forwarded appropriately by the router. If the mode is disable, this router does not respond to the mtrace queries it receives from other router devices.


Default

none

Format

disable ip multicast mdebug mtrace

Mode

Global Config


no disable ip multicast mdebug mtrace

This command is used to enable the processing capability of mtrace query on this router. If the mode is enable, the mtrace queries received by the router are processed and forwarded appropriately by the router. If the mode is disable, this router does not respond to the mtrace queries it receives from other router devices.


Format

no disable ip multicast mdebug mtrace

Mode

Global Config


mrinfo

This command is used to query the neighbor information of a multicast-capable router specified by [ipaddr]. The default value is the IP address of the system at which the command is issued. The mrinfo command can take up to 2 minutes to complete. Only one mrinfo command may be in process at a time. The results of this command will be available in the results bufferpool which can be displayed by using show mrinfo.


Format

mrinfo [<ipaddr>]

Mode

Privileged EXEC


mstat

Use this command to find the IP Multicast packet rate and loss information path from a source to a receiver (unicast router id of the host running mstat). The results of this command are available in the results bufferpool which you can display by using the command show mstat. If a debug command is already in progress, a message is displayed and the new request fails.

The <source> is the IP address of the remote multicast-capable source. The [receiver] is the IP address of the receiver. The default value is the IP address of the system at which the command is issued. The [group] is a multicast address of the group to be displayed. The default value is 224.2.0.1(the group used for the multicast backbone).



Note - You can enter the group and receiver IP addresses in any order.



Default

none

Format

mstat <source> [<group/receiver>] [<group/receiver>]

Mode

Privileged EXEC


mtrace

This command is used to find the IP Multicast path from a source to a receiver (unicast router ID of the host running mtrace). A trace query is passed hop-by-hop along the reverse path from the receiver to the source, collecting hop addresses, packet counts, and routing error conditions along the path, and then the response is returned to the requestor. The results of this command are available in the results buffer pool which can be displayed by using the command show mtrace.

The <source> is the IP address of the remote multicast-capable source. The [receiver] is the IP address of the receiver. The default value is the IP address of system at which the command is issued. The [group] is the multicast address of the group to be displayed. The default value is 224.2.0.1(the group used for the multicast backbone). If a debug command is already in execution, a message is displayed and the new request fails.



Note - You can enter the group and destination IP addresses in any order.



Default

none

Format

mtrace <sourceipaddr> [<group/destination>] [<group/destination >]

Mode

Privileged EXEC


no ip mcast mroute

Use this command to clear entries in the mroute table. Use the all parameter to clear all entries. Use the source parameter to clear the routes in the mroute table entries containing the specified <sourceipaddr> or <sourceipaddr> [groupipaddr] pair. The source address is the source IP address of the multicast packet. The group address is the Group Destination IP address of the multicast packet. Use the group parameter to clear the routes in the mroute table entries containing the specified <groupipaddr>. The group address is the Group Destination IP address of the multicast packet.


Default

none

Format

no ip mcast mroute {group <groupipaddr> | source <sourceipaddr> [<groupipaddr>] | all}

Mode

Global Config


show ip mcast

This command displays the system-wide multicast information.


Format

show ip mcast

Modes

Privileged EXEC
User EXEC



TABLE 6-1 Entry Definitions for show ip mcast

Entry

Definition

Admin Mode

The administrative status of multicast.

Protocol State

The current state of the multicast protocol. Possible values are Operational or Non-Operational.

Table Max Size

The maximum number of entries allowed in the multicast table.

Number Of Packets For Which Source Not Found

The number of packets for which the source is not found.

Number Of Packets For Which Group Not Found

The number of packets for which the group is not found.

Protocol

The multicast protocol running on the router. Possible values are PIMDM, PIMSM, or DVMRP.

Entry Count

The number of entries in the multicast table.

Highest Entry Count

The highest entry count in the multicast table.


show ip mcast boundary

This command displays all the configured administrative scoped multicast boundaries.


Format

show ip mcast boundary {<slot/port> | all}

Modes

Privileged EXEC
User EXEC

Interface

Valid slot and port number separated by forward slashes.

Group Ip

The group IP address

Mask

The group IP mask


show ip mcast interface

This command displays the multicast information for the specified interface.


Format

show ip mcast interface <slot/port>

Modes

Privileged EXEC
User EXEC

Interface

Valid slot and port number separated by forward slashes.

TTL

The time-to-live value for this interface.


show ip mcast mroute

This command displays a summary or all the details of the multicast table.


Format

show ip mcast mroute {detail | summary}

Modes

Privileged EXEC
User EXEC



TABLE 6-2 Entry Definitions for show ip mcast mroute

Entry

Definition

Source IP Addr

The IP address of the multicast data source.

Group IP Addr

The IP address of the destination of the multicast packet.

Expiry Time

The time of expiry of this entry in seconds.

Up Time

The time elapsed since the entry was created in seconds.

RPF Neighbor

The IP address of the RPF neighbor.

Flags

The flags associated with this entry.

 

If you use the summary parameter, the command displays the following fields.

Source IP Addr

The IP address of the multicast data source.

Group IP Addr

The IP address of the destination of the multicast packet.

Protocol

The multicast routing protocol by which the entry was created.

Incoming Interface

The interface on which the packet for the source/group arrives.

Outgoing Interface List

The list of outgoing interfaces on which the packet

is forwarded.


show ip mcast mroute group

This command displays the multicast configuration settings such as flags, timer settings, incoming and outgoing interfaces, RPF neighboring routers, and expiration times of all the entries in the multicast mroute table containing the given <groupipaddr>.


Format

show ip mcast mroute group <groupipaddr> {detail |summary}

Modes

Privileged EXEC
User EXEC



TABLE 6-3 Entry Definitions for show ip mcast mroute group

Entry

Definition

Source IP Addr

The IP address of the multicast data source.

Group IP Addr

The IP address of the destination of the multicast packet.

Protocol

The multicast routing protocol by which this entry was created.

Incoming Interface

The interface on which the packet for this group arrives.

Outgoing Interface List

The list of outgoing interfaces on which this packet is forwarded.


show ip mcast mroute source

This command displays the multicast configuration settings such as flags, timer settings, incoming and outgoing interfaces, RPF neighboring routers, and expiration times of all the entries in the multicast mroute table containing the given source IP address or source IP address and group IP address pair.


Format

show ip mcast mroute source <sourceipaddr> {summary | <groupipaddr>}

Modes

Privileged EXEC
User EXEC


If you use the <groupipaddr> parameter, the command displays the following column headings in the output table.


TABLE 6-4 Entry Definitions for show ip mcast mroute source group

Entry

Definition

Source IP Addr

The IP address of the multicast data source.

Group IP Addr

The IP address of the destination of the multicast packet.

Expiry Time

The time of expiry of this entry in seconds.

Up Time

The time elapsed since the entry was created in seconds.

RPF Neighbor

The IP address of the RPF neighbor.

Flags

The flags associated with this entry.


If you use the summary parameter, the command displays the following column headings in the output table.


TABLE 6-5 Entry Definitions for show ip mcast mroute source summary

Entry

Definition

Source IP Addr

The IP address of the multicast data source.

Group IP Addr

The IP address of the destination of the multicast packet.

Protocol

The multicast routing protocol by which this entry was created.

Incoming Interface

The interface on which the packet for this source arrives.

Outgoing Interface List

The list of outgoing interfaces on which this packet is forwarded.


show ip mcast mroute static

This command displays all the static routes configured in the static mcast table if is specified or displays the static route associated with the particular <sourceipaddr>.


Format

show ip mcast mroute static [<sourceipaddr>]

Modes

Privileged EXEC
User EXEC



TABLE 6-6 Entry Definitions for show ip mcast mroute static

Entry

Definition

Source Address

The IP address of the multicast packet source.

Source Mask

The mask applied to the IP address of the multicast packet source.

RPF Address

The IP address to be used as RPF for the given source and mask.

Metric

The metric value corresponding to the source address.

Interface

Valid slot and port number separated by forward slashes.


show mrinfo

This command is used to display the neighbor information of a multicast-capable router from the results buffer pool of the router subsequent to the execution/completion of a mrinfo [ipaddr] command. The results subsequent to the completion of the latest mrinfo will be available in the buffer pool after a maximum duration of two minutes after the completion of the show mrinfo command. A subsequent issue mrinfo overwrites the contents of the buffer pool with fresh results.


Default

none

Format

show mrinfo

Mode

Privileged EXEC



TABLE 6-7 Entry Definitions for show mrinfo

Entry

Definition

Router Interface

The IP address of this neighbor

Neighbor

The neighbor associated with the router interface

Metric

The metric value associated with this neighbor

TTL

The TTL threshold associated with this neighbor

Flags

Status of the neighbor


show mstat

This command is used to display the results of packet rate and loss information from the results buffer pool of the router, subsequent to the execution/completion of a mstat <source> [group] [receiver] command. Within two minutes of the completion of the mstat command, the results will be available in the buffer pool. The next issuing of mstat overwrites the buffer pool with fresh results.


Default

none

Format

show mstat

Mode

Privileged EXEC


show mtrace

This command is used to display results of multicast trace path from the results buffer pool of the router, subsequent to the execution/completion of a mtrace <source> [group] [receiver] command. The results subsequent to the completion of the mtrace will be available in the buffer pool within two minutes and thereafter. A subsequent mtrace command overwrites the results in the buffer pool.


Default

none

Format

show mtrace

Modes

Privileged EXEC
User EXEC



TABLE 6-8 Entry Definitions for show mrtrace

Entry

Definition

Hops Away From Destination

The ordering of intermediate routers between the source and the destination

Intermediate Router Address

The address of the intermediate router at the specified hop distance

Mcast Protocol In Use

The multicast routing protocol used for the out interface of the specified intermediate router.

TTL Threshold

The Time-To-Live threshold of the out interface on the specified intermediate router.

Time Elapsed Between Hops (msecs)

The time between arrival at one intermediate router to the arrival at the next.



DVMRP Commands

This section provides a detailed explanation of the Distance Vector Multicast Routing Protocol (DVMRP) commands.

ip dvmrp

This command sets administrative mode of DVMRP in the router to active. IGMP must be enabled before DVMRP can be enabled.


Default

disabled

Format

ip dvmrp

Mode

Global Config


no ip dvmrp

This command sets administrative mode of DVMRP in the router to inactive.


Format

no ip dvmrp

Mode

Global Config


ip dvmrp metric

This command configures the metric for an interface. This value is used in the DVMRP messages as the cost to reach this network. This field has a range of 1 to 31.


Default

1

Format

ip dvmrp metric <metric>

Mode

Interface Config


no ip dvmrp metric

This command resets the metric for an interface to the default value. This value is used in the DVMRP messages as the cost to reach this network.


Format

no ip dvmrp metric

Mode

Interface Config


ip dvmrp trapflags

This command enables the DVMRP trap mode.


Default

disabled

Format

ip dvmrp trapflags

Mode

Global Config


no ip dvmrp trapflags

This command disables the DVMRP trap mode.


Format

no ip dvmrp trapflags

Mode

Global Config


ip dvmrp

This command sets the administrative mode of DVMRP on an interface to active.


Default

disabled

Format

ip dvmrp

Mode

Interface Config


no ip dvmrp

This command sets the administrative mode of DVMRP on an interface to inactive.


Format

no ip dvmrp

Mode

Interface Config


show ip dvmrp

This command displays the system-wide information for DVMRP.


Format

show ip dvmrp

Modes

Privileged EXEC
User EXEC



TABLE 6-9 Entry Definitions for show ip dvmrp

Entry

Definition

Admin Mode

This field indicates whether DVMRP is enabled or disabled.

Version String

The version of DVMRP being used.

Number of Routes

The number of routes in the DVMRP routing table.

Reachable Routes

The number of entries in the routing table with non-infinite metrics.

The following fields are displayed for each interface.

Interface

Valid slot and port number separated by forward slashes.

Interface Mode

The mode of this interface. Possible values are Enabled and Disabled.

State

The current state of DVMRP on this interface. Possible values are Operational or Non-Operational.


show ip dvmrp interface

This command displays the interface information for DVMRP on the specified interface.


Format

show ip dvmrp interface <slot/port>

Modes

Privileged EXEC
User EXEC



TABLE 6-10 Entry Definitions for show ip dvmrp interface

Entry

Definition

Interface Mode

This field indicates whether DVMRP is enabled or disabled on the specified interface.

Metric

The metric of this interface. This is a configured value.

Local Address

The IP Address of the interface.

Generation ID

This field is displayed only when DVMRP is operational on the interface. The Generation ID value for the interface. This is used by the neighboring routers to detect that the DVMRP table should be resent.

The following fields are displayed only if DVMRP is enabled on this interface.

Received Bad Packets

The number of invalid packets received.

Received Bad Routes

The number of invalid routes received.

Sent Routes

The number of routes that have been sent on this interface.


show ip dvmrp neighbor

This command displays the neighbor information for DVMRP.


Format

show ip dvmrp neighbor

Modes

Privileged EXEC
User EXEC



TABLE 6-11 Entry Definitions for show ip dvmrp neighbor

Entry

Definition

IfIndex

The value of the interface used to reach the neighbor.

Nbr IP Addr

The IP Address of the DVMRP neighbor for which this entry contains information.

State

The state of the neighboring router. The possible value for this field are ACTIVE or DOWN.

Up Time

The time since this neighboring router was learned.

Expiry Time

The time remaining for the neighbor to age out. This field is not applicable if the State is DOWN.

Generation ID

The Generation ID value for the neighbor.

Major Version

The major version of DVMRP protocol of neighbor.

Minor Version

The minor version of DVMRP protocol of neighbor.

Capabilities

The capabilities of neighbor.

Received Routes

The number of routes received from the neighbor.

Rcvd Bad Pkts

The number of invalid packets received from this neighbor.

Rcvd Bad Routes

The number of correct packets received with invalid routes.


show ip dvmrp nexthop

This command displays the next hop information on outgoing interfaces for routing multicast datagrams.


Format

show ip dvmrp nexthop

Modes

Privileged EXEC
User EXEC



TABLE 6-12 Entry Definitions for show ip dvmrp nexthop

Entry

Definition

Source IP

The sources for which this entry specifies a next hop on an outgoing interface.

Source Mask

The IP Mask for the sources for which this entry specifies a next hop on an outgoing interface.

Next Hop Interface

The interface in slot/port format for the outgoing interface for this next hop.

Type

The network is a LEAF or a BRANCH.


show ip dvmrp prune

This command displays the table listing the router’s upstream prune information.


Format

show ip dvmrp prune

Modes

Privileged EXEC
User EXEC



TABLE 6-13 Entry Definitions for show ip dvmrp prune

Entry

Definition

Group IP

This field identifies the multicast Address that is pruned.

Source IP

This field displays the IP Address of the source that has pruned.

Source Mask

This field displays the network Mask for the prune source. It should be all 1s or both the prune source and prune mask must match.

Expiry Time (secs)

This field indicates the expiry time in seconds. This is the time remaining for this prune to age out.


show ip dvmrp route

This command displays the multicast routing information for DVMRP.


Format

show ip dvmrp route

Modes

Privileged EXEC
User EXEC



TABLE 6-14 Entry Definitions for show ip dvmrp route

Entry

Definition

Source Address

This field displays the multicast address of the source group.

Source Mask

This field displays the IP Mask for the source group.

Upstream Neighbor

This field indicates the IP Address of the neighbor which is the source for the packets for a specified multicast address.

Interface

This field displays the interface used to receive the packets sent by the sources.

Metric

This field displays the distance in hops to the source subnet. This field has a different meaning than the Interface Metric field.

Expiry Time (secs)

This field indicates the expiry time in seconds. This is the time remaining for this route to age out.

Up Time (secs)

This field indicates the time when a specified route was learnt, in seconds.



PIM-DM Commands

This section describes the commands you use to configure Protocol Independent Multicast - Dense Mode (PIM-DM). PIM-DM is a multicast routing protocol that provides scalable inter-domain multicast routing across the Internet, independent of the mechanisms provided by any particular unicast routing protocol. PIM-DM is typically used in LAN applications, while PIM-SM is for WAN applications.

ip pimdm

This command enables the administrative mode of PIM-DM in the router.


Default

disabled

Format

ip pimdm

Mode

Global Config


no ip pimdm

This command disables the administrative mode of PIM-DM in the router. IGMP must be enabled before PIM-DM can be enabled.


Format

no ip pimdm

Mode

Global Config


ip pimdm mode

This command sets administrative mode of PIM-DM on an interface to enabled.


Default

disabled

Format

ip pimdm mode <slot/port>

Mode

Interface Config


no ip pimdm mode

This command sets administrative mode of PIM-DM on an interface to disabled.


Format

no ip pimdm mode <slot/port>

Mode

Interface Config


ip pimdm query-interval

This command configures the transmission frequency of hello messages between PIM enabled neighbors. This field has a range of 10 to 3600 seconds.


Default

30

Format

ip pimdm query-interval <seconds>

Mode

Interface Config


no ip pimdm query-interval

This command resets the transmission frequency of hello messages between PIM enabled neighbors to the default value.


Format

no ip pimdm query-interval

Mode

Interface Config


show ip pimdm

This command displays the system-wide information for PIM-DM.


Format

show ip pimdm

Modes

Privileged EXEC
User EXEC



TABLE 6-15 Entry Definitions for show ip pimdm

Entry

Definition

PIM-DM Admin Mode

This field indicates whether PIM-DM is enabled or disabled.

Interface

Valid slot and port number separated by forward slashes.

Interface Mode

This field indicates whether PIM-DM is enabled or disabled on this interface.

State

The current state of PIM-DM on this interface. Possible values are Operational or Non-Operational.


show ip pimdm interface

This command displays the interface information for PIM-DM on the specified interface.


Format

show ip pimdm interface <slot/port>

Modes

Privileged EXEC
User EXEC

Interface Mode

This field indicates whether PIM-DM is enabled or disabled on the specified interface.

PIM-DM Interface Hello Interval

The frequency at which PIM hello messages are transmitted on this interface. By default, the value is 30 seconds.


show ip pimdm interface stats

This command displays the statistical information for PIM-DM on the specified interface.


Format

show ip pimdm interface stats {<slot/port> | all}

Modes

Privileged EXEC
User EXEC



TABLE 6-16 Entry Definitions for show ip pimdm interface stats

Entry

Definition

Interface

Valid slot and port number separated by forward slashes.

IP Address

The IP Address that represents the PIM-DM interface.

Nbr Count

The neighbor count for the PIM-DM interface.

Hello Interval

The time interval between two hello messages sent from the router on the given interface.

Designated Router

The IP Address of the Designated Router for this interface.


show ip pimdm neighbor

This command displays the neighbor information for PIM-DM on the specified interface.


Format

show ip pimdm neighbor {<slot/port> | all}

Modes

Privileged EXEC
User EXEC



TABLE 6-17 Entry Definitions for show ip pimdm neighbor

Entry

Definition

Neighbor Address

The IP Address of the neighbor on an interface.

Interface

Valid slot and port number separated by forward slashes.

Up Time

The time since this neighbor has become active on this interface.

Expiry Time

The expiry time of the neighbor on this interface.



PIM-SM Commands

This section describes the commands you use to configure Protocol Independent Multicast - Sparse Mode (PIM-SM). PIM-SM is a multicast routing protocol that provides scalable inter-domain multicast routing across the Internet, independent of the mechanisms provided by any particular unicast routing protocol. PIM-DM is typically used in LAN applications, while PIM-SM is for WAN applications.

ip pimsm cbsrpreference

This command is used to configure the CBSR preference for a particular PIM-SM interface. The range of CBSR preference is -1 to 255.


Default

0

Format

ip pimsm cbsrpreference <-1-255>

Mode

Interface Config


no ip pimsm cbsrpreference

Use this command to reset the CBSR preference for a particular PIM-SM interface to zero.


Format

no ip pimsm cbsrpreference

Mode

Interface Config


ip pimsm cbsrhashmasklength

This command is used to configure the CBSR hash mask length to be advertised in bootstrap messages for a particular PIM-SM interface. This hash mask length will be used in the hash algorithm for selecting the RP for a particular group. The valid range is 0 - 32.


Default

30

Format

ip pimsm cbsrhashmasklength <0-32>

Mode

Interface Config


no ip pimsm cbsrhashmasklength

Use this command to reset the CBSR hash mask length for a particular PIM-SM interface to the default.


Format

no ip pimsm cbsrhashmasklength

Mode

Interface Config


ip pimsm crppreference

This command is used to configure the Candidate Rendezvous Point (CRP) for a particular PIM-SM interface. The valid values are from (-1 to 255), and the value of -1 is used to indicate that the local interface is not a Candidate RP interface.

The active router interface, with the highest IP Address and crppreference greater than -1, is chosen as the CRP for the router. The default value is 0.

In the CRP advertisements sent to the bootstrap router (BSR), the router interface advertises itself as the CRP for the group range 224.0.0.0 mask 240.0.0.0.


Default

0

Format

ip pimsm crppreference <-1-255>

Mode

Interface Config


no ip pimsm crppreference

This command is used to reset the Candidate Rendezvous Point (CRP) for a particular PIM-SM interface to the default value.


Format

no ip pimsm crppreference

Mode

Interface Config


ip pimsm message-interval

This command is used to configure the global join/prune interval for PIM-SM router. The join/prune interval is specified in seconds. This parameter can be configured to a value from 10 to 3600.


Default

60

Format

ip pimsm message-interval <10-3600>

Mode

Global Config


no ip pimsm message-interval

Use this command to reset the global join/prune interval to the default value.


Format

no ip pimsm message-interval

Mode

Global Config


ip pimsm

This command sets administrative mode of PIM-SM multicast routing across the router to enabled. IGMP must be enabled before PIM-SM can be enabled.


Default

disabled

Format

ip pimsm

Mode

Global Config


no ip pimsm

This command sets administrative mode of PIM-SM multicast routing across the router to the default value. IGMP must be enabled before PIM-SM can be enabled.


Format

no ip pimsm

Mode

Global Config


ip pimsm mode

This command sets administrative mode of PIM-SM multicast routing on a routing interface to enabled.


Default

disabled

Format

ip pimsm mode

Mode

Interface Config


no ip pimsm mode

This command sets administrative mode of PIM-SM multicast routing on a routing interface to the default value.


Format

no ip pimsm mode

Mode

Interface Config


ip pimsm query-interval

This command configures the transmission frequency of hello messages in seconds between PIM enabled neighbors. This field has a range of 10 to 3600 seconds.


Default

30

Format

ip pimsm query-interval <10-3600>

Mode

Interface Config


no ip pimsm query-interval

This command resets the transmission frequency of hello messages between PIM enabled neighbors to the default value.


Format

no ip pimsm query-interval

Mode

Interface Config


ip pimsm spt-threshold

This command is used to configure the Threshold rate for the RP router to switch to the shortest path. The rate is specified in Kilobytes per second. The possible values are 0 to 2000.


Default

50

Format

ip pimsm spt-threshold <0-2000>

Mode

Global Config


no ip pimsm spt-threshold

This command is used to reset the Threshold rate for the RP router to switch to the shortest path to the default value.


Format

no ip pimsm spt-threshold

Mode

Global Config


ip pim-trapflags

This command enables the PIM trap mode for both Sparse Mode (SM) and Dense Mode. (DM).


Default

disabled

Format

ip pim-trapflags

Mode

Global Config


no ip pim-trapflags

This command sets the PIM trap mode to the default.


Format

no ip pim-trapflags

Mode

Global Config


ip pimsm staticrp

This command is used to create RP IP address for the PIM-SM router. The parameter <ipaddress> is the IP address of the RP. The parameter <groupaddress> is the group address supported by the RP. The parameter <groupmask> is the group mask for the group address.


Default

disabled

Format

ip pimsm staticrp <ipaddress> <groupaddress> <groupmask>

Mode

Global Config


no ip pimsm staticrp

This command is used to delete RP IP address for the PIM-SM router. The parameter <ipaddress> is the IP address of the RP. The parameter <groupaddress> is the group address supported by the RP. The parameter <groupmask> is the group mask for the group address.


Format

no ip pimsm staticrp <ipaddress> <groupaddress> <groupmask>

Mode

Global Config


show ip pimsm

This command displays the system-wide information for PIM-SM.


Format

show ip pimsm

Modes

Privileged EXEC
User EXEC



TABLE 6-18 Entry Definitions for show ip pimsm

Entry

Definition

PIM-SM Admin Mode

This field indicates whether PIM-SM is enabled or disabled.

Join/Prune Interval (secs)

The interval at which periodic PIM-SM Join/Prune messages are to be sent.

Data Threshold Rate (Kbps)

The data threshold rate for the PIM-SM router.

Register Threshold Rate (Kbps)

The threshold rate for the RP router to switch to the shortest path.

Interface

Valid slot and port number separated by forward slashes.

Interface Mode

This field indicates whether PIM-SM is enabled or disabled on the interface.

Protocol State

The current state of the PIM-SM protocol on the interface. Possible values are Operational or Non-Operational.


show ip pimsm candrptable

This command displays the IP multicast groups for which the local router is to advertise itself as a Candidate-RP when the value of hold time is non-zero.


Format

show ip pimsm candrptable

Modes

Privileged EXEC
User EXEC



TABLE 6-19 Entry Definitions for show ip pimsm candrptable

Entry

Definition

Group Address

The IP multicast group address.

Group Mask

The multicast group address subnet mask.

Address

The unicast address of the interface that will be advertised as a Candidate-RP.


show ip pimsm componenttable

This command displays the table containing objects specific to a PIM domain. One row exists for each domain to which the router is connected.


Format

show ip pimsm componenttable

Modes

Privileged EXEC
User EXEC



TABLE 6-20 Entry Definitions for show ip pimsm componenttable

Entry

Definition

Component Index

A number which uniquely identifies the component.

Component BSR Address

The IP address of the bootstrap router (BSR) for the local PIM region.

Component BSR Expiry Time

The minimum time remaining before the BSR in the local domain will be declared down.

Component CRP Hold Time

The hold time of the component when it is a candidate.


show ip pimsm interface

This command displays the interface information for PIM-SM on the specified interface.


Format

show ip pimsm interface <slot/port>

Modes

Privileged EXEC
User EXEC



TABLE 6-21 Entry Definitions for show ip pimsm interface

Entry

Definition

Interface

Valid slot and port number separated by forward slashes.

IP Address

The IP address of the specified interface.

Subnet Mask

The Subnet Mask for the IP address of the PIM interface.

Mode

This field indicates whether PIM-SM is enabled or disabled on the specified interface. By default it is disabled.

Hello Interval

The frequency at which PIM hello messages are transmitted on this interface. By default, the value is 30 seconds.

CBSR Preference

The preference value for the local interface as a candidate bootstrap router.

CRP Preference

The preference value as a candidate rendezvous point on this interface.

CBSR Hash Mask Length

The hash mask length to be advertised in bootstrap messages if this interface is elected as the bootstrap router. The value is used in the hash algorithm for selecting the RP for a particular group.


show ip pimsm interface stats

This command displays the statistical information for PIM-SM on the specified interface.


Format

show ip pimsm interface stats {<slot/port> | all}

Modes

Privileged EXEC
User EXEC



TABLE 6-22 Entry Definitions for show ip pimsm interface stats

Entry

Definition

Interface

Valid slot and port number separated by forward slashes.

IP Address

The IP Address that represents the PIM-SM interface.

Subnet Mask

The Subnet Mask of this PIM-SM interface.

Designated Router

The IP Address of the Designated Router for this interface.

Neighbor Count

The number of neighbors on the PIM-SM interface.


show ip pimsm neighbor

This command displays the neighbor information for PIM-SM on the specified interface.


Format

show ip pimsm neighbor {<slot/port> | all}

Modes

Privileged EXEC
User EXEC



TABLE 6-23 Entry Definitions for show ip pimsm neighbor

Entry

Definition

Interface

Valid slot and port number separated by forward slashes.

IP Address

The IP Address of the neighbor on an interface.

Up Time

The time since this neighbor has become active on this interface.

Expiry Time

The expiry time of the neighbor on this interface.


show ip pimsm rp

This command displays the PIM information for candidate Rendezvous Points (RPs) for all IP multicast groups or for the specific <groupaddress> <groupmask> provided in the command. The information in the table is displayed for each IP multicast group.


Format

show ip pimsm rp {<groupaddress> <groupmask> | candidate | all}

Modes

Privileged EXEC
User EXEC



TABLE 6-24 Entry Definitions for show ip pimsm rp

Entry

Definition

Group Address

The IP multicast group address.

Group Mask

The multicast group address subnet mask.

Address

The IP address of the Candidate-RP.

Hold Time

The hold time of a Candidate-RP.

Expiry Time

The minimum time remaining before the Candidate-RP is declared down.

Component

A number which uniquely identifies the component. Each protocol instance connected to a separate domain should have a different index value.


show ip pimsm rphash

This command displays the RP router that will be selected from the set of active RP routers. The RP router, for the group, is selected by using the hash algorithm defined in RFC 2362.


Format

show ip pimsm rphash <groupaddress>

Modes

Privileged EXEC
User EXEC

RP IP Address

The IP address of the RP.

Group Mask

The group mask for the group address.


show ip pimsm staticrp

This command displays the static RP information for the PIM-SM router.


Format

show ip pimsm staticrp

Modes

Privileged EXEC
User EXEC

RP IP Address

The IP address of the RP.

Group Address

The group address supported by the RP.

Group Mask

The group mask for the group address.



Internet Group Message Protocol (IGMP) Commands

This section describes the commands you use to view and configure IGMP settings.

ip igmp

This command sets the administrative mode of IGMP in the system to active.


Default

disabled

Format

ip igmp

Mode

Global Config


no ip igmp

This command sets the administrative mode of IGMP in the system to inactive.


Format

no ip igmp

Mode

Global Config


ip igmp version

This command configures the version of IGMP for an interface. The value for <version> is either 1, 2 or 3.


Default

3

Format

ip igmp version <version>

Mode

Interface Config


no ip igmp version

This command resets the version of IGMP to the default value.


Format

no ip igmp version

Mode

Interface Config


ip igmp last-member-query-count

This command sets the number of Group-Specific Queries sent before the router assumes that there are no local members on the interface. The range for <count> is 1 to 20.


Format

ip igmp last-member-query-count <count>

Mode

Interface Config


no ip igmp last-member-query-count

This command resets the number of Group-Specific Queries to the default value.


Format

no ip igmp last-member-query-count

Mode

Interface Config


ip igmp last-member-query-interval

This command configures the Maximum Response Time inserted in Group-Specific Queries which are sent in response to Leave Group messages. The range for <seconds> is 0 to 255 tenths of a second.


Default

10 tenths of a second (1 second)

Format

ip igmp last-member-query-interval <seconds>

Mode

Interface Config


no ip igmp last-member-query-interval

This command resets the Maximum Response Time to the default value.


Format

no ip igmp last-member-query-interval

Mode

Interface Config


ip igmp query-interval

This command configures the query interval for the specified interface. The query interval determines how fast IGMP Host-Query packets are transmitted on this interface. The range for <queryinterval> is 1 to 3600 seconds.


Default

125 seconds

Format

ip igmp query-interval <seconds>

Mode

Interface Config


no ip igmp query-interval

This command resets the query interval for the specified interface to the default value. This is the frequency at which IGMP Host-Query packets are transmitted on this interface.


Format

no ip igmp query-interval

Mode

Interface Config


ip igmp query-max-response-time

This command configures the maximum response time interval for the specified interface, which is the maximum query response time advertised in IGMPv2 queries on this interface.The time interval is specified in tenths of a second. The range for <maxresptime> is 0 to 255 tenths of a second.


Default

100

Format

ip igmp query-max-response-time <seconds>

Mode

Interface Config


no ip igmp query-max-response-time

This command resets the maximum response time interval for the specified interface, which is the maximum query response time advertised in IGMPv2 queries on this interface to the default value. The maximum response time interval is reset to the default time.


Format

no ip igmp query-max-response-time

Mode

Interface Config


ip igmp robustness

This command configures the robustness that allows tuning of the interface. The robustness is the tuning for the expected packet loss on a subnet. If a subnet is expected to have a lot of loss, the Robustness variable may be increased for the interface. The range for <robustness> is 1 to 255.


Default

2

Format

ip igmp robustness <robustness>

Mode

Interface Config


no ip igmp robustness

This command sets the robustness value to default.


Format

no ip igmp robustness

Mode

Interface Config


ip igmp startup-query-count

This command sets the number of Queries sent out on startup, separated by the Startup Query Interval on the interface. The range for <count> is 1 to 20.


Default

2

Format

ip igmp startup-query-count <count>

Mode

Interface Config


no ip igmp startup-query-count

This command resets the number of Queries sent out on startup, separated by the Startup Query Interval on the interface to the default value.


Format

no ip igmp startup-query-count

Mode

Interface Config


ip igmp startup-query-interval

This command sets the interval between General Queries sent on startup on the interface. The time interval value is in seconds. The range for <interval> is 1 to 300 seconds.


Default

31

Format

ip igmp startup-query-interval <interval>

Mode

Interface Config


no ip igmp startup-query-interval

This command resets the interval between General Queries sent on startup on the interface to the default value.


Format

no ip igmp startup-query-interval

Mode

Interface Config


show ip igmp

This command displays the system-wide IGMP information.


Format

show ip igmp

Modes

Privileged EXEC
User EXEC



TABLE 6-25 Entry Definitions for show ip igmp

Entry

Definition

IGMP Admin Mode

This field displays the administrative status of IGMP. This is a configured value.

Interface

Valid slot and port number separated by forward slashes.

Interface Mode

This field indicates whether IGMP is enabled or disabled on the interface. This is a configured value.

Protocol State

This field indicates the current state of IGMP on this interface. Possible values are Operational or Non-Operational.


show ip igmp groups

This command displays the registered multicast groups on the interface. If [detail] is specified this command displays the registered multicast groups on the interface in detail.


Format

show ip igmp groups <slot/port> [detail]

Mode

Privileged EXEC



TABLE 6-26 Entry Definitions for show ip igmp groups

Entry

Definition

IP Address

This displays the IP address of the interface participating in the multicast group.

Subnet Mask

This displays the subnet mask of the interface participating in the multicast group.

Interface Mode

This displays whether IGMP is enabled or disabled on this interface.

 

The following fields are not displayed if the interface is not enabled:

Querier Status

This displays whether the interface has IGMP in Querier mode or Non-Querier mode.

Groups

This displays the list of multicast groups that are registered on this interface.

 

If you use the detail keyword, the following fields appear:

Multicast IP Address

This displays the IP Address of the registered multicast group on this interface.

Last Reporter

This displays the IP Address of the source of the last membership report received for the specified multicast group address on this interface.

Up Time

This displays the time elapsed since the entry was created for the specified multicast group address on this interface.

Expiry Time

This displays the amount of time remaining to remove this entry before it is aged out.

Version1 Host Timer

This displays the time remaining until the local router assumes that there are no longer any IGMP version 1 multicast members on the IP subnet attached to this interface. This could be an integer value or “-----” if there is no Version 1 host present.

Version2 Host Timer

This displays the time remaining until the local router assumes that there are no longer any IGMP version 2 multicast members on the IP subnet attached to this interface. This could be an integer value or “-----” if there is no Version 2 host present.

Group Compatibility Mode

The group compatibility mode (v1, v2 or v3) for this group on the specified interface.


show ip igmp interface

This command displays the IGMP information for the interface.


Format

show ip igmp interface <slot/port>

Modes

Privileged EXEC
User EXEC



TABLE 6-27 Entry Definitions for show ip igmp interface

Entry

Definition

Interface

Valid slot and port number separated by forward slashes.

IGMP Admin Mode

The administrative status of IGMP.

Interface Mode

This field indicates whether IGMP is enabled or disabled on the interface.

IGMP Version

The version of IGMP running on the interface. This value can be configured to create a router capable of running either IGMP version 1 or 2.

Query Interval

The frequency at which IGMP Host-Query packets are transmitted on this interface.

Query Max Response Time

The maximum query response time advertised in IGMPv2 queries on this interface.

Robustness

The tuning for the expected packet loss on a subnet. If a subnet is expected to be have a lot of loss, the Robustness variable may be increased for that interface.

Startup Query Interval

The interval between General Queries sent by a Querier on startup.

Startup Query Count

The number of Queries sent out on startup, separated by the Startup Query Interval.

Last Member Query Interval

The Maximum Response Time inserted into Group-Specific Queries sent in response to Leave Group messages.

Last Member Query Count

The number of Group-Specific Queries sent before the router assumes that there are no local members.


show ip igmp interface membership

This command displays the list of interfaces that have registered in the multicast group.


Format

show ip igmp interface membership <multiipaddr> [detail]

Mode

Privileged EXEC



TABLE 6-28 Entry Definitions for show ip igmp interface membership

Entry

Definition

Interface

Valid unit, slot and port number separated by forward slashes.

Interface IP

The IP address of the interface participating in the multicast group.

State

The interface that has IGMP in Querier mode or Non-Querier mode.

Group Compatibility Mode

The group compatibility mode (v1, v2 or v3) for the specified group on this interface.

Source Filter Mode

The source filter mode (Include/Exclude) for the specified group on this interface. This is “-----” for IGMPv1 and IGMPv2 Membership Reports. If you use the detail keyword, the following fields appear:

Interface

Valid unit, slot and port number separated by forward slashes.

Group Compatibility Mode

The group compatibility mode (v1, v2 or v3) for the specified group on this interface.

Source Filter Mode

The source filter mode (Include/Exclude) for the specified group on this interface. This is “-----” for IGMPv1 and IGMPv2 Membership Reports.

Source Hosts

The list of unicast source IP Addresses in the group record of the IGMPv3 Membership Report with the specified multicast group IP Address. This is “-----” for IGMPv1 and IGMPv2 Membership Reports.

Expiry Time

The amount of time remaining to remove this entry before it is aged out. This is “-----” for IGMPv1 and IGMPv2 Membership Reports.


show ip igmp interface stats

This command displays the IGMP statistical information for the interface. The statistics are only displayed when the interface is enabled for IGMP.


Format

show ip igmp interface stats <slot/port>

Modes

Privileged EXEC
User EXEC



TABLE 6-29 Entry Definitions for show ip igmp interface stats

Entry

Definition

Querier Status

The status of the IGMP router, whether it is running in Querier mode or Non-Querier mode.

Querier IP Address

The IP Address of the IGMP Querier on the IP subnet to which this interface is attached.

Querier Up Time

The time since the interface Querier was last changed.

Querier Expiry Time

The amount of time remaining before the Other Querier Present Timer expires. If the local system is the querier, the value of this object is zero.

Wrong Version Queries

The number of queries received whose IGMP version does not match the IGMP version of the interface.

Number of Joins

The number of times a group membership has been added on this interface.

Number of Groups

The current number of membership entries for this interface



IGMP Proxy Commands

The IGMP Proxy is used by IGMP Router (IPv4 system) to enable the system to issue IGMP host messages on behalf of hosts that the system discovered through standard IGMP router interfaces. With IGMP Proxy enabled, the system acts as proxy to all the hosts residing on its router interfaces.

ip igmp-proxy

This command enables the IGMP Proxy on the router. To enable the IGMP Proxy on the router, you must enable multicast forwarding. Also, make sure that there are no multicast routing protocols enabled on the router.


Format

ip igmp-proxy

Mode

Interface Config


no ip igmp-proxy

This command disables the IGMP Proxy on the router.


Format

no ip igmp-proxy

Mode

Interface Config


ip igmp-proxy unsolicit-rprt-interval

This command sets the unsolicited report interval for the IGMP Proxy router. This command is valid only when you enable IGMP Proxy on the interface. The value of <interval> can be 1-260 seconds.


Default

1

Format

ip igmp-proxy unsolicit-rprt-interval <interval>

Mode

Interface Config


no ip igmp-proxy unsolicit-rprt-interval

This command resets the unsolicited report interval of the IGMP Proxy router to the default value.


Format

no ip igmp-proxy unsolicit-rprt-interval

Mode

Interface Config


ip igmp-proxy reset-status

This command resets the host interface status parameters of the IGMP Proxy router. This command is valid only when you enable IGMP Proxy on the interface.


Format

ip igmp-proxy reset-status

Mode

Interface Config


show ip igmp-proxy

This command displays a summary of the host interface status parameters. It displays the following parameters only when you enable IGMP Proxy.


Format

show ip igmp-proxy

Mode

Privileged EXEC
User EXEC



TABLE 6-30 Entry Definitions for show ip igmp-proxy

Entry

Definition

Interface index

The interface number of the IGMP Proxy.

Admin Mode

States whether the IGMP Proxy is enabled or not. This is a configured value.

Operational Mode

States whether the IGMP Proxy is operationally enabled or not. This is a status parameter.

Version

The present IGMP host version that is operational on the proxy interface.

Number of Multicast Groups

States the number of multicast groups that are associated with the IGMP Proxy interface.

Unsolicited Report Interval

The time interval at which the IGMP Proxy interface sends unsolicited group membership report.

Querier IP Address on Proxy Interface

The IP address of the Querier, if any, in the network attached to the upstream interface (IGMP-Proxy interface).

Older Version 1 Querier Timeout

The interval used to timeout the older version 1 queriers.

Older Version 2 Querier Timeout

The interval used to timeout the older version 2 queriers.

Proxy Start Frequency

The number of times the IGMP Proxy has been stopped and started.


show ip igmp-proxy interface

This command displays a detailed list of the host interface status parameters. It displays the following parameters only when you enable IGMP Proxy.


Format

show ip igmp-proxy interface

Mode

Privileged EXEC
User EXEC



TABLE 6-31 Entry Definitions for show ip igmp-proxy interface

Entry

Definition

Interface Index

Shows the slot/port of the IGMP proxy. The column headings of the table associated with the interface are as follows:

Ver

Shows the IGMP version.

Query Rcvd

Number of IGMP queries received.

Report Rcvd

Number of IGMP reports received.

Report Sent

Number of IGMP reports sent.

Leaves Rcvd

Number of IGMP leaves received.

Leaves Sent

Number of IGMP leaves sent.


show ip igmp-proxy groups

This command displays information about the subscribed multicast groups that IGMP Proxy reported. It displays a table of entries with the following as the fields of each column.


Format

show ip igmp-proxy groups

Mode

Privileged EXEC
User EXEC



TABLE 6-32 Entry Definitions for show ip igmp-proxy groups

Entry

Definition

Interface

The interface number of the IGMP Proxy.

Group Address

The IP address of the multicast group.

Last Reporter

The IP address of host that last sent a membership report.

Up Time (in secs)

The time elapsed since last created.

Member State

The status of the entry. Possible values are IDLE_MEMBER or DELAY_MEMBER.

  • IDLE_MEMBER - interface has responded to the latest group membership query for this group.
  • DELAY_MEMBER - interface is going to send a group membership report to respond to a group membership query for this group.

Filter Mode

Possible values are Include or Exclude.

Sources

The number of sources attached to the multicast group.


show ip igmp-proxy groups detail

This command displays complete information about multicast groups that IGMP Proxy reported. It displays a table of entries with the following as the fields of each column.


Format

show ip igmp-proxy groups detail

Mode

Privileged EXEC
User EXEC



TABLE 6-33 Entry Definitions for show ip igmp-proxy groups detail

Entry

Definition

Interface

The interface number of the IGMP Proxy.

Group Address

The IP address of the multicast group.

Last Reporter

The IP address of host that last sent a membership report for the current group, on the network attached to the IGMP-Proxy interface (upstream interface).

Up Time (in secs)

The time elapsed since last created.

Member State

The status of the entry. Possible values are IDLE_MEMBER or DELAY_MEMBER.

  • IDLE_MEMBER - interface has responded to the latest group membership query for this group.
  • DELAY_MEMBER - interface is going to send a group membership report to respond to a group membership query for this group.

Filter Mode

Possible values are include or exclude.

Sources

The number of sources attached to the multicast group.

Group Source List

The list of IP addresses of the sources attached to the multicast group.

Expiry Time

Time left before a source is deleted.