OcNOS-SP : Multicast Guide : Protocol Independent Multicasting Command Reference : PIMv4 Commands
PIMv4 Commands
The chapter includes the commands that support the Protocol-Independent Multicast (PIM).
ip pim
clear ip mroute
Use this command to delete all multicast route table entries and all multicast routes at the PIM protocol level.
Command Syntax
clear ip mroute *
clear ip mroute * pim (dense-mode|sparse-mode)
clear ip mroute A.B.C.D
clear ip mroute A.B.C.D A.B.C.D
clear ip mroute A.B.C.D A.B.C.D pim (dense-mode|sparse-mode)
clear ip mroute A.B.C.D pim sparse-mode
clear ip mroute statistics *
clear ip mroute statistics A.B.C.D
clear ip mroute statistics A.B.C.D A.B.C.D
clear ip mroute (vrf NAME|) *
clear ip mroute (vrf NAME|) * pim (dense-mode|sparse-mode)
clear ip mroute (vrf NAME|) A.B.C.D
clear ip mroute (vrf NAME|) A.B.C.D A.B.C.D
clear ip mroute (vrf NAME|) A.B.C.D A.B.C.D pim (dense-mode|sparse-mode)
clear ip mroute (vrf NAME|) A.B.C.D pim sparse-mode
clear ip mroute (vrf NAME|) statistics *
clear ip mroute (vrf NAME|) statistics A.B.C.D
clear ip mroute (vrf NAME|) statistics A.B.C.D A.B.C.D
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
*
Delete all multicast routes
pim
Protocol Independent Multicast (PIM)
A.B.C.D
Clears group IP address
A.B.C.D
Clears source IP address
dense-mode
Clears multicast rout table for PIM dense-mode
sparse-mode
Clears multicast route table for PIM sparse mode
statistics
Clears multicast route statistics
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#clear ip mroute * pim sparse-mode
#clear ip mroute 224.2.2.2 4.4.4.4 pim sparse-mode
clear ip msdp peer
Use this command to clear the TCP connection to a Multicast Source Discovery Protocol (MSDP) peer.
This command closes the TCP connection to the peer, resets all the MSDP peer statistics, and clears the input and output queues to and from the MSDP peer.
Command Syntax
clear ip msdp peer (A.B.C.D|)
clear ip msdp (vrf NAME|) peer (A.B.C.D|)
Parameters
A.B.C.D
IPv4 address of peer
NAME
Name of the VPN routing/forwarding instance
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#clear ip msdp peer 192.168.1.26
clear ip msdp sa-cache
Use this command to clear Multicast Source Discovery Protocol (MSDP) Source-Active (SA) cache entries.
Command Syntax
clear ip msdp sa-cache (A.B.C.D |)
clear ip msdp (vrf NAME|) sa-cache (A.B.C.D |)
Parameters
A.B.C.D
Multicast group address; if not specified, all SA cache entries are cleared
NAME
Name of the VPN routing/forwarding instance
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#clear ip msdp sa-cache 225.25.25.1
 
clear ip pim sparse-mode
Use this command to clear all rendezvous point (RP) sets learned through the PIMv2 Bootstrap Router (BSR).
Command Syntax
clear ip pim sparse-mode bsr rp-set *
clear ip pim (vrf NAME|) sparse-mode bsr rp-set *
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
rp-set
PIMv2 bootstrap router RP set
bsr
PIMv2 Bootstrap Router
*
Clear all RP sets
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#clear ip pim sparse-mode bsr rp-set *
debug ip pim
Use this command to enable debugging for PIM.
Use the no option with this command to deactivate debugging for PIM.
Command Syntax
debug ip pim (all|events|mfc|mib|mtrace|msdp|nexthop|nsm|packet|state|timer)
debug ip pim (vrf NAME|)(all|events|mfc|mib|mtrace|msdp|nexthop|nsm|packet|state|timer)
no debug ip pim (all|events|mfc|mib|mtrace|msdp|nexthop|nsm|packet|state|timer)
no debug ip pim (vrf NAME|) (all|events|mfc|mib|mtrace|msdp|nexthop|nsm|packet |state|timer)
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
all
Enable debugging for all PIM events
events
Enable debugging for general configuration, VRF context
mfc
Enable debugging for MFC updates
mib
Enable debugging for MIB entries
mtrace
Enable debugging for MTRACE messages
msdp
Enable debugging for MSDP
nexthop
Enable debugging for Reverse Path Forwarding (RPF) neighbor nexthop cache handling
nsm
Enable debugging for NSM
packet
Enable debugging for PIM packets
state
Enable debugging for PIM states
timer
Enable debugging for PIM timers
Default
By default, all debug options are disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#debug ip pim all
debug ip pim packet
Use this command to activate debugging of incoming or outgoing PIM packets.
Use the no option with this command to deactivate debugging of incoming or outgoing PIM packets.
Command Syntax
debug ip pim packet
debug ip pim packet in
debug ip pim packet out
debug ip pim (vrf NAME|) packet
debug ip pim (vrf NAME|) packet in
debug ip pim (vrf NAME|) packet out
no debug ip pim packet
no debug ip pim packet in
no debug ip pim packet out
no debug ip pim (vrf NAME|) packet
no debug ip pim (vrf NAME|) packet in
no debug ip pim (vrf NAME|) packet out
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
in
Debug incoming packets
out
Debug outgoing packets
Default
By default, all debug options are disabled.
Command Mode
Configure and Exec modes
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#debug ip pim packet in
debug pim bfd
Use this command to print all the PIM BFD session related logs, this command is for all VRF instances and address families (PIMv4 and PIMv6).
Use the no option to disable PIM BFD logging.
Command Syntax
 
debug pim bfd
no debug pim bfd
Parameters
None
Default
By default, PIM BFD logging is disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced in OcNOS version 5.1.
Examples
# terminal
(config)#debug pim bfd
 
