| Sun Ethernet Fabric Operating System CLI Enterprise Reference Manual
|
   
|
PIM |
PIM is a multicast routing architecture that allows the addition of IP multicast routing on existing IP networks. Multicast IP routing protocols are used to distribute data to multiple recipients. Using multicast, a source can send a single copy of data to a single multicast address, which is then distributed to an entire group of recipients. A multicast group identifies a set of recipients that are interested in a particular data stream, and is represented by an IP address from a well-defined range. Data sent to this IP address is forwarded to all members of the multicast group.
PIM is a unicast routing protocol independent and can be operated in two modes: dense and sparse (currently, only sparse mode is supported) It is designed to provide scalable inter-domain multicast routing across the Internet. PIM provides multicast routing and forwarding capability to the switch. It maintains the integrity of the hardware based multicast forwarding table with respect to the forwarding table existing in the software. It is independent of the underlying unicast routing protocol and uses the information from the unicast routing protocol.
9.1 PIM Commands
The list of CLI commands for the configuration of PIM is as follows:
9.1.1 set ip pim
Enables or disables PIM globally.
set ip pim {enable | disable}
|
|
Syntax Description
|
enable - Enables PIM.
disable - Disables PIM.
|
|
Mode
|
Global Configuration
|
|
Defaults
|
Disabled.
|
|
Example
|
SEFOS(config)# set ip pim enable
|
|
Notes
|
- PIM mode will be set as sparse, when PIM is enabled globally.
- IGMP proxy service must be disabled in the system, before enabling the PIM globally.
|
9.1.2 ip multicast
Enables PIM globally. This command operates similar to the command set ip pim.
|
Mode
|
Global Configuration
|
|
Defaults
|
Disabled.
|
|
Example
|
SEFOS(config)# ip multicast
|
|
Notes
|
- PIM mode will be set as sparse, when PIM is enabled globally.
- IGMP proxy service must be disabled in the system, before enabling the PIM globally.
|
9.1.3 ip pim version
Sets the PIM version.
|
Syntax Description
|
1 | 2 - PIM version is configured either as v1 or v2.
Only PIM version 2 is currently supported.
|
|
Mode
|
Global Configuration
|
|
Example
|
SEFOS(config)# ip pim version 2
|
9.1.4 set ip pim threshold
Specifies the SPT group or source threshold when exceeded, switching to shortest path tree is initiated. To switch to SPT, the threshold must be configured.
set ip pim threshold {spt-grp | spt-src} number-of-packets_0-2147483647
|
|
Syntax Description
|
spt-grp - The threshold of data rate for any group when exceeded, source specific counters are initiated for that particular group. It is based on number of bits per second.
spt-src - The switching to Shortest Path Tree is initiated, when the threshold of data rate for any source is exceeded. It is based on number of bits per second.
number-of-packets_0-2147483647 - Number of packets.
|
|
Mode
|
Global Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config)# set ip pim threshold spt-grp 50
|
9.1.5 set ip pim spt-switchperiod
Specifies the time period (in seconds) during which the data rate is to be monitored for switching to shortest path tree.
set ip pim spt-switchperiod seconds_0-2147483647
|
|
Mode
|
Global Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config)# set ip pim spt-switchperiod 60
|
|
Notes
|
- The same period is used for monitoring the data rate for both source and group. To switch to SPT, this period must be configured.
- The SPT (Shortest Path Tree) is used for multicast transmission of packets with the shortest path from sender to recipients
|
- show ip pim thresholds - Displays threshold configured for SPT, RP thresholds, rate limit values for both SM and DM
9.1.6 set ip pim rp-threshold
Specifies the threshold at which the Rendezvous Point (RP) initiates switching to source specific shortest path tree.
set ip pim rp-threshold number-of-reg-packets_0-2147483647
|
|
Mode
|
Global Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config)# set ip pim rp-threshold 50
|
|
Notes
|
To switch to SPT, this threshold must be configured and this switching is based on the number of registered packets received.
|
- show ip pim thresholds - Displays threshold configured for SPT, RP thresholds, rate limit values for both SM and DM
9.1.7 set ip pim rp-switchperiod
Specifies the time period (in seconds) during which RP monitors register packets for switching to the source specific shortest path tree.
set ip pim rp-switchperiod seconds_0-2147483647
|
|
Mode
|
Global Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config)# set ip pim rp- switchperiod 100
|
|
Notes
|
- To switch to SPT, this time period must be configured.
- RP-tree is a pattern that multicast packets are sent to a PIM-SM router by unicast and then forwarded to actual recipients from RP.
|
9.1.8 set ip pim regstop-ratelimit-period
Specifies the time period during which RP monitors the number of register packets after sending the register stop message.
set ip pim regstop-ratelimit-period seconds_0-2147483647
|
|
Mode
|
Global Configuration
|
|
Defaults
|
5
|
|
Example
|
SEFOS(config)# set ip pim regstop-ratelimit-period 100
|
|
Notes
|
Register stop message is used to avoid encapsulation of multicast data packets from the first hop router to the RP.
|
9.1.9 set ip pim pmbr
Enables or disables the PMBR (PIM Multicast Border Router) status.
set ip pim pmbr {enable | disable}
|
|
Syntax Description
|
enable - Enables the PMBR status.
disable - Disables the PMBR status.
|
|
Mode
|
Global Configuration
|
|
Defaults
|
Disabled.
|
|
Example
|
SEFOS(config)# set ip pim pmbr enable
|
|
Notes
|
- A PMBR integrates two different PIM domains (either PIM -SM or PIM -DM).
- A PMBR connects a PIM domain to other multicast routing domain(s).
|
9.1.10 ip pim component
Configures the PIM component in the router. The no form of the command destroys the PIM component.
ip pim component component-id_1-255
|
no ip pim component component-id_1-255
|
|
Mode
|
Global Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config)# ip pim component 1
|
|
Notes
|
- The PIM Component 1 cannot be deleted as it is the default component.
- The PIM Component corresponds to each instance of a PIM domain and classifies it as sparse or dense mode. Currently, only sparse mode is supported.
|
9.1.11 set ip pim static-rp
Enables or disables the Static RP configuration Status. This command specifies whether to use the configured static- RP.
set ip pim static-rp {enable | disable}
|
|
Syntax Description
|
enable - Enables the static RP configuration status.
disable - Disables the static RP configuration status.
|
|
Mode
|
Global Configuration
|
|
Defaults
|
Disabled
|
|
Example
|
SEFOS(config)# set ip pim static-rp enable
|
9.1.12 rp-candidate rp-address
Sets the address of the interface, which is advertised as a candidate-RP. The no form of the command disables the address of the interface, which will be advertised as a candidate-RP.
rp-candidate rp-address group-address group-mask ip-address
|
no rp-candidate rp-address group-address group-mask ip-address
|
|
Syntax Description
|
group-address - The IP multicast group address for which this entry contains multicast routing information.
group-mask - The IP multicast group address mask that gives the group prefix for which this entry contains information about the RP.
ip-address - IP address.
|
|
Mode
|
Global Configuration
|
|
Example
|
SEFOS(pim-comp)# rp-candidate rp-address 224.1.0.0 255.255.0.0 20.0.0.2
|
|
Notes
|
A candidate-RP is a router configured to send periodic candidate-RP-advertisement messages to the BSR and to process join or prune or register messages for the advertised group prefix, when it is elected as a RP.
|
9.1.13 rp-candidate holdtime
Sets the hold time of the component when it is a candidate RP in the local domain. The no form of the command sets the default hold time (0) of the component.
rp-candidate holdtime 0-255
|
|
Mode
|
PIM Component
|
|
Defaults
|
0
|
|
Example
|
SEFOS(pim-comp)# rp-candidate holdtime 25
|
|
Notes
|
- If its value is set to 0, it indicates that the local system is not a candidate RP.
- Hold time is the amount of time the candidate RP advertisement is valid. This field allows advertisements to be aged out.
|
9.1.14 rp-static rp-address
Sets the address of the interface, which is advertised as a static-RP. The no form of the command disables the address of the interface, which is advertised as a static-RP.
rp-static rp-address group-address group-mask ip-address
|
no rp-static rp-address group-address group-mask
|
|
Syntax Description
|
group-address - Indicates the PIM Sparse multicast group address using the listed RP.
group-mask - The IP multicast group address mask that gives the group prefix for which this entry contains information about the RP.
ip-address - IP address.
|
|
Mode
|
Global Configuration
|
|
Example
|
SEFOS(pim-comp)# rp-candidate rp-address 224.1.0.0 255.255.0.0 20.0.0.2
|
|
Notes
|
A candidate-RP is a router configured to send periodic candidate-RP-advertisement messages to the BSR and to process join or prune or register messages for the advertised group prefix, when it is elected as a RP.
|
9.1.15 ip pim query-interval
Sets the frequency at which PIM hello messages are transmitted on this interface. The no form of the command sets the default hello timer interval for this interface. This command is applicable only in VLAN Interface mode.
ip pim query-interval seconds_0-65535
|
|
Mode
|
Interface Configuration
|
|
Defaults
|
30
|
|
Example
|
SEFOS (config-if)# ip pim query-interval 60
|
|
Notes
|
The query message informs the presence of a PIM router on the interface to the neighboring PIM routers.
|
9.1.16 ip pim message-interval
Sets the frequency at which PIM join or prune messages are transmitted on this PIM interface. The no form of the command sets the default value for PIM join/prune message. This command is applicable only in VLAN Interface mode.
ip pim message-interval interval_0-65535
|
no ip pim message-interval
|
|
Mode
|
Interface Configuration
|
|
Defaults
|
60
|
|
Example
|
SEFOS(config-if)# ip pim message-interval 120
|
|
Notes
|
The same join or prune message interval must be used on all the PIM routers in the PIM domain. If all the routers do not use the same timer interval, the performance of PIM Sparse can be adversely affected.
|
9.1.17 ip pim bsr-candidate - value
Sets the preference value for the local interface as a candidate bootstrap router. The no form of the command sets the default preference value for the local interface as a candidate bootstrap router. This command is applicable only in VLAN Interface mode.
ip pim bsr-candidate 0-255
|
|
Mode
|
Interface Configuration
Applicable only in the VLAN Interface.
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config-if)# ip pim bsr-candidate 1
|
|
Notes
|
A BSR is a dynamically elected router within a PIM domain.
|
9.1.18 ip pim bsr-candidate - vlan
Sets the local interface as a candidate BSR. This command operates similar to the command ip pim bsr-candidate - value. This command is applicable only in VLAN Interface mode.
ip pim bsr-candidate vlan-id_1-4094 [priority value]
|
|
Syntax Description
|
vlan-id_1-4094 - VLAN interface number from which BSR address is derived to make BSR as a candidate. This value ranges between 1 and 4094.
priority - Priority of the candidate BSR. This value ranges between 0 and 255.
|
|
Mode
|
Global Configuration
|
|
Defaults
|
priority - 0
|
|
Example
|
SEFOS(config)# ip pim bsr-candidate 1 priority 100
|
|
Notes
|
The router with highest priority is considered as the BSR. If the priority values are same, then the router with largest IP address is considered as the BSR.
|
9.1.19 ip pim componentId
Adds the interface to the component.
|
Mode
|
Global Configuration
|
|
Defaults
|
1
|
|
Example
|
SEFOS(config-if)# ip pim componentId 1
|
|
Notes
|
This command adds the current VLAN into the specified PIM component.
|
9.1.20 ip pim dr-priority
Sets the designated router priority value configured for the router interface. The no form of the command sets the default designated router priority value (0) for the router interface. This command is applicable only in VLAN Interface mode.
ip pim dr-priority 1-65535
|
|
Mode
|
Interface Configuration
|
|
Defaults
|
1
|
|
Example
|
SEFOS(config-if)# ip pim dr-priority 100
|
|
Notes
|
The DR sets up multicast route entries and sends corresponding join or prune and register messages on behalf of directly-connected receivers and sources, respectively.
|
9.1.21 ip pim override-interval
Sets the override interval configured for router interface and the no form of the command sets the default override interval (0) for router interface. This command is applicable only in VLAN Interface mode.
ip pim override-interval 0-65535
|
no ip pim override-interval
|
|
Mode
|
Interface Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config-if)# ip pim override-interval 100
|
|
Notes
|
Override interval is the random amount of time delayed for sending override messages to avoid synchronization of override messages when multiple downstream routers share a multi-access link.
|
9.1.22 ip pim lan-delay
Sets the LanDelay configured for the router interface. The no form of the command sets the default LanDelay (0) for the router per interface. This command is applicable only in VLAN Interface mode.
|
Mode
|
Interface Configuration
|
|
Defaults
|
0
|
|
Example
|
SEFOS(config-if)# ip pim lan-delay 120
|
|
Notes
|
The LAN delay inserted by a router in the LAN prune delay option expresses the expected message propagation delay on the interface. It is used by upstream routers to find out the delayed time interval for a Join override message before pruning an interface.
|
9.1.23 set ip pim lan-prune-delay
Sets the LanPruneDelay bit configured for the router interface to advertise the LAN delay. This command is applicable only in VLAN Interface mode.
set ip pim lan-prune-delay {enable | disable}
|
|
Syntax Description
|
enable - Enables LAN-prune-delay.
disable - Disables LAN-prune-delay.
|
|
Mode
|
Interface Configuration
|
|
Defaults
|
Disabled.
|
|
Example
|
SEFOS(config-if)# set ip pim lan-prune-delay enable
|
|
Notes
|
The command specifies whether to use LAN prune delay or not.
|
9.1.24 set ip pim graft-retry interval
Sets the time before which graft is retransmitted upon no receipt of graft ACK. The no form of the command sets the graft retry interval to the default value. This command is applicable only in VLAN Interface mode.
set ip pim graft-retry interval 1-10
|
no ip pim graft-retry interval
|
|
Mode
|
Interface Configuration
|
|
Defaults
|
3 seconds.
|
|
Example
|
SEFOS(config-if)# set ip pim graft-retry interval 4
|
9.1.25 no ip pim interface
Deletes an interface at PIM level. This command is applicable only in VLAN Interface mode.
|
Mode
|
Interface Configuration
|
|
Example
|
SEFOS(config-if)# no ip pim interface
|
|
Notes
|
This command is used to destroy the interface at PIM.
|
9.1.26 debug ip pim
Enables PIM trace and the no form of the command disables PIM trace.
debug ip pim {[nbr] [grp] [jp] [ast] [bsr] [io] [pmbr] [mrt] [mdh] [mgmt] [srm] | [all]}
|
no debug ip pim {[nbr] [grp] [jp] [ast] [bsr] [io] [pmbr] [mrt] [mdh] [mgmt] [srm] | [all]}
|
|
Syntax Description
|
nbr - Neighbor discovery traces.
grp - Group membership traces.
jp - Join or prune traces.
ast - Assert state traces.
bsr - Bootstrap/RP traces.
io - Input/output traces.
pmbr - Interoperability traces.
mrt - Multicast route table update traces.
mdh - Multicast data handling traces.
mgmt - Configuration traces.
srm - State refresh messages.
all - All traces.
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# debug ip pim all
|
|
Notes
|
A four-byte integer value is specified for enabling the level of debugging. Each bit in the four-byte integer variable represents a level of debugging. The combinations of levels are also allowed. You must enter the corresponding integer value for the bit set.
|
9.1.27 show ip pim interface
Displays the router’s PIM interfaces.
show ip pim interface [{Vlan vlan-id | interface-type interface-id | detail}]
|
|
Syntax Description
|
Vlan - VLAN identifier.
detail - Detailed information of the interface.
interface-type - Interface type.
interface-id - Interface identifier.
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim interface
Address IfName/IfId Ver/Mode Nbr Qry DR-Address DR-Prio
Count Interval
10.0.0.1 vlan1/160 2/Sparse 0 45 10.0.0.1 5
20.0.0.1 vlan2/33 2/Sparse 0 30 20.0.0.1 1
30.0.0.1 vlan3/34 2/Sparse 0 60 30.0.0.1 1
|
|
|
SEFOS# show ip pim interface vlan 1
Address IfName/IfId Ver/Mode Nbr Qry DR-Address DR-Prio
Count Interval
10.0.0.1 vlan1/160 2/Sparse 0 45 10.0.0.1 5
|
|
|
SEFOS# show ip pim interface detail
vlan1 33 is up
Internet Address is 12.0.0.1
Muticast Switching : Enabled
PIM : Enabled
PIMv6 : Disabled
PIM version : 2, mode: Sparce
PIM DR : 12.0.0.1
PIM DR Priority : 1
PIM Neighbour Count : 0
|
|
|
PIM Hello/Query Interval : 90
PIM Message Interval : 60
PIM Override Interval : 0
PIM Lan Delay : 0
PIM Lan-Prune-Delay : Disabled
PIM Graft Retry Interval : 3
|
|
|
PIM State Refresh : Uncapable
PIM Component Id : 1
PIM domain border : disabled
PIM State Refresh Processing : enabled
PIM Refresh Origination : Disabled
|
|
Notes
|
It shows the list of interface addresses, the mode of the interface, designated router on that interface, hello interval, join/prune Interval of the interface.
|
9.1.28 show ip pim neighbor
Displays the router’s PIM neighbors’ information.
show ip pim neighbor [{Vlan vlan-id | interface-type interface-id}]
|
|
Syntax
|
Vlan - VLAN identifier.
interface-type - Interface type.
interface-id - Interface identifier.
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim neighbor vlan 1
Neighbour IfName/Idx Uptime/Expiry Ver DRPri CompId Override LanDelay
Address /Mode Interval
-------- -------- ------------- --- ----- ------ ------- --------
12.0.0.2 vlan1/33 00:00:45/275 v2 1 1 0 0
|
|
Notes
|
It shows the neighbor address, the interface used to reach the PIM neighbor, the up time (the time since this neighbor became the neighbor of the local router), expiry time (the minimum time remaining before this PIM neighbor will be aged out), LAN delay and override interval.
|
9.1.29 show ip pim rp-candidate
Displays the candidate RP information.
show ip pim rp-candidate [ComponentId 1-255]
|
|
Syntax Description
|
ComponentId - Component ID.
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim rp-candidate 2
CompId GroupAddress Group Mask RPAddress/Priority
2 224.1.0.0 255.255.0.0 20.0.0.1/192
|
|
Notes
|
It shows the group addresses, the group mask and the RP address that indicates the IP address of the rendezvous point (RP) for the listed PIM sparse group.
|
9.1.30 show ip pim rp-set
Displays the RP-set information.
show ip pim rp-set [rp-address]
|
|
Syntax Description
|
rp-address - Indicates the IP address of the rendezvous point for the listed PIM sparse group.
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim rp-set
PIM Group-to-RP mappings
---------------------------
Group Address: 224.1.0.0 Group Mask: 255.255.0.0
RP: 20.0.0.1
Component-Id: 2
Hold Time: 120, Expiry Time: 00:01:43
|
|
Notes
|
It shows details of the Group Prefix, RP address, hold time and expiry time.
|
9.1.31 show ip pim bsr
Displays the BSR information.
show ip pim bsr [Component-Id 1-255]
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim bsr 1
PIMv2 Bootstrap Configuration For Component 1
-----------------------------------------------
This system is the Bootstrap Router (BSR)
BSR Address: 10.0.0.1
BSR Priority: 6, Hash Mask Length: 30
|
9.1.32 show ip pim rp-static
Displays the static RP information.
show ip pim rp-static [ComponentId 1-255]
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim rp-static 2
Static-RP Enabled
CompId GroupAddress Group Mask RPAddress
2 225.1.0.0 255.255.0.0 20.0.0.1
|
9.1.33 show ip pim component
Displays the component information.
show ip pim component [ComponentId 1-255]
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim component 1
PIM Component Information
---------------------------
Component-Id: 1
PIM Mode: sparse, PIM Version: 2
Elected BSR: 10.0.0.1
Candidate RP Holdtime: 0
|
9.1.34 show ip pim thresholds
Displays threshold configured for SPT, RP thresholds, and rate limit values for SM (sparse mode).
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim thresholds
PIM SPT Threshold Information
Group Threshold: 0
Source Threshold: 0
Switching Period: 0
PIM SPT-RP Threshold Information
Register Threshold: 0
RP Switching Period: 0
Register Stop rate limit: 5
|
- set ip pim threshold - Specifies the SPT group or source threshold when exceeded, switching to shortest path tree is initiated
- set ip pim spt-switchperiod - Specifies the period (in seconds) over which the data rate is to be monitored for switching to shortest path tree
- set ip pim rp-threshold - Specifies the threshold at which the RP initiates switching to source specific shortest path tree
- set ip pim rp-switchperiod - Specifies the period (in seconds) over which RP monitors register packets for switching to the source specific shortest path tree
- set ip pim regstop-ratelimit-period - Specifies the period over which RP monitors number of register packets after sending the register stop message
- set ip pim pmbr - Enables or disables the PMBR status
- ip pim dr-priority - Sets the designated router priority value configured for the router interface
9.1.35 show ip pim mroute
Displays the PIM multicast information.
show ip pim mroute [{comp-id_1-255 | group-address | source-address} summary]
|
|
Syntax Description
|
comp-id_1-255 - Component identifier.
group-address - Indicates the PIM multicast group address using the listed RP.
source-address - The network address that identifies the sources for which this entry contains multicast routing information.
summary - Summary of PIM mroute information.
|
|
Mode
|
Privileged EXEC
|
|
Example
|
SEFOS# show ip pim mroute
IP Multicast Routing Table
--------------------------
Route Flags S: SPT Bit W: Wild Card Bit R: RPT Bit
IIF State P: Pruned F: Forwarding A: Graft Ack Pending
Timers: Uptime/Expires
Interface State: Interface, State/Mode
|
|
|
PIM Multicast Routing Table For Component 1
(12.0.0.10,227.1.1.1) ,00:00:03/05:43:11
Incoming Interface : vlan1 ,RPF nbr : NULL ,Route Flags : ---
IIF State : P ,SRM Generation : Enabled
Source Active Timer Value 210
Source Active Remaining Time : 05:43:11
State Refresh Remaining Time : 00:00:00
Prune Limit Remaing Time : 00:00:00
Outgoing Interface List : NULL
|
|
|
SEFOS# show ip pim mroute 1 summary
IP Multicast Routing Table
---------------------------
Route Flags S: SPT Bit W: Wild Card Bit R: RPT Bit
Timers : Uptime/Expires
Interface State : Interface, State/Mode
|
|
|
PIM Multicast Routing Table For Component 1
(*, 224,1,0.0) , 00:04:35/--- , RP : 12.0.0.1
Incoming Interface : vlan1, RPF nbr : NULL, Route Flags : WR
Outgoing InterfaceList:
vlan2, Forwarding/Sparse, 00:04:35/---
|
|
|
(12.0.0.30,224.1.0.0) , 00:00:04/00:03:26
Incoming Interface : vlan1, RPF nbr : NULL, Route Flages : S
Outgoing InterfaceList :
vlan2, Forwarding/Sparse , 00:00:04/---
|
|
Notes
|
It shows details of the (S ,G) ,(*,G) and (*,*,RP) entries.
|
| Sun Ethernet Fabric Operating System CLI Enterprise Reference Manual
|
E26514-03
|
|
Copyright © 2013, Oracle and/or its affiliates. All rights reserved.