Cisco IOS XR Multicast Command Reference, Release 3.4
Multicast PIM Commands on Cisco IOS XR Software

Table Of Contents

Multicast PIM Commands on Cisco IOS XR Software

accept-register

auto-rp candidate-rp

auto-rp listen disable

auto-rp mapping-agent

bsr-border

bsr candidate-bsr

bsr candidate-rp

clear pim autorp

clear pim bsr

clear pim counters

clear pim topology

dr-priority

embedded-rp

embedded-rp disable

hello-interval (PIM)

interface (pim)

join-prune-interval

maximum autorp

maximum group-mappings

maximum register-states

maximum route-interfaces

maximum routes

neighbor-check-on-recv enable

neighbor-check-on-send enable

neighbor-filter

nsf lifetime (PIM)

old-register-checksum

router pim

router pim interface bfd

rp-address

rpf-vector

show auto-rp candidate-rp

show auto-rp mapping-agent

show pim bsr candidate-rp

show pim bsr election

show pim bsr rp-cache

show pim df election-state

show pim df winner

show pim group-map

show pim interface

show pim join-prune statistics

show pim mstatic

show pim neighbor

show pim nsf

show pim range-list

show pim rpf

show pim rpf hash

show pim summary

show pim topology

show pim traffic

show pim tunnel info

spt-threshold infinity

ssm


Multicast PIM Commands on Cisco IOS XR Software


This chapter describes the commands used to configure and monitor Protocol Independent Multicast (PIM) on Cisco IOS XR software.


Note For PIM-related commands, IPv4 is the default IP address family; however, many commands, including clear pim and show pim, include both an IPv4 and IPv6 prefix. To run commands related to IPv6, you must use the IPv6 prefix. You need not specify the IPv4 prefix to run IPv4-related commands.


For detailed information about multicast routing concepts, configuration tasks, and examples, refer to the Implementing Multicast Routing on Cisco IOS XR Software configuration module.

accept-register

To configure a rendezvous point (RP) router to filter PIM register messages, use the accept-register command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

accept-register access-list-name

no accept-register

Syntax Description

access-list-name

Defines the access list number or name.


Defaults

No default behavior or values

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The accept-register command prevents unauthorized sources from registering with the rendezvous point. If an unauthorized source sends a register message to the rendezvous point, the rendezvous point immediately sends back a register-stop message.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to restrict the rendezvous point. Sources in the Source Specific Multicast (SSM) range of addresses are not allowed to register with the rendezvous point. These statements need to be configured only on the rendezvous point.

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# accept-register no-ssm-range
RP/0/RP0/CPU0:router(config-pim-ipv4)# exit
RP/0/RP0/CPU0:router(config)# ipv4 access-list no-ssm-range
RP/0/RP0/CPU0:router(config-ipv4-acl)# deny 232.0.0.0 0.255.255.255
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit any

auto-rp candidate-rp

To configure a router as a PIM rendezvous point (RP) candidate that sends messages to the well-known CISCO-RP-ANNOUNCE multicast group (224.0.1.39), use the auto-rp candidate-rp command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

auto-rp candidate-rp type instance scope ttl-value [group-list access-list-name] [interval seconds] [bidir]

no auto-rp candidate-rp

Syntax Description

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.

scope ttl-value

Time-to-live (TTL) value (in router hops) that limits the scope of the Auto-RP announce messages that are sent out of that interface. It can be a value from 1 to 255.

group-list access-list-name

(Optional) Access list that describes the group ranges for which this router is the rendezvous point.

interval seconds

(Optional) Time between rendezvous point announcements. It can be a number from 1 to 600.

bidir

(Optional) Bidirectional rendezvous point is specified for PIM.


Defaults

A router is not configured as a PIM rendezvous point candidate.

seconds: 60

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The auto-rp candidate-rp command is used by the rendezvous point for a multicast group range. The router sends an Auto-RP announcement message to the well-known group CISCO-RP-ANNOUNCE (224.0.1.39). This message announces the router as a candidate rendezvous point for the groups in the range described by the access list.

When the interval keyword is specified, the interval between Auto-RP announcements is set to number of seconds with the total hold time of the announcements automatically set to three times the interval time. The recommended interval time range is from 1 to 180 seconds.

The hold time of the Auto-RP announcement is the time for which the announcement is valid. After the designated hold time, the announcement expires and the entry is purged from the mapping cache until there is another announcement.

If the optional group-list keyword is omitted, the group range advertised is 224.0.0.0/4. This range corresponds to all IP multicast group addresses, which indicates that the router is willing to serve as the rendezvous point for all groups.

A router may be configured to serve as a candidate rendezvous point for more than one group range by a carefully crafted access list in the router configuration.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to send rendezvous point announcements out all PIM-enabled interfaces for a maximum of 31 hops. The IP address by which the router wants to be identified as a rendezvous point is the IP address associated with Packet-over-SONET/SDH (POS) interface 0/1/0/1. Access list 5 designates the groups that this router serves as the rendezvous point.

RP/0/RP0/CPU0:router(config)# ipv4 access-list 5 
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 224.0.0.0 15.255.255.255
RP/0/RP0/CPU0:router(config-ipv4-acl)# exit
RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp candidate-rp pos 0/1/0/1 scope 31 
group-list 5
RP/0/RP0/CPU0:router(config-pim-ipv4)# end

The router identified in the following example advertises itself as the candidate rendezvous point and is associated with loopback interface 0 for the group ranges 239.254.0.0 to 239.255.255.255 and 224.0.0.0 to 231.255.255.255:

RP/0/RP0/CPU0:router(config)# ipv4 access-list 10 
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 239.254.0.0 0.0.255.255
RP/0/RP0/CPU0:router(config-ipv4-acl)# exit
RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp candidate-rp loopback 0 scope 16 
group-list 10
RP/0/RP0/CPU0:router(config-pim-ipv4)# end

Related Commands

Command
Description

auto-rp mapping-agent

Configures the router to be a rendezvous point mapping agent on a specified interface.


auto-rp listen disable

To prevent a PIM process from learning about IP multicast traffic for the Auto-RP group 224.0.1.40 that is flooded across interfaces, use the auto-rp listen disable command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

auto-rp listen disable

no auto-rp listen disable

Syntax Description

This command has no arguments or keywords.

Defaults

PIM rendezvous point mappings are learned through Auto-RP.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to disable rendezvous point discovery:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp listen disable

auto-rp mapping-agent

To configure the router to be a rendezvous point (RP) mapping agent on a specified interface, use the auto-rp mapping-agent command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

auto-rp mapping-agent type instance scope ttl-value [interval seconds]

no auto-rp mapping-agent

Syntax Description

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.

scope ttl-value

Time-to-live (TTL) value (in router hops) that limits the scope of the rendezvous point discovery messages that are sent from that interface. Range is from 1 to 255.

interval seconds

(Optional) Time in seconds between discovery messages. Range is from 1 to 600.


Defaults

A router is not configured as a PIM rendezvous point mapping agent.

seconds: 60

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

After the router is configured as a rendezvous point mapping agent and determines the rendezvous point-to-group mappings through the CISCO-RP-ANNOUNCE (224.0.1.39) group, the router sends the mappings in an Auto-RP discovery message to the well-known group CISCO-RP-DISCOVERY (224.0.1.40). A PIM designated router (DR) listens to this well-known group to determine which rendezvous point to use.

More than one rendezvous point mapping agent can be configured in a network sending redundant information for a slight increase in reliability.

The TTL value is used to limit the range, or scope, of a multicast transmission. Therefore, use this value only on border routers.

The mapping packets are always sourced out of the default interface but have the source IP address as the address of the type and instance arguments. Packets have a TTL of 1 to 255 and are sent out each configured interval (when not specified, the default is 60 seconds).

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to limit Auto-RP discovery messages to 20 hops:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp mapping-agent pos 0/0/0/1 scope 20

Related Commands

Command
Description

auto-rp candidate-rp

Configures a router as a PIM rendezvous point candidate that sends messages to the well-known CISCO-RP-ANNOUNCE multicast group (224.0.1.39).


bsr-border

To stop the forwarding of bootstrap router (BSR) messages on a PIM router interface, use the bsr-border command in router pim interface configuration mode. To return to the default behavior, use the no form of this command.

bsr-border

no bsr-border

Syntax Description

This command has no arguments or keywords.

Defaults

BSR messages are forwarded on the PIM router interface.

Command Modes

Router PIM interface configuration

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

When you configure the bsr-border command, no PIM Version 2 BSR messages are sent or received through the interface. You should configure an interface bordering another PIM domain with this command to avoid BSR messages from being exchanged between the two domains. BSR messages should not be exchanged between different domains, because routers in one domain may elect rendezvous points (RPs) in the other domain, resulting in protocol malfunction or loss of isolation between the domains.


Note This command is used for the purpose of setting up a PIM domain BSR message border, and not for multicast boundaries.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the Packet-over-SONET/SDH (POS) 0/1/0/0 interface to be the PIM domain border:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0
RP/0/RP0/CPU0:router(config-pim-ipv4-if)# bsr-border

bsr candidate-bsr

To configure the router to announce its candidacy as a bootstrap router (BSR), use the bsr candidate-bsr command in router pim configuration mode. To return to the default behavior, use the no form of this command.

bsr candidate-bsr ip-address [hash-mask-len length] [priority value]

no bsr candidate-bsr ip-address [hash-mask-len length] [priority value]

Syntax Description

ip-address

IP address of the BSR router for the domain. For IPv4, this is an IP address in four-part dotted-decimal notation. For IPv6, the IP address is specified in hexadecimal format using 16-bit values between colons.

hash-mask-len length

(Optional) Length of a mask that is to be used in the hash function.

All groups with the same seed hash (correspond) to the same RP. For example, if this value is 24, only the first 24 bits of the group addresses matter. This fact allows you to get one RP for multiple groups.

For IPv4 addresses, a value of 30 is recommended. The range is 0 to 32.

For IPv6 addresses, a value of 126 is recommended. The range is 0 to 128.

priority value

(Optional) Priority of the candidate BSR. Range is 1 to 255. The BSR with the higher priority is recommended. If the priority values are the same, the router with the higher IP address is the BSR.


Defaults

value: 1

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The bsr candidate-bsr command causes the router to send bootstrap messages to all its PIM neighbors, with the address of the designated interface as the BSR address. Each neighbor compares the BSR address with the address it had from previous bootstrap messages (not necessarily received on the same interface). If the current address is the same or higher address, the PIM neighbor caches the current address and forwards the bootstrap message. Otherwise, the bootstrap message is dropped.

This router continues to be the BSR until it receives a bootstrap message from another candidate BSR saying that it has a higher priority (or if the same priority, a higher IP address).