debug ip pim timer assert
Use this command to enable debugging of the PIM assert timers.
Use the no option with this command to disable debugging for PIM assert timers.
Command Syntax
debug ip pim timer assert
debug ip pim (vrf NAME|) timer assert
no debug ip pim timer assert
no debug ip pim (vrf NAME|) timer assert
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Default
By default, all debug options are disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3 and updated in OcNOS version 6.2.0.
Example
#debug ip pim timer assert
debug ip pim timer bsr
Use this command to enable debugging of PIM BSR time.
Use the no option with this command to disable debugging of the PIM BSR timer.
Command Syntax
debug ip pim timer bsr
debug ip pim timer bsr bst
debug ip pim timer bsr crp
debug ip pim (vrf NAME|) timer bsr
debug ip pim (vrf NAME|) timer bsr bst
debug ip pim (vrf NAME|) timer bsr crp
no debug ip pim timer bsr
no debug ip pim timer bsr bst
no debug ip pim timer bsr crp
no debug ip pim (vrf NAME|) timer bsr
no debug ip pim (vrf NAME|) timer bsr bst
no debug ip pim (vrf NAME|) timer bsr crp
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
bst
Turn on or turn off the bootstrap debugging timer
crp
Turn on or turn off the Candidate-RP debugging timer
Default
By default, all debug options are disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#debug ip pim timer bsr bst
debug ip pim timer hello
Use this command to enable debugging of various PIM Hello timers.
Use the no option with this command to disable debugging of the PIM Hello timers.
Command Syntax
debug ip pim timer hello
debug ip pim timer hello ht
debug ip pim timer hello nlt
debug ip pim timer hello tht
debug ip pim (vrf NAME|) timer hello
debug ip pim (vrf NAME|) timer hello ht
debug ip pim (vrf NAME|) timer hello nlt
debug ip pim (vrf NAME|) timer hello tht
no debug ip pim timer hello
no debug ip pim timer hello ht
no debug ip pim timer hello nlt
no debug ip pim timer hello tht
no debug ip pim (vrf NAME|) timer hello
no debug ip pim (vrf NAME|) timer hello ht
no debug ip pim (vrf NAME|) timer hello nlt
no debug ip pim (vrf NAME|) timer hello tht
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
ht
Turn on or turn off the PIM Hello debugging timer (ht)
nlt
Turn on or turn off the PIM Neighbor Liveliness debugging timer (nlt)
tht
Turn on or turn off the Triggered Hello Timer (tht)
Default
By default, all debug options are disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#debug ip pim timer hello ht
debug ip pim timer joinprune
Use this command to enable debugging of various PIM JoinPrune timers.
Use the no option with this command to disable the debugging of the PIM JoinPrune timers.
Command Syntax
debug ip pim timer joinprune
debug ip pim timer joinprune et
debug ip pim timer joinprune kat
debug ip pim timer joinprune jt
debug ip pim timer joinprune ot
debug ip pim timer joinprune ppt
debug ip pim (vrf NAME|) timer joinprune
debug ip pim (vrf NAME|) timer joinprune et
debug ip pim (vrf NAME|) timer joinprune kat
debug ip pim (vrf NAME|) timer joinprune jt
debug ip pim (vrf NAME|) timer joinprune ot
debug ip pim (vrf NAME|) timer joinprune ppt
no debug ip pim timer joinprune
no debug ip pim timer joinprune et
no debug ip pim timer joinprune kat
no debug ip pim timer joinprune jt
no debug ip pim timer joinprune ot
no debug ip pim timer joinprune ppt
no debug ip pim (vrf NAME|) timer joinprune
no debug ip pim (vrf NAME|) timer joinprune et
no debug ip pim (vrf NAME|) timer joinprune kat
no debug ip pim (vrf NAME|) timer joinprune jt
no debug ip pim (vrf NAME|) timer joinprune ot
no debug ip pim (vrf NAME|) timer joinprune ppt
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
et
Turn on or turn off the PIM JoinPrune expiry timer (et)
jt
Turn on or turn off the PIM JoinPrune upstream Join Timer (jt)
kat
Turn on or turn off the PIM JoinPrune Keep Alive timer (kat)
ot
Turn on or turn off the PIM JoinPrune Upstream Override Timer (ot)
ppt
Turn on or turn off the PIM JoinPrune PrunePending Timer ((ppt)
Default
By default, all debug options are disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#debug ip pim timer joinprune et
debug ip pim timer register
Use this command to enable the PIM register timer’s debugging.
Use the no option with this command to disable the PIM register timer’s debugging.
Command Syntax
debug ip pim timer register
debug ip pim (vrf NAME|) timer register
no debug ip pim timer register
no debug ip pim (vrf NAME|) timer register
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Default
By default, all debug options are disabled.
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#debug ip pim timer register
 
 
ip msdp default-peer
Use this command to set a Multicast Source Discovery Protocol (MSDP) peer from which to accept Source-Active (SA) messages.
You can have multiple active default peers:
When you enter multiple ip msdp default-peer commands with a prefix-list keyword, all the default peers are used at the same time for different RP prefixes. This form is typically used in a service provider cloud that connects stub site clouds.
When you enter multiple ip msdp default-peer commands without a prefix-list keyword, a single active peer accepts all SA messages. If that peer fails, the next configured default peer accepts all SA messages. This form is typically used at a stub site.
Use the no option with this command to stop accepting SA messages from a peer.
Command Syntax
ip msdp default-peer A.B.C.D (prefix-list WORD|)
ip msdp (vrf NAME|) default-peer A.B.C.D (prefix-list WORD|)
no ip msdp default-peer A.B.C.D
no ip msdp (vrf NAME|) default-peer A.B.C.D
Parameters
A.B.C.D
IPv4 address of a previously configured MSDP peer
prefix-list
Make this the default peer only for an access list of rendezvous points (RPs):
WORD
Access list name
NAME
Name of the VPN routing/forwarding instance
Default
The IPv4 multicast forwarding is disabled by default
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#configure terminal
(config)#ip msdp default-peer 192.168.1.26 prefix-list xyz
ip msdp mesh-group
Use this command to add a Multicast Source Discovery Protocol (MSDP) peer to a mesh group.
You can set up multiple mesh groups on the same device and multiple peers per mesh group.
Use the no option with this command to remove a peer from a mesh group.
Command Syntax
ip msdp mesh-group WORD A.B.C.D
ip msdp (vrf NAME|) mesh-group WORD A.B.C.D
no ip msdp mesh-group WORD A.B.C.D
no ip msdp (vrf NAME|) mesh-group WORD A.B.C.D
Parameters
WORD
Name of the mesh group
A.B.C.D
IPv4 address of peer
NAME
Name of the VPN routing/forwarding instance
Default
The IPv4 multicast forwarding is disabled by default
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#configure terminal
(config)#ip msdp mesh-group mg-1 192.168.1.26
ip msdp originator-id
Use this command to allow a Multicast Source Discovery Protocol (MSDP) speaker that originates a Source-Active (SA) message to use the IP address of an interface as a rendezvous point (RP) address in the SA message.
By default, OcNOS uses the RP address of the device.
Use the no option with this command to use the RP address of the device in SA messages.
Command Syntax
ip msdp originator-id IFNAME
ip msdp (vrf NAME|) originator-id IFNAME
no ip msdp originator-id IFNAME
no ip msdp (vrf NAME|) originator-id IFNAME
Parameters
IFNAME
Use the IP address of this interface as an RP address in SA messages
NAME
Name of the VPN routing/forwarding instance
Default
The RP address is used as the originator ID.
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#configure terminal
(config)#ip msdp originator-id eth2
ip msdp password
Use this command to set an MD5-shared password key used for authenticating a Multicast Source Discovery Protocol (MSDP) peer. By default, no MD5 password is enabled.
Use the no option with this command to remove a password.
Command Syntax
ip msdp password WORD peer A.B.C.D
ip msdp (vrf NAME|) password WORD peer A.B.C.D
no ip msdp password WORD peer A.B.C.D
no ip msdp (vrf NAME|) password WORD peer A.B.C.D
Parameters
WORD
Password
A.B.C.D
IPv4 address of peer
NAME
Name of the VPN routing/forwarding instance
Default
The MD5 password authentication for TCP connections between MSDP peer is disabled.
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#configure terminal
(config)#ip msdp password S#m*u104!! peer 192.168.1.26
ip msdp peer
Use this command to configure an Multicast Source Discovery Protocol (MSDP) peer relationship.
Use the no option with this command to remove a peer relationship.
Command Syntax
ip msdp peer A.B.C.D ((connect-source (IFNAME))|)
ip msdp (vrf NAME|) peer A.B.C.D ((connect-source (IFNAME))|)
ip msdp peer A.B.C.D connect-source A.B.C.D
ip msdp (vrf Name|) peer A.B.C.D connect-source A.B.C.D
no ip msdp peer A.B.C.D
no ip msdp (vrf NAME|) peer A.B.C.D
Parameters
A.B.C.D
IP address of the potential peer
A.B.C.D
IP address of local peer
IFNAME
Use the primary address of this interface for the TCP connection with the peer
NAME
Name of the VPN routing/forwarding instance
Default
By default, all ip msdp options are disabled.
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#configure terminal
(config)#ip msdp peer 192.168.1.26 connect-source eth2
 
 
 
 
 
ip msdp sa
Use this command to configure an msdp source active entry.
Use the no form of this command to remove an msdp source active entry configuration.
Command Syntax
ip msdp (vrf NAME|) sa s A.B.C.D g A.B.C.D r A.B.C.D
no ip msdp (vrf NAME|) sa s A.B.C.D g A.B.C.D
Parameters
NAME
Name of the VPN routing/forwarding instance name
A.B.C.D
IP address of the remote peer
A.B.C.D
IP address of the remote group
A.B.C.D
IP address of the remote RP
Default
By default, all ip msdp options are disabled.
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#configure terminal
(config)#ip msdp sa s 192.0.2.1 g 233.252.0.1 r 192.0.2.2
(config)#no ip msdp sa s 192.0.2.1 g 233.252.0.1
ip pim
Use this command to enable PIM dense-mode or sparse-mode on the current interface.
Use the no option with this command to disable PIM dense-mode or sparse-mode on the interface.
Command Syntax
ip pim (dense-mode|sparse-mode)
no ip pim (dense-mode|sparse-mode)
Parameters
dense-mode
Enable PIM dense-mode operation
sparse-mode
Enable PIM sparse-mode
Default
By default, the ip pim option is disabled.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim dense-mode
 
(config)#interface eth0
(config-if)#no ip pim dense-mode
 
(config)#interface eth0
(config-if)#ip pim sparse-mode
(config-if)#no ip pim sparse-modei
 
p pim accept-register
Use this command to configure the ability to filter out multicast sources specified by the given access-list at the RP, so that the RP will accept/refuse to perform the Register mechanism for the packets sent by the specified sources. By default, the RP accepts Register packets from all multicast sources.
Use the no option with this command to revert to default.
Command Syntax
ip pim accept-register list WORD
ip pim (vrf NAME|) accept-register list WORD
no ip pim accept-register
no ip pim (vrf NAME|) accept-register
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
WORD
Name of a standard access list
Default
By default, all ip pim options are disabled.
 
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip pim accept-register list xyz
 
(config)#no ip pim accept-register
ip pim anycast-rp
Use this command to configure the Anycast RP in the RP set.
Use the no option with this command to remove the configuration.
Command Syntax
ip pim anycast-rp A.B.C.D A.B.C.D
ip pim (vrf NAME|) anycast-rp A.B.C.D A.B.C.D
no ip pim anycast-rp A.B.C.D
no ip pim anycast-rp A.B.C.D A.B.C.D
no ip pim (vrf NAME|) anycast-rp A.B.C.D
no ip pim (vrf NAME|) anycast-rp A.B.C.D A.B.C.D
Parameters
vrf
The VPN routing/forwarding instance.
NAME
Specify the name of the VPN routing/forwarding instance.
A.B.C.D
Unicast IP address of the Anycast RP set. An Anycast RP set is a collection of RPs in the same domain.
A.B.C.D
Destination IP address where Register messages are copied and sent. A Member RP is an individual RP member in the Anycast RP set.
Default
By default, all ip pim options are disabled.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
The following example shows how to configure the Anycast RP in the RP set.
#configure terminal
(config)#ip pim anycast-rp 1.1.1.1 10.10.10.10
The following example shows how to remove the configuration.
#configure terminal
(config)#no ip pim anycast-rp 1.1.1.1 10.10.10.10
 
ip pim bfd
Use this command to enable PIMv4 BFD on an interface.
Use the no option with this command to revert to default.
Command Syntax
ip pim bfd (disable|)
no ip pim bfd
Parameters
disable
Useful when PIMv4 BFD is enabled at global level (refer command ip pim bfd all-interfaces) and it is required to disable pim bfd on a particular interface.
Default
By default, PIMv4 BFD is disabled on the interface.
Command Mode
Interface mode
Applicability
This command was introduced in OcNOS version 5.1.
Examples
#configure terminal
(config)#interface eth0
(config-if))#ip pim bfd
(config-if)#ip pim bfd disable
(config-if)#no ip pim bfd
ip pim bfd all-interfaces
Use this command to enable PIMv4 BFD on all the interfaces of a VRF instance.
Use the no option with this command to revert to default.
Command Syntax
ip pim (vrf NAME|) bfd all-interfaces
no ip pim (vrf NAME|) bfd all-interfaces
Parameters
vrf
The VPN routing/forwarding instance.
NAME
Specify the name of the VPN routing/forwarding instance.
Default
By default, PIMv4 BFD is disabled on all interfaces.
Command Mode
Configure mode
Applicability
This command was introduced in OcNOS version 5.1.
Examples
#configure terminal
(config)#ip pim bfd all-interfaces
(config)#no ip pim bfd all-interfaces
#configure terminal
(config)#ip pim vrf TEST_VRF bfd all-interfaces
 
