PIM

Note - You must enable state refresh on all the PIM routers in the distribution tree to take advantage of this feature.

PIM Protocol

The PIM mode to use. One of:

• Sparse Mode (SM)
• Dense Mode (DM)
• Source-Specific Multicast (SSM)

State Refresh

In Dense Mode, use state refresh messages to delay timing out prune state of multicast traffic that has no active receivers. This helps suppress the flood-and-prune cycle inherent to dense mode.

Interface

Select the interface on which to enable PIM

Local Address

Use the specified local address for all advertisements sent on the interface. This is useful on interfaces with multiple IP addresses (aliases). The local address must match one of the addresses configured on the interface. If a local address is specified while the virtual address option enabled, the local address must match a virtual address on the interface.

Note - Each router must have at least one interface address with a subnet prefix shared by all neighboring PIM routers. If any neighboring routers choose advertisement addresses that do not appear to be on a shared subnet all messages from those neighbors will be rejected. This holds true even when the virtual address option is enabled.

• Range: Dotted-quad ([0-255].[0-255].[0-255].[0-255]).
• Default: Selects one of the IP addresses configured on the interface. If the virtual address option is enabled, PIM will use the virtual address configured on the interface after the router transitions to master state with respect to VRRP.

Use Virtual Address

Use the VRRP virtual IP address on this interface. If enabled, PIM runs on this interface only after the router transitions to become a VRRP master after a failover.

When you enable virtual IP support for VRRP on a PIM interface, it establishes the neighbor relationship by using the virtual IP if the router is a VRRP master. The master in the VRRP pair sends hello messages that include the virtual IP as the source address and processes PIM control messages from routers that neighbor the VRRP pair.

Note - You cannot configure a local address or a virtual address when ClusterXL is enabled.

• Range: Enabled, cleared
• Default: Cleared

DR Priority

The dr-priority advertised in the PIM hello messages sent on the interface. This is used for DR election on a LAN. The router with the highest priority is elected the designated router. To break a tie, the DR is selected on the basis of the highest IP address. If even one router does not advertise a dr-priority, the DR election is based on the IP address.

• Range: 0-4294967295 (2^32 - 1).
• Default: 1.

Note - To verify whether a PIM neighbor supports DR Priority, use the following command:
show pim neighbor <ip_address>
For neighbors that advertise a DR election priority value, the following message appears in the summary:
DRPriorityCapable Yes.

Hello interval

Interval between which PIM hellos are sent on a multicast-capable interface. Hello messages are addressed to the All-PIM-Routers multicast group (224.0.0.13) so that PIM routers may discover neighbors on a multi-access network.

• Range: 1-21845 seconds
• Default: 30

Data Interval

The life-time of a new PIM forwarding entry. Subsequently the life of the entry will be extended in different ways depending on the location of this router in the network. For example, in some cases the receipt of PIM control messages (e.g. periodic join/prune messages) will extend the life of the entry and in others the presence of local senders of multicast traffic will prevent the entry from being deleted.

• Range: 11-3600 seconds
• Default: 210

Assert Interval

If an assert battle on an upstream interface results in a PIM neighbor other than the unicast reverse-path-forwarding (RPF) neighbor towards the source of the data traffic (for which the assert battle was generated) getting elected as the designated forwarder on that interface, the winner is used as the upstream neighbor for all subsequent join/prune messages. This change is timed-out after expiry of the assert interval (measured in seconds).

• Range: 1-3600 seconds
• Default: 180

Assert-rate Limit.

The number of asserts to send per second. Asserts are generated by the router when data from a source is detected on an interface other than the incoming interface (based on the unicast routing table) towards the source. These messages are rate-limited and the router should not originate more than a fixed number of assert messages per second. If the limit is set to 0, rate-limiting is disabled.

• Range: 0, 10-10000
• Default: 10

Join Prune Interval

Interval between sending Join/Prune messages.

• Range: 1-3600 seconds
• Default: 60

Join Prune Delay Interval

The maximum interval from the time when the unicast Reverse Path Forwarding (RPF) neighbor (towards a source or the RP) changes, and a triggered Join/Prune message is sent.