Note Use the bsr candidate-bsr command only in backbone routers with good connectivity to all parts of the PIM domain. A subrouter that relies on an on-demand dialup link to connect to the rest of the PIM domain is not a good candidate BSR.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the router as a candidate BSR with a hash mask length of 30:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# bsr candidate-bsr 10.0.0.1 hash-mask-len 30

Related Commands

Command
Description

clear pim bsr

Clears BSR entries from the PIM rendezvous point group mapping cache.

show pim bsr candidate-rp

Displays PIM candidate rendezvous point information for the BSR.

show pim bsr election

Displays PIM candidate election information for the BSR.

show pim bsr rp-cache

Displays PIM rendezvous point cache information for the BSR.


bsr candidate-rp

To configure the router to advertise itself as a PIM Version 2 candidate rendezvous point (RP) to the bootstrap router (BSR), use the bsr candidate-rp command in router PIM configuration mode.To return to the default behavior, use the no form of this command.

bsr candidate-rp ip-address [group-list access-list] [interval seconds] [priority value]

no bsr candidate-rp

Syntax Description

ip-address

IP address of the router that is advertised as a candidate rendezvous point address.

group-list access-list

(Optional) Specifies the IP access list number or name that defines the group prefixes that are advertised in association with the rendezvous point address. The access list name cannot contain a space or quotation mark, and must begin with an alphabetic character to avoid confusion with numbered access lists.

interval seconds

(Optional) Specifies the candidate rendezvous point advertisement interval in seconds. Range is 30 to 600.

priority value

(Optional) Indicates the rendezvous point priority value. Range is 1 to 255.


Defaults

priority: 1

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and
Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The bsr candidate-rp command causes the router to send a PIM Version 2 message advertising itself as a candidate rendezvous point to the BSR. The addresses allowed by the access list, together with the router identified by the IP address, constitute the rendezvous point and its range of addresses for which it is responsible.


Note Use the bsr candidate-rp command only in backbone routers that have good connectivity to all parts of the PIM domain. That is, a stub router that relies on an on-demand dialup link to connect to the rest of the PIM domain is not a good candidate rendezvous point.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the router to advertise itself as a candidate rendezvous point to the BSR in its PIM domain. Access list number 4 specifies the group prefix associated with the candidate rendezvous point address 172.16.0.0. This rendezvous point is responsible for the groups with the prefix 239.

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# bsr candidate-rp 172.16.0.0 group-list 4
RP/0/RP0/CPU0:router(config-pim-ipv4)# exit
RP/0/RP0/CPU0:router(config)# ipv4 access-list 4
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 239.0.0.0 0.255.255.255
RP/0/RP0/CPU0:router(config-ipv4-acl)# end

Related Commands

Command
Description

bsr candidate-bsr

Configures the router to announce its candidacy as a BSR.

bsr candidate-rp

Configures the router to advertise itself as a PIM Version 2 candidate rendezvous point to the BSR.


clear pim autorp

To clear Auto-RP entries from the PIM rendezvous point (RP) group mapping cache, use the clear pim autorp command in EXEC mode.

clear pim autorp [rp-address]

Syntax Description

rp-address

Hostname or IP address of the rendezvous point.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows sample output before and after Auto-RP entries have been cleared from the PIM rendezvous point group mapping cache:

RP/0/RP0/CPU0:router# show pim group-map

IP PIM Group Mapping Table 
(* indicates group mappings being used)
Group Range     Proto  Client    Groups     RP address Info
224.0.1.39/32*  DM     static    1          0.0.0.0 
224.0.1.40/32*  DM     static    1          0.0.0.0 
224.0.0.0/24*   NO     static    0          0.0.0.0 
232.0.0.0/8*    SSM    config    0          0.0.0.0 
224.0.0.0/4*    SM     autorp    0          10.1.1.1   RPF: De0,10.1.1.1 (us) 
224.0.0.0/4     SM     static    0          0.0.0.0    RPF: Null,0.0.0.0

RP/0/RP0/CPU0:router# clear pim autorp 232.0.0.0/8

RP/0/RP0/CPU0:router# show pim group-map

IP PIM Group Mapping Table 
(* indicates group mappings being used)
Group Range     Proto  Client    Groups     RP address Info
224.0.1.39/32*  DM     static    1          0.0.0.0 
224.0.1.40/32*  DM     static    1          0.0.0.0 
224.0.0.0/24*   NO     static    0          0.0.0.0 
224.0.0.0/4*    SM     static    0          0.0.0.0    RPF: Null,0.0.0.0

clear pim bsr

To clear bootstrap router (BSR) entries from the PIM rendezvous point (RP) group mapping cache, use the clear pim bsr command in EXEC mode.

clear pim {ipv4 | ipv6} bsr

Syntax Description

ipv4

Specifies IPv4 address prefixes.

ipv6

Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows sample output before and after the BSR group mappings have been cleared from the rendezvous point group mapping cache:

RP/0/RP0/CPU0:router# show pim group-map

IP PIM Group Mapping Table
(* indicates group mappings being used)
(+ indicates BSR group mappings active in MRIB)

Group Range         Proto Client Groups RP address      Info
224.0.1.39/32*      DM    static 0      0.0.0.0
224.0.1.40/32*      DM    static 1      0.0.0.0
224.0.0.0/24*       NO    static 0      0.0.0.0
232.0.0.0/8*        SSM   config 0      0.0.0.0
224.0.0.0/4*        SM    bsr+   1      91.1.1.1        RPF: De0,91.1.1.1 (us)
224.0.0.0/4         SM    static 0      0.0.0.0         RPF: Null,0.0.0.

RP/0/RP0/CPU0:router# clear pim bsr 

RP/0/RP0/CPU0:router# show pim group-map

IP PIM Group Mapping Table
(* indicates group mappings being used)
(+ indicates BSR group mappings active in MRIB)
Group Range         Proto Client Groups RP address      Info
224.0.1.39/32*      DM    static 0      0.0.0.0
224.0.1.40/32*      DM    static 1      0.0.0.0
224.0.0.0/24*       NO    static 0      0.0.0.0
232.0.0.0/8*        SSM   config 0      0.0.0.0
224.0.0.0/4*        SM    static 1      0.0.0.0         RPF: Null,0.0.0.0

Related Commands

Command
Description

show pim group-map

Displays group-to-PIM mode mapping.


clear pim counters

To clear PIM counters and statistics, use the clear pim counters command in EXEC mode.

clear pim {ipv4 | ipv6} counters

Syntax Description

ipv4

Specifies IPv4 address prefixes.

ipv6

Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows sample output before and after clearing PIM counters and statistics:

RP/0/RP0/CPU0:router# show pim traffic

PIM Traffic Counters 
Elapsed time since counters cleared: 00:53:34
                  Received Sent 
Valid PIM Packets        0 97 
Hello                    0 420 
Join-Prune               0 0 
Register                 0 0 
Register Stop            0 0 
Assert                   0 0 
Bidir DF Election        0 0
Errors: 
Malformed Packets 0 
Bad Checksums 0 
Socket Errors 0 
Packets dropped due to invalid socket 0 
Packets which couldn't be accessed 0 
Packets sent on Loopback Errors 323 
Packets received on PIM-disabled Interface 0 
Packets received with Unknown PIM Version 0 

RP/0/RP0/CPU0:router# clear pim counters

RP/0/RP0/CPU0:router# show pim traffic

PIM Traffic Counters 
Elapsed time since counters cleared: 00:00:03
                  Received Sent 
Valid PIM Packets        0 0 
Hello                    0 0 
Join-Prune               0 0 
Register                 0 0 
Register Stop            0 0 
Assert                   0 0 
Bidir DF Election        0 0
Errors: 
Malformed Packets 0 
Bad Checksums 0 
Socket Errors 0 
Packets dropped due to invalid socket 0 
Packets which couldn't be accessed 0 
Packets sent on Loopback Errors 0 
Packets received on PIM-disabled Interface 0 
Packets received with Unknown PIM Version 0 

Related Commands

Command
Description

show pim traffic

Displays PIM traffic counter information.


clear pim topology

To clear group entries from the PIM topology table and reset the Multicast Routing Information Base (MRIB) connection, use the clear pim topology command in EXEC mode.

clear pim {ipv4 | ipv6} topology [ip-address-name | reset]

Syntax Description

ipv4

Specifies IPv4 address prefixes.

ipv6

Specifies IPv6 address prefixes.

ip-address-name

(Optional) Can be either one of the following:

Name of the multicast group, as defined in the Domain Name System (DNS) hosts table or with the domain ipv4 host or domain ipv6 host command.

IP address of the multicast group, in IPv4 or IPv6 format according to the specified address family.

reset

(Optional) Deletes all entries from the topology table and resets the MRIB connection.


Defaults

When the command is used with no arguments, all group entries located in the PIM topology table are cleared of PIM protocol information.

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The clear pim topology command clears existing PIM routes from the PIM topology table. Information obtained from the MRIB table, such as Internet Group Management Protocol (IGMP) local membership, is retained. If a multicast group is specified, only those group entries are cleared.

If the reset keyword is specified, all information from the topology table is cleared and the MRIB connections are automatically reset. This form of the command can be used to synchronize state between the PIM topology table and the MRIB database. The reset keyword should be strictly reserved to force synchronized PIM and MRIB entries when communication between the two components is malfunctioning.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to clear the PIM topology table:

RP/0/RP0/CPU0:router# clear pim topology

dr-priority

To configure the designated router (DR) priority on a PIM router, use the dr-priority command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

dr-priority value

no dr-priority

Syntax Description

value

An integer value to represent DR priority. Range is from 0 to 4294967295.


Defaults

If this command is not specified in interface configuration mode, the interface adopts the DR priority value specified in router PIM configuration mode.

If this command is not specified in router PIM configuration mode, the DR priority value is 1.

Command Modes

Router PIM interface configuration

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

If all the routers on the LAN support the DR priority option in the PIM Version 2 (PIMv2) hello message that they send, you can force the DR election by use of the dr-priority command so that a specific router on the subnet is elected as DR. The router with the highest DR priority becomes the DR.

When PIMv2 routers receive a hello message without the DR priority option (or when the message has priority of 0), the receiver knows that the sender of the hello message does not support DR priority and that DR election on the LAN segment should be based on IP address alone.


Note If this command is configured in router PIM configuration mode, parameters are inherited by all new and existing interfaces. You can override these parameters on individual interfaces from router PIM interface configuration mode.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the router to use DR priority 4 for Packet-over-SONET/SDH (POS) interface 0/1/0/0, but other interfaces will inherit DR priority 2:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# dr-priority 2
RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0
RP/0/RP0/CPU0:router(config-pim-ipv4-if)# dr-priority 4

embedded-rp

To configure the static address for the embedded rendezvous point (RP) on a PIM router, use the embedded-rp command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

embedded-rp rp-address access-list

no embedded-rp

Syntax Description

rp-address

Rendezvous point IPv6 address.

access-list

Number or name of an IPv6 address access list that specifies embedded group ranges.