ip pim bidir-enable
Use this command to enable Bidirectional PIM.
Use the no option with this command to disable Bidirectional PIM.
Command Syntax
ip pim bidir-enable
no ip pim bidir-enable
Parameters
None
Default
By default, bidirectional pim is disabled.
Command Mode
Global mode
Applicability
This command was introduced in OcNOS version 4.0.
Examples
#configure terminal
(config)#ip pim bidir-enable
 
#configure terminal
(config)#no ip pim bidir-enable
 
 
ip pim bidir-offer-interval
Use this command to configure the bidirectional pim designated forwarder (DF) election offer message interval time. Time interval default unit is seconds.
Use the no command to revert the offer interval period configuration to the default value.
Command Syntax
ip pim bidir-offer-interval <1-20000> (msec|)
no ip pim bidir-offer-interval
Parameters
msec
Specify interval time in milliseconds
Default
The default value for interval time is 100 ms.
Command Mode
Global mode
Applicability
This command was introduced in OcNOS version 4.0.
Examples
#configure terminal
(config)#ip pim bidir-offer-interval 123 msec
(config)#no ip pim bidir-offer-interval
 
ip pim bidir-offer-limit
Use this command to configure the number of unanswered offers before the device changes the interface state to the designated forwarder (DF) Winner
Use the no command to reset the offer limit to its default
Command Syntax
ip pim bidir-offer-limit <4-100>
no ip pim bidir-offer-limit
Parameters
<4-100>
Specify the limit of unanswered offers.
Default
The default value is three unanswered offers.
Command Mode
Global mode
Applicability
This command was introduced in OcNOS version 4.0.
Examples
#configure terminal
(config)#ip pim bidir-offer-limit 50
(config)#no ip pim bidir-offer-limit
 
ip pim bidir-neighbor-filter
Use this command to specify which BIDIR neighbors to be considered in DF election.
Use the no form of this command to allow all BIDIR neighbors to take place in DF election.
Command Syntax
ip pim bidir-neighbor-filter WORD
no ip pim bidir-neighbor-filter
Parameters
WORD
Name of an BIDIR peering filter
Default
None
Command Mode
Interface mode
Applicability
This command was introduced in OcNOS version 4.0.
Examples
#configure terminal
(config)#interface eth1
(config-if)#ip pim bidir-neighbor-filter acl1
(config-if)#no ip pim bidir-neighbor-filter
ip pim bind ecmp-bundle
Use this command to bind interfaces to an ECMP bundle.
Use the no option with this command to unbind the interfaces from an ECMP bundle.
Command Syntax
ip pim bind ecmp-bundle WORD
no ip pim bind ecmp-bundle
Parameters
WORD
ECMP bundle name
Default
None
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
(config)#ip pim bind ecmp-bundle ebund1
(config)#commit
(config)#no ip pim bind ecmp-bundle
(config)#commit
ip pim bsr-border
Use this command to prevent bootstrap router (BSR) messages from being sent or received through an interface.
When this command is configured on an interface, no PIM Version 2 BSR messages are sent or received through the interface. Use this command to configure an interface bordering another PIM domain to avoid the exchange of BSR messages 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 a protocol malfunction or loss of isolation between the domains.
Note: This command does not set up multicast boundaries. It only sets up a PIM domain BSR message border.
Use the no option with this command to remove the BSR border configuration.
Command Syntax
ip pim bsr-border
no ip pim bsr-border
Default
By default, the ip pim bsr-border is disabled.
Parameters
None
Default
Bootstrap router border configuration is disabled by default.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
The following example configures the interface to be the PIM domain border:
#configure terminal
(config)#interface eth0
(config-if)#ip pim bsr-border
 