• Range: 1-3600 seconds
• Default: 5

Join Prune Suppress Interval

Mean interval from receiving a Join/Prune with a higher Holdtime (with ties broken by higher network layer address) and allowing duplicate Join/Prunes to be sent again. Set this interval to 1.25 times the join/prune interval.

• Range: 2-3600 seconds
• Default: 75

Direct

OSPF

Kernel

Static

RIP

BGP

Used to compare the cost of protocols in order to determine which router will forward multicast data packets on a multi-access LAN. These values are used in assert messages sent out on a LAN when a router detects data packets on an interface other than the incoming interface towards the source of the data. These values must be the same for all routers on a multi-access LAN that are running the same protocol. Hence, the default values have been specifically configured to match that of other implementations.

• Range: 0-255
• Defaults:
  • Direct: 0
  • OSPF: 10
  • Kernel: 40
  • Static: 60
  • RIP: 100
  • BGP: 170

State Refresh Interval

For Dense Mode, the interval at which state refresh messages are sent for multicast traffic originated by directly-connected sources.

• Range: 1-255
• Default: 60

State Refresh TTL

For Dense Mode, the time-to-live (TTL) placed in the state refresh messages originated for multicast traffic from directly-connected sources. This value can be used to limit the forwarding of state refresh messages in the network. In the absence of user configuration it is derived from the multicast data.

• Range: 1-255
• Default: None

CRP Advertise Interval

The interval between which candidate‑rendezvous point routers send candidate‑rendezvous point advertisements to the elected bootstrap router.

• Range: 1-3600 seconds
• Default: 60 seconds

Multicast Group

The multicast group address to apply to the shortest path tree (spt) threshold.

• Range: Dotted-quad ([224-239].[0-255].[0-255].[0-255])
• Default: None

Subnet mask

Mask length.

• Range: 1-32
• Default: None

Use Infinity

Specifies that there is no spt switch.

Use Integer

The data rate threshold in Kbits/sec to trigger the spt switchover.

When the data rate for a sparse-mode group exceeds the shortest-path-tree threshold at the last-hop router, an (S,G) entry is created and a join/prune message is sent toward the source. Setting this option builds a shortest-path tree from the source S to the last-hop router.

• Range: 0-1000000 Kbits/s, or infinity (for no switchover)
• Default: None

Enable Bootstrap Router

If enabled, this router is a candidate bootstrap router (C-BSR). All candidate RPs (C-RPs) send C-RP-Advertisements to the elected bootstrap router (BSR). The BSR then disseminates this information in bootstrap messages across the PIM domain. To avoid a single point of failure, configure more than one router in a domain as a candidate BSR.

• Default: Cleared

Local Address

Address used for the C-BSR state machine and the bootstrap messages.

If PIM clustering is enabled, then this address must be configured and must match that of one of the PIM interfaces.

If PIM clustering is not enabled, this address can either be that of the PIM interfaces or an address configured on the loopback interface. If an address from the loopback interface is used, take care not select an address in the 127/8 address range.

• Range: Address of PIM interface or a non 127.0.0.0/8 loopback address.
• Default: The IP address of one of the interfaces on which PIM is enabled. The default does not apply if PIM clustering is enabled.

Local Preference

The priority advertised in C-BSR messages. The candidate bootstrap router with the highest priority value is elected as the bootstrap router for the domain. The C-RP with the lowest priority has the highest preference. The highest priority value is 0.

• Range: 0-255
• Default: 0

Enable Candidate RP

Specifies that the platform is a candidate rendezvous point router.

Local Address

Address used for the C-RP state machine and in the C-RP-Advertisements sent to the elected bootstrap router.

If PIM clustering is enabled, then this address must be configured and must match that of one of the PIM interfaces.

If clustering is not enabled, this address can either be that of one of the PIM interfaces or an address configured on the loopback interface. If an address from the loopback interface is used, take care not select an address in the 127/8 address range.

• Range: Address of PIM interface or a non 127.0.0.0/8 loopback address.
• Default: Selects the IP address of one of the interfaces on which PIM is enabled. The default does not apply if PIM clustering is enabled.