Defaults

The static address for the embedded rendezvous point is not configured.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

When the embedded rendezvous point is enabled (which is the default behavior of the PIM router), you should configure a static address for the rendezvous point for the embedded rendezvous point ranges. Additional configuration is not required on other IPv6 PIM routers, because those routers discover the rendezvous point address from the IPv6 group address.


Note This command is available only for IPv6 address prefixes.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the static address for the embedded rendezvous point and specify an access list for group ranges:

RP/0/RP0/CPU0:router(config)# router pim address-family ipv6
RP/0/RP0/CPU0:router(config-pim-ipv6)# embedded-rp 2:2:2::2 acl_embed

RP/0/RP0/CPU0:router(config)# ipv6 access-list acl_embed
RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff73:240:2:2:2::/96
RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff74:240:2:2:2::/96
RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff75:240:2:2:2::/96
RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff76:240:2:2:2::/96
RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff77:240:2:2:2::/96
RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff78:240:2:2:2::/96

The following sample output displays the embedded rendezvous point information that was previously configured:

RP/0/RP0/CPU0:router# show pim ipv6 group-map

IP PIM Group Mapping Table
(* indicates group mappings being used)
(+ indicates BSR group mappings active in MRIB)

Group Range                                            Proto Client   Groups

ff02::/16*                                             NO    perm     0
  RP: ::
ff12::/16*                                             NO    perm     0
  RP: ::
ff22::/16*                                             NO    perm     0
  RP: ::
ff32::/16*                                             NO    perm     0
  RP: ::
ff42::/16*                                             NO    perm     0
  RP: ::
.
.
.
ff73:240:2:2:2::/96*                                   SM    embd-cfg 0
  RP: 2:2:2::2
  RPF: De6tunnel0,2:2:2::2 (us)
ff74:240:2:2:2::/96*                                   SM    embd-cfg 0
  RP: 2:2:2::2
  RPF: De6tunnel0,2:2:2::2 (us)
ff75:240:2:2:2::/96*                                   SM    embd-cfg 0
  RP: 2:2:2::2
  RPF: De6tunnel0,2:2:2::2 (us)
ff76:240:2:2:2::/96*                                   SM    embd-cfg 0
  RP: 2:2:2::2
  RPF: De6tunnel0,2:2:2::2 (us)
ff77:240:2:2:2::/96*                                   SM    embd-cfg 0
  RP: 2:2:2::2
  RPF: De6tunnel0,2:2:2::2 (us)
ff78:240:2:2:2::/96*                                   SM    embd-cfg 0
  RP: 2:2:2::2
  RPF: De6tunnel0,2:2:2::2 (us)
ff70::/12*                                             SM    embd     0
  RP: ::
  RPF: Null,::
fff0::/12*                                             NO    embd     0
  RP: ::
ff33::/32*                                             SSM   config   0
  RP: ::

Related Commands.

Command
Description

embedded-rp disable

Disables embedded rendezvous point support on a PIM router.

rp-address

Enters router PIM configuration mode.

show pim group-map

Displays group-to-PIM mode mapping.


embedded-rp disable

To disable embedded rendezvous point (RP) support on a PIM router, use the embedded-rp disable command in router PIM configuration mode. To restore the default value, use the no form of this command.

embedded-rp disable

no embedded-rp disable

Syntax Description

This command has no arguments or keywords.

Defaults

Embedded rendezvous point support is enabled.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The embedded rendezvous point applies only to the IPv6 group ranges ff7::/12 and fff::/12. When this command is enabled, the router parses groups that are in the embedded rendezvous point IPv6 group ranges, and then the router extracts the RP to be used from the multicast group address.


Note The embedded-rp disable command is available for IPv6 address prefixes only.


Examples

The following example shows how to disable embedded rendezvous point support:

RP/0/RP0/CPU0:router(config)# router pim address-family ipv6

RP/0/RP0/CPU0:router(config-pim-ipv6)# embedded-rp disable

Related Commands

Command
Description

rp-address

Enters router PIM configuration mode.

embedded-rp

Configures the static address for the embedded rendezvous point on a PIM router.


hello-interval (PIM)

To configure the frequency of PIM hello messages, use the hello-interval command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

hello-interval seconds

no hello-interval seconds

Syntax Description

seconds

Interval at which PIM hello messages are sent. Range is 1 to 3600.


Defaults

If this command is not specified in router PIM configuration mode, the hello interval is 30 seconds for broadcast and nonbroadcast.

Command Modes

Router PIM interface configuration

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Routers configured for IP multicast send PIM hello messages to establish PIM neighbor adjacencies and to determine which router is the designated router (DR) for each LAN segment (subnet).

To establish these adjacencies, every hello period a PIM multicast router multicasts a PIM router-query message to the All-PIM-Routers (224.0.0.13) multicast address on each of its multicast-enabled interfaces. Default time is 30 seconds. PIM hello messages contain a hold-time value that tells the receiver when the neighbor adjacency associated with the sender should expire if no further PIM hello messages are received. Typically the value of the hold-time field is 3.5 times the interval time value, or 120 seconds if the interval time is 30 seconds.

Use the show pim neighbor command to display PIM neighbor adjacencies and elected DRs.


Note If you configure the hello-interval command in router PIM configuration mode, parameters are inherited by all new and existing interfaces. You can override these parameters on individual interfaces from router PIM interface configuration mode.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the PIM hello message interval to 45 seconds. This setting is adopted by all interfaces excluding the 60 second interval time set for Packet-over-SONET/SDH (POS) interface 0/1/0/0:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# hello-interval 45
RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0
RP/0/RP0/CPU0:router(config-pim-ipv4-if)# hello-interval 60

Related Commands

Command
Description

dr-priority

Configures the DR priority on a PIM router.

show pim neighbor

Displays the PIM neighbors discovered by the Cisco IOS XR software.


interface (pim)

To configure PIM interface properties, use the interface command in router pim configuration mode. To disable multicast routing on an interface, use the no form of this command.

interface type instance

no interface type instance

Syntax Description

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.


Defaults

No default behavior or values

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Use the interface command to configure PIM routing properties for specific interfaces. Specifically, this command can be used to override the global settings for the following commands:

dr-priority

hello-interval

join-prune-interval

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the PIM hello message interval to 45 seconds. This setting is adopted by all interfaces excluding the 60-second interval time set for Packet-over-SONET/SDH (POS) interface 0/1/0/0:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# hello-interval 45
RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0
RP/0/RP0/CPU0:router(config-pim-ipv4-if)# hello-interval 60

Related Commands

Command
Description

dr-priority

Configures the designated router (DR) priority on a PIM router.

hello-interval (PIM)

Configures the frequency of PIM hello messages.

join-prune-interval

Configures the join and prune interval time for PIM protocol traffic.


join-prune-interval

To configure the join and prune interval time for PIM protocol traffic, use the join-prune-interval command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

join-prune-interval seconds

no join-prune-interval seconds

Syntax Description

seconds

Interval, in seconds, at which PIM multicast traffic can join or be removed from the shortest path tree (SPT) or rendezvous point tree (RPT). Range is 10 to 600.


Defaults

If this command is not specified in interface configuration mode, the interface adopts the join and prune interval parameter specified in router PIM configuration mode.

If this command is not specified in router PIM configuration mode, the join and prune interval is 60 seconds.

Command Modes

Router PIM interface configuration

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.


Note If this command is configured in router PIM configuration mode, parameters are inherited by all new and existing interfaces. You can override these parameters on individual interfaces from router PIM interface configuration mode.


This command is used to configure the frequency at which a PIM sparse-mode router sends periodic join and prune messages.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example changes the join and prune interval time to 90 seconds on Packet-over-SONET/SDH (POS) interface 0/1/0/0:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0
RP/0/RP0/CPU0:router(config-pim-ipv4-if)# join-prune-interval 90

maximum autorp

To configure the Auto-RP maximum cache setting, use the maximum autorp command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

maximum autorp mapping-agent-cache cache-size

no maximum autorp mapping-agent-cache cache-size

Syntax Description

mapping-agent-cache

Specifies the mapping agent cache.

cache-size

Maximum cache size. Range is 1 to 100.


Defaults

No default behavior or values

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to set the maximum mapping agent cache size to 66:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# maximum autorp mapping-agent-cache 66

Related Commands

Command
Description

maximum group-mappings

Configures the maximum number of PIM group map ranges learned from Auto-RP.

show pim summary

Displays configured OOR limits and current counts.


maximum group-mappings

To configure the maximum number of PIM group map ranges learned from Auto-RP, use the maximum group-mappings autorp command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

maximum group-mappings number

no maximum group-mappings

Syntax Description

number

Maximum number of PIM group mappings. Range is 200 to 5000.


Defaults

number: 500

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The maximum group-mappings command lets you set the upper limit for the PIM Out-of-Resource (OOR) configuration range. The range is initiated from the Auto-RP mapping agent announcement. Once the limit has been reached, PIM will not create additional Auto-RP group mapping ranges.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to set the upper limit number for group mapping to 200:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# maximum group-mappings 200

Related Commands

Command
Description

maximum autorp

Configures the Auto-RP maximum cache setting.

show pim summary

Displays configured OOR limits and current counts.


maximum register-states

To configure the maximum number of sparse-mode source register states that is allowed by PIM, use the maximum register-states command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

maximum register-states number

no maximum register-states

Syntax Description

number

Maximum number of PIM sparse-mode source register states. Range is 0 to 75000.


Defaults

number: 20000

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to set an upper limit for PIM register states. When the limit is reached, PIM discontinues route creation from PIM register messages.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to set the upper limit for PIM register states to 10000:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# maximum register-states 10000

Related Commands

Command
Description

show pim summary

Displays configured OOR limits and current counts.


maximum route-interfaces

To configure the maximum number of route interface states that is allowed by PIM, use the maximum route-interfaces command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

maximum route-interfaces number

no maximum route-interfaces

Syntax Description

number

Maximum number of PIM route interface states. Range is 1 to 600000.


Defaults

number: 30000

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to set an upper limit for route interface states. When the limit is reached, PIM discontinues route interface creation for its topology table.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to set the upper limit for PIM route interface states to 200000:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# maximum route-interfaces 200000

Related Commands

Command
Description

show pim summary

Displays configured OOR limits and current counts.


maximum routes

To configure the maximum number of routes that is allowed by PIM, use the maximum routes command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

maximum routes number

no maximum routes

Syntax Description

number

Maximum number of PIM routes. Range is 1 to 200000.


Defaults

number: 100000

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to set an upper limit for PIM routes. When the limit is reached, PIM discontinues route creation for its topology table.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to set the upper limit for PIM routes to 200000:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# maximum routes 200000

Related Commands

Command
Description

show pim summary

Displays configured OOR limits and current counts.


neighbor-check-on-recv enable