(config)#interface eth0
(config-if)#no ip pim bsr-border
ip pim bsr-candidate
Use this command to give the router the candidate BSR status using the specified IP address of the interface.
Use the no option with this command to disable this function.
Command Syntax
ip pim (vrf NAME|) bsr-candidate IFNAME
ip pim (vrf NAME|) bsr-candidate IFNAME <0-32>
ip pim (vrf NAME|) bsr-candidate IFNAME <0-32> <0-255>
ip pim (vrf NAME|) bsr-candidate IFNAME
no ip pim (vrf NAME|) bsr-candidate
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
IFNAME
Specify the name of the interface
<0-32>
Specify a hash mask length for RP selection
<0-255>
Specify a priority for a BSR candidate
Default
The router is not configured to announce itself as a candidate BSR.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip pim bsr-candidate eth0 20 30
(config)#ip pim bsr-candidate eth1
(config)#no ip pim bsr-candidate
ip pim crp-cisco-prefix
Use this command to turn on or turn the Candidate-RP debugging timer-working with Cisco BSR.
Use the no form of this command to turn off the Candidate-RP debugging timer-working with Cisco BSR.
Command Syntax
ip pim crp-cisco-prefix
no ip pim crp-cisco-prefix
Parameters
crp-cisco-prefix
 
Candidate-RP debugging timer-working with Cisco BSR.
Default
None
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip pim crp-cisco-prefix
(config)#no ip pim crp-cisco-prefix
 
 
ip pim dr-priority
Use this command to set the designated router’s priority value.
Use the no option with this command to remove the priority from the DR.
Command Syntax
ip pim dr-priority <0-4294967294>
no ip pim dr-priority
Parameter
<0-4294967294>
Valid range of values for DR priority, with a higher value resulting in a higher preference
Default
The default DR priority value is 1.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim dr-priority 11234
 
(config)#interface eth0
(config-if)#no ip pim dr-priority
ip pim ecmp-bundle
Use this command to create an ECMP bundle.
Use the no option with this command to delete an ECMP bundle.
Command Syntax
ip pim (vrf NAME|) ecmp-bundle WORD
no ip pim (vrf NAME|) ecmp-bundle WORD
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
WORD
ECMP bundle name
Default
.None
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
(config)#ip pim ecmp-bundle ebund1
(config)#commit
(config)#no ip pim ecmp-bundle ebund1
(config)#commit
ip pim exclude-genid
Use this command to exclude the GenID (generated ID) option from Hello packets sent by the PIM module on an interface. This command is used to inter-operate with older Cisco IOS versions.
Use the no option with this command to restore PIM to its default setting.
Command Syntax
ip pim exclude-genid
no ip pim exclude-genid
Parameters
None
Default
By default, the ip pim exclude-genid command is disabled.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Default
By default, this command is disabled; that is, the GenID option is included.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim exclude-genid
 
(config)#interface eth0
(config-if)#no ip pim exclude-genid
ip pim hello-holdtime
Use this command to configure a hello holdtime other than the default(3.5 * hello_interval seconds).
When configuring hello-holdtime, if the configured value is less than the current hello_interval, it is refused.
When removing a configured hello_holdtime, the value is reset to (3.5 * current hello_interval) value.
Every time the hello_interval is updated, the hello-holdtime is also updated according to rules below:
If the hello_holdtime is not configured, or if the hello_holdtime is configured, but is less than the current hello_interval value, it is modified to (3.5 * hello_interval). Otherwise, the configured value is maintained.
Use the no option with this command to remove the configured hello-holdtime.
Command Syntax
ip pim hello-holdtime <1-65535>
no ip pim hello-holdtime
Parameter
<1-65535>
Range of values for hello-holdtime, in seconds
Default
The default hello-holdtime is 105 seconds.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim hello-holdtime 123
 
(config)#interface eth0
(config-if)#no ip pim hello-holdtime
ip pim hello-interval
Use this command to configure a hello interval value other than the default. When a hello-interval is configured and hello-holdtime is not configured, or when the hello-holdtime value configured is less than the new hello-interval value, the holdtime value is modified to (3.5 * hello_interval). Otherwise, the hello-holdtime value is the configured value.
Use the no option with this command to reset the hello-interval to its default value.
Command Syntax
ip pim hello-interval <1-18724>
no ip pim hello-interval
Parameter
<1-18724>
Range of values for the hello-interval. No fractional values are allowed in seconds.
Default
The default value for hello-interval is 30 seconds.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#interface eth0
(config-if)#ip pim hello-interval 123
 
(config)#interface eth0
(config-if)#no ip pim hello-interval
ip pim ignore-rp-set-priority
Use this command to ignore the RP-SET priority value, and use only the hashing mechanism for RP selection. This command is used to inter-operate with older Cisco IOS versions.
Use the no option with this command to remove this setting.
Command Syntax
ip pim ignore-rp-set-priority
ip pim (vrf NAME|) ignore-rp-set-priority
no ip pim ignore-rp-set-priority
no ip pim (vrf NAME|) ignore-rp-set-priority
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Default
By default, all ip pim options are disabled.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip pim ignore-rp-set-priority
 
#configure terminal
(config)#no ip pim ignore-rp-set-priority
ip pim jp-timer
Use this command to set a PIM join/prune timer.
Use the no option with this command to remove the join/prune timer.
Command Syntax
ip pim (vrf NAME|) jp-timer <1-65535>
no ip pim (vrf NAME|) jp-timer
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
<1-65535>
Range of values for the Join/Prune timer, in seconds
Default
The ip pim jp-timer default value is 60 seconds.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip pim jp-timer 234
 
#configure terminal
(config)#no ip pim jp-timer
ip pim neighbor-filter
Use this command to enable filtering of neighbors on the interface. When configuring a neighbor filter, PIM either not establish adjacency with neighbor or terminates adjacency with existing neighbors, when denied by filtering access list.
Use the no option with this command to disable filtering of neighbors on the interface.
Command Syntax
ip pim neighbor-filter WORD
no ip pim neighbor-filter
Parameters
WORD
Name of an IP standard access list
Default
By default, the ip pim option is disabled.
Command Mode
Interface mode
Default
This command is disabled by default there is no filtering.
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#interface eth0
(config-if)#ip pim neighbor-filter xyz
(config-if)#commit
(config-if)#no ip neighbor-filter
(config-if)#commit
(config-if)#
 
ip pim passive
Use this command to enable or disable passive mode operation for local members on the interface. Passive mode essentially stops PIM transactions on the interface, allowing only the Internet Group Management Protocol (IGMP) mechanism to be active.
Use the no option with this command to disable the passive mode.
Command Syntax
ip pim (dense-mode|sparse-mode) passive
no ip pim (dense-mode|sparse-mode) passive
Parameters
dense-mode
Enable passive operation for PIM dense-mode
sparse-mode
Enable passive operation for PIM sparse-mode
Default
By default, the ip pim option is disabled.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim dense-mode passive
 
(config)#interface eth0
(config-if)#no ip pim dense-mode passive
 
#configure terminal
(config)#interface eth0
(config-if)#ip pim sparse-mode passive
 
(config)#interface eth0
(config-if)#no ip pim sparse-mode passive
ip pim propagation-delay
Use this command to configure a propagation delay value for PIM.
Use the no option with this command to return the propagation delay to its default value.
Command Syntax
ip pim propagation-delay <0-32767>
no ip pim propagation-delay
Parameter
<0-32767>
Range of values for propagation delay, in milliseconds
Default
The default propagation delay is 1000 milliseconds.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim propagation-delay 1000
 
(config)#interface eth0
(config-if)#no ip pim propagation-delay
ip pim redundancy
Use this command to set the priority for which a router is elected as the designated router (DR).
Use the no form of this command to unset the configured priority.
Note: This command should be applied to the all related VRRP routers with identical priority values
Command Syntax
ip pim redundancy <1-255> vrrp dr-priority <0-4294967294>
no ip pim redundancy vrrp
Parameter
<1-255>
VRRP virtual router identifier
<0-4294967294>
DR priority
Default
None.
Command Mode
Interface mode
Applicability
This command was introduced in OcNOS version 4.0.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim redundancy 1 vrrp dr-priority 900
(config)#interface eth0
(config-if)#no ip pim redundancy vrrp
 