Local Preference

The priority of this C-RP. All PIM routers select the same RP for a multicast group address from the list of C-RPs received in the bootstrap messages from the elected BSR. The lower the Local Preference of the C-RP, the higher the priority.

• Range: 0-255
• Default: 0

Multicast Group

The multicast group(s) for which this rendezvous point is responsible. Enter the group multicast IP address and mask length.

Multicast group address

• Range: Dotted-quad ([224-239].[0-255].[0-255].[0-255])
• Default: 224.0.0.0/4

Subnet mask

Mask length:

• Range: 1-32
• Default: None

Enable Static RP

Enables or disables the static rendezvous point.

Static Rendezvous Point

A static rendezvous point. If an associated multicast group and prefix is not configured, the static-rp is considered to be responsible for all multicast groups (224.0.0.0/4). This needs to be consistent with the RP information at other routers in a multicast domain irrespective of the RP-dissemination mechanism (bootstrap or autoRP) used.

Note - The static RP overrides the RP information received from other RP-dissemination mechanisms, such as bootstrap routers.

• Range: Any IP address
• Default: None

Multicast Group

The multicast group(s) for which this rendezvous point is responsible. Enter the group multicast IP address and mask length.

Multicast group address

• Range: Dotted-quad ([224-239].[0-255].[0-255].[0-255])
• Default: 224.0.0.0/4

Subnet mask

Mask length:

• Range: 1-32
• Default: None

set pim mode

   dense

   sparse

   ssm 

set pim state-refresh <on | off>

<dense | sparse | ssm>

The PIM mode to use. One of:

• Sparse Mode (SM)
• Dense Mode (DM)
• Source-Specific Multicast (SSM)

state-refresh <on | off>

In Dense Mode, use state refresh messages to delay timing out prune state of multicast traffic that has no active receivers. This helps suppress the flood-and-prune cycle inherent to dense mode.

set pim interface if_name

   <on | off>

   virtual-address <on | off>

   local‑address ip_address

   dr‑priority <0‑4294967295>

   dr‑priority default

interface if_name <on | off>

Whether to enable or disable PIM on a specified interface.

virtual-address <on | off>

Use the VRRP virtual IP address on this interface. If enabled, PIM runs on this interface only after the router transitions to become a VRRP master after a failover.

When you enable virtual IP support for VRRP on a PIM interface, it establishes the neighbor relationship by using the virtual IP if the router is a VRRP master. The master in the VRRP pair sends hello messages that include the virtual IP as the source address and processes PIM control messages from routers that neighbor the VRRP pair.

Note - You cannot configure a local address or a virtual address when ClusterXL is enabled.

• Default: Off

local‑address ip_address

Use the specified local address for all advertisements sent on the interface. This is useful on interfaces with multiple IP addresses (aliases). The local address must match one of the addresses configured on the interface. If a local address is specified while the virtual address option enabled, the local address must match a virtual address on the interface.

Note - Each router must have at least one interface address with a subnet prefix shared by all neighboring PIM routers. If any neighboring routers choose advertisement addresses that do not appear to be on a shared subnet all messages from those neighbors will be rejected. This holds true even when the virtual address option is enabled.

• Range: Dotted-quad ([0-255].[0-255].[0-255].[0-255]).
• Default: Selects one of the IP addresses configured on the interface. If the virtual address option is enabled, PIM will use the virtual address configured on the interface after the router transitions to master state with respect to VRRP.

dr‑priority <0‑4294967295>

The dr-priority advertised in the PIM hello messages sent on the interface. This is used for DR election on a LAN. The router with the highest priority is elected the designated router. To break a tie, the DR is selected on the basis of the highest IP address. If even one router does not advertise a dr-priority, the DR election is based on the IP address.

• Range: 0-4294967295 (2^32 - 1).
• Default: 1.
• Note - To verify whether a PIM neighbor supports DR Priority, use the following command:
  show pim neighbor <ip_address>
  For neighbors that advertise a DR election priority value, the following message appears in the summary:
  DRPriorityCapable Yes.

dr‑priority default

