Command Line Reference
IP Multicast
PIM Configuration
37 min
show ip pim group type show ip pim group type \[command] show ip pim group type \[json] \[purpose] show the current multicast group address range for the pim ssm model \[view] system view \[use cases] sonic# show ip pim group type ssm group range 232 0 0 0/8 sonic# show ip pim group type json { "ssmgroups" "232 0 0 0\\/8" } show ip pim group type show ip pim group type \[command] show ip pim group type \[ group addres s ] \[purpose] show the pim mode of the multicast address \[parameter] parameter description group address multicast address \[view] system view \[use cases] sonic# show ip pim group type 224 1 1 1 group type asm sonic# show ip pim group type 232 1 1 1 group type ssm show ip pim interface show ip pim interface \[command] show ip pim interface \[ interface name | json | detail ] \[purpose] show the status information of the pim interface \[parameter] parameter description interface name interface name \[view] system view \[use cases] sonic# show ip pim interface interface state address pim nbrs pim dr fhr ifchannels ethernet49 up 20 1 1 2 1 local 0 0 loopback0 up 120 1 1 122 0 local 0 0 vlan1000 up 123 1 1 1 0 local 0 3 vlan4000 up 20 1 2 2 1 local 0 0 pimreg up 0 0 0 0 0 local 0 0 show ip pim interface traffic show ip pim interface traffic \[command] show ip pim interface traffic \[ interface name | json ] \[purpose] show the statistics of pim packets sent and received on the interface \[parameter] parameter description interface name interface name \[view] system view \[use cases] sonic# show ip pim interface traffic interface hello join prune register register stop assert bsm rx/tx rx/tx rx/tx rx/tx rx/tx rx/tx rx/tx \ ethernet49 2554/2558 0/1075 0/2 0/0 0/0 0/0 0/0 loopback0 0/3511 0/0 0/0 0/0 0/0 0/0 0/0 vlan1000 0/3511 0/0 0/0 0/0 0/0 0/0 0/0 vlan4000 2640/2643 0/30 0/17 0/0 0/0 0/0 0/0 show ip pim join show ip pim join \[command] show ip pim join \[ group1 address | group1 address group2 address | json ] \[purpose] show the multicast group information joined via pim join \[parameter] parameter description group1 address multicast address, when group2 address is specified, the value is the multicast group source address group2 address multicast address \[view] system view \[notes] if group1 address is specified, the display will be filtered to show only that multicast group address if group2 address is also specified, group1 address will be treated as the source (s) in the (s, g) entry, and group2 address will be treated as the group (g) for filtered display a state of join indicates that the entry was generated by a pim join message a state of noinfo indicates that the entry was not generated by locally received pim join messages this can be cross referenced with the ' show ip pim local membership ' command to determine whether the entry was generated by locally received igmp messages \[use cases] sonic# show ip pim join interface address source group state uptime expire prune vlan1000 123 1 1 1 12 1 1 1 225 1 3 1 noinfo vlan1000 123 1 1 1 12 1 1 1 225 1 3 2 noinfo vlan1000 123 1 1 1 12 1 1 1 225 1 3 3 noinfo sonic# sonic# show ip pim join 225 1 3 1 interface address source group state uptime expire prune vlan1000 123 1 1 1 12 1 1 1 225 1 3 1 noinfo sonic# sonic# show ip pim join 12 1 1 1 225 1 3 2 interface address source group state uptime expire prune vlan1000 123 1 1 1 12 1 1 1 225 1 3 2 noinfo show ip pim local membership show ip pim local membership \[command] show ip pim local membership \[json] \[purpose] show the local relationships of pim entries \[view] system view \[notes] a status of include indicates that the entry was generated by locally received igmp messages a status of noinfo indicates that the entry was not generated by locally received igmp messages in this case, you can use the ' show ip pim join ' command to check whether the entry was generated by pim join messages \[use cases] sonic# show ip pim local membership interface address source group membership vlan1000 123 1 1 1 12 1 1 1 225 1 3 1 include vlan1000 123 1 1 1 12 1 1 1 225 1 3 2 include vlan1000 123 1 1 1 12 1 1 1 225 1 3 3 include show ip pim neighbor show ip pim neighbor \[command] show ip pim neighbor \[ interface name | details | json ] \[purpose] show the neighbor relationships of the pim interface \[parameter] parameter description interface name interface name \[view] system view \[use cases] sonic# show ip pim neighbor interface neighbor uptime holdtime dr pri ethernet49 20 1 1 1 22 18 17 00 01 29 1 vlan4000 20 1 2 1 23 02 19 00 01 29 1 show ip pim rp info show ip pim rp info \[command] show ip pim rp info \[json] \[purpose] show rp information \[view] system view \[use cases] sonic# show ip pim rp info rp address group/prefix list oif i am rp source 120 1 1 159 225 1 0 0/16 vlan4000 no static show ip pim rpf show ip pim rpf \[command] show ip pim rpf \[json] \[purpose] show rpf interface information \[view] system view \[use cases] sonic# show ip pim rpf rpf cache refresh delay 50 msecs rpf cache refresh timer 0 msecs rpf cache refresh requests 50 rpf cache refresh events 48 rpf cache refresh last 22 32 33 nexthop lookups 813 nexthop lookups avoided 0 source group rpfiface rpfaddress ribnexthop metric pref 12 1 1 1 225 1 3 1 ethernet49 20 1 1 1 20 1 1 1 0 1 12 1 1 1 225 1 3 2 ethernet49 20 1 1 1 20 1 1 1 0 1 12 1 1 1 225 1 3 3 ethernet49 20 1 1 1 20 1 1 1 0 1 show ip pim upstream show ip pim upstream \[command] show ip pim upstream \[ group1 address | group1 address group2 address | json ] \[purpose] show the upstream interface status information of the (s, g) entry \[parameter] parameter description group1 address multicast address, when group2 address is specified, the value is the multicast group source address group2 address multicast address \[view] system view \[notes] if group1 address is specified, the display will be filtered to show only that multicast group address if group2 address is also specified, group1 address will be treated as the source (s) in the (s, g) entry, and group2 address will be treated as the group (g) for filtered display \[use cases] sonic# show ip pim upstream iif source group state uptime jointimer rstimer katimer refcnt ethernet49 12 1 1 1 225 1 3 1 j 02 18 47 00 00 12 1 ethernet49 12 1 1 1 225 1 3 2 j 02 18 47 00 00 12 1 ethernet49 12 1 1 1 225 1 3 3 j 02 18 47 00 00 12 1 show ip mroute show ip mroute \[command] show ip mroute \[ vrf { vrf name | all }] \[ fill | summary | json ] \[purpose] show the multicast routing table entries on the device \[parameter] parameter description vrf name vrf name fill view all fields of multicast group entries without hiding any information summary view the count of multicast routing entries \[view] system view \[use cases] sonic# show ip mroute ip multicast routing table flags s sparse, c connected, p pruned r sgrpt pruned, f register flag, t spt bit set source group flags proto input output ttl uptime 12 1 1 1 225 1 3 1 sct igmp ethernet49 vlan1000 1 02 34 14 12 1 1 1 225 1 3 2 sc igmp ethernet49 vlan1000 1 02 34 14 12 1 1 1 225 1 3 3 sct igmp ethernet49 vlan1000 1 02 34 14 120 1 1 122 224 1 0 2 static loopback0 ethernet49 1 23 09 17 show counters mroute show counters mroute \[command] show counters mroute \[ configured pattern source address group address ] \[ vrf vrf name ] \[purpose] show the statistics of multicast routing \[parameter] parameter description vrf name vrf name source address the source of multicast address group address multicast address \[view] system view \[use cases] sonic(config)# do show counters mroute mroute pattern vrf matched mroutes packets \ 120 1 1 122/32|224 1 1 123/32 default 120 1 1 122,224 1 1 123 0 counter mroute enable counter mroute enable \[command] counter mroute enable no counter mroute enable \[purpose] globally enable the multicast routing statistics function \[view] system configuration view \[use cases] sonic(config)# counter mroute enable counter mroute pattern counter mroute pattern \[command] counter mroute pattern source address group address vrf vrf name no counter mroute pattern source address group address vrf vrf name \[purpose] enable the statistics function for multicast routing entries \[parameter] parameter description vrf name vrf name source address the source of multicast address group address multicast address \[view] system configuration view \[use cases] sonic(config)# counter mroute pattern 1 1 1 0/24 224 1 1 1/32 vrf default counter mroute poll interval counter mroute poll interval \[command] counter mroute poll interval interval no counter mroute poll interval interval \[purpose] configure the statistics update interval for multicast routing entries \[parameter] parameter description interval value range 1000 30000, unit\ ms, default 10000 \[view] system configuration view \[use cases] sonic(config)# counter mroute poll interval 1000 ip pim rp ip pim rp \[command] ip pim rp a b c d \[ a b c d/m | prefix list prefix name ] no ip pim rp a b c d \[ a b c d/m | prefix list prefix name ] \[purpose] statically configure the multicast rp address \[parameter] parameter description a b c d rp address a b c d/m the multicast address range covered by the rp prefix name prefix list name configure a prefix list to covere the rp corresponding to multicast groups \[view] system configuration view \[use cases] sonic(config)# ip pim rp 120 1 1 159 225 1 0 0/16 ip pim join prune interval ip pim join prune interval \[command] ip pim join prune interval interval no ip pim join prune interval interval \[purpose] configure the join/prune interval \[parameter] parameter description interval value range 1 65535, unit\ second, default 60s \[view] system configuration view \[notes] the default join/prune interval is 60 seconds the default aging cycle for pim entries is 3 5 times the join/prune interval, which is 210 seconds \[use cases] sonic(config)# ip pim rp 120 1 1 159 225 1 0 0/16 ip pim register accept list ip pim register accept list \[command] ip pim register accept list prefix name no ip pim register accept list prefix name \[purpose] when pim receives a registration packet, the source address of the packet will be compared against the specified prefix list if the comparison passes, the packet will continue to be processed normally if the source address of the registration packet is denied (rejected), a register stop message will be sent to the source \[parameter] parameter description prefix name name \[view] system configuration view \[use cases] sonic(config)# ip pim register accept list test ip pim register suppress time ip pim register suppress time \[command] ip pim register suppress time interval no ip pim register suppress time interval \[purpose] configure the source registration suppression timer when the timer expires, the rp will send a register stop message to the source's dr \[parameter] parameter description interval value range 1 65535, unit\ second, default 60s \[view] system configuration view \[use cases] sonic(config)# ip pim register suppress time 60 clear ip mroute clear ip mroute \[command] clear ip mroute \[ vrf vrf name | count ] \[purpose] clear dynamically generated mroute entries / clear the statistics of mroute entries \[parameter] parameter description vrf name vrf name \[view] system configuration view \[use cases] sonic# clear ip mroute ip pim ip pim \[command] ip pim \[ hello interval |drpriority priority |use source a b c d ] no ip pim \[ hello interval |drpriority priority |use source a b c d ] \[purpose] enable the pim function on the layer 3 interface \[parameter] parameter description interval value range 1 65535, default 30 priority value rangel 1 65535, default 1 a b c d specify the source ip address for pim hello packet \[view] interface view,vlanif view,lagif view,loopback view \[use cases] sonic(config vlanif 1000)# ip pim multicast enable multicast enable \[command] multicast enable no multicast enable \[purpose] enable multicast routing and forwarding on the layer 3 interface \[view] interface view,vlanif view,lagif view,loopback view \[use cases] sonic(config vlanif 1000)# multicast enable ip mroute ip mroute \[command] ip mroute {ethernet interface id |vlan vlan id | link aggregation lag id } a b c d \[ source address ] no ip mroute {ethernet interface id |vlan vlan id |link aggregation lag id } a b c d \[ source address ] \[purpose] configure static mroute entries \[parameter] parameter description interface id specify the interface id as the outbound interface for the mroute vlan id specify the vlan id as the outbound interface for the mroute lag id specify the lag id as the outbound interface for the mroute a b c d multicast address source address the source of multicast address \[view] interface view,vlanif view,lagif view,loopback view \[notes] when configuring static multicast routing entries, ensure that both the inbound and outbound interfaces have pim enabled \[use cases] sonic(config vlanif 1000)# ip mroute ethernet 1 224 1 1 1 120 1 1 122 unknown multicast trap unknown multicast trap \[command] unknown multicast trap no unknown multicast trap \[purpose] configure unknown multicast packets to be sent to the cpu \[view] system configuration view \[use cases] sonic(config)# unknown multicast trap ip igmp host proxy ip igmp host proxy \[command] ip igmp host proxy no ip igmp host proxy \[purpose] enabling this function under the interface allows the layer 3 multicast routing table entries to be converted into igmp report messages as a response \[view] interface view,vlanif view,lagif view \[use cases] sonic(config)# interface vlan 1000 sonic(config vlanif 1000)# ip igmp host proxy