ip pim register-rate-limit
Use this command to configure the rate of Register packets sent by this designated router (DR), in number of packets per second.
Use the no option to remove the register-rate-limit configuration.
Note: The configured rate is per (S,G) state, and is not a system-wide rate.
Command Syntax
ip pim (vrf NAME|) register-rate-limit <1-65535>
no ip pim (vrf NAME|) register-rate-limit
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
<1-65535>
Range of values for packets to send per second
Default
No rate limit is set for PIM-SM register packets.
Command mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip pim register-rate-limit 3444
 
#configure terminal
(config)#no ip pim register-rate-limit
ip pim register-rp-reachability
Use this command to enable the RP reachability check for PIM Registers at the DR.
Use the no option to reset to disable the RP reachability check for PIM Registers at the DR.
Command Syntax
ip pim (vrf NAME|) register-rp-reachability (disable|enable)
no ip pim (vrf NAME|) register-rp-reachability
Parameter
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Default
The default setting is checking for rendezvous point reachability,
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip pim register-rp-reachability disable
(config)#no ip register-rp-reachability
(config)#commit
ip pim register-source
Use this command to configure the source address of Register packets sent by this DR, overriding the default source address, which is the address of the RPF interface toward the source host.
Use the no option to remove the source address of register packets sent by this DR, and reset it to use the default source address, that is, the address of the RPF interface toward the source host.
The configured address must be a reachable address so the RP can send corresponding Register-Stop messages in response. This address is usually the loopback interface address, but can also be other physical addresses. The address must be advertised by unicast routing protocols on the DR.
Note: The interface configured does not require PIM to be enabled.
Command Syntax
ip pim (vrf NAME|) register-source (A.B.C.D|IFNAME)
no ip pim (vrf NAME|) register-source
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
A.B.C.D
The IP address to use as the source of the register packets
IFNAME
The name of the interface to use as the source of the register packets
Default
By default, the IP address of the outgoing interface of the DR leading toward the RP is used as the IP source address of a register message.
Command mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#ip pim register-source 3.3.3.2
(config)#no ip register-source
ip pim register-suppression
Use this command to configure the register-suppression time, in seconds, overriding the default value of 60 seconds. Configuring this value modifies register-suppression time at the DR; configuring this value at the RP modifies the RP-keepalive-period value if the ip pim rp-register-kat command is not used.
Use the no option to remove the register-suppression setting.
Command Syntax
ip pim register-suppression <11-65535>
ip pim (vrf NAME|) register-suppression <11-65535>
no ip pim register-suppression
no ip pim (vrf NAME|) register-suppression
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
<11-65535>
Range of values for register suppression time in seconds
Default
By default, the ip pim option is disabled.
Command mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip pim register-suppression 555
 
#configure terminal
(config)#no ip pim register-suppression
ip pim router-id
Use this command to configure PIM router-ID to uniquely identify the router.By default, PIM registers for the NSM router-id service. This command will override the router-id received from NSM.
Use the no option with this command to unconfigure PIM router-ID. This will make PIM fall back to the NSM router-id
Command Syntax
ip pim (vrf NAME|) router-id A.B.C.D
no ip pim (vrf NAME|) router-id
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
A.B.C.D
Specify the Router ID
Default
By default, the ip pim option is disabled.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip pim router-id 1.1.1.1
 
(config)#no ip pim router-id
 
ip pim rp-address
Use this command to statically configure Rendezvous Point (RP) address for multicast groups.
Use the no option to remove the RP address.
OcNOS PIM supports multiple static RPs. It also supports static-RP and Bootsrtrap Router (BSR) mechanism simultaneously. The following list states the correct usage of this command:
If RP-address configured through BSR and RP-address configured statically are both available for a group range, the RP-address configured through BSR is chosen over statically configured RP-address.
One static-RP can be configured for multiple group ranges using Access Lists. However, configuring multiple static RPs (using ip pim rp-address command) with the same RP address is not allowed. The static-RP can either be configured for the whole multicast group range 224/4 (without ACL) or for specific group ranges (using ACL). For example, configuring ip pim rp-address 1.2.3.4 will configure static-RP 1.2.3.4 for the default group range 224/4. Configuring ip pim rp-address 5.6.7.8 grp-list will configure static-RP 5.6.7.8 for all the group ranges represented by Permit filters in grp-list ACL.
If multiple static-RPs are available for a group range, then one with the highest IP address is chosen.
Only permit filters in ACL are considered as valid group ranges. The default Permit filter 0.0.0.0/0 is converted to default multicast filter 224/4.
When selecting static-RPs for a group range, the first element, with the static-RP with highest IP address, is chosen.
Group mode and RP address mappings learned through BSR take precedence over mappings statistically defined by the ip pim rp-address command without the override keyword. Commands with the override keyword take precedence over dynamically learned mappings.
Command Syntax
ip pim (vrf NAME|) rp-address A.B.C.D (override|)
ip pim (vrf NAME|) rp-address A.B.C.D WORD
ip pim (vrf NAME|) rp-address A.B.C.D WORD override bidir
no ip pim (vrf NAME|) rp-address A.B.C.D WORD override bidir
no ip pim (vrf NAME|) rp-address A.B.C.D bidir
no ip pim (vrf NAME|) rp-address A.B.C.D (override|)
no ip pim (vrf NAME|) rp-address A.B.C.D WORD
Parameters
bidir
Bidirectional RP address
 
 
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
WORD
Standard Access-list name
override
Static RP overrides dynamically-learned RP
Default
No PIM static group-to-RP mappings are configured.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#ip pim rp-address 192.168.100.1 override
(config)#ip pim rp-address 3.3.3.3 xyz
(config)#ip pim rp-address 2.2.2.2 ip1 bidir
(config)#ip pim rp-address 192.168.0.1 abc override bidir
(config)#no ip pim rp-address 192.168.0.1 abc override bidir
(config)#no ip pim rp-address 192.168.100.1 override
(config)#no ip pim rp-address 192.168.0.1 bidir
ip pim rp-candidate
Use this command to give the router a candidate RP status using the IP address of the specified interface.
Use the no option along with this command to remove the settings.
Command Syntax
ip pim rp-candidate IFNAME (bidir|) (group-list WORD|) (interval <0-16383>|) (priority <0-255>|)
ip pim (vrf NAME) rp-candidate IFNAME (bidir|) (group-list WORD|) (interval <0-16383>|) (priority <0-255>|)
 
ip pim (vrf NAME|) rp-candidate IFNAME bidir
no ip pim (vrf NAME|) rp-candidate IFNAME bidir
Parameters
vrf NAME
The VPN routing/forwarding instance
IFNAME
Specify an interface name
WORD
A named standard access list
group-list
Group Ranges for this C-RP
interval
C-RP advertisement interval
priority
Candidate-RP priority
<0-16383>
Range of values for candidate-RP advertisement interval, in seconds
<0-255>
Range of values for priority of an RP candidate
Default
The ip pim rp-candidate default priority is 192 and interval is 60 seconds.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip pim rp-candidate eth0
(config)#ip pim rp-candidate eth1 bidir
(config)#no ip pim rp-candidate eth1 bidir
 
ip pim rp-register-kat
Use this command to configure a Keepalive Timer (KAT) value for (S,G) states at RP to monitor PIM register packets, overriding the generic KAT timer value.
Use the no option to remove this configuration.
Command Syntax
ip pim rp-register-kat <1-65535>
ip pim (vrf NAME|) rp-register-kat <1-65535>
no ip pim rp-register-kat
no ip pim (vrf NAME|) rp-register-kat
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
<1-65535>
Range of values for a KAT time in seconds
Default
The ip pim rp-register-kat default is 60 seconds.
Command mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip pim rp-register-kat 3454
 
