-
Cisco IOS XR Multicast Command Reference, Release 3.6
-
Preface
-
Multicast IPv4 and IPv6 Commands on Cisco IOS XR Software
-
Multicast Routing and Forwarding Commands on Cisco IOS XR Software
-
Multicast Source Discovery Protocol Commands on Cisco IOS XR Software
-
Multicast PIM Commands on Cisco IOS XR Software
-
Multicast Tool and Utility Commands on Cisco IOS XR Software
-
Index
-
Table Of Contents
Multicast PIM Commands on Cisco IOS XR Software
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 in Cisco IOS XR Multicast Configuration Guide.
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 do not need to 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 Protocol Independent Multicast (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 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
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 pimRP/0/RP0/CPU0:router(config-pim-default-ipv4)# accept-register no-ssm-rangeRP/0/RP0/CPU0:router(config-pim-default-ipv4)# exitRP/0/RP0/CPU0:router(config)# ipv4 access-list no-ssm-rangeRP/0/RP0/CPU0:router(config-ipv4-acl)# deny ipv4 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 Protocol Independent Multicast (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 type instance scope ttl-value [group-list access-list-name] [interval seconds] [bidir]
Syntax Description
Defaults
A router is not configured as a PIM rendezvous point 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 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
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 5RP/0/RP0/CPU0:router(config-ipv4-acl)# permit ipv4 any 224.0.0.0 15.255.255.255RP/0/RP0/CPU0:router(config-ipv4-acl)# exitRP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-default-ipv4)# auto-rp candidate-rp pos 0/1/0/1 scope 31 group-list 5RP/0/RP0/CPU0:router(config-pim-default-ipv4)# endThe 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 10RP/0/RP0/CPU0:router(config-ipv4-acl)# permit ipv4 any 239.254.0.0 0.0.255.255RP/0/RP0/CPU0:router(config-ipv4-acl)# exitRP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-default-ipv4)# auto-rp candidate-rp loopback 0 scope 16 group-list 10RP/0/RP0/CPU0:router(config-pim-default-ipv4)# endRelated Commands
Configures the router to be a rendezvous point mapping agent on a specified interface.
auto-rp listen disable
To prevent a Protocol Independent Multicast (PIM) process from learning about IP multicast traffic for the automatic route processing (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
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 rendezvous point discovery:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-default-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 Protocol Independent Multicast (PIM) rendezvous point 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 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 automatic route processing (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
Examples
The following example shows how to limit Auto-RP discovery messages to 20 hops:
RP/0/RP0/CPU0:router(config)# router pimRP/0/RP0/CPU0:router(config-pim-default-ipv4)# auto-rp mapping-agent pos 0/0/0/1 scope 20Related Commands
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 Protocol Independent Multicast (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
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-default-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
Syntax Description
Defaults
value: 1
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 bsr candidate-bsr command causes the router to send bootstrap messages to all its Protocol Independent Multicast (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)# router pimRP/0/RP0/CPU0:router(config-pim-default-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 Protocol Independent Multicast (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 ip-address
Syntax Description
Defaults
priority: 1
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 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
Task ID
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 pimRP/0/RP0/CPU0:router(config-pim-default-ipv4)# bsr candidate-rp 172.16.0.0 group-list 4RP/0/RP0/CPU0:router(config-pim-default-ipv4)# exitRP/0/RP0/CPU0:router(config)# ipv4 access-list 4RP/0/RP0/CPU0:router(config-ipv4-acl)# permit ipv4 any 239.0.0.0 0.255.255.255RP/0/RP0/CPU0:router(config-ipv4-acl)# endRelated Commands
Configures the router to announce its candidacy as a BSR.
Configures the router to advertise itself as a PIM Version 2 candidate rendezvous point to the BSR.
clear pim autorp
To clear automatic route processing (Auto-RP) entries from the Protocol Independent Multicast (PIM) rendezvous point (RP) group mapping cache, use the clear pim autorp command in EXEC mode.
clear pim [vrf vrf-name] [ipv4] autorp [rp-address]
Syntax Description
vrf vrf-name
(Optional) Specifies a VPN routing and forwarding (VRF) instance.
ipv4
(Optional) Specifies IPv4 address prefixes.
rp-address
(Optional) Hostname or IP address of the rendezvous point.
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 rendezvous point 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 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)(+ indicates BSR group mappings active in MRIB)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 Protocol Independent Multicast (PIM) rendezvous point (RP) group mapping cache, use the clear pim bsr command in EXEC mode.
clear pim [vrf vrf-name] [ipv4 | ipv6] bsr
Syntax Description
vrf vrf-name
(Optional) Specifies a VPN routing and forwarding (VRF) instance.
ipv4
(Optional) Specifies IPv4 address prefixes.
ipv6
(Optional) Specifies IPv6 address prefixes.
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 the BSR group mappings have been cleared from the rendezvous point 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 Protocol Independent Multicast (PIM) counters and statistics, use the clear pim counters command in EXEC mode.
clear pim [vrf vrf-name] [ipv4 | ipv6] counters
Syntax Description
vrf vrf-name
(Optional) Specifies a VPN routing and forwarding (VRF) instance.
ipv4
(Optional) Specifies IPv4 address prefixes.
ipv6
(Optional) Specifies IPv6 address prefixes.
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 0Data Register 0 0Null Register 0 0Register Stop 0 0Assert 0 0Batched Assert 0 0Bidir DF Election 0 0BSR Message 0 0Candidate-RP Adv. 0 0Join groups sent 0Prune groups sent 0Output JP bytes 0Output hello bytes 10326804Errors:Malformed Packets 0Bad Checksums 0Socket Errors 0Subnet Errors 0Packets dropped since send queue was full 0Packets dropped due to invalid socket 0Packets which couldn't be accessed 0Packets sent on Loopback Errors 15098Packets 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:04Received SentValid PIM Packets 0 0Hello 0 0Join-Prune 0 0Data Register 0 0Null Register 0 0Register Stop 0 0Assert 0 0Batched Assert 0 0Bidir DF Election 0 0BSR Message 0 0Candidate-RP Adv. 0 0Join groups sent 0Prune groups sent 0Output JP bytes 0Output hello bytes 0Errors:Malformed Packets 0Bad Checksums 0Socket Errors 0Subnet Errors 0Packets dropped since send queue was full 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