To block the receipt of join and prune messages from non-Protocol Independent Multicast (PIM) neighbors, use the neighbor-check-on-recv enable command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

neighbor-check-on-recv enable

no neighbor-check-on-recv enable

Syntax Description

This command has no arguments or keywords.

Defaults

Join and prune messages that are sent from non-PIM neighbors are received and not rejected.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.2

This command was introduced as neighbor-check-on-recv disable on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

Command was changed to neighbor-check-on-recv enable.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to enable PIM neighbor checking on received join and prune messages:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-default-ipv4)# neighbor-check-on-recv enable

Related Commands

Command
Description

neighbor-check-on-send enable

Configures PIM to not send join and prune messages to adjacent routers that are not established PIM neighbors.


neighbor-check-on-send enable

To enable Protocol Independent Multicast (PIM) neighbor checking when sending join and prune messages, use the neighbor-check-on-send enable command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

neighbor-check-on-send enable

no neighbor-check-on-send enable

Syntax Description

This command has no arguments or keywords.

Defaults

Join and prune messages are sent to non-PIM neighbors.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.2

This command was introduced as neighbor-check-on-send disable on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

Command was changed to neighbor-check-on-send enable.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to disable PIM neighbor checking when sending Join/Prune messages:

RP/0/RP0/CPU0:router# router pim
RP/0/RP0/CPU0:router(config-pim-default-ipv4)# neighbor-check-on-send enable 

Related Commands

Command
Description

neighbor-check-on-recv enable

Blocks the receipt of join and prune messages from non-Protocol Independent Multicast (PIM) neighbors.


neighbor-filter

To filter PIM neighbor messages from specific IP addresses, use the neighbor-filter command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

neighbor-filter access-list

no neighbor-filter

Syntax Description

access-list

Number or name of a standard IP access list that denies PIM packets from a source.


Defaults

PIM neighbor messages are not filtered.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to prevent unauthorized routers on the LAN from becoming PIM neighbors. Hello messages from addresses specified in the command are ignored.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example causes PIM to ignore all hello messages from IP address 10.0.0.1:

RP/0/RP0/CPU0:router(config-pim-ipv4)# neighbor-filter 1
RP/0/RP0/CPU0:router(config)# ipv4 access-list 1
RP/0/RP0/CPU0:router(config-ipv4-acl)# deny 10.0.0.1

nsf lifetime (PIM)

To configure the nonstop forwarding (NSF) timeout value for the PIM process, use the nsf lifetime command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

nsf lifetime seconds

no nsf lifetime

Syntax Description

seconds

Maximum time for NSF mode in seconds. Range is 10 to 600.


Defaults

seconds: 120

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

While in PIM NSF mode, PIM is recovering multicast routing topology from the network and updating the Multicast Routing Information Base (MRIB). After the PIM NSF timeout value is reached, PIM will signal the MRIB and resume normal operation.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following command shows how to set the PIM NSF timeout value to 30 seconds:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# nsf lifetime 30

Related Commands

Command
Description

nsf lifetime (IGMP/MLD)

Configures the maximum time for the NSF timeout value on the IGMP process.

nsf

Turns on NSF capability for the multicast routing system.

show igmp nsf

Displays the state of NSF operation in IGMP.

show mfib nsf

Displays the state of NSF operation for the MFIB line cards.

show mrib nsf

Displays the state of NSF operation in the MRIB.

show pim nsf

Displays the state of NSF operation for PIM.


old-register-checksum

To configure a Cisco IOS XR designated router (DRs) in a network where the rendezvous point is running an older version of Cisco IOS software, use the old-register-checksum command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

old-register-checksum

no old-register-checksum

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Cisco IOS XR software accepts register messages with checksum on the PIM header and the next 4 bytes only. This differs from the Cisco IOS method that accepts register messages with the entire PIM message for all PIM message types. The old-register-checksum command generates and accepts registers compatible with Cisco IOS software. This command is provided entirely for backward compatibility with IOS implementations.


Note To allow interoperability with Cisco IOS rendezvous points running older software, execute this command on all DRs in your network running Cisco IOS XR software. Cisco IOS XR register messages are incompatible with Cisco IOS software.


Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to set a source designated router (DR) to generate a register compatible with an earlier version of Cisco IOS XR PIM rendezvous point:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# old-register-checksum

router pim

To enter PIM configuration mode, use the router pim command in global configuration mode. To return to the default behavior, use the no form of this command.

router pim [address-family {ipv4 | ipv6}]

no router pim

Syntax Description

address-family

(Optional) Specifies which address prefixes to use.

ipv4

Specifies IPv4 address prefixes.

ipv6

Specifies IPv6 address prefixes.


Defaults

IPv4 address prefixes

Command Modes

Global configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

The address-family keyword was added on the Cisco CRS-1 router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

From router PIM configuration mode, you can configure the address of a rendezvous point (RP) for a particular group, configure nonstop forwarding (NSF) timeout value for the PIM process, and so on.

To locate all commands available in router PIM configuration mode, enter a question mark from the PIM configuration prompt:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# ?

  accept-register        Registers accept filter
  auto-rp                Auto-RP Commands
  commit                 Commit the configuration changes to running
  default                Set a command to its defaults
  describe               Describe a command without taking real actions
  do                     Run an exec command
  dr-priority            Inherited by all interfaces : PIM Hello DR priority
  exit                   Exit from this submode
  hello-interval         Inherited by all interfaces : Hello interval in seconds
  interface              PIM interface configuration subcommands
  join-prune-interval    Inherited by all interfaces : Join-Prune interval
  neighbor-filter        Neighbor filter
  no                     Negate a command or set its defaults
  nsf                    Configure Non-stop forwarding (NSF) options
  old-register-checksum  Generate registers compatible with older IOS versions
  rp-address             Configure Rendezvous Point
  show                   Show contents of configuration
  spt-threshold          Configure threshold for switching to SPT on last-hop

The following example shows how to enter router PIM configuration mode and specify the address-family ipv6 keywords:

RP/0/RP0/CPU0:router(config)# router pim address-family ipv6
RP/0/RP0/CPU0:router(config-pim-ipv6)# ?

  accept-register         Registers accept filter
  commit                  Commit the configuration changes to running
  convergence-timeout     Timeout value for the RIB convergence notification
  describe                Describe a command without taking real actions
  do                      Run an exec command
  dr-priority             Inherited by all interfaces : PIM Hello DR priority
  embedded-rp             Set Embedded RP processing support
  exit                    Exit from this submode
  hello-interval          Inherited by all interfaces : Hello interval in seconds
  interface               PIM interface configuration subcommands
  join-prune-interval     Inherited by all interfaces : Join-Prune interval
  maximum                 Maximum state limits
  neighbor-check-on-recv  Check for PIM neighbor before rcv'ing control messages
  neighbor-check-on-send  Check for PIM neighbor before sending control messages
  neighbor-filter         Neighbor filter
  no                      Negate a command or set its defaults
  nsf                     Configure Non-stop forwarding (NSF) options
  old-register-checksum   Generate registers compatible with older IOS versions
  rp-address              Configure Rendezvous Point
  show                    Show contents of configuration
  spt-threshold           Configure threshold for switching to SPT on last-hop

Examples

The following example shows how to enter router PIM configuration mode for IPv4 address prefixes, and set an RP address for all multicast groups:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 10.0.0.1

router pim interface bfd

To configure bidirectional forwarding detection (BFD) parameters, use the router pim interface command in global configuration mode. To return to the default behavior, use the no form of this command.

router pim interface {type instance} bfd {fast-detect | minimum-interval value | multiplier value}

no router pim interface {type instance} bfd {fast-detect | minimum-interval value | multiplier value}

Syntax Description

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.

fast-detect

Enables fast path failure detection.

minimum-interval

Specifies the minimum hello interval in milli-seconds. Range is 15 to 30000.

multiplier value

Specifies the detect multiplier value. Range is 2 to 50.


Defaults

No default behavior or values

Command Modes

Global configuration

Command History

Release
Modification

Release 3.4.0

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Examples

The following example shows how to enable fast detection on a specified TenGigabitEthernet/IEEE 802.3 interface:

RP/0/RP0/CPU0:router# configure
RP/0/RP0/CPU0:router(config)# router pim interface tengige 0/2/5/0 bfd fast-detect

Related Commands

Command
Description

router pim

Enters router PIM configuration mode.


rp-address

To statically configure the address of a PIM rendezvous point (RP) for a particular group, use the rp-address command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

rp-address ip-address [group-access-list] [bidir] [override]

no rp-address ip-address [group-access-list] [bidir] [override]

Syntax Description

ip-address

IP address of a router to be a PIM rendezvous point. This address is a unicast IP address in four-part dotted-decimal notation.

group-access-list

(Optional) Name of an access list that defines for which multicast groups the rendezvous point should be used. This list is a standard IP access list.

bidir

(Optional) Configures a bidirectional (bidir) rendezvous point.

override

(Optional) Indicates that if there is a conflict, the rendezvous point configured with this command prevails over the rendezvous point learned by Auto-RP.


Defaults

No PIM rendezvous points are preconfigured.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

All routers within a common PIM sparse mode (PIM-SM) or bidir domain require the knowledge of the well-known PIM rendezvous point address. The address is learned through Auto-RP or is statically configured using this command.

If the optional group-access-list-number argument is not specified, the rendezvous point for the group is applied to the entire IP multicast group range (224.0.0.0/4).

You can configure a single rendezvous point to serve more than one group. The group range specified in the access list determines the PIM rendezvous point group mapping. If no access list is specified, the rendezvous point default maps to 224/4.

If the rendezvous point for a group is learned through a dynamic mechanism, such as Auto-RP, this command might not be required. If there is a conflict between the rendezvous point configured with this command and one learned by Auto-RP, the Auto-RP information is used unless the override keyword is specified.

Task ID

Task ID
Operations

multicast

read


Examples

The following example shows how to set the PIM rendezvous point address to 10.0.0.1 for all multicast groups:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 10.0.0.1

The following example shows how to set the PIM rendezvous point address to 172.16.6.21 for the group 225.2.2.2:

RP/0/RP0/CPU0:router(config)# ipv4 access list 1 
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 225.2.2.2 0.0.0.0

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 172.16.6.21

The following example shows how to set the PIM rendezvous point address to 172.17.1.1 to serve the bidirectional group range defined in access list user1:

RP/0/RP0/CPU0:router(config)# ipv4 access-list user1
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 230.0.0.0 0.255.255.255

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 172.17.1.1 user1 bidir

Related Commands

Command
Description

ipv4 access-list

Defines a standard IP access list.


rpf-vector

To enable reverse path forwarding (RPF) vector signalling for PIM, use the rpf-vector command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

rpf-vector

no rpf-vector

Syntax Description

This command has no arguments or keywords.

Defaults

By default, RPF vector signalling is disabled.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