(config)#no ip pim rp-register-kat
ip pim spt-threshold
Use this command to turn on the ability of the last-hop PIM router to switch to SPT.
Use the no option with this command to turn off the ability of the last-hop PIM router to switch to SPT.
Note: This option is binary, meaning that the switching to SPT happens either at the receiving of the first data packet or not at all. It is not rate-based.
Command Syntax
ip pim spt-threshold
ip pim spt-threshold group-list WORD
ip pim (vrf NAME|) spt-threshold
ip pim (vrf NAME|) spt-threshold group-list WORD
no ip pim spt-threshold
no ip pim spt-threshold group-list WORD
no ip pim (vrf NAME|) spt-threshold
no ip pim (vrf NAME|) spt-threshold group-list WORD
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
group-list
Enable the ability for the last-hop PIM router to switch to SPT for multicast group addresses indicated by the given access-list
WORD
A named standard access list
Default
When this command is not used, the PIM leaf router joins the shortest path tree immediately after the first packet arrives from a new source.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip pim spt-threshold
 
#configure terminal
(config)#ip pim spt-threshold group-list LIST1
(config)#ip access-list permit 224.0.1.3
 
#configure terminal
(config)#no ip pim spt-threshold
ip pim ssm
Use this command to configure Source Specific Multicast (SSM) and define the range of multicast IP addresses. The keyword default defines the SSM range as 232/8. To define an SSM range other than the default, specify an access-list.
When an SSM range of IP multicast addresses is defined with this command, the no (*,G) or (S,G,rpt) state is initiated for groups in the SSM range.
The messages corresponding to these states are not accepted and originate in the SSM range.
Use the no form of this command to disable the SSM range.
Command Syntax
ip pim ssm default
ip pim ssm range WORD
ip pim (vrf NAME|) ssm default
ip pim (vrf NAME|) ssm range WORD
no ip pim ssm
no ip pim (vrf NAME|) ssm
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
default
This keyword defines the 232/8 group range for SSM
range
Define an access-list for group range to use for SSM
WORD
A named standard access list
Default
By default, all ip pim options are disabled.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
The following example shows how to configure SSM service for the IP address range defined by access list 10:
#configure terminal
(config)#access-list 10 permit 225.1.1.1
(config)#ip pim ssm range xyz
ip pim state-refresh origination-interval
Use this command to configure a PIM-DM State-Refresh origination interval other than the default value. The origination interval is the number of seconds between PIM-DM State Refresh control messages.
Use the no option with this command to return the origination interval to its default value.
Command Syntax
ip pim state-refresh origination-interval <1-100>
no ip pim state-refresh origination-interval
Parameter
<1-100>
Range of values for state-refresh origination interval, in seconds
Note: No fractional values are allowed for the interval time.
Default
The default state-refresh origination interval is 60 seconds.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim state-refresh origination-interval 65
 
(config)#interface eth0
(config-if)#no ip pim state-refresh origination-interval
ip pim unicast-bsm
Use this command to enable support for sending and receiving unicast Bootstrap Messages (BSM) on an interface. This command supports backward-compatibility with older versions of the Bootstrap Router specification, which specifies unicast BSM to refresh the state of new or restarting neighbors.
Use the no option with this command to disable unicast bootstrap messaging on an interface.
Command Syntax
ip pim unicast-bsm
no ip pim unicast-bsm
Parameters
None
Default
Unicast bootstrap messaging is disabled by default.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#interface eth0
(config-if)#ip pim unicast-bsm
 
(config)#interface eth0
(config-if)#no ip pim unicast-bsm
show debugging ip pim
Use this command to display the debug status for the PIM process.
Command Syntax
show debugging ip pim
show debugging ip pim (vrf NAME|)
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Command Mode
Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#show debugging ip pim
PIM Debugging status:
PIM event debugging is on
PIM MFC debugging is on
PIM state debugging is on
PIM incoming packet debugging is on
PIM outgoing packet debugging is on
PIM Hello HT timer debugging is on
PIM Hello NLT timer debugging is on
PIM Hello THT timer debugging is on
PIM Join/Prune JT timer debugging is on
PIM Join/Prune ET timer debugging is on
PIM Join/Prune PPT timer debugging is on
PIM Join/Prune KAT timer debugging is on
PIM Join/Prune OT timer debugging is on
PIM Assert AT timer debugging is on
PIM Register RST timer debugging is on
PIM Bootstrap BST timer debugging is on
PIM Bootstrap CRP timer debugging is on
PIM mib debugging is on
PIM nexthop debugging is on
PIM mtrace debugging is on
PIM NSM debugging is on
PIM MSDP debugging is on
show debugging pim
Use this command to display the status of debugging for PIM.
Command Syntax
show debugging pim
Parameters
None
Command Mode
Privileged Exec and Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
This command displays one of several status:
#show debugging pim
PIM Debugging status:
PIM event debugging is on
PIM MFC debugging is on
PIM state debugging is on
PIM incoming packet debugging is on
PIM outgoing packet debugging is on
PIM Hello HT timer debugging is on
PIM Hello NLT timer debugging is on
PIM Hello THT timer debugging is on
PIM Join/Prune JT timer debugging is on
PIM Join/Prune ET timer debugging is on
PIM Join/Prune PPT timer debugging is on
PIM Join/Prune KAT timer debugging is on
PIM Join/Prune OT timer debugging is on
PIM Assert AT timer debugging is on
PIM Register RST timer debugging is on
PIM Bootstrap BST timer debugging is on
PIM Bootstrap CRP timer debugging is on
PIM mib debugging is on
PIM nexthop debugging is on
PIM mtrace debugging is on
PIM NSM debugging is on
PIM MSDP debugging is on
 
show ip msdp peer
Use this command to display information about a Multicast Source Discovery Protocol (MSDP) peer.
Command Syntax
show ip msdp peer (A.B.C.D|)
show ip msdp (vrf NAME|) peer (A.B.C.D|)
Parameters
A.B.C.D
IPv4 address of peer
NAME
Name of the VPN routing/forwarding instance
Command Mode
Privileged Exec and Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#show ip msdp peer
 
MSDP Peer 11.1.1.12
Connection status
State: Up (Established)
Keepalive sent: 1
Keepalive received: 1
Number of connect retries: 0
 
Table 1-18: show ip msdp peer output
Entry
Description
MSDP Peer
IP address of the peer
Connection status
State – Up, Down, Invalid, Disabled, Inactive, Listening, Connecting, Established, or Maximum.
 
Keepalive sent – Keepalive messages sent to peer.
 
Keepalive received – Keepalive messages received from the peer.
 
number of connect retries – Number of peer connect retries.
show ip msdp sa-cache
Use this command to display the (S,G) state learned from Multicast Source Discovery Protocol (MSDP) peers.
You can specify zero, one, or two addresses:
If you do not specify any address, the entire Source-Active (SA) cache is displayed.
If you specify only a unicast address it is treated as a source; if you specify only a multicast address it is treated as a group. In either case, entries corresponding to that address are displayed.
If you specify two addresses, an (S, G) entry corresponding to those addresses is displayed; one address must be unicast and the other address must be multicast.
Command Syntax
show ip msdp sa-cache
show ip msdp sa-cache details
show ip msdp sa-cache A.B.C.D
show ip msdp sa-cache A.B.C.D A.B.C.D
show ip msdp (vrf NAME|) sa-cache
show ip msdp (vrf NAME|) sa-cache details
show ip msdp (vrf NAME|) sa-cache A.B.C.D
show ip msdp (vrf NAME|) sa-cache A.B.C.D A.B.C.D
Parameters
A.B.C.D
Source and/or group IP address
details
Detailed sa-cache information
NAME
Name of the VPN routing/forwarding instance
Command Mode
Privileged Exec and Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
#show ip msdp sa-cache
MSDP Source-Active Cache:
(20.1.1.11, 224.1.1.1), RP 10.1.1.11, RPF-Peer 11.1.1.12 Uptime 00:00:02 Exptime 00:03:28P
 
 
Table 1-19: show ip msdp sa-cache output
Entry
Description
MSDP Source-Active Cache
(S,G) address pair – Source address, multicast address
RP – Reverse Path address
RRF-Peer – Reverse Path Forwarding address
Uptime – as stated
Exptime – Time until entry timeout
show ip pim ecmp-bundle
Use this command to display PIM ECMP bundle information.
Command Syntax
show ip pim ecmp-bundle (WORD|)
Parameters
WORD
Specify the bundle name.
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.2.0.
Examples
#show ip pim ecmp-bundle
Name : dn_str_rtrs_bundle_1
Interface : <ECMP REDIRECT status>
xe7 : allowed
xe8 : allowed
 
