This section describes the commands you use to configure Protocol Independent Multicast -Dense Mode (PIM-DM) and Protocol Independent Multicast - Sparse Mode (PIM-SM). PIM-DM and PIM-SM are multicast routing protocols that provides scalable inter-domain multicast routing across the Internet, independent of the mechanisms provided by any particular unicast routing protocol. Only one PIM mode can be operational at a time.
ip pim dense
This command administratively enables the PIM Dense mode across the router.
Default: disabled
Format: ip pim dense
Mode: Global Config
no ip pim dense
This command administratively disables the PIM Dense mode across the router.
Format: no ip pim dense
Mode: Global Config
ip pim sparse
This command administratively enables the PIM Sparse mode across the router.
Default: disabled
Format: ip pim sparse
Mode: Global Config
no ip pim sparse
This command administratively disables the PIM Sparse mode across the router.
Format: no ip pim sparse
Mode: Global Config
ip pim
Use this command to administratively enable PIM on the specified interface.
Default: disabled
Format: ip pim
Mode: Interface Config
no ip pim
Use this command to disable PIM on the specified interface.
Format: no ip pim
Mode: Interface Config
ip pim hello-interval
This command configures the transmission frequency of PIM hello messages the specified interface. This field has a range of 0 to 18000 seconds.
Default: 30
Format: ip pim hello-interval seconds
Mode: Interface Config
no ip pim hello-interval
This command resets the transmission frequency of hello messages between PIM enabled neighbors to the default value.
Format: no ip pim hello-interval
Mode: Interface Config
ip pim bsr-border
Use this command to prevent bootstrap router (BSR) messages from being sent or received on the specified interface.
NOTE: This command takes effect only when Sparse mode in enabled in the Global mode.
Default: disabled
Format: ip pim bsr-border
Mode: Interface Config
no ip pim bsr-border
Use this command to disable the specified interface from being the BSR border.
Format: no ip pim bsr-border
Mode: Interface Config
ip pim bsr-candidate
This command is used to configure the router to announce its candidacy as a bootstrap router (BSR).
NOTE: This command takes effect only when PIM-SM is configured as the PIM mode.
Default: Disabled
Format: ip pim bsr-candidate interface unit/slot/port hash-mask-length [bsr-priority] [interval interval]
Mode: Global Config
unit/slot/port: Interface number on this router from which the BSR address is derived, to make it a candidate. This interface must be enabled with PIM.
hash-mask-length: Length of a mask (32 bits maximum) that is to be ANDed with the group address before the hash function is called. All groups with the same seed hash correspond to the same RP. For example, if this value is 24, only the first 24 bits of the group addresses matter. This allows you to get one RP for multiple groups.
bsr-priority: Priority of the candidate BSR. The range is an integer from 0 to 255. The BSR with the larger priority is preferred. If the priority values are the same, the router with the larger IP address is the BSR. The default value is 0.
interval: [Optional] Indicates the BSR candidate advertisement interval. The range is from 1 to 16383 seconds. The default value is 60 seconds.
no ip pim bsr-candidate
Use this command to remove the configured PIM Candidate BSR router.
Format: no ip pim bsr-candidate interface unit/slot/portFormat
Mode: Global Config
ip pim dr-priority
Use this command to set the priority value for which a router is elected as the designated router (DR).
NOTE: This command takes effect only when Sparse mode is enabled in the Global mode.
Default: 1
Format: ip pim dr-priority 0-2147483647
Mode: Interface Config
no ip pim dr-priority
Use this command to return the DR Priority on the specified interface to its default value.
Format: no ip pim dr-priority
Mode: Interface Config
ip pim join-prune-interval
Use this command to configure the frequency of PIM Join/Prune messages on a specified interface. The join/prune interval is specified in seconds. This parameter can be configured to a value from 0 to 18000.
NOTE: This command takes effect only when is configured as the PIM mode.
Default: 60
Format: ip pim join-prune-interval 0-18000
Mode: Interface Config
no ip pim join-prune-interval
Use this command to set the join/prune interval on the specified interface to the default value.
Format: no ip pim join-prune-interval
Mode: Interface Config
ip pim register-rate-limit
This command sets a limit on the maximum number of PIM register messages sent, in kilobits per second, for each (S,G) entry. The valid values are from (0 to 2000 kilobits/sec).
NOTE: This command takes effect only when PIM-SM is configured as the PIM mode.
Default: 0
Format: ip pim register-rate-limit 0-2000
Mode: Global Config
no ip pim register-rate-limit
This command resets the register rate limit to the default value.
Format: no ip pim register-rate-limit
Mode: Global Config
ip pim rp-address
This command defines the address of a PIM Rendezvous point (RP) for a specific multicast group range.
NOTE: This command takes effect only when PIM-SM is configured as the PIM mode.
Default: 0
Format: ip pim rp-address rp-address group-address group-mask [override]
Mode: Global Config
rp-address: The IP address of the RP.
group-address: The group address supported by the RP.
group-mask: The group mask for the group address.
override: [Optional] Indicates that if there is a conflict, the RP configured with this command prevails over the RP learned by BSR.
no ip pim rp-address
Use this command to remove the address of the configured PIM Rendezvous point (RP) for the specified multicast group range.
Format: no ip pim rp-address rp-address group-address group-mask [override]
Mode: Global Config
ip pim rp-candidate
Use this command to configure the router to advertise itself as a PIM candidate rendezvous point (RP) to the bootstrap router (BSR) for a specific multicast group range.
NOTE: This command takes effect only when PIM-SM is configured as the PIM mode.
Default: Disabled
Format: ip pim rp-candidate interface unit/slot/port group-address group-mask [interval interval]
Mode: Global Config
unit/slot/port: The IP address associated with this interface type and number is advertised as a candidate RP address. This interface must be enabled with PIM.
group-address: The multicast group address that is advertised in association with the RP address.
group-mask: The multicast group prefix that is advertised in association with the RP address.
interval: [Optional] Indicates the RP candidate advertisement interval. The range is from 1 to 16383 seconds. The default value is 60 seconds.
no ip pim rp-candidate
Use this command to remove the configured PIM candidate Rendezvous point (RP) for a specific multicast group range.
Format: no ip pim rp-candidate interface unit/slot/port group-address group-mask
Mode: Global Config
ip pim spt-threshold
Use this command to configure the Data Threshold rate for the last-hop router to switch to the shortest path on the router. The rate is specified in Kilobits per second. The possible values are 0 to 2000.
NOTE: Some software platforms do not support a non-zero data threshold rate. For these platforms, only a "Switch on First Packet" policy is supported.
NOTE: This command takes effect only when PIM-SM is configured as the PIM mode.
Default: 0
Format: ip pim spt-threshold 0-2000
Mode: Global Config
no ip pim spt-threshold
This command is used to set the Data Threshold rate for the RP router to the default value.
Format: no ip pim spt-threshold
Mode: Global Config
ip pim ssm
Use this command to define the Source Specific Multicast (SSM) range of IP multicast addresses on the router.
NOTE: This command takes effect only when PIM-SM is configured as the PIM mode.
Default: disabled
Format: ip pim ssm {default | group-address group-mask}
Mode: Global Config
default-range: Defines the SSM range access list to 232/8.
no ip pim ssm
Use this command to remove the Source Specific Multicast (SSM) range of IP multicast addresses on the router.
Format: no ip pim ssm {default | group-address group-mask}
Mode: Global Config
ip pim-trapflags
This command enables the PIM trap mode for both Sparse Mode (SM) and Dense Mode. (DM).
Default: disabled
Format: ip pim-trapflags
Mode: Global Config
no ip pim-trapflags
This command sets the PIM trap mode to the default.
Format: no ip pim-trapflags
Mode: Global Config
show ip pim
This command displays the system-wide information for PIM-DM or PIM-SM.
Format: show ip pim
Modes: Privileged EXEC\User EXEC
NOTE: If the PIM mode is PIM-DM (dense), some of the fields in the following table do not display in the command output because they are applicable only to PIM-SM.
PIM Mode: Indicates the configured mode of the PIM protocol as dense (PIM-DM) or sparse (PIM-SM)
Data Threshold Rate: Rate (in kbps) of SPT Threshold
Register Rate-limit: Rate (in kbps) of the Register Threshold
C-BSR Adv. Interval: Interval (in secs) that a C-BSR advertises its messages.
C-RP Adv. Interval: Interval (in secs) that a C-BRP advertises its messages.
Interface: unit/slot/port
Interface Mode: Indicates whether PIM is enabled or disabled on this interface.
Operational Status: The current state of PIM on this interface: Operational or Non-Operational.
show ip pim ssm
This command displays the configured source specific IP multicast addresses. If no SSM Group range is configured, this command output is No SSM address range is configured.
Format: show ip pim ssm
Modes: Privileged EXEC\User EXEC
Group Address: The IP multicast address of the SSM group.
Prefix Length: The network prefix length.
show ip pim interface
This command displays the PIM interface status parameters. If no interface is specified, the command displays the status parameters of all PIM-enabled interfaces.
Format: show ip pim interface [unit/slot/port]
Modes: Privileged EXEC\User EXEC
Interface: unit/slot/port The interface number.
Mode: Indicates the active PIM mode enabled on the interface is dense or sparse.
Hello Interval: The frequency at which PIM hello messages are transmitted on this interface. By default, the value is 30 seconds.
Join Prune Interval: The join/prune interval value for the PIM router. The interval is in seconds.
DR Priority: The priority of the Designated Router configured on the interface. This field is not applicable if the interface mode is Dense.
BSR Border: Identifies whether this interface is configured as a bootstrap router border interface.
Neighbor Count: The number of PIM neighbors learned on this interface. This is a dynamic value and is shown only when a PIM interface is operational.
Designated Router: The IP address of the elected Designated Router for this interface. This is a dynamic value and will only be shown when a PIM interface is operational. This field is not applicable if the interface mode is Dense.
show ip pim neighbor
This command displays PIM neighbors discovered by PIMv2 Hello messages. If the interface number is not specified, this command displays the neighbors discovered on all the PIM-enabled interfaces.
Format: show ip pim neighbor [unit/slot/port]
Modes: Privileged EXEC\User EXEC
Neighbor Address: The IP address of the PIM neighbor on an interface.
Interface: unit/slot/port
Up Time: The time since this neighbor has become active on this interface.
Expiry Time: Time remaining for the neighbor to expire.
DR Priority: The DR Priority configured on this Interface (PIM-SM only).
NOTE: DR Priority is applicable only when sparse-mode configured routers are neighbors. Otherwise, NA is displayed in this field.
show ip pim bsr-router
This command displays the bootstrap router (BSR) information.
Format: show ip pim bsr-router {candidate | elected}
Mode: Privileged EXEC\User EXEC
BSR Address: IP address of the BSR.
BSR Priority: Priority as configured in the ip pim bsr-candidate command.
BSR Hash Mask Length: Length of a mask (maximum 32 bits) that is to be ANDed with the group address before the hash function is called. This value is configured in the ip pim bsr-candidate command.
C-BSR Advertisement Interval: Indicates the configured C-BSR Advertisement interval with which the router, acting as a C-BSR, will periodically send the C-BSR advertisement messages.
Next Bootstrap Message: Time (in hours, minutes, and seconds) in which the next bootstrap message is due from this BSR.
show ip pim rp-hash
This command displays the rendezvous point (RP) selected for the specified group address.
Format: show ip pim rp-hash group-address
Modes: Privileged EXEC\User EXEC
RP Address: The IP address of the RP for the group specified.
Type: Indicates the mechanism (BSR or static) by which the RP was selected.
show ip pim rp mapping
Use this command to display the mapping for the PIM group to the active Rendezvous points (RP) of which the router is a aware (either configured or learned from the bootstrap router (BSR)). Use the optional parameters to limit the display to a specific RP address or to view group-to-candidate RP or group to Static RP mapping information.
Format: show ip pim rp mapping [{rp-address|candidate|static}]
Modes: Privileged EXEC\User EXEC
RP Address: The IP address of the RP for the group specified.
Group Address: The IP address of the multicast group.
Group Mask: The subnet mask associated with the group.
Origin: Indicates the mechanism (BSR or static) by which the RP was selected.
C-RP Advertisement Interval: Indicates the configured C-RP Advertisement interval with which the router acting as a Candidate RP will periodically send the C-RP advertisement messages to the elected BSR.