A value of 1.

set pim

   bootstrap‑candidate <on | off>

   bootstrap‑candidate local‑address ip_address

   bootstrap‑candidate priority <0‑255>

   bootstrap‑candidate priority default

   candidate‑rp <on | off>

   candidate‑rp local‑address ip_address

   candidate‑rp priority <0‑255>

   canidate‑rp priority default

   candidate‑rp multicast group mcast_ip_prefix <on | off>

   static‑rp off

   static‑rp rp‑address ip_address < on | off>

   static‑rp rp‑address ip_address multicast‑group <mcast_address>/<mask_length> <on | off>

   register‑suppress‑interval <60‑3600>

   register‑suppress‑interval default

   candidate‑rp advertise‑interval <1‑3600>

   candidate rp‑advertise‑interval default

   spt‑threshold multicast <mcast_address>/<mask_length> threshold <0‑1000000> <on | off>

   spt‑threshold multicast <mcast_address>/<mask_length> threshold infinity <on | off>

bootstrap‑candidate <on | off>

If enabled, this router is a candidate bootstrap router (C-BSR). All candidate RPs (C-RPs) send C-RP-Advertisements to the elected bootstrap router (BSR). The BSR then disseminates this information in bootstrap messages across the PIM domain. To avoid a single point of failure, configure more than one router in a domain as a candidate BSR.

• Default: off

bootstrap‑candidate local‑address ip_address

Address used for the C-BSR state machine and the bootstrap messages.

If PIM clustering is enabled, then this address must be configured and must match that of one of the PIM interfaces.

If PIM clustering is not enabled, this address can either be that of the PIM interfaces or an address configured on the loopback interface. If an address from the loopback interface is used, take care not select an address in the 127/8 address range.

• Range: Address of PIM interface or a non 127.0.0.0/8 loopback address.
• Default: The IP address of one of the interfaces on which PIM is enabled. The default does not apply if PIM clustering is enabled.

bootstrap‑candidate priority <0‑255>

The priority advertised in C-BSR messages. The candidate bootstrap router with the highest priority value is elected as the bootstrap router for the domain. The C-RP with the lowest priority has the highest preference. The highest priority value is 0.

• Range: 0-255
• Default: 0

bootstrap‑candidate priority default

Specifies a value of 0.

candidate‑rp <on | off>

Specifies that the platform is a candidate rendezvous point router.

• Default: off

candidate‑rp local‑address ip_address

Address used for the C-RP state machine and in the C-RP-Advertisements sent to the elected bootstrap router.

If PIM clustering is enabled, then this address must be configured and must match that of one of the PIM interfaces.

If clustering is not enabled, this address can either be that of one of the PIM interfaces or an address configured on the loopback interface. If an address from the loopback interface is used, take care not select an address in the 127/8 address range.

• Range: Address of PIM interface or a non 127.0.0.0/8 loopback address.
• Default: Selects the IP address of one of the interfaces on which PIM is enabled. The default does not apply if PIM clustering is enabled.

candidate‑rp priority <0‑255>

The priority of this C-RP. All PIM routers select the same RP for a multicast group address from the list of C-RPs received in the bootstrap messages from the elected BSR. The lower the Local Preference of the C-RP, the higher the priority.

• Range: 0-255
• Default: 0

candidate‑rp priority default

A value of 0.

candidate‑rp multicast‑group <mcast_address>/<mask_length> <on | off>

The multicast address advertised in the candidate rendezvous point advertisements. Enter the group multicast IP address and mask length. If you do not specify a group multicast address, the candidate rendezvous point advertises itself as the rendezvous point for all multicast groups.

Multicast group address

• Range: Dotted-quad ([224-239].[0-255].[0-255].[0-255]).
• Default: None.

Mask length:

• Range: 1-32
• Default: None

static‑rp off

Disables the static rendezvous point option.

static‑rp rp‑address ip_address <on | off>

A static rendezvous point. If an associated multicast group and prefix is not configured, the static-rp is considered to be responsible for all multicast groups (224.0.0.0/4). This needs to be consistent with the RP information at other routers in a multicast domain irrespective of the RP-dissemination mechanism (bootstrap or autoRP) used.