show ip pim interface
Use this command to display PIM interface information.
Command Syntax
show ip pim interface
show ip pim interface detail
show ip pim (vrf NAME|) interface
show ip pim (vrf NAME|) interface detail
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
detail
Display detailed information about a PIM interface
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
Router_E#show ip pim interface
Address Interface VIFindex Ver/ Nbr DR DR
Mode Count Prior
192.168.1.10 eth1 0 v2/S 1 1 192.168.1.10
172.16.1.10 eth2 2 v2/S 1 1 172.16.1.10
 
 
The output for PIM ECMP Redirect is as below:
rtr6#show ip pim interface detail
eth1 (vif 0):
Address 192.168.10.57, DR 192.168.10.57
Hello period 30 seconds, Next Hello in 18 seconds
Triggered Hello period 5 seconds
Propagation delay is 1000 milli-seconds
Interface ID: Router-ID:1.1.1.57 Local-ID 3
Neighbors:
192.168.10.52
eth2 (vif 2):
Address 192.168.1.57, DR 192.168.1.152
Hello period 30 seconds, Next Hello in 20 seconds
Triggered Hello period 5 seconds
Propagation delay is 1000 milli-seconds
Interface ID: Router-ID:1.1.1.57 Local-ID 4
ECMP REDIRECT, bundle : ecmpbundle, status : allowed
Neighbors:
192.168.1.149
192.168.1.150
192.168.1.152
Note: For show ip pim (vrf NAME|) interface detail command:
Output shall contain 'Bidirectional Forwarding Detection is enabled' in case PIMv4 BFD is enabled on an interface either by global command or at interface level.
Output shall contain 'Bidirectional Forwarding Detection is disabled' in case PIMv4 BFD is explicitly disabled on an interface.
 
Table 1-20: Show ip pim interface output
Entry
Description
Address
IP address of the interface
Interface
Interface name (eth1, xe3, ge4/1, etc.).
VIFindex
The index number of the Virtual Host Interface (vif).
Ver/Mode
PIM version (either v1, v2, or v3) / PIM Mode – Either S (sparse mode) or D (dense mode).
Nbr Count
Neighbor Count.
DR Prior
Designated Router Priority.
DR
Address of the Designated Router.
Hello Period
Routing devices send hello messages at a fixed interval on all PIM-enabled interfaces. By using hello messages, routing devices advertise their existence as PIM routing devices on the subnet.
Next Hello
When the interval counts down to 0, the routing device sends another hello message, and the timer is reset. A routing device that receives no response from a neighbor in 3.5 times the interval value drops the neighbor.
Propagation Delay
Vif Hello LAN Delay – propagation delay in milliseconds.
ECMP Redirect, bundle
An ECMP bundle is a set of PIM-enabled interfaces on a router, where all interfaces belonging to the same bundle share the same routing metric. The next hops for the ECMP are all one hop away. There can be one or more ECMP bundles on any router, while one individual interface can only belong to a single bundle. ECMP bundles are created on a router via configuration.
Neighbors
A list of the addresses of PIM multicast neighbors.
show ip pim interface df
Use this command to display Bidirectional-PIM Designated Forwarder(DF) election status.
Command Syntax
show ip pim interface (IFNAME|) df (A.B.C.D|)
Parameters
IFNAME
Name of the interface
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 4.0.
Examples
Router# show ip pim interface df
 
Interface RP DF Winner Metric
eth1 10.10.0.2 10.4.0.2 0
10.10.0.3 10.4.0.3 0
10.10.0.5 10.4.0.4 409600
eth2 10.10.0.2 10.5.0.2 0
 
Router# show ip pim interface eth1 df 10.10.0.3
 
Designated Forwarder election for eth1, 10.4.0.2, RP 10.10.0.3
State Non-DF
Offer count is 0
Current DF ip address 10.4.0.3
Last winner metric preference 0
Last winner metric 0
 
show ip pim mroute
Use this command to display information in the IP PIM multicast routing table.
Command Syntax
show ip pim mroute (detail|)
show ip pim mroute A.B.C.D (detail|)
show ip pim mroute A.B.C.D A.B.C.D (detail|)
show ip pim (vrf NAME|) mroute (detail|)
show ip pim (vrf NAME|) mroute A.B.C.D (detail|)
show ip pim (vrf NAME|) mroute A.B.C.D A.B.C.D (detail|)
Parameter
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
A.B.C.D
Display all entries for this group IP address
A.B.C.D
Display all entries for this source IP address
Note: A group IP address and a source IP address cannot be simultaneously
detail
Display detailed PIM multicast routing table information
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#show ip pim mroute
 
IP Multicast Routing Table
 
(*,*,RP) Entries: 0
(*,G) Entries: 1
(S,G) Entries: 0
(S,G,rpt) Entries: 0
(*, 224.0.1.3)
RP: 10.10.1.5
RPF nbr: 172.16.1.2
RPF idx: eth2
Upstream State: JOINED
Local ................................
Joined j...............................
Asserted ................................
Outgoing o...............................
 
Table 1-21: Show ip pim mroute output
Entry
Description
(*, *, RP) Entries:
Source, Group, Rendezvous Point Include entries.
(*, G) Entries:
PIM Include entries
(S, G) Entries:
PIM Include entries (Source, Group)
(S, G, rpt) Entries:
The RPT is the path between the RP and receivers (hosts) in a multicast group. The RPT is built by means of a PIM join message from a receiver's DR.
RP:
Rendezvous Point
RPF nbr:
Reverse Path Forwarding neighbor.
RPF idx:
Reverse Path Forwarding index.
Upstream State:
As stated.
show ip pim neighbor
Use this command to display PIM neighbor information.
Command Syntax
show ip pim neighbor (detail|)
show ip pim neighbor IFNAME (detail|)
show ip pim neighbor IFNAME A.B.C.D (detail|)
show ip pim (vrf NAME|) neighbor (detail|)
show ip pim (vrf NAME|) neighbor IFNAME (detail|)
show ip pim (vrf NAME|) neighbor IFNAME A.B.C.D (default|)
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
IFNAME
Name of the interface
A.B.C.D
IPv4 address of the neighbor interface
detail
Display detailed information for a PIM neighbor
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#show ip pim neighbor
Neighbor Interface Uptime/Expires Ver DR
Address Priority/Mode
10.10.14.11 eth3 00:14:30/00:01:45 v2 1 / DR
 
 
The validation command to view PIM ECMP Redirect is as below:
 
rtr6#show ip pim neighbor detail
Nbr 192.168.10.52 (eth1)
Expires in 83 seconds, uptime 00:21:52
Holdtime: 105 secs, T-bit: off, Lan delay: 1, Override interval: 3
DR priority: 1, Gen ID: 1048865461,
Nbr 192.168.1.149 (eth2)
Expires in 99 seconds, uptime 00:22:06
Holdtime: 105 secs, T-bit: off, Lan delay: 1, Override interval: 3
DR priority: 1, Gen ID: 2102076842,
Interface ID: Router-ID: 1.1.1.149 Local-ID: 4,
ECMP REDIRECT enabled
Nbr 192.168.1.150 (eth2)
Expires in 77 seconds, uptime 00:22:02
Holdtime: 105 secs, T-bit: off, Lan delay: 1, Override interval: 3
DR priority: 1, Gen ID: 1306457151,
Interface ID: Router-ID: 1.1.1.153 Local-ID: 4,
ECMP REDIRECT enabled
Nbr 192.168.1.152 (eth2), DR
Expires in 86 seconds, uptime 00:22:06
Holdtime: 105 secs, T-bit: off, Lan delay: 1, Override interval: 3
DR priority: 1, Gen ID: 170629600,
Interface ID: Router-ID: 1.1.1.152 Local-ID: 4,
ECMP REDIRECT enabled
Note: For show ip pim (vrf NAME|) neighbor detail command:
Output shall contain ‘Bidirectional Forwarding Detection is enabled’ in case PIMv4 BFD detection is enabled for this neighbor.
 
