Multicast Commands
OcNOS multicast protocol modules work with the Multicast Routing Information Base (MRIB).
clear ip mroute
Use this command to delete entries from the IP multicast routing table. This command clears the multicast route entries in the multicast route table and removes the entries from the multicast forwarder. MRIB sends a clear message to the multicast protocols. Each multicast protocol has its own clear multicast route command. The protocol-specific clear command clears multicast routes from the protocol and clears the routes from the MRIB.
Command Syntax
clear ip mroute *
clear ip mroute A.B.C.D
clear ip mroute A.B.C.D A.B.C.D
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 A.B.C.D pim sparse-mode
clear ip mroute A.B.C.D A.B.C.D pim (dense mode| sparse-mode)
clear ip mroute (vrf NAME|) *
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|) 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
clear ip mroute (vrf Name|) A.B.C.D pim sparse-mode
clear ip mroute (vrf Name|) A.B.C.D A.B.C.D pim (dense-mode | sparse-mode)
Parameters
*
All multicast routes.
A.B.C.D
Group IP address.
A.B.C.D
Source IP address.
vrf
VRF name.
statistics
Multicast route statistics.
dense-mode
Dense Mode (PIM-DM).
sparse-mode
sparse Mode (PIM-SM)
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#clear ip mroute vrf VRF_A 225.1.1.1 3.3.3.3
debug ip mrib
Use this command to set debug options for IPv4 multicast.
Use the no parameter with this command to disable debugging IPv4 multicast.
Command Syntax
debug ip mrib (all|event|vif|mrt|stats|fib-msg|register-msg|nsm-msg|mrib-msg|mtrace|mtrace-detail)
debug ip mrib (vrf NAME|)(all|event|vif|mrt|stats|fib-msg|register-msg|nsm-msg|mrib-msg|mtrace|mtrace-detail)
no debug ip mrib (all|event|vif|mrt|stats|fib-msg|register-msg|nsm-msg|mrib-msg|mtrace|mtrace-detail)
no debug ip mrib (vrf NAME|) ((all|event|vif|mrt|stats|fib-msg|register-msg|nsm-msg|mrib-msg|mtrace|mtrace-detail)
Parameters
all
Enable all IPv4 multicast debugging.
event
Enable debugging of multicast events.
fib-msg
Enable debugging of multicast FIB messages
mrib-msg
Enable debugging of multicast MRIB messages
mrt
Enable debugging of multicast route
mtrace
Enable debugging of multicast traceroute
mtrace-detail
Enable detailed debugging of multicast traceroute messages
nsm-msg
Enable debugging of multicast NSM messages
register-msg
Enable debugging of multicast PIM Register messages
stats
Enable debugging of multicast statistics.
vif
Enable debugging of multicast interface
vrf
Specify the VRF name
Command Mode
Exec mode, Privileged Exec mode, and Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#debug ip mrib all
ip mroute
Use this command to create a multicast static route.
Multicast static routes are unicast routes which allow multicast and unicast topologies to be incongruous. These routes are used by multicast routing protocols to perform Reverse Path Forwarding (RPF) checks.
Use the no form of this command to clear a multicast static route.
Command Syntax
ip mroute (vrf NAME|) A.B.C.D/M (static|rip|ospf|bgp|isis|) (A.B.C.D|INTERFACE)
ip mroute (vrf NAME|) A.B.C.D/M (static|rip|ospf|bgp|isis|) (A.B.C.D|INTERFACE) <1-255>
no ip mroute (vrf NAME|) A.B.C.D/M (static|rip|ospf|bgp|isis|)
Parameters
NAME
Virtual Routing and Forwarding name
A.B.C.D/M
Multicast source IP address and mask of the source
static
Static routes.
rip
Routing Information Protocol.
ospf
Open Shortest Patch First protocol.
bgp
Border Gateway Protocol.
isis
Intermediate System to Intermediate System protocol.
A.B.C.D
IP address to use as the RPF address. A host IP address can be a directly connected system or a remote system. For remote systems, a recursive lookup is done from the unicast routing table to find a directly connected system. Recursive lookup is done up to one level.
INTERFACE
Incoming interface name or pseudo interface null. Only specify for non-broadcast interfaces.
<1-255>
Administrative distance for the multicast static route. This value determines whether a unicast route or multicast static route is used for the RPF lookup. Lower distances have preference. If the multicast static route has the same distance as the other RPF sources, the multicast static route takes precedence.
Default
The default administrative distance for the multicast static route is 0.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#ip mroute 10.10.10.50/24 10.10.10.20 1
#configure terminal
(config)#ip mroute vrf VRF_A 10.10.10.50/1 10.10.10.20 1
ip multicast route-limit
Use this command to limit the number of multicast routes that can be added to a multicast routing table. It generates an error message when the limit is exceeded. If the threshold parameter is set, a threshold warning message is generated when this threshold is exceeded and the message continues to occur until the number of mroutes reaches the limit set by the limit argument.
Note: The mroute warning threshold must not exceed the mroute limit.
Use the no parameter with this command to disable this configuration.
Command Syntax
ip multicast route-limit <1-2147483647>
ip multicast route-limit <1-2147483647> <1-2147483647>
ip multicast (vrf NAME|) route-limit <1-2147483647>
ip multicast (vrf NAME|) route-limit <1-2147483647> <1-2147483647>
no ip multicast route-limit
no ip multicast (vrf NAME|) route-limit
Parameters
vrf
VRF name
<1-2147483647>
Number of routes
<1-2147483647>
Threshold at which to generate a warning message
Default
The default limit and threshold value is 2147483647.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip multicast route-limit 34 24
ip multicast ttl-threshold
Use this command to configure the time-to-live (TTL) threshold of packets being forwarded out of an interface. Only multicast packets with a TTL value greater than the threshold are forwarded out of the interface.
Use the no parameter with this command to return to the default TTL threshold.
Command Syntax
ip multicast ttl-threshold <1-255>
no ip multicast ttl-threshold
Parameters
<1-255>
The time-to-live threshold.
Default
The default TTL value is 1.
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#interface eth1
(config-if)#ip multicast ttl-threshold 34
ip multicast-routing
Use this command to turn on/off multicast routing on the router; when turned off, the multicast protocol daemon remains present, but does not perform multicast functions. When multicast routing is enabled, the MRIB re-creates tunnels, and starts processing any VIF addition/deletion requests, MRT addition/deletion requests, and any multicast forwarding events.
Use the no parameter with this command to disable this function. When the no parameter is used, the MRIB releases all VIFs and tunnels, cleans up MRTs, stops IGMPv2 operation and stops relaying multicast forwarder events to multicast protocols.
Command Syntax
ip multicast-routing
ip multicast-routing (vrf NAME|)
no ip multicast-routing
no ip multicast-routing (vrf NAME|)
Parameter
vrf
Specify the VRF name.
Default
By default, multicast routing is disabled.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#configure terminal
(config)#ip multicast-routing
ipv6 mroute
Use this command to create a multicast static route.
Multicast static routes are unicast routes that allow multicast and unicast topologies to be incongruous. These routes are used by multicast routing protocols to perform Reverse Path Forwarding (RPF) checks.
Use the no form of this command to clear a multicast static route.
Command Syntax
ipv6 mroute (vrf NAME|) X:X::X:X/M (static|rip|ospf|bgp|isis|) X:X::X:X INTERFACE
ipv6 mroute (vrf NAME|) X:X::X:X/M (static|rip|ospf|bgp|isis|) (X:X::X:X|INTERFACE)
ipv6 mroute (vrf NAME|) X:X::X:X/M (static|rip|ospf|bgp|isis|) X:X::X:X INTERFACE <1-255>
ipv6 mroute (vrf NAME|) X:X::X:X/M (static|rip|ospf|bgp|isis|) (X:X::X:X|INTERFACE) <1-255>
no ipv6 mroute (vrf NAME|) X:X::X:X/M (static|rip|ospf|bgp|isis|)
Parameters
NAME
Virtual Routing and Forwarding name
X:X::X:X/M
Specify multicast source IP address and mask
static
Static routes.
rip
Routing Information Protocol.
bgp
Border Gateway Protocol.
ospf
Open Shortest Path First.
isis
Intermediate System to Intermediate System.
X:X::X:X
RPF address for the multicast route. A host IP address can be a directly connected system or a remote system. For remote systems, a recursive lookup is done from the unicast routing table to find a directly connected system. Recursive lookup is done up one level.
INTERFACE
Incoming interface name. Can only be specified for non-broadcast interfaces.
<1-255>
Administrative distance for the multicast static route. This value determines whether a unicast route or multicast static route is used for the RPF lookup. Lower distances have preference. If the multicast static route has the same distance as the other RPF sources, the multicast static route takes precedence.
Default
The default administrative distance for the multicast static route is 0.
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#ipv6 mroute 10:10::10:10/64 10:10::10:12 1
show debugging ip mrib
Use this command to display IPv4 multicast debugging information.
Command Syntax
show debugging ip mrib
show debugging ip mrib (vrf NAME|)
Parameters
vrf
Display routes from a VPN Routing/Forwarding instance.
Command Mode
Exec mode and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
The following is a sample output of the show debugging ip mrib command.
#show debugging ip mrib
Debugging status:
MRIBv4 event debugging is on
MRIBv4 VIF debugging is on
MRIBv4 route debugging is on
MRIBv4 route statistics debugging is on
MRIBv4 FIB message debugging is on
MRIBv4 PIM Register message debugging is on
MRIBv4 NSM IPC message debugging is on
MRIBv4 MRIB IPC message debugging is on
MRIBv4 traceroute debugging is on
MRIBv4 traceroute detailed debugging is on
#
show ip mroute
Use this command to display the IP multicast routing (mroute) table. The routing table is based on the pairing of Source Addresses with their respective Destination Multicast Group Address (S, G).
Command Syntax
show ip mroute (dense|sparse|) (count|summary|)
show ip mroute A.B.C.D (dense|sparse|)(count|summary|)
show ip mroute A.B.C.D A.B.C.D (dense|sparse|) (count|summary|)
show ip mroute (vrf NAME|) (dense|sparse|) (count|summary|)
show ip mroute (vrf NAME|) A.B.C.D (dense|sparse|) (count|summary|)
show ip mroute (vrf NAME|) A.B.C.D A.B.C.D (dense|sparse|) (count|summary|)
Parameters
A.B.C.D
Source or Group IP address.
count
Route and packet count data.
summary
Provide abbreviated display.
dense
Show dense multicast routes.
sparse
Show sparse multicast routes.
vrf
Specify the VRF name.
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
The following is a sample output of this command displaying the IP multicast routing table, with and without specifying the group and source IP address:
rtr6#show ip mroute
IP Multicast Routing Table
Flags: I - Immediate Stat, T - Timed Stat, F - Forwarder installed
B - BIDIR
Timers: Uptime/Stat Expiry
Interface State: Interface (TTL)
(172.31.1.52, 224.0.0.13), uptime 00:09:39
Owner PIM, Flags: F
Incoming interface: eth1
Outgoing interface list:
eth2 (1)
The following is a sample output of this command displaying the packet count from the IP multicast routing table:
#show ip mroute count
IP Multicast Statistics
Total 1 routes using 132 bytes memory
Route limit/Route threshold: 2147483647/2147483647
Total NOCACHE/WRONGVIF/WHOLEPKT recv from fwd: 1/0/0
Total NOCACHE/WRONGVIF/WHOLEPKT sent to clients: 1/0/0
Immediate/Timed stat updates sent to clients: 0/0
Reg ACK recv/Reg NACK recv/Reg pkt sent: 0/0/0
Next stats poll: 00:01:10
Forwarding Counts: Pkt count/Byte count, Other Counts: Wrong If pkts
Fwd msg counts: WRONGVIF/WHOLEPKT recv
Client msg counts: WRONGVIF/WHOLEPKT/Imm Stat/Timed Stat sent
Reg pkt counts: Reg ACK recv/Reg NACK recv/Reg pkt sent
(10.10.1.52, 224.0.1.3), Forwarding: 2/19456, Other: 0
Fwd msg: 0/0, Client msg: 0/0/0/0, Reg: 0/0/0
The following is a sample output for this command displaying the IP multicast routing table in an abbreviated form:
#show ip mroute summary
IP Multicast Routing Table
Flags: I - Immediate Stat, T - Timed Stat, F - Forwarder installed
Timers: Uptime/Stat Expiry
Interface State: Interface (TTL)
(10.10.1.52, 224.0.0.13), 00:01:32/00:03:20, PIM-SM, Flags: TF
Table 1: mroute pointers
Pointers | Description |
|---|
I | Immediate statistics |
T | Timed statistics |
F | Forwarder installed |
B | Bidirectional |
Timers | • Uptime – route uptime. • Statistics Expiry –The time the routing table waits before updating statistics. |
Interface State | Interface Time to Live (TTL) |
Table 2: Show ip mroute output
Entry | Description |
|---|
(a.d.c.d, 224.x.x.x) | Source Address paired with its Destination Multicast Group Address |
uptime | As stated. |
Owner | The owner is derived from the multicast group notable address (IANA). In the example above, the owner is specified as PIM because it is using the IANA address: 224.0.0.13. Other owners can be OSPF (224.0.0.5), IS-IS (224.0.0.19–21), and so on. |
Flags | The flags associated with this mroute table entry. |
Incoming interface | The name of the in coming interface (eth1, xe5/2, etc.). |
Outgoing interface list | A numbered list of the outgoing interfaces |
Table 3: Show ip mroute statistics received and sent
Entry | Description |
|---|
NOCACHE | Number of No Cache messages received. |
WRONGVIF | The Virtual Host Interface (VIF) enables the router to send and receive IP multicast packets on several different interfaces at once. This is the count of wrong VIFs received. |
WHOLEPKT | When a source is multicasting a large volume data and the PIM router does not know about the particular Rendezvous Point (RP(G)), the PIM process will constantly receive WHOLEPKT notification from the kernel – this shows the count of such notifications. |
show ip mvif
Use this command to display the MRIB VIF table entries.
The Virtual Host Interface (VIF) used in Pragmatic General Multicast (PGM) or “Reliable Multicast.” The VIF enables the router to send and receive IP multicast packets on several different interfaces at once, as dictated by the multicast routing tables on the router.
Command Syntax
show ip mvif
show ip mvif IFNAME
show ip mvif (vrf NAME|)
show ip mvif (vrf NAME|) IFNAME
Parameters
IFNAME
Specify the interface name.
vrf
Specify the VRF name.
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
The following are sample outputs of this command displaying the contents for the MRIB VIF table, both with and without the interface parameter specified:
#show ip mvif
Interface Vif Owner TTL Local Remote Uptime
Idx Module Address Address
wm0 0 PIM-SM 1 192.168.1.53 0.0.0.0 00:04:26
Register 1 1 192.168.1.53 0.0.0.0 00:04:26
wm1 2 PIM-SM 1 192.168.10.53 0.0.0.0 00:04:25
#show ip mvif wm0
Interface Vif Owner TTL Local Remote Uptime
Idx Module Address Address
wm0 0 PIM-SM 1 192.168.1.53 0.0.0.0 00:05:17
Table 4: Show ip mvif output
Entries | Description |
|---|
Interface | The name of the interface. |
Vif Idx | The VIF Index – the numbering of the entries in the MRIB table. |
Owner | What multicast protocol is being used for an entry. For example, PIM-SM (PIM Sparce Mode). |
TTL | Time to Live for the entry. |
Local Address | AS stated. |
Remote Address | As stated. |
Uptime | How long the multicast interface has been operating. |
show running-config interface multicast
Use this command to show the running system status and configuration for a multicast interface.
Command Syntax
show running-config interface IFNAME ip multicast
Parameters
IFNAME
Interface name.
Command Mode
Privileged exec mode and configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
#show running-config interface eth1 ip multicast
!
interface eth1
!
snmp restart mribd
Use this command to restart SNMP in Multicast Routing Information Base (MRIB)
Command Syntax
snmp restart mribd
Parameters
None
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
#configure terminal
(config)#snmp restart mribd