Note - The static RP overrides the RP information received from other RP-dissemination mechanisms, such as bootstrap routers.

• Range: Any IP address
• Default: None

static‑rp rp‑address ip_address multicast‑group <mcast_address>/<mask_length> <on | off>

The multicast group(s) for which this rendezvous point is responsible. Enter the group multicast IP address and mask length.

Multicast group address

• Range: Dotted-quad ([224-239].[0-255].[0-255].[0-255])
• Default: 224.0.0.0/4

Mask length:

• Range: 1-32
• Default: None

register‑suppress‑interval <60‑3600>

The mean interval between receiving a register‑stop and allowing registers to be sent again. A lower value means more frequent register bursts at the rendezvous point. A higher value means a longer join latency for new receivers.

• Range: 60-3600 seconds
• Default: 60 seconds

register‑suppress‑interval default

A value of 60 seconds.

candidate‑rp advertise‑interval <1‑3600>

The interval between which candidate‑rendezvous point routers send candidate‑rendezvous point advertisements to the elected bootstrap router.

• Range: 1-3600 seconds
• Default: 60 seconds

candidate‑rp advertise‑interval default

A value of 60 seconds.

spt‑threshold multicast <mcast_address>/<mask_length> threshold infinity <on | off>

Specifies that there is no spt switchover.

Multicast group address

• Range: Dotted-quad ([224-239].[0-255].[0-255].[0-255])
• Default: 224.0.0.0/4

Mask length:

• Range: 1-32
• Default: None

set pim

   hello‑interval <1‑21845>

   hello‑interval default

   data‑interval <11‑3600>

   data‑interval default

   assert‑interval <1‑3600>

   assert‑interval default

   assert‑limit <10‑10000>

   assert‑limit default

   assert‑limit <0>

   jp‑interval <1‑3600>

   jp‑interval default

   jp‑delay‑interval <1‑3600>

   jp‑delay‑interval default

   jp‑suppress‑interval <2‑3600>

   jp‑suppress‑interval default

   assert‑rank protocol protocol name rank <0‑255>

   assert‑rank protocol protocol name rank default

   state-refresh-interval <1 – 255>

   state-refresh-ttl <1 – 255>

hello interval <1‑21845>

Interval between which PIM hellos are sent on a multicast-capable interface. Hello messages are addressed to the All-PIM-Routers multicast group (224.0.0.13) so that PIM routers may discover neighbors on a multi-access network.

• Range: 1-21845 seconds
• Default: 30

hello interval default

A value of 30.

data‑interval <11‑3600>

The life-time of a new PIM forwarding entry. Subsequently the life of the entry will be extended in different ways depending on the location of this router in the network. For example, in some cases the receipt of PIM control messages (e.g. periodic join/prune messages) will extend the life of the entry and in others the presence of local senders of multicast traffic will prevent the entry from being deleted.

• Range: 11-3600 seconds
• Default: 210

data‑interval default

A value of 210.

assert‑interval <1‑3600>

If an assert battle on an upstream interface results in a PIM neighbor other than the unicast reverse-path-forwarding (RPF) neighbor towards the source of the data traffic (for which the assert battle was generated) getting elected as the designated forwarder on that interface, the winner is used as the upstream neighbor for all subsequent join/prune messages. This change is timed-out after expiry of the assert interval (measured in seconds).

• Range: 1-3600 seconds
• Default: 180

assert‑interval default

A value of 180.

assert‑limit <10‑10000>

The number of asserts to send per second. Asserts are generated by the router when data from a source is detected on an interface other than the incoming interface (based on the unicast routing table) towards the source. These messages are rate-limited and the router should not originate more than a fixed number of assert messages per second. If the limit is set to 0, rate-limiting is disabled.

• Range: 0, 10-10000
• Default: 10

assert‑limit default

A value of 10.

assert‑limit <0>

Disables the limit placed on the number of asserts that can be sent per second.

jp‑interval <1‑3600>

Interval between sending Join/Prune messages.

• Range: 1-3600 seconds
• Default: 60