RPF vector is a PIM proxy that lets core routers without RPF information forward Join/Prune messages for external sources (for example, an MPLS based BGP-free core, where the MPLS core router is without external routes learned from BGP).

Task ID

Task ID
Operations

multicast

read


Examples

The following example shows how to enable RPF vector:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# rpf-vector

show auto-rp candidate-rp

To display the group ranges that this router represents (advertises) as a candidate rendezvous point (RP), use the show auto-rp candidate-rp command in EXEC mode.

show auto-rp [ipv4] candidate-rp

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 is the default.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 keyword was added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command displays all the candidate rendezvous points configured on this router.

Information that is displayed is the time-to-live (TTL) value, the interval from which the rendezvous point announcements were sent, and the mode, such as PIM sparse mode (SM), to which the rendezvous point belongs.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show auto-rp candidate-rp command:

RP/0/RP0/CPU0:router# show auto-rp candidate-rp

Group Range    Mode   Candidate RP   ttl  interval
224.0.0.0/4     SM       10.0.0.6     30      30

Table 26 describes the significant fields shown in the display.

Table 26 show auto-rp candidate-rp Field Descriptions 

Field
Description

Group Range

Multicast group address and prefix for which this router is advertised as a rendezvous point.

Mode

PIM protocol mode for which this router is advertised as a rendezvous point, either PIM-SM or bidirectional PIM (BiDir).

Candidate RP

Address of the interface serving as a rendezvous point for the range.

ttl

TTL scope value (in router hops) for Auto-RP candidate announcement messages sent out from this candidate rendezvous point interface.

interval

Time between candidate rendezvous point announcement messages for this candidate rendezvous point interface.


Related Commands

Command
Description

auto-rp candidate-rp

Configures a router as a PIM rendezvous point candidate that sends messages to the well-known CISCO-RP-ANNOUNCE multicast group (224.0.1.39).


show auto-rp mapping-agent

To display the mapping agent cache, use the show auto-rp mapping-agent command in EXEC mode.

show auto-rp [ipv4] mapping-agent

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 is the default.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and trace keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command shows all the system-wide candidate rendezvous point (RP) announcements that originate from the same or different multicast groups.

Information that is displayed shows that the mapping agent selects one rendezvous point for the group. If two rendezvous point announcements are bound for the same group, the mapping agent selects the one with the higher IP address as the "winner" and sends that out to the CISCO-RP-DISCOVERY group. All multicast routers join this group.

Task ID

Task ID
Operations

multicast

read


Examples

The following sample output shows that the mapping agent has received two candidate rendezvous point announcements for the same group range (224/4) and has selected the one with the higher IP address (winner indicated by a *):

RP/0/RP0/CPU0:router# show auto-rp mapping-agent

Mapping Agent Table
10.0.0.6 (expire : 80 secs)
  224.0.0.0/4  SM  *
10.0.0.2 (expire : 75 secs)
  224.0.0.0/4  SM

Table 27 describes the significant fields shown in the display.

Table 27 show auto-rp mapping-agent Field Descriptions 

Field
Description

10.0.0.6

Rendezvous point address of the advertised candidate rendezvous point.

(expire : 80 secs)

Hold time remaining until the candidate rendezvous point expires from the mapping agent cache.

224.0.0.0/4

Group range (address and prefix) that the candidate rendezvous point serves.

SM

PIM protocol mode for which this router is advertised as a rendezvous point.

*

Winning rendezvous point for the group range.


Related Commands

Command
Description

auto-rp mapping-agent

Configures the router to be a rendezvous point mapping agent on a specified interface.


show pim bsr candidate-rp

To display PIM candidate rendezvous point (RP) information for the bootstrap router (BSR), use the show pim bsr candidate-rp command in EXEC mode.

show pim [ipv4 | ipv6] bsr candidate-rp

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read


Examples

The following example shows how to display PIM candidate rendezvous point information:

RP/0/RP0/CPU0:router# show pim bsr candidate-rp

PIM BSR Candidate RP Info

Cand-RP     mode    scope     priority    uptime   group-list
91.1.1.1    SM       16          255      00:00:00     224/4

Table 28 describes the significant fields shown in the display.

Table 28 show pim bsr candidate-rp Field Descriptions 

Field
Description

Cand-RP

IP address of the candidate BSR rendezvous point.

mode

PIM mode of the candidate BSR rendezvous point.

scope

Number of messages sent.

priority

Candidate BSR rendezvous point priority value.

uptime

Time candidate BSR rendezvous point has been up.


Related Commands

Command
Description

bsr candidate-bsr

Configures the router to announce its candidacy as a BSR.


show pim bsr election

To display PIM candidate election information for the bootstrap router (BSR), use the show pim bsr election command in EXEC mode.

show pim [ipv4 | ipv6] bsr election

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read


Examples

This example shows how to display PIM candidate election information:

RP/0/RP1/CPU0:router# show pim bsr election

PIM BSR Election State

Cand/Elect-State      Uptime     BS-Timer    BSR                 C-BSR

Inactive/Accept-Any   00:00:00   00:00:00    0.0.0.0 [0, 0]   99.1.1.1 [0, 30]

Table 29 describes the significant fields shown in the display.

Table 29 show pim bsr election Field Descriptions 

Field
Description

Cand/Elect-State

Current candidate BSR state. Possible states include:

No-Info

Not-Elected

Pending

Elected

Elect-State indicates the current elected BSR state. Possible states include:

Accept-Any

Accept-Preferred

Uptime

Time the candidate BSR has been up.

BS-Timer

Time remaining before the bootstrap timer fires.

BSR

BSR IP address.

C-BSR

IP address, priority, and hash mask length of the candidate BSR.


Related Commands

Command
Description

bsr candidate-bsr

Configures the router to announce its candidacy as a BSR.


show pim bsr rp-cache

To display PIM rendezvous point (RP) cache information for the bootstrap router (BSR), use the show pim bsr rp-cache command in EXEC mode.

show pim [ipv4 | ipv6] bsr rp-cache

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.2

This command was introduced on the Cisco CRS-1 router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim bsr rp-cache command:

RP/0/RP0/CPU0:router# show pim bsr rp-cache

Group(s) 224.0.0.0/4, RP count 1
RP-addr        Priority    Holdtime(s)   Uptime    Expires
40.40.40.1     255         150           03:05:03  00:02:12

Table 30 describes the significant fields shown in the display.

Table 30 show pim bsr rp-cache Field Descriptions 

Field
Description

Group(s), RP count

Group range and number of rendezvous points.

RP-addr

IP address of the rendezvous point.

Priority

Priority value of the rendezvous point.

Holdtime(s)

Time the rendezvous point announcement is valid.

Uptime

Time the rendezvous point announcement expires.


Related Commands

Command
Description

bsr candidate-rp

Configures the router to advertise itself as a PIM Version 2 candidate rendezvous point to the BSR.


show pim df election-state

To display bidirectional designated forwarder (DF) election state for a rendezvous point (RP) or interface, use the show pim df election-state command in EXEC mode.

show pim [ipv4 | ipv6] df election-state [rp-ip-address] [type instance]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

Specifies IPv6 address prefixes.

rp-ip-address

(Optional) IP address or name of the rendezvous point. This address is an IP address in either IPv4 or IPv6 format.

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The tunnel-ipsec and tunnel-te interfaces were added


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command shows the state of DF election on a per-interface or per-RP basis. The DF election may result in one of the following states: Offer, Winner, Lose, or Backoff.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim df election-state command; the far right column shows the interface route metric toward the RP:

RP/0/RP0/CPU0:router# show pim df election-state pos 0/4/0/0

RP               Interface              DF State         Timer         Metrics
172.16.1.3        POS0/4/0/0            Winner           7s 956ms      [110/2]
172.16.1.6        POS0/4/0/0            Lose             0s 0ms        [inf/inf]

Table 31 describes the significant fields shown in the display.

Table 31 show pim df election-state Field Descriptions 

Field
Description

RP

Address of the rendezvous point.

Interface

Interface on which the DF election takes place.

DF State

DF election state for this router: Offer, Winner, Lose, or Backoff.

Timer

Time for which the DF election state is valid.

Metrics

Unicast routing metric for the rendezvous point sent from the DF election.


Related Commands

Command
Description

domain ipv4 host

Defines a static hostname-to-address mapping in the host cache using IPv4.

show pim df winner

Displays the bidirectional DF "winner" for a rendezvous point or an interface.


show pim df winner

To display the bidirectional designated forwarder (DF) "winner" for a rendezvous point (RP) or interface, use the show pim df winner command in EXEC mode.

show pim [ipv4 | ipv6] df winner [rp-ip-address] [type instance]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

Specifies IPv6 address prefixes.

rp-ip-address

(Optional) IP address of the rendezvous point. This address is an IP address in either IPv4 or IPv6 format.

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The tunnel-ipsec and tunnel-te interfaces were added


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The show pim df winner command displays the DF winner address for each interface or rendezvous point.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim df winner command; the far right column shows the winner metric toward the rendezvous point:

RP/0/RP0/CPU0:router# show pim df winner 172.16.1.3

RP               Interface              DF Winner        Metrics
172.16.1.3        Loopback3             172.17.3.2        [110/2]
172.16.1.3        Loopback2             172.17.2.2        [110/2]
172.16.1.3        Loopback1             172.17.1.2        [110/2]
172.16.1.3        POS0/2/0/2             10.10.2.3        [0/0]
172.16.1.3        POS0/2/0/0             10.10.1.2        [110/2]

Table 32 describes the significant fields shown in the display.

Table 32 show pim df winner Field Descriptions 

Field
Description

RP

Rendezvous point address.

Interface

Interface on which the DF election takes place.

DF Winner

DF winner address.

Metrics

Unicast routing metric for the rendezvous point sent by the DF winner.


Related Commands

Command
Description

domain ipv4 host

Defines a static hostname-to-address mapping in the host cache using IPv4.

show pim df election-state

Displays the bidirectional DF election state for a rendezvous point or an interface.


show pim group-map

To display group-to-PIM mode mapping, use the show pim group-map command in EXEC mode.

show pim [ipv4 | ipv6] group-map [ip-address-name] [info-source]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

Specifies IPv6 address prefixes.

ip-address-name

(Optional) Can be either one of the following:

Name of the multicast group, as defined in the Domain Name System (DNS) hosts table or with the domain ipv4 host command.

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

info-source

(Optional) Displays the group range information source.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

The ipv4 and ipv6 keywords were added on the Cisco CRS-1 router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command displays all group protocol address mappings for the rendezvous point. Mappings are learned from different clients, such as Auto-RP.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim group-map command:

RP/0/RP0/CPU0:router# show pim group-map 

Group Range         Proto Client Groups RP address      Info