Table 1-22: Show ip pim neighbor output
Entry
Description
Neighbor
Neighbor IP address
Interface
Name of the interface (eth1, xe3, xe5/1 etc.).
Uptime/Expires
Neighbor’s uptime / time until uptime expires and starts sending hello messages.
Ver
PIM version (version1 =v1, version2 - v2, version3 = v3).
DR Priority/mode
Priority and Mode of neighbor as Designated Router.
Nbr
NEighbor IP address and interface name (eth1, xe3, xe5/1 etc.).
Expires in
Time before the Hello timer expires and must retransmit.
uptime
Neighbor uptime.
Holdtime:
Before an interface goes down or changes primary IP address, a Hello message with a zero HoldTime should be sent immediately (with the old IP address if the IP address changed). This will cause PIM neighbors to remove this neighbor (or its old IP address) immediately. After an interface has changed its IP address, it MUST send a Hello message with its new IP address. If an interface changes one of its secondary IP addresses, a Hello message with an updated Address_List option and a non-zero HoldTime should be sent immediately. This will cause PIM neighbors to update this neighbor's list of secondary addresses immediately.
T-bit:
RPT-bit is a 1-bit value. The RPT-bit is set to 1 for Assert(*,G) messages and 0 for Assert(S,G) messages.
Lan delay:
In addition to the information recorded for the DR Election, the following per neighbor information is obtained from the LAN Prune Delay Hello option:
In addition to the information recorded for the DR Election, the following per neighbor information is obtained from the LAN Prune Delay Hello option:
 
neighbor.lan_prune_delay_present
A flag indicating if the LAN Prune Delay option was present in
the Hello message.
 
neighbor.tracking_support
A flag storing the value of the T bit in the LAN Prune Delay
option if it is present in the Hello message. This indicates
the neighbor's capability to disable Join message suppression.
 
neighbor.propagation_delay
The Propagation Delay field of the LAN Prune Delay option (if
present) in the Hello message.
 
neighbor.override_interval
The Override_Interval field of the LAN Prune Delay option (if
present) in the Hello message.
 
The additional state described above is deleted along with the DR neighbor state when the neighbor timeout expires.
 
Override interval:
Hello Override Interval
DR priority:
The DR_Priority Option allows a network administrator to give preference to a particular router in the DR election process by giving it a numerically larger DR Priority.The DR_Priority Option SHOULD be included in every Hello message, even if no DR Priority is explicitly configured on that interface. This is necessary because priority-based DR election is only enabled when all neighbors on an interface advertise that they are capable of using the DR_Priority Option. The default priority is 1.
Gen ID:
Generation Identifier, used to detect reboots.
Interface ID:
As stated.
Router-ID:
As stated.
Local-ID:
As stated.
ECMP REDIRECT
Whether ECMP Redirect is enabled or disabled.
show ip pim nexthop
Displays the nexthop information from NSM as used by PIM.
Command Syntax
show ip pim nexthop
show ip pim (vrf NAME|) nexthop
Parameter
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#show ip pim nexthop
 
show ip pim bsr-router
Use this command to show the bootstrap router PIMv2 address.
Command Syntax
show ip pim bsr-router
show ip pim (vrf NAME|) bsr-router
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Command Mode
Privileged Exec and Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#show ip pim bsr-router
PIMv2 Bootstrap information
BSR address: 10.10.11.35 (?)
Uptime: 00:00:38, BSR Priority: 0, Hash mask length: 10
Expires: 00:01:32
Role: Non-candidate BSR
State: Accept Preferred
 
#show ip pim bsr-router
PIMv2 Bootstrap information
BSR address: 20.0.1.21
Uptime: 00:40:20, BSR Priority: 64, Hash mask length: 10
Expires: 00:02:07
Role: Candidate BSR
State: Candidate BSR
 
Table 1-23: Show ip pim bsr-router output 
Entry
Description
BSR address
Bootstrap Router’s IP address.
Uptime
As stated
BSR Priority
BSR election priority; can be set manually, but default is 64.
Hash mask length
As stated.
Expires
Group-to-C-RP mapping Expiry Timer.
Role
Specifies whether the BSR is the Candidate BSR or a Non-candidate BSR
State
The current state of a Candidate BSR, one of the following: Candidate-BSR, Pending-BSR, or Elected-BSR.
The current state of a Non-candidate BSR, one of the following: Accept Any or Accept Preferred.
 
 
show ip pim local-members
Use this command to display information about local membership for PIM interfaces.
Command Syntax
show ip pim local-members
show ip pim local-members IFNAME
show ip pim (vrf NAME|) local-members
show ip pim (vrf NAME|) local-members IFNAME
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
IFNAME
Display local membership for an interface name
Command Mode
Privileged Exec and Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#show ip pim vrf q local-members p8p1
PIM Local membership information
 
p8p1:
(*, 233.5.5.5) : Include
(*, 233.7.7.7) : Include
 
Table 1-24: Show ip pim local-members output
Entry
Description
NAME:
Interface name
(*,G)
The local members in the form (Source/Group). Shows state – either Include or Exclude.
show ip pim rp-hash
Use this command to display the rendezvous point (RP) to chose based on the group selected.
Command Syntax
show ip pim rp-hash A.B.C.D
show ip pim (vrf NAME|) rp-hash A.B.C.D
Parameters
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
A.B.C.D
Specify a group address
Command Mode
Privileged Exec mode and Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
A.B.C.D in command refers to the group address to be hashed.
#show ip pim rp-hash 224.0.1.3
Group(s): 224.0.0.0/4
RP: 172.16.1.2
Info source: 172.16.1.2, via bootstrap
 
Table 1-25: Show ip PIM rp-hash output
Entry
Description
Group(s)
The group address to be hashed.
RP
Rendezvous Point
Info source
The address and identity from which this information was received. In the example above, it was learned from the bootstrap router.
 
show ip pim rp mapping
Use this command to show group-to-RP (rendezvous point) mappings, and the RP set.
Command Syntax
show ip pim rp mapping
show ip pim (vrf NAME|) rp mapping
Parameter
vrf
The VPN routing/forwarding instance
NAME
Specify the name of the VPN routing/forwarding instance
Command Mode
Privileged Exec mode and Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#show ip pim rp mapping
This system is the Bootstrap Router (v2)
Group(s): 224.0.0.0/4
RP: 10.10.1.5
Info source: 172.16.1.2, via bootstrap, priority 192
Uptime: 00:00:13, expires: 00:02:29
RP: 172.16.1.2
Info source: 172.16.1.2, via bootstrap, priority 2
Uptime: 00:34:42, expires: 00:01:49
 
Table 1-26: Show ip PIM rp mapping output
Entry
Description
Identity declaration
This system is the Bootstrap Router (PIM version number v1, v2. or, v3) or not the Bootstrap Router.
Group(s):
The Multicast address of this multicast Group.
RP
Addresses of the Rendezvous Points.
Info source:
Address of the info source, whether it was learned from the Bootstrap Router, and the configured priority.
snmp restart pim
Use this command to restart SNMP in (PIM).
Note: This command restarts IPv4 PIM daemon
Command Syntax
snmp restart pim
Parameters
None
Default
By default, the snmp restart pim is disabled.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#snmp restart pim