jp‑interval default

A value of 60.

jp‑delay‑interval <1‑3600>

The maximum interval from the time when the unicast Reverse Path Forwarding (RPF) neighbor (towards a source or the RP) changes, and a triggered Join/Prune message is sent.

• Range: 1-3600 seconds
• Default: 5

jp‑delay‑interval default

A value of 5.

jp‑suppress‑interval <2‑3600>

Mean interval from receiving a Join/Prune with a higher Holdtime (with ties broken by higher network layer address) and allowing duplicate Join/Prunes to be sent again. Set this interval to 1.25 times the join/prune interval.

• Range: 2-3600 seconds
• Default: 75

jp‑suppress‑interval default

A value of 75.

assert‑rank protocol protocol name rank default

Default assert‑rank values for supported protocols that match other implementations.

• Defaults:
  • Direct: 0
  • OSPF: 10
  • Kernel: 40
  • Static: 60
  • RIP: 100
  • BGP: 170

state-refresh-ttl <1 – 255>

For Dense Mode, the time-to-live (TTL) placed in the state refresh messages originated for multicast traffic from directly-connected sources. This value can be used to limit the forwarding of state refresh messages in the network. In the absence of user configuration it is derived from the multicast data.

• Range: 1-255
• Default: None

set trace pim

   assert <on | off>

   bootstrap <on | off>

   crp <on | off>

   graft <on | off>

   hello <on | off>

   join <on | off>

   mfc <on | off>

   mrt <on | off>

   packets <on | off>

   rp <on | off>

   register <on | off>

   trap <on | off>

   traceoptions <on | off>

assert

Trace PIM assert messages.

hello

Trace PIM router hello messages.

join

Trace PIM join/prune messages.

mfc

Trace calls to or from the multicast forwarding cache

mrt

Trace PIM multicast routing table events.

packets

Trace all PIM packets.

trap

Trace PIM trap messages.

all

Trace all PIM events and packets.

bootstrap

Trace bootstrap messages.

crp

Trace candidate‑RP‑advertisements.

rp

Trace RP‑specific events, including RP set‑specific and bootstrap‑specific events.

register

Trace register and register‑stop packets.

graft

Trace graft and graft acknowledgment packets.

show pim

	interfaces

	interfaces if_address

	neighbors

	neighbor ip_address

	memory

	timers

	stats

	summary

show pim

	bootstrap

	candidate‑rp

	joins

	rps

	sarse‑mode‑stats

	group‑rp‑mapping <mcast_address>

interface

The interfaces that are running PIM, their status, and their mode. This command also displays the interface and its DR priority and the number of PIM neighbors on the interface.

neighbors

The IP address of each PIM neighbor and the interface on which the neighbor is present. This command also displays the neighbor’s DR priority, generation ID, holdtime and the time the neighbor is set to expire based on the holdtime received in the most recent hello message.

neighbor ip_address

Use this command to verify whether a PIM neighbor supports DR Priority.
For neighbors that advertise a DR election priority value, the following message appears in the summary:
DRPriorityCapable Yes.

stats

The number of different types of PIM packets received and transmitted and any associated errors.

memory

timers

summary

bootstrap

The IP address and state of the Bootstrap router.

candidate-rp

The state of the Candidate Rendezvous Point state machine.

joins

PIM’s view of the join-prune (*, G and S, G) state, including RP for the group, incoming, and outgoing interface(s), interaction with the multicast forwarding cache and the presence of local members. To view the equivalent information for dense-mode PIM, use the show mfc cache command.

rps

The active RP-set, including the RP addresses, their type (or source of information about them) and the groups for which they are configured to act as RP.

group-rp-mapping <group-address>

The RP selected for a particular group based on information from the active RP-set.

sparse-mode stats

Error statistics for multicast forwarding cache (MFC); Bootstrap Router (BSR) messages; Candidate Rendezvous Point (CRP) advertisements; and the Internet Group Management Protocol (IGMP).

show mfc 

   cache

   interface

cache

Multicast source and group forwarding state by prefix.

interface

Multicast source and group forwarding state by interface.