224.0.1.39/32*      DM    static 1      0.0.0.0         
224.0.1.40/32*      DM    static 1      0.0.0.0         
224.0.0.0/24*       NO    static 0      0.0.0.0         
232.0.0.0/8*        SSM   config 0      0.0.0.0         
224.0.0.0/4*        SM    autorp 1      10.10.2.2       RPF: POS01/0/3,10.10.3.2

In lines 1 and 2, Auto-RP group ranges are specifically denied from the sparse mode group range.

In line 3, link-local multicast groups (224.0.0.0 to 224.0.0.255 as defined by 224.0.0.0/24) are also denied from the sparse mode group range.

In line 4, the PIM Source Specific Multicast (PIM-SSM) group range is mapped to 232.0.0.0/8.

The last entry shows that all the remaining groups are in sparse mode mapped to rendezvous point 10.10.3.2.

Table 33 describes the significant fields shown in the display.

Table 33 show pim group-map Field Descriptions 

Field
Description

Group Range

Multicast group range that is mapped.

Proto

Multicast forwarding mode.

Client

States how the client was learned.

Groups

Number of groups from the PIM topology table.

RP address

Rendezvous point address.

Info

RPF interface used and the PIM-SM RPF information toward the rendezvous point.


Related Commands

Command
Description

domain ipv4 host

Defines a static hostname-to-address mapping in the host cache using IPv4.

rp-address

Configures the address of a PIM rendezvous point for a particular group.

show pim range-list

Displays the range-list information for PIM.


show pim interface

To display information about interfaces configured for PIM, use the show pim interface command in EXEC mode.

show pim [ipv4 | ipv6] interface [type instance | state-on | state-off] [detail]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

Specifies IPv6 address prefixes.

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.

state-on

(Optional) Displays only interfaces from which PIM is enabled and active.

state-off

(Optional) Displays only interfaces from which PIM is disabled or inactive.

detail

(Optional) Displays detailed address information.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The tunnel-ipsec and tunnel-te interfaces were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command displays neighboring information on all PIM-enabled interfaces, such as designated router (DR) priority and DR election winner.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim interface command:

RP/0/RP0/CPU0:router# show pim interface 

Address                      Interface              PIM  Nbr   Hello  DR    DR
                                                         Count Intvl  Prior
172.29.52.127                MgmtEth0/0/CPU0/0      off  0     30     1     not elected
10.6.6.6                     Loopback0              off  0     30     1     not elected
0.0.0.0                      Loopback60             off  0     30     1     not elected
0.0.0.0                      Loopback61             off  0     30     1     not elected
10.46.4.6                    ATM0/2/0/0.1           off  0     30     1     not elected
10.46.5.6                    ATM0/2/0/0.2           off  0     30     1     not elected
10.46.6.6                    ATM0/2/0/0.3           off  0     30     1     not elected
10.46.7.6                    ATM0/2/0/0.4           off  0     30     1     not elected
10.46.8.6                    ATM0/2/0/3.1           off  0     30     1     not elected
10.46.9.6                    ATM0/2/0/3.2           off  0     30     1     not elected
10.56.16.6                   Serial0/3/2/1          off  0     30     1     not elected
10.56.4.2                    Serial0/3/0/0/0:0      off  0     30     1     not elected
10.56.4.6                    Serial0/3/0/0/1:0      off  0     30     1     not elected
10.56.4.10                   Serial0/3/0/0/2:0      off  0     30     1     not elected
10.56.4.14                   Serial0/3/0/0/2:1      off  0     30     1     not elected
10.56.4.18                   Serial0/3/0/0/3:0      off  0     30     1     not elected
10.56.4.22                   Serial0/3/0/0/3:1      off  0     30     1     not elected
10.56.4.26                   Serial0/3/0/0/3:2      off  0     30     1     not elected
10.56.4.30                   Serial0/3/0/0/3:3      off  0     30     1     not elected
10.56.8.2                    Serial0/3/0/1/0:0      off  0     30     1     not elected
10.56.12.6                   Serial0/3/2/0.1        off  0     30     1     not elected
10.56.13.6                   Serial0/3/2/0.2        off  0     30     1     not elected
10.56.14.6                   Serial0/3/2/0.3        off  0     30     1     not elected
10.56.15.6                   Serial0/3/2/0.4        off  0     30     1     not elected
10.67.4.6                    POS0/4/1/0             off  0     30     1     not elected
10.67.8.6                    POS0/4/1/1             off  0     30     1     not elected

Table 34 describes the significant fields shown in the display.

Table 34 show pim interface Field Descriptions 

Field
Description

Address

IP address of the interface.

Interface

Interface type and number that is configured to run PIM.

PIM

PIM is turned off or turned on this interface.

Nbr Count

Number of PIM neighbors in the neighbor table for the interface.

Hello Intvl

Frequency, in seconds, of PIM hello messages, as set by the ip pim hello-interval interface configuration command.

DR Priority

Designated router priority is advertised by the neighbor in its hello messages.

DR

IP address of the DR on the LAN. Note that serial lines do not have DRs, so the IP address is shown as 0.0.0.0. If the interface on this router is the DR, "this system" is indicated; otherwise, the IP address of the external neighbor is given.


Related Commands

Command
Description

show pim neighbor

Lists the PIM neighbors discovered by the Cisco IOS XR software.


show pim join-prune statistics

To display PIM join and prune aggregation statistics, use the show pim join-prune statistics command in EXEC mode.

show pim [ipv4 | ipv6] join-prune statistics [type instance]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The tunnel-ipsec and tunnel-te interfaces were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command displays the average PIM join and prune groups for the most recent packets (in increments of 1000/10000/50000) that either were sent out or received from each PIM interface. If fewer than 1000/10000/50000 join and prune group messages are received since PIM was started or the statistics were cleared, the join-prune aggregation shown in the command display is zero (0).

Because each PIM join and prune packet can contain multiple groups, this command can provide a snapshot view of the average pace based on the number of join and prune packets, and on the consideration of the aggregation factor of each join and prune packet.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim join-prune statistics command with all router interfaces specified:

RP/0/RP0/CPU0:router# show pim join-prune statistics

Interface      MTU    Transmitted    Received 

Loopback0      1514   0 / 0 / 0      0 / 0 / 0 
Encapstunnel0  0      0 / 0 / 0      0 / 0 / 0 
Decapstunnel0  0      0 / 0 / 0      0 / 0 / 0 
Loopback1      1514   0 / 0 / 0      0 / 0 / 0 
POS0/3/0/0     4470   0 / 0 / 0      0 / 0 / 0 
POS0/3/0/3     4470   0 / 0 / 0      0 / 0 / 0 

Table 35 describes the significant fields shown in the display.

Table 35 show pim join-prune statistics Field Descriptions 

Field
Description

Interface

Interface from which statistics were collected.

MTU

Maximum Transmission Unit (MTU) in bytes for the interface.

Transmitted

Number of join and prune states aggregated into transmitted messages in the last 1000/10000/50000 transmitted join and prune messages.

Received

Number of join and prune states aggregated into received messages in the last 1000/10000/50000 received join and prune messages.


show pim mstatic

To display multicast static routing information, use the show pim mstatic command in EXEC mode.

show pim [ipv4 | ipv6] mstatic

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.


Command Modes

EXEC

Command History

Release
Modification

Release 3.4.0

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The show pim mstatic command is used to view all the multicast static routes. Multicast static routes are defined by the static-rpf command.

Examples

The following is sample output from the show mstatic command that shows how to reach IP address 10.0.0.1:

RP/0/RP0/CPU0:router# show pim mstatic

IP Multicast Static Routes Information
* 10.0.0.1/32 via pos0/1/0/1 with nexthop 172.16.0.1 and distance 0 

Table 36 describes the significant fields shown in the display.

Table 36 show pim mstatic Field Descriptions 

Field
Description

10.0.0.1

Destination IP address.

pos0/1/0/1

Interface that is entered to reach destination IP address 10.0.0.1

172.16.0.1

Next hop IP address to enter in order to reach destination address 10.0.0.1.

0

Distance of this mstatic route.


Related Commands

Command
Description

static-rpf

Configures a static RPF rule for a given prefix mask.


show pim neighbor

To display the PIM neighbors discovered by the Cisco IOS XR software, use the show pim neighbor command in EXEC mode.

show pim [ipv4 | ipv6] neighbor [type instance] [count] [detail]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

type

Interface type. For more information, use the question mark (?) online help function.

instance

Either a physical interface instance or a virtual interface instance as follows:

Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

rack: Chassis number of the rack.

slot: Physical slot number of the modular services card or line card.

module: Module number. A physical layer interface module (PLIM) is always 0.

port: Physical port number of the interface.

Note In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0.
Example: interface MgmtEth0/RP1/CPU0/0.

Virtual interface instance. Number range varies depending on interface type.

For more information about the syntax for the router, use the question mark (?) online help function.

count

(Optional) Number of neighbors present on the specified interface, or on all interfaces if one is not specified. The interface on this router counts as one neighbor in the total count.

detail

(Optional) Displays detailed information.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The tunnel-ipsec and tunnel-te interfaces were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to determine the PIM neighbors known to this router through PIM hello messages. Also, this command indicates that an interface is a designated router (DR) and when the neighbor is capable of bidirectional operation.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim neighbor command:

RP/0/RP0/CPU0:router# show pim neighbor

Neighbor Address  Interface              Uptime    Expires DR pri Bidir

172.17.1.2*       Loopback1              03:41:22  00:01:43 1 (DR) B
172.17.2.2*       Loopback2              03:41:20  00:01:31 1 (DR) B
172.17.3.2*       Loopback3              03:41:18  00:01:28 1 (DR) B
10.10.1.1         POS0/2/0/0             03:40:36  00:01:41 1      B
10.10.1.2*        POS0/2/0/0             03:41:28  00:01:32 1 (DR) B
10.10.2.2*        POS0/2/0/2             03:41:26  00:01:36 1      B
10.10.2.3         POS0/2/0/2             03:41:25  00:01:29 1 (DR) B

The following is sample output from the show pim neighbor command with the count option:

RP/0/RP0/CPU0:router# show pim neighbor count

Interface   Nbr count
POS0/3/0/0     1 
Loopback1      1
Total Nbrs     2

Table 37 describes the significant fields shown in the display.

Table 37 show pim neighbor Field Descriptions 

Field
Description

Neighbor Address

IP address of the PIM neighbor.

Interface

Interface type and number on which the neighbor is reachable.

Uptime

Time the entry has been in the PIM neighbor table.

Expires

Time until the entry is removed from the IP multicast routing table.

DR pri

DR priority sent by the neighbor in its hello messages. If this neighbor is elected as the DR on the interface, it is annotated with "(DR)" in the command display.

Bidir

Indicates that the neighbor is capable of bidirectional PIM mode operation.

Nbr count

Number of PIM neighbors in the neighbor table for all interfaces on this router.


Related Commands

Command
Description

show pim interface

Displays information about interfaces configured for PIM.


show pim nsf

