-
Cisco IOS XR Multicast Command Reference, Release 3.3
-
Preface
-
Multicast IPv4 and IPv6 Commands on Cisco IOS XR Software
-
Multicast PIM Commands on Cisco IOS XR Software
-
Multicast Routing and Forwarding Commands on Cisco IOS XR Software
-
Multicast Tool and Utility Commands on Cisco IOS XR Software
-
Multicast Source Discovery Protocol Commands on Cisco IOS XR Software
-
Index
-
Table Of Contents
Multicast PIM Commands on Cisco IOS XR Software
neighbor-check-on-recv disable
neighbor-check-on-send disable
show pim join-prune statistics
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 needn't 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
Defaults
No default behavior or values
Command Modes
Router PIM configuration
Command History
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 RP. If an unauthorized source sends a register message to the RP, the RP will immediately send back a register-stop message.
Task ID
Examples
The following example shows how to restrict the RP. Sources in the Source Specific Multicast (SSM) range of addresses are not allowed to register with the RP. These statements need to be configured only on the RP.
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# accept-register no-ssm-rangeRP/0/RP0/CPU0:router(config)# ipv4 access-list no-ssm-rangeRP/0/RP0/CPU0:router(config-ipv4-acl)# deny any 232.0.0.0 0.255.255.255RP/0/RP0/CPU0:router(config-ipv4-acl)# permit anyauto-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-number] [interval seconds] [bidir]
no auto-rp candidate-rp
Syntax Description
Defaults
A router is not configured as a PIM RP candidate
seconds: 60
Command Modes
Router PIM configuration
Command History
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 RP 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 RP 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 RP for all groups.
A router may be configured to serve as candidate RP for more than one group range by a carefully crafted access list in the router configuration.
Task ID
Examples
The following example sends RP announcements out all PIM-enabled interfaces for a maximum of 31 hops. The IP address by which the router wants to be identified as an RP is the IP address associated with Packet-over-SONET/SDH (POS) interface 0/1/0/1. Access list 5 designates the groups this router serves as RP.
RP/0/RP0/CPU0:router(config)# ipv4 access-list 5RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 224.0.0.0 15.255.255.255RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp candidate-rp pos 0/1/0/1 scope 31 group-list 5The router in the following example advertises itself as the candidate RP and is associated with loopback interface 0 for group range 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 10RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 239.254.0.0 0.0.255.255RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp candidate-rp loopback 0 scope 16 group-list 10Related Commands
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 RP mappings are learned through Auto-RP.
Command Modes
Router PIM configuration
Command History
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
Examples
The following example show how to disable RP discovery:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp listen disableauto-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
Defaults
A router is not configured as a PIM RP mapping agent.
seconds: 60
Command Modes
Router PIM configuration
Command History
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 an RP mapping agent and determines the RP-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 RP to use.
More than one RP 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
Examples
The following example shows how to limit Auto-RP discovery messages to 20 hops:
RP/0/RP0/CPU0:router(config-pim-ipv4)# auto-rp mapping-agent pos 0/0/0/1 scope 20Related Commands
Configures a router as a PIM RP 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 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
Interface configuration
Command History
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.
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
Task ID
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 pimRP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0RP/0/RP0/CPU0:router(config-pim-ipv4-if)# bsr-borderbsr 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
Defaults
priority: 1
Command Modes
Router PIM configuration
Command History
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.
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
Task ID
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-pim-ipv4)# bsr candidate-bsr 10.0.0.1 hash-mask-len 30Related Commands
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] [priority value]
no bsr candidate-rp
Syntax Description
Defaults
priority: 1
Command Modes
Router PIM configuration
Command History
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.
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 RP to the BSR. The addresses allowed by the access list, together with the router identified by the IP address, constitute the RP and its range of addresses for which it is responsible.
Note
Task ID
Examples
The following example shows how to configure the router to advertise itself as a candidate RP to the BSR in its PIM domain. Access list number 4 specifies the group prefix associated with the candidate RP address 172.16.0.0. This RP is responsible for the groups with the prefix 239.
RP/0/RP0/CPU0:router(config-pim-ipv4)# bsr candidate-rp 172.16.0.0 group-list 4RP/0/RP0/CPU0:router(config)# ipv4 access-list 4RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 239.0.0.0 0.255.255.255Related Commands
Configures the router to announce its candidacy as a BSR.
Configures the router to advertise itself as a PIM Version 2 candidate RP 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
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following example shows sample output before and after Auto-RP entries have been cleared from the PIM RP group mapping cache:
RP/0/RP0/CPU0:router# show pim group-mapIP PIM Group Mapping Table(* indicates group mappings being used)Group Range Proto Client Groups RP address Info224.0.1.39/32* DM static 1 0.0.0.0224.0.1.40/32* DM static 1 0.0.0.0224.0.0.0/24* NO static 0 0.0.0.0232.0.0.0/8* SSM config 0 0.0.0.0224.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.0RP/0/RP0/CPU0:router# clear pim autorp 232.0.0.0/8RP/0/RP0/CPU0:router# show pim group-mapIP PIM Group Mapping Table(* indicates group mappings being used)Group Range Proto Client Groups RP address Info224.0.1.39/32* DM static 1 0.0.0.0224.0.1.40/32* DM static 1 0.0.0.0224.0.0.0/24* NO static 0 0.0.0.0224.0.0.0/4* SM static 0 0.0.0.0 RPF: Null,0.0.0.0clear 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 bsr
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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.
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
Examples
The following example shows sample output before and after the BSR group mappings have been cleared from the RP group mapping cache:
RP/0/RP0/CPU0:router# show pim group-mapIP PIM Group Mapping Table(* indicates group mappings being used)(+ indicates BSR group mappings active in MRIB)Group Range Proto Client Groups RP address Info224.0.1.39/32* DM static 0 0.0.0.0224.0.1.40/32* DM static 1 0.0.0.0224.0.0.0/24* NO static 0 0.0.0.0232.0.0.0/8* SSM config 0 0.0.0.0224.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 bsrRP/0/RP0/CPU0:router# show pim group-mapIP PIM Group Mapping Table(* indicates group mappings being used)(+ indicates BSR group mappings active in MRIB)Group Range Proto Client Groups RP address Info224.0.1.39/32* DM static 0 0.0.0.0224.0.1.40/32* DM static 1 0.0.0.0224.0.0.0/24* NO static 0 0.0.0.0232.0.0.0/8* SSM config 0 0.0.0.0224.0.0.0/4* SM static 1 0.0.0.0 RPF: Null,0.0.0.0Related Commands
clear pim counters
To clear PIM counters and statistics, use the clear pim counters command in EXEC mode.
clear pim counters
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following example shows sample output before and after clearing PIM counters and statistics:
RP/0/RP0/CPU0:router# show pim trafficPIM Traffic CountersElapsed time since counters cleared: 00:53:34Received SentValid PIM Packets 0 97Hello 0 420Join-Prune 0 0Register 0 0Register Stop 0 0Assert 0 0Bidir DF Election 0 0Errors:Malformed Packets 0Bad Checksums 0Socket Errors 0Packets dropped due to invalid socket 0Packets which couldn't be accessed 0Packets sent on Loopback Errors 323Packets received on PIM-disabled Interface 0Packets received with Unknown PIM Version 0RP/0/RP0/CPU0:router# clear pim countersRP/0/RP0/CPU0:router# show pim trafficPIM Traffic CountersElapsed time since counters cleared: 00:00:03Received SentValid PIM Packets 0 0Hello 0 0Join-Prune 0 0Register 0 0Register Stop 0 0Assert 0 0Bidir DF Election 0 0Errors:Malformed Packets 0Bad Checksums 0Socket Errors 0Packets dropped due to invalid socket 0Packets which couldn't be accessed 0Packets sent on Loopback Errors 0Packets received on PIM-disabled Interface 0Packets received with Unknown PIM Version 0Related Commands
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 topology [ip-address-name | reset]
Syntax Description
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
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
Examples
The following example shows how to clear the PIM topology table:
RP/0/RP0/CPU0:router# clear pim topologydr-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
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
Interface configuration
Router PIM configuration
Command History
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
Task ID
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 pimRP/0/RP0/CPU0:router(config-pim-ipv4)# dr-priority 2RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0RP/0/RP0/CPU0:router(config-pim-ipv4-if)# dr-priority 4embedded-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
Specifies an RP 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 RP is not configured.
Command Modes
Router PIM configuration
Command History
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.
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 RP is enabled (which is the default behavior of the PIM router), you should configure a static address for the RP for the embedded RP ranges. Additional configuration is not required on other ipv6 PIM routers, because those routers will discover the RP address from the ipv6 group address.
Note
Task ID
Examples
The following example shows how to configure the static address for the embedded RP and specifies an access list for group ranges:
RP/0/RP0/CPU0:router(config)# router pim address-family ipv6RP/0/RP0/CPU0:router(config-pim-ipv6)# embedded-rp 2:2:2::2 acl_embedRP/0/RP0/CPU0:router(config)# ipv6 access-list acl_embedRP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff73:240:2:2:2::/96RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff74:240:2:2:2::/96RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff75:240:2:2:2::/96RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff76:240:2:2:2::/96RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff77:240:2:2:2::/96RP/0/RP0/CPU0:router(config-ipv6-acl)# permit ipv6 any ff78:240:2:2:2::/96The following sample output displays the embedded RP information that was previously configured:
RP/0/RP0/CPU0:router# show pim ipv6 group-mapIP PIM Group Mapping Table(* indicates group mappings being used)(+ indicates BSR group mappings active in MRIB)Group Range Proto Client Groupsff02::/16* NO perm 0RP: ::ff12::/16* NO perm 0RP: ::ff22::/16* NO perm 0RP: ::ff32::/16* NO perm 0RP: ::ff42::/16* NO perm 0RP: ::...ff73:240:2:2:2::/96* SM embd-cfg 0RP: 2:2:2::2RPF: De6tunnel0,2:2:2::2 (us)ff74:240:2:2:2::/96* SM embd-cfg 0RP: 2:2:2::2RPF: De6tunnel0,2:2:2::2 (us)ff75:240:2:2:2::/96* SM embd-cfg 0RP: 2:2:2::2RPF: De6tunnel0,2:2:2::2 (us)ff76:240:2:2:2::/96* SM embd-cfg 0RP: 2:2:2::2RPF: De6tunnel0,2:2:2::2 (us)ff77:240:2:2:2::/96* SM embd-cfg 0RP: 2:2:2::2RPF: De6tunnel0,2:2:2::2 (us)ff78:240:2:2:2::/96* SM embd-cfg 0RP: 2:2:2::2RPF: De6tunnel0,2:2:2::2 (us)ff70::/12* SM embd 0RP: ::RPF: Null,::fff0::/12* NO embd 0RP: ::ff33::/32* SSM config 0RP: ::Related Commands.
Disables embedded RP support on a PIM router.
Enters router PIM configuration mode.
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 RP support is enabled.
Command Modes
Router PIM configuration
Command History
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.
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 RP 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 RP ipv6 group ranges, and then the router extracts the RP to be used from the multicast group address.
Note
Examples
The following example shows how to disable embedded RP support:
RP/0/RP0/CPU0:router(config)# router pim address-family ipv6RP/0/RP0/CPU0:router(config-pim-ipv6)# embedded-rp disableRelated Commands
Enters router PIM configuration mode.
Configures the static address for the embedded RP 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
Defaults
If this command is not specified in router PIM configuration mode, the hello interval is 30 seconds for broadcast and nonbroadcast.
Command Modes
Interface configuration
Router PIM configuration
Command History
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
Task ID
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 pimRP/0/RP0/CPU0:router(config-pim-ipv4)# hello-interval 45RP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0RP/0/RP0/CPU0:router(config-pim-ipv4-if)# hello-interval 60Related Commands
Configures the DR priority on a PIM router.
Displays the PIM neighbors discovered by the Cisco IOS XR software.
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
Interface configuration
Router PIM configuration
Command History
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
This command is used to configure the frequency at which a PIM sparse-mode router sends periodic join and prune messages.
Task ID
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 pimRP/0/RP0/CPU0:router(config-pim-ipv4)# interface pos 0/1/0/0RP/0/RP0/CPU0:router(config-pim-ipv4-if)# join-prune-interval 90maximum 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
no maximum autorp mapping-agent-cache
Syntax Description
Defaults
No default behavior or values
Command Modes
Router PIM configuration
Command History
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
Examples
The following example shows how to set the maximum mapping agent cache size to 66:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# maximum autorp 66Related Commands
Configures the maximum number of PIM group map ranges learned from Auto-RP.
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
Defaults
number: 500
Command Modes
Router PIM configuration
Command History
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
Examples
The following example shows how to set the upper limit number for group mapping to 200:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# maximum group-mappings 200Related Commands
Configures the Auto-RP maximum cache setting.
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
Defaults
number: 20000
Command Modes
Router PIM configuration
Command History
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
Examples
The following example shows how to set the upper limit for PIM register states to 10000:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# maximum register-states 10000Related Commands
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
Defaults
number: 30000
Command Modes
Router PIM configuration
Command History
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
Examples
The following example shows how to set the upper limit for PIM route interface states to 200000:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# maximum route-interfaces 200000Related Commands
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
Defaults
number: 100000
Command Modes
Router PIM configuration
Command History
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
Examples
The following example shows how to set the upper limit for PIM routes to 200000:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# maximum routes 200000Related Commands
neighbor-check-on-recv disable
To disable PIM neighbor checking on received Join/Prune messages, use the neighbor-check-on-recv disable command in router PIM configuration mode. To return to the default behavior, use the no form of this command.
neighbor-check-on-recv disable
Syntax Description
This command has no arguments or keywords.
Defaults
Join/Prune messages are rejected that are sent from non-PIM neighbors.
Command Modes
Router PIM configuration
Command History
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.
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
Examples
The following example shows how to disable PIM neighbor checking on received Join/Prune messages:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# neighbor-check-on-recv disableRelated Commands
Configures PIM not to send Join/Prune messages to adjacent routers that are not established PIM neighbors.
neighbor-check-on-send disable
To disable PIM neighbor checking when sending Join/Prune messages, use the neighbor-check-on-send disable command in router PIM configuration mode. To return to the default behavior, use the no form of this command.
neighbor-check-on-send disable
Syntax Description
This command has no arguments or keywords.
Defaults
Join/Prune messages are not sent to non-PIM neighbors.
Command Modes
Router PIM configuration
Command History
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.
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
Examples
The following example shows how to disable PIM neighbor checking when sending Join/Prune messages:
RP/0/RP0/CPU0:router# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# neighbor-check-on-send disableRelated Commands
Configures PIM to reject Join/Prune messages from adjacent routers that are not established 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
Defaults
PIM neighbor messages are not filtered.
Command Modes
Router PIM configuration
Command History
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
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 1RP/0/RP0/CPU0:router(config)# ipv4 access-list 1RP/0/RP0/CPU0:router(config-ipv4-acl)# deny 10.0.0.1nsf 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
Defaults
seconds: 120
Command Modes
Router PIM configuration
Command History
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
Examples
The following command shows how to set the PIM NSF timeout value to 30 seconds:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# nsf lifetime 30Related Commands
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
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 backword compatibility with IOS implementations.
Note
Cisco IOS XR register messages are incompatible with Cisco IOS software.Task ID
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 PIM RP:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# old-register-checksumrouter pim
To enter PIM configuration mode, use the router pim command in global configuration mode. To exit PIM configuration mode, use the no form of this command.
router pim [address-family ipv6]
no router pim
Syntax Description
Defaults
IPv4 address prefixes
Command Modes
Global configuration
Command History
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, issue a question mark from the PIM configuration prompt:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# ?accept-register Registers accept filterauto-rp Auto-RP Commandscommit Commit the configuration changes to runningdefault Set a command to its defaultsdescribe Describe a command without taking real actionsdo Run an exec commanddr-priority Inherited by all interfaces : PIM Hello DR priorityexit Exit from this submodehello-interval Inherited by all interfaces : Hello interval in secondsinterface PIM interface configuration subcommandsjoin-prune-interval Inherited by all interfaces : Join-Prune intervalneighbor-filter Neighbor filterno Negate a command or set its defaultsnsf Configure Non-stop forwarding (NSF) optionsold-register-checksum Generate registers compatible with older IOS versionsrp-address Configure Rendezvous Pointshow Show contents of configurationspt-threshold Configure threshold for switching to SPT on last-hopThe 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 ipv6RP/0/RP0/CPU0:router(config-pim-ipv6)# ?accept-register Registers accept filtercommit Commit the configuration changes to runningconvergence-timeout Timeout value for the RIB convergence notificationdescribe Describe a command without taking real actionsdo Run an exec commanddr-priority Inherited by all interfaces : PIM Hello DR priorityembedded-rp Set Embedded RP processing supportexit Exit from this submodehello-interval Inherited by all interfaces : Hello interval in secondsinterface PIM interface configuration subcommandsjoin-prune-interval Inherited by all interfaces : Join-Prune intervalmaximum Maximum state limitsneighbor-check-on-recv Check for PIM neighbor before rcv'ing control messagesneighbor-check-on-send Check for PIM neighbor before sending control messagesneighbor-filter Neighbor filterno Negate a command or set its defaultsnsf Configure Non-stop forwarding (NSF) optionsold-register-checksum Generate registers compatible with older IOS versionsrp-address Configure Rendezvous Pointshow Show contents of configurationspt-threshold Configure threshold for switching to SPT on last-hopExamples
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 ipv4RP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 10.0.0.1rp-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
Defaults
No PIM RPs are preconfigured.
Command Modes
Router PIM configuration
Command History
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 RP 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 RP for the group is applied to the entire IP multicast group range (224.0.0.0/4).
You can configure a single RP to serve more than one group. The group range specified in the access list determines the PIM RP group mapping. If no access list is specified, the RP default maps to 224/4.
If the RP 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 RP configured with this command and one learned by Auto-RP, the Auto-RP information is used unless the override keyword is specified.
Task ID
Examples
The following example shows how to set the PIM RP address to 10.0.0.1 for all multicast groups:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 10.0.0.1The following example shows how to set the PIM RP address to 172.16.6.22 for the group 225.2.2.2:
RP/0/RP0/CPU0:router(config)# ipv4 access list 1RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 225.2.2.2 0.0.0.0RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 172.16.6.21The following example shows how to set the PIM RP 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 user1RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 230.0.0.0 0.255.255.255RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# rp-address 172.17.1.1 user1 bidirRelated Commands
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 3.3.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.
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
Examples
The following example shows how to enable RPF vector:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-ipv4)# rpf-vectorshow 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 candidate-rp
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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 RPs configured on this router.
Information that is displayed is the time-to-live (TTL) value, the interval from which the RP announcements were sent, and the mode, such as PIM sparse mode (SM), to which the RP belongs.
Task ID
Examples
The following is sample output from the show auto-rp candidate-rp command:
RP/0/RP0/CPU0:router# show auto-rp candidate-rpGroup Range Mode Candidate RP ttl interval224.0.0.0/4 SM 10.0.0.6 30 30Table 7 describes the significant fields shown in the display.
Related Commands
Configures a router as a PIM RP 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 mapping-agent [group-name | group-address]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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 RP for the group. If two RP 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
Examples
The following sample output shows that the mapping agent has received two candidate RP 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-agentMapping Agent Table10.0.0.6 (expire : 80 secs)224.0.0.0/4 SM *10.0.0.2 (expire : 75 secs)224.0.0.0/4 SMTable 8 describes the significant fields shown in the display.
Related Commands
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 bsr candidate-rp
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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.
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
Examples
The following example shows how to display PIM candidate rendezvous point (RP) information:
RP/0/RP0/CPU0:router# show pim bsr candidate-rpPIM BSR Candidate RP InfoCand-RP mode scope priority uptime group-list91.1.1.1 SM 16 255 00:00:00 224/4Table 9 describes the significant fields shown in the display.
Related Commands
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 bsr election
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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.
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
Examples
This example shows how to display PIM candidate election information:
RP/0/RP1/CPU0:router# show pim bsr electionPIM BSR Election StateCand/Elect-State Uptime BS-Timer BSR C-BSRInactive/Accept-Any 00:00:00 00:00:00 0.0.0.0 [0, 0] 99.1.1.1 [0, 30]Table 10 describes the significant fields shown in the display.
Related Commands
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 bsr rp-cache
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.2
This command was introduced on the Cisco CRS-1 router.
Release 3.3.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
Examples
The following is sample output from the show pim bsr rp-cache command:
RP/0/RP0/CPU0:router# show pim bsr rp-cacheGroup(s) 224.0.0.0/4, RP count 1RP-addr Priority Holdtime(s) Uptime Expires40.40.40.1 255 150 03:05:03 00:02:12Table 11 describes the significant fields shown in the display.
Related Commands
Configures the router to advertise itself as a PIM Version 2 candidate RP 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 df election-state {ip-address-name | type instance}
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
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/0RP Interface DF State Timer Metrics172.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 12 describes the significant fields shown in the display.
Related Commands
domain ipv4 host
Defines a static host name-to-address mapping in the host cache using ipv4.
Displays the bidirectional DF "winner" for an RP or 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 df winner {ip-address-name | type instance}
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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 DF winner address on a per-interface or per-RP basis.
Task ID
Examples
The following is sample output from the show pim df winner command; the far right column shows the winner metric toward the RP:
RP/0/RP0/CPU0:router# show pim df winner 172.16.1.3RP Interface DF Winner Metrics172.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 13 describes the significant fields shown in the display.
Related Commands
domain ipv4 host
Defines a static host name-to-address mapping in the host cache using ipv4.
Displays the bidirectional DF election state for an RP or interface.
show pim group-map
To display group-to-PIM mode mapping, use the show pim group-map command in EXEC mode.
show pim group-map [ip-address-name] [info-source]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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 RP. Mappings are learned from different clients, such as Auto-RP.
Task ID
Examples
The following is sample output from the show pim group-map command:
RP/0/RP0/CPU0:router# show pim group-mapGroup Range Proto Client Groups RP address Info224.0.1.39/32* DM static 1 0.0.0.0224.0.1.40/32* DM static 1 0.0.0.0224.0.0.0/24* NO static 0 0.0.0.0232.0.0.0/8* SSM config 0 0.0.0.0224.0.0.0/4* SM autorp 1 10.10.2.2 RPF: POS01/0/3,10.10.3.2In 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 RP 10.10.3.2.
Table 14 describes the significant fields shown in the display.
Related Commands
show pim interface
To display information about interfaces configured for PIM, use the show pim interface command in EXEC mode.
show pim interface [state-on | state-off | type instance]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following is sample output from the show pim interface command:
RP/0/RP0/CPU0:router# show pim interfaceAddress Interface PIM Nbr Hello DR DRIntvl Priority0.0.0.0 Encapstunnel0 off 0 30 1 not elected172.17.1.2 Loopback1 on 1 30 1 this system172.17.2.2 Loopback2 on 1 30 1 this system172.17.3.2 Loopback3 on 1 30 1 this system10.10.1.2 POS0/2/0/0 on 2 30 1 this system10.10.2.2 POS0/2/0/2 on 2 30 1 10.10.2.3Table 15 describes the significant fields shown in the display.
Related Commands
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 join-prune statistics [type instance]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
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 statisticsInterface MTU Transmitted ReceivedLoopback0 1514 0 / 0 / 0 0 / 0 / 0Encapstunnel0 0 0 / 0 / 0 0 / 0 / 0Decapstunnel0 0 0 / 0 / 0 0 / 0 / 0Loopback1 1514 0 / 0 / 0 0 / 0 / 0POS0/3/0/0 4470 0 / 0 / 0 0 / 0 / 0POS0/3/0/3 4470 0 / 0 / 0 0 / 0 / 0Table 16 describes the significant fields shown in the display.
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 neighbor [type instance] [count]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following is sample output from the show pim neighbor command:
RP/0/RP0/CPU0:router# show pim neighborNeighbor Address Interface Uptime Expires DR pri Bidir172.17.1.2* Loopback1 03:41:22 00:01:43 1 (DR) B172.17.2.2* Loopback2 03:41:20 00:01:31 1 (DR) B172.17.3.2* Loopback3 03:41:18 00:01:28 1 (DR) B10.10.1.1 POS0/2/0/0 03:40:36 00:01:41 1 B10.10.1.2* POS0/2/0/0 03:41:28 00:01:32 1 (DR) B10.10.2.2* POS0/2/0/2 03:41:26 00:01:36 1 B10.10.2.3 POS0/2/0/2 03:41:25 00:01:29 1 (DR) BThe following is sample output from the show pim neighbor command with the count option:
RP/0/RP0/CPU0:router# show pim neighbor countInterface Nbr countPOS0/3/0/0 1Loopback1 1Total Nbrs 2Table 17 describes the significant fields shown in the display.
Related Commands
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 nsf
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following is sample output from the show pim nsf command:
RP/0/RP0/CPU0:router# show pim nsfIP PIM Non-Stop Forwarding Status:Multicast routing state: Non-Stop Forwarding ActivatedNSF Lifetime: 00:02:00NSF Time Remaining: 00:01:56Table 18 describes the significant fields shown in the display.
show pim range-list
To display range-list information for PIM, use the show pim range-list command in EXEC mode.
show pim range-list [autorp | config] [ip-address-name]
Syntax Description
ip-address-name
(Optional) IP address of the RP.
autorp
(Optional) PIM Auto-RP range list information.
config
(Optional) PIM command-line interface (CLI) range list information.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following is sample output from the show pim range-list command:
RP/0/RP0/CPU0:router# show pim range-listconfig SSM Exp: never Src: 0.0.0.0230.0.0.0/8 Up: 03:47:09config BD RP: 172.16.1.3 Exp: never Src: 0.0.0.0239.0.0.0/8 Up: 03:47:16config SM RP: 172.18.2.6 Exp: never Src: 0.0.0.0235.0.0.0/8 Up: 03:47:09Table 19 describes the significant fields shown in the display.
Related Commands
domain ipv4 host
Defines a static host name-to-address mapping in the host cache using ipv4.
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 rpf [name | ip-address] [summary]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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 RP 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 RP address.
Task ID
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.110.0.0.1/32 [110/2]via 10.1.0.1, POS0/2/0/0via 10.2.0.1, GigabitEthernet0/3/0/1via 10.3.0.1, GigabitEthernet0/3/0/2The following is sample output from the show pim rpf summary command:RP/0/RP0/CPU0:router# show pim rpf summaryPIM RPFs registered with Unicast RIB tableMBGP Not configuredOSPF Mcast-intact Not configuredISIS Mcast-intact Not configuredRIB Table convergedRIB Convergence Timeout Value: 00:03:00 Multipath RPF Selection isDisabledRelated Commands
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 rpf hash ip-address [group name / ip-address [hash-mask-length prefix-length]]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.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 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 RP address and omit the group address option. For (S,G) routes, use the source address and the group address.
Task ID
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.1Multipath RPF selection is enabled.RPF next-hop neighbor selection result: POS0/2/0/0,10.1.0.1Related Commands
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 summary
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
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 summaryPIM SummaryPIM State CountersCurrent MaximumRoutes 5 100000Routes x Interfaces 11 300000SM Registers 0 20000Group Ranges from AutoRP 1 500Table 20 describes the significant fields shown in the display.
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 topology [name | ip-address] [route-count]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Task ID
Examples
The following is sample output from the show pim topology command:
RP/0/RP0/CPU0:router# show pim topologyIP PIM Multicast Topology TableEntry state: (*/S,G)[RPT/SPT] Protocol Uptime InfoEntry 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 ConnectedInterface state: Name, Uptime, Fwd, InfoInterface 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:13JP: Join(never) RPF: Loopback1,11.0.0.1* Flags: KAT(00:03:16) RA RRNo 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: LHPOS0/3/0/0 4d14h fwd LI II LH(*,224.0.1.39) DM Up: 02:10:38 RP: 0.0.0.0JP: Null(never) RPF: Null,0.0.0.0 Flags: LH DSSPOS0/2/0/0 02:10:38 off LI II LH(*,224.0.1.40) DM Up: 03:54:23 RP: 0.0.0.0JP: Null(never) RPF: Null,0.0.0.0 Flags: LH DSSPOS0/2/0/0 03:54:23 off LI II LHPOS0/2/0/2 03:54:14 off LIPOS0/4/0/0 03:53:37 off LI(*,239.100.1.1) BD Up: 03:51:35 RP: 200.6.1.6JP: 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.6JP: 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 21 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.
Related Commands
show pim traffic
To display PIM traffic counter information, use the show pim traffic command in EXEC mode.
show pim traffic
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
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 trafficPIM Traffic CountersElapsed time since counters cleared: 1d01hReceived SentValid PIM Packets 15759217 15214426Hello 9207 12336Join-Prune 1076805 531981Register 14673205 0Register Stop 0 14673205Assert 0 0Bidir DF Election 0 0Errors:Malformed Packets 0Bad Checksums 4Socket Errors 0Packets dropped due to invalid socket 0Packets which couldn't be accessed 0Packets sent on Loopback Errors 3096Packets received on PIM-disabled Interface 0Table 22 describes the significant fields shown in the display.
show pim tunnel info
To display information for the PIM tunnel interface, use the show pim tunnel info command in EXEC mode
show pim tunnel info {interface-unit | all}
Syntax Description
interface-unit
Name of virtual tunnel interface that represents the encapsulation tunnel or the decapsulation tunnel.
all
Specifies both encapsulation and decapsulation tunnel interfaces.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
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
Examples
The following is sample output from the show pim tunnel info command:
RP/0/RP0/CPU0:router# show pim tunnel info allInterface RP Address Source AddressEncapstunnel0 10.1.1.1 10.1.1.1Decapstunnel0 10.1.1.1Table 23 describes the significant fields shown in the display.
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
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
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
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 pimRP/0/RP0/CPU0:router(config-pim-ipv4)# spt-threshold infinity group-list grp1ssm
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 {range [access-list] | disable}
no ssm {range [access-list] | disable}
Syntax Description
range [access-list]
Access list describing group ranges for this router when operating in PIM SSM mode.
disable
Disables SSM group ranges.
Defaults
Interface operates in PIM sparse mode (PIM-SM).
Command Modes
Multicast routing configuration
Command History
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
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 4RP/0/RP0/CPU0:router(config-ipv4-acl)# permit 224.2.151.141RP/0/RP0/CPU0:router(config)# multicast-routingRP/0/RP0/CPU0:router(config-mcast-ipv4)# ssm range 4