To display the state of nonstop forwarding (NSF) operation for PIM, use the show pim nsf command in EXEC mode.

show pim [ipv4 | ipv6] nsf

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command displays the current multicast NSF state for PIM. For multicast NSF, the state may be normal or activated for nonstop forwarding. The latter state indicates that recovery is in progress due to a failure in MRIB or PIM. The total NSF timeout and time remaining are displayed until NSF expiration.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim nsf command:

RP/0/RP0/CPU0:router# show pim nsf 

IP PIM Non-Stop Forwarding Status: 
Multicast routing state: Non-Stop Forwarding Activated 
NSF Lifetime: 00:02:00 
NSF Time Remaining: 00:01:56

Table 38 describes the significant fields shown in the display.

Table 38 show pim nsf Field Descriptions 

Field
Description

Multicast routing state

PIM state is in NSF recovery mode (Normal or Non-Stop Forwarding Activated).

NSF Lifetime

Total NSF lifetime (seconds, hours, and minutes) configured for PIM.

NSF Time Remaining

Time remaining in NSF recovery for PIM if NSF recovery is activated.


show pim range-list

To display range-list information for PIM, use the show pim range-list command in EXEC mode.

show pim [ipv4 | ipv6] range-list [autorp | config] [ip-address-name]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

autorp

(Optional) PIM Auto-RP range list information.

config

(Optional) PIM command-line interface (CLI) range list information.

ip-address-name

(Optional) IP address of the rendezvous point.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to determine the multicast forwarding mode to group mapping. The output also indicates the rendezvous point (RP) address for the range, if applicable. The config keyword means that the particular range is statically configured.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim range-list command:

RP/0/RP0/CPU0:router# show pim range-list 

config SSM Exp: never Src: 0.0.0.0
  230.0.0.0/8 Up: 03:47:09
config BD RP: 172.16.1.3 Exp: never Src: 0.0.0.0
  239.0.0.0/8 Up: 03:47:16
config SM RP: 172.18.2.6 Exp: never Src: 0.0.0.0
  235.0.0.0/8 Up: 03:47:09

Table 39 describes the significant fields shown in the display.

Table 39 show pim range-list Field Descriptions 

Field
Description

config

Group range was learned by means of configuration.

SSM

PIM mode is operating in Source Specific Multicast (SSM) mode. Other modes are Sparse-Mode (SM) and bidirectional (BD).

Exp: never

Expiration time for the range is "never".

Src: 0.0.0.0

Advertising source of the range.

230.0.0.0/8

Group range: address and prefix.

Up: 03:47:09

Total time that the range has existed in the PIM group range table. In other words, the uptime in hours, minutes and seconds.


Related Commands

Command
Description

domain ipv4 host

Defines a static hostname-to-address mapping in the host cache using IPv4.

show pim group-map

Displays group-to-PIM mode mapping.


show pim rpf

To display Reverse Path Forwarding (RPF) information, use the show pim rpf command in EXEC mode.

show pim [ipv4 | ipv6] rpf [ip-address | summary]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

ip-address

(Optional) Name or IP address of the source as defined in the Domain Name System (DNS) hosts table.

Note The ip-address argument can also be a PIM rendezvous point (RP) address.

summary

(Optional) Displays information about the interaction of PIM with the unicast RIB, including the convergence state, SAFI table to which it is registered, and number of source or rendezvous point registrations created.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

The count keyword was deprecated and replaced with the summary keyword.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

PIM obtains RPF information used to direct Join/Prune messages using the next-hop state from the RIB tables. The show pim rpf command provides the next hops used by PIM for each source and rendezvous point address in the PIM topology table. If you have configured the multicast-routing address-family [ipv4 | ipv6] multipath command, multiple next hops can appear for each source or rendezvous point address.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim rpf command using a specific IP address:

RP/0/RP0/CPU0:router# show pim rpf 10.0.0.1

10.0.0.1/32 [110/2]
  via 10.1.0.1, POS0/2/0/0
  via 10.2.0.1, GigabitEthernet0/3/0/1
  via 10.3.0.1, GigabitEthernet0/3/0/2

The following is sample output from the show pim rpf summary command:

RP/0/RP0/CPU0:router# show pim rpf summary

PIM RPFs registered with Unicast RIB table

MBGP                   Not configured
OSPF Mcast-intact      Not configured
ISIS Mcast-intact      Not configured

RIB Table converged
RIB Convergence Timeout Value: 00:03:00 Multipath RPF Selection is
Disabled

Related Commands

Command
Description

show pim rpf hash

Displays RIB source lookup information.


show pim rpf hash

To perform a RIB lookup to predict RPF next-hop paths used to match multicast routes from a set of ECMP next-hop paths, use the show pim rpf hash command in EXEC mode.

show pim [ipv4 | ipv6] rpf hash ip-address [group-address [hash-mask-length length]]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

ip-address

(Optional) Name or IP address of the source as defined in the Domain Name System (DNS) hosts table.

Note The ip-address argument can also be a PIM rendezvous point (RP) address.

group-address

(Optional) Can be either one of the following:

Name of the multicast group, as defined in the Domain Name System (DNS) hosts table or with the domain ipv4 host or domain ipv6 host command.

IP address of the multicast group. This is a multicast IP address in IPv4 or IPv6 format.

hash-mask-length length

(Optional) BSR hash mask length to be applied to the next-hop hashing. Default is the BSR hash mask length known for the matching group range (or host mask length if BSR is not configured for the range). Range is 0 to 128.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 router and Cisco XR 12000 Series Router.

Release 3.4.0

Range of hash mask length changed from 0 to 32 to 0 to 128.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

The show pim rpf hash command lets you predict the way routes balance across ECMP next hops. It does not require that route to exist in the MRIB at the time.

When using the root name or ip-address argument for a (*,G) route, use the rendezvous point address and omit the group address option. For (S,G) routes, use the source address and the group address.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output for the show pim rpf hash command:

RP/0/RP0/CPU0:router# show pim rpf hash 10.0.0.1 239.0.0.1

 Multipath RPF selection is enabled.
 RPF next-hop neighbor selection result: POS0/2/0/0,10.1.0.1

Related Commands

Command
Description

show pim rpf

Displays Reverse Path Forwarding (RPF) information.


show pim summary

To display configured PIM Out-of-Resource (OOR) limits and current counts, use the show pim summary command in EXEC mode.

show pim [ipv4 | ipv6] summary

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command is used to identify configured OOR information for the PIM protocol, such as number of current and maximum routes.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim summary command that shows five PIM routes and the maximum number of routes allowed is 100000:

RP/0/RP0/CPU0:router# show pim summary

PIM Summary 

PIM State Counters 
                      Current Maximum 
Routes                   5    100000 
Routes x Interfaces     11    300000 
SM Registers             0    20000 
Group Ranges from AutoRP 1    500

Table 40 describes the significant fields shown in the display.

Table 40 show pim summary Field Descriptions 

Field
Description

Routes

Current number of routes (in the PIM topology table) and the maximum allowed before the creation of new routes is prohibited to avoid Out of Resource (OOR) conditions.

Routes x Interfaces

Current total number of interfaces (in the PIM topology table) present in all route entries and the maximum allowed before the creation of new routes is prohibited to avoid OOR conditions.

SM Registers

Current number of sparse mode route entries from which PIM register messages are received and the maximum allowed before the creation of new register states is prohibited to avoid OOR conditions.

Group Ranges from AutoRP

Current number of sparse mode group range-to-rendezvous point mappings learned from Auto-RP and the maximum allowed before the creation of new group ranges is prohibited to avoid OOR conditions.


show pim topology

To display PIM topology table information for a specific group or all groups, use the show pim topology command in EXEC mode.

show pim [ipv4 | ipv6] topology [ip-address | entry-flag flag | interface-flag | summary] [route-count]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

ip-address

(Optional) Name or IP address of the multicast group or source as defined in the Domain Name System (DNS) hosts table.

entry-flag flag

(Optional) Displays routes with a specific entry flag set. Valid flags are as follows:

AA

DCC

DSS

E

KAT

LH

PA

RA

RR

SR

interface-flag flag

(Optional) Displays routes with a specific interface flag set. Valid flags are as follows:

AB

AS

ID

II

LD

LH

LI

summary

(Optional) Displays summary information.

route-count

(Optional) Number of routes in the PIM topology table.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The entry-flag and interface-flag keywords were added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Use the PIM topology table to display various entries for a given group, (*, G), (S, G), and (S, G)RPT, each with its own interface list.

PIM communicates the contents of these entries through the Multicast Routing Information Base (MRIB), which is an intermediary for communication between multicast routing protocols, such as PIM, local membership protocols, such as Internet Group Management Protocol (IGMP), and the multicast forwarding engine of the system.

The MRIB shows on which interface the data packet should be accepted and on which interfaces the data packet should be forwarded, for a given (S, G) entry. Additionally, the Multicast Forwarding Information Base (MFIB) table is used during forwarding to decide on per-packet forwarding actions.


Note For forwarding information, use the show mfib route and show mrib route commands rather than the show mroute command.


Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim topology command:

RP/0/RP0/CPU0:router# show pim topology 

IP PIM Multicast Topology Table 
Entry state: (*/S,G)[RPT/SPT] Protocol Uptime Info 
Entry flags: KAT - Keep Alive Timer, AA - Assume Alive, PA - Probe Alive, 
RA - Really Alive, LH - Last Hop, DSS - Don't Signal Sources, 
RR - Register Received, SR - Sending Registers, E - MSDP External, 
DCC - Don't Check Connected 
Interface state: Name, Uptime, Fwd, Info 
Interface flags: LI - Local Interest, LD - Local Dissinterest, 
II - Internal Interest, ID - Internal Dissinterest, 
LH - Last Hop, AS - Assert, AB - Admin Boundary

(11.0.0.1,239.9.9.9)SPT SM Up: 00:00:13 
JP: Join(never) RPF: Loopback1,11.0.0.1* Flags: KAT(00:03:16) RA RR 
No interfaces in immediate olist

(*,239.9.9.9) SM Up: 4d14h RP: 11.0.0.1*
JP: Join(never) RPF: Decapstunnel0,11.0.0.1 Flags: LH 
POS0/3/0/0 4d14h fwd LI II LH 

(*,224.0.1.39) DM Up: 02:10:38 RP: 0.0.0.0
JP: Null(never) RPF: Null,0.0.0.0 Flags: LH DSS 
  POS0/2/0/0 02:10:38  off LI II LH 

(*,224.0.1.40) DM Up: 03:54:23 RP: 0.0.0.0
JP: Null(never) RPF: Null,0.0.0.0 Flags: LH DSS 
  POS0/2/0/0 03:54:23  off LI II LH 
  POS0/2/0/2               03:54:14  off LI 
  POS0/4/0/0 03:53:37  off LI 

(*,239.100.1.1) BD Up: 03:51:35 RP: 200.6.1.6
JP: Join(00:00:24) RPF: POS0/4/0/0,10.10.4.6 Flags: 
  POS0/2/0/0 03:42:05  fwd Join(00:03:18) 
  POS0/2/0/2               03:51:35  fwd Join(00:02:54) 

(*,235.1.1.1) SM Up: 03:51:39 RP: 200.6.2.6
JP: Join(00:00:50) RPF: POS0/4/0/0,10.10.4.6 Flags: 
  POS0/2/0/2               02:36:09  fwd Join(00:03:20) 
  POS0/2/0/0 03:42:04  fwd Join(00:03:16) 

Table 41 describes the significant fields shown in the display. This table includes fields that do not appear in the example, but that may appear in your output.

Table 41 show pim topology Field Descriptions 

Field
Description

(11.0.0.1,239.9.9.9)SPT

Entry state. Source address, group address, and tree flag (shortest path tree or rendezvous point tree) for the route entry. Note that the tree flag may be missing from the entry.

SM

Entry protocol. PIM protocol mode in which the entry operates: sparse mode (SM), source specific multicast (SSM), bidirectional (BD), or dense-mode (DM).

Up: 00:00:13

Entry uptime. Time (in hours, minutes, and seconds) this entry has existed in the topology table.

RP: 11.0.0.1*

Entry information. Additional information about the route entry. If route entry is a sparse mode or bidirectional PIM route, the RP address is given.

JP: Null(never)

Entry join/prune state. Indicates if and when a join or prune message is sent to the RPF neighbor for the route.

Entry Information Flags

KAT - Keep Alive Timer

The keepalive timer tracks whether traffic is flowing for the
(S, G) route on which it is set. A route will not time out while the KAT is running. The KAT runs for 3.5 minutes, and the route goes into KAT probing mode for as long as 65 seconds. The route is deleted if no traffic is seen during the probing interval, and there is no longer any reason to keep the route—for example, registers and (S, G) joins.

AA - Assume Alive

Flag that indicates that the route was alive, but recent confirmation of traffic flow was not received.

PA - Probe Alive

Flag that indicates that the route is probing the data plane to determine if traffic is still flowing for this route before it is timed out.

RA - Really Alive

Flag that indicates that the source is confirmed to be sending traffic for the route.

LH - Last Hop

Flag that indicates that the entry is the last hop router for the entry. If (S, G) routes inherit the LH olist from an (*, G) route, the route entry LH flag appears only on the (*, G) route.

DSS - Don't Signal Sources

Flag that may be set on the last hop (*, G) entries that indicates that new matching sources should not be signaled from the forwarding plane.

DCC - Don't Check Connected

Flag that is set when the KAT probes which indicates that the connected check for new sources should be omitted in the forwarding plane.

RR - Register Received

Flag that indicates that the RP has received and answered PIM register messages for this (S, G) route.

SR - Sending Registers

Flag that indicates that the first hop DR has begun sending registers for this (S, G) route, but has not yet received a Register-Stop message.

E - MSDP External

Flag that is set on those entries that have sources, learned through Multicast Source Discovery Protocol (MSDP), from another RP.

POS0/2/0/0

Interface name. Name of an interface in the entry's interface list.

03:54:23

Interface uptime. Time (in hours, minutes, and seconds) this interface has existed in the entry.

off

Interface forwarding status. Outgoing forwarding status of the interface for the entry is "fwd" or "off".

Interface Information Flags

LI - Local Interest

Flag that indicates that there are local receivers for this entry on this interface as reported by Internet Group Management Protocol (IGMP).

LD - Local Disinterest

Flag that indicates that there is explicit disinterest for this entry on this interface, as reported by IGMP exclude mode reports.

II - Internal Interest

Flag that indicates that the host stack of the router has internal receivers for this entry.

ID - Internal Disinterest

Flag that indicates that the host stack of the router has explicit internal disinterest for this entry.

LH - Last Hop

Flag that indicates that this interface has directly connected receivers and this router serves as a last hop for the entry. If the (S, G) outgoing interface list is inherited from a (*, G) route, the LH flag is set on the (*, G) outgoing LH interface.

AS - Assert

Flag that indicates that a PIM assert message was seen on this interface and the active PIM assert state exists.

AB - Administrative Boundary

Flag that indicates that forwarding on this interface is blocked by a configured administrative boundary for this entry's group range.


Related Commands

Command
Description

show mfib route

Displays all entries in the MFIB table.

show mfib route

Displays all entries in the MRIB table.


show pim traffic

To display PIM traffic counter information, use the show pim traffic command in EXEC mode.

show pim [ipv4 | ipv6] traffic

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim traffic command that displays a row for valid PIM packets, number of hello packets, and so on:

RP/0/RP0/CPU0:router# show pim traffic

PIM Traffic Counters 
Elapsed time since counters cleared: 1d01h
                  Received Sent 
Valid PIM Packets 15759217 15214426 
Hello                 9207 12336 
Join-Prune         1076805 531981 
Register          14673205 0 
Register Stop            0 14673205 
Assert                   0 0 
Bidir DF Election        0 0
Errors: 
Malformed Packets 0 
Bad Checksums 4 
Socket Errors 0 
Packets dropped due to invalid socket 0 
Packets which couldn't be accessed 0 
Packets sent on Loopback Errors 3096 
Packets received on PIM-disabled Interface 0 

Table 42 describes the significant fields shown in the display.

Table 42 show pim traffic Field Descriptions

Field
Description

Elapsed time since counters cleared

Time (in days and hours) that had elapsed since the counters were cleared with the clear pim counters command.

Valid PIM Packets

Total PIM packets that were received and sent.

Hello
Join-Prune
Register
Register Stop
Assert
Bidir DF Election

Specific type of PIM packets that were received and sent.

Malformed Packets

Invalid packets due to format errors that were received and sent.

Bad Checksums

Packets received or sent due to invalid checksums.

Socket Errors

Packets received or sent due to errors from the router's IP host stack sockets.

Packets dropped due to invalid socket

Packets received or sent due to invalid sockets in the router's IP host stack.

Packets which couldn't be accessed

Packets received or sent due to errors when accessing packet memory.

Packets sent on Loopback Errors

Packets received or sent due to due to use of loopback interfaces.

Packets received on PIM-disabled Interface

Packets received or sent due to use of interfaces not enabled for PIM.

Packets received with Unknown PIM Version

Packets received or sent due to invalid PIM version numbers in the packet header.


show pim tunnel info

To display information for the PIM tunnel interface, use the show pim tunnel info command in EXEC mode

show pim [ipv4 | ipv6] tunnel info {interface-unit | all} [netio]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes. IPv4 addressing is the default.

ipv6

(Optional) Specifies IPv6 address prefixes.

interface-unit

Name of virtual tunnel interface that represents the encapsulation tunnel or the decapsulation tunnel.

all

Specifies both encapsulation and decapsulation tunnel interfaces.

netio

Displays information obtained from the Netio DLL.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

The ipv4 and ipv6 keywords were added.

The netio keyword was added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

PIM register packets are sent through the virtual encapsulation tunnel interface from the source's first hop DR router to the route processor (RP). On the RP, a virtual decapsulation tunnel is used to represent the receiving interface of the PIM register packets. This command displays tunnel information for both types of interfaces.

Register tunnels are the encapsulated (in PIM register messages) multicast packets from a source that is sent to the RP for distribution through the shared tree. Registering applies only to SM, not SSM and bidirectional PIM.

Task ID

Task ID
Operations

multicast

read


Examples

The following is sample output from the show pim tunnel info command:

RP/0/RP0/CPU0:router# show pim tunnel info all

Interface     RP Address Source Address 
Encapstunnel0 10.1.1.1   10.1.1.1 
Decapstunnel0 10.1.1.1   

Table 43 describes the significant fields shown in the display.

Table 43 show pim tunnel info Field Descriptions 

Field
Description

Interface

Name of the tunnel interface.

RP Address

IP address of the RP tunnel endpoint.

Source Address

IP address of the first hop DR tunnel endpoint, applicable only to encapsulation interfaces.


spt-threshold infinity

To change the behavior of the last hop router to always use the shared tree and never perform a shortest-path tree (SPT) switchover, use the spt-threshold infinity command in router PIM configuration mode. To return to the default behavior, use the no form of this command.

spt-threshold infinity [group-list access-list]

no spt-threshold infinity

Syntax Description

group-list access-list

(Optional) Indicates the groups restricted by the access list.


Defaults

The last hop PIM router switches to the shortest-path source tree by default.
If the group-list keyword is not used, this command applies to all multicast groups.

Command Modes

Router PIM configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

No modification.

Release 3.4.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command causes the last hop PIM router to always use the shared tree instead of switching to the shortest-path source tree.

If the group-list keyword is not used, this command applies to all multicast groups.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure the PIM source group grp1 to always use the shared tree:

RP/0/RP0/CPU0:router(config)# router pim
RP/0/RP0/CPU0:router(config-pim-ipv4)# spt-threshold infinity group-list grp1

ssm

To define the PIM-Source Specific Multicast (SSM) range of IP multicast addresses, use the ssm command in multicast routing configuration mode. To return to the default behavior, use the no form of this command.

ssm {allow-override | disable | range [access-list]}

no ssm {allow-override | disable | range}

Syntax Description

allow-override

Allows SSM ranges to be overridden by more specific ranges.

disable

Disables SSM group ranges.

range [access-list]

Access list describing group ranges for this router when operating in PIM SSM mode.


Defaults

Interface operates in PIM sparse mode (PIM-SM).

Command Modes

Multicast routing configuration

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1 router.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

The default-range keyword was deleted.

Release 3.4.0

The allow-override keyword was added.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS-XR Software module of the Cisco IOS-XR System Security Configuration Guide.

This command does source filtering, which is the ability of a router to report interest in receiving packets from specific source addresses (or from all but the specific source addresses) to an IP multicast address. Unlike PIM-SM that uses a rendezvous point (RP) and shared trees, PIM-SSM uses information on source addresses for a multicast group provided by receivers through the local membership protocol Internet Group Management Protocol (IGMP) and is used to directly build source-specific trees.

IGMP Version 3 must be enabled on routers that want to control the sources they receive via the network.

When multicast routing is enabled, the default is PIM-SSM enabled on the default SSM range, 232/8. SSM may be disabled with the disable form of the command, or any ranges may be specified in an access list with the range form. All forms of this command are mutually exclusive. If an access list is specified, the default SSM range will not be used unless specified in the access list.

Task ID

Task ID
Operations

multicast

read, write


Examples

The following example shows how to configure SSM service for the IP address range defined by access list 4:

RP/0/RP0/CPU0:router(config)# ipv4 access-list 4 
RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 224.2.151.141
RP/0/RP0/CPU0:router(config)# multicast-routing
RP/0/RP0/CPU0:router(config-mcast-ipv4)# ssm range 4