accounting per-prefix

To enable accounting for multicast routing, use the accounting per-prefix command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

accountingper-prefix

noaccountingper-prefix

Syntax Description

This command has no keywords or arguments.

Command Default

This feature is disabled by default.

Command Modes

Multicast routing configuration

Multicast routing address family IPv4 configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The accounting per-prefix command is used to enable per-prefix counters only in hardware. Cisco IOS XR Software counters are always present. When enabled, every existing and new (S, G) route is assigned forward, punt, and drop counters on the ingress route and forward and punt counters on the egress route. The (*, G) routes are assigned a single counter.

There are a limited number of counters on all nodes. When a command is enabled, counters are assigned to routes only if they are available.

To display packet statistics, use the show mfib route and the show mfib hardware route statistics commands. These commands display “N/A” for counters when no hardware statistics are available or whenthe accounting per-prefix command is disabled .

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable accounting for multicast routing:

accounting per-prefix forward-only

To reduce hardware statistics resource allocations when enabling accounting, particularly for multicast VPN (MVPN), use the accounting per-prefix forward-only command under multicast routing configuration mode. To return to the default mode of accounting per-prefix, use the no form of this command.

accountingper-prefixforward-only

noaccountingper-prefixforward-only

Syntax Description

This command has no keywords or arguments.

Command Default

If no counters were configured, there is no default.

If the accounting per-prefix counter was previously configured, it becomes the default.

If no accounting was configured for multicast routing, forwarding-only is the default mode and triggers a data MDT transition in the case of MVPN deployment.

Command Modes

Multicast routing configuration

Multicast routing address family IPv4 and IPv6 configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.8.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Note

The accounting per-prefix forward-only command has only one fwd-only counter. In other words, there is no punt or drop counter allocated.

We recommended this command for configuration of multicast VPN routing or for any line card that has a route-intensive configuration. Each individual router can support up to 150,000 routes.

There are a limited number of counters on all nodes. When accounting on a prefix is enabled, counters are assigned to routes only if they are available.

To display packet statistics, use the show mfib route and the show mfib hardware route statistics commands. These commands display “N/A” for counters when no hardware statistics are available or when neither the accounting per-prefix command nor the accounting per-prefix forward-only command are enabled.

You may switch between accounting-perprefix and accounting per-prefix forward-only statistics for ipv4 or ipv6 multicast family. However, be aware that only one set of counters is supported on the (*,G) routes (with fwd/punt/drop on ingress and fwd/drop on egress) regardless of whether you enabled the accounting-perprefix or accounting-perprefix fwd-only command.

Although you can switch accounting modes, this involves freeing the hardware statistics and reallocating them, thereby resulting in a loss of any previously collected data. Therefore, it is preferable to decide which statistics mode you want to use at the start to avoid the resource cost entailed by resetting the statistics counter values with a change in mode.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable accounting per-prefix forward-only for MVPN routing:

Related Commands

address-family (multicast)

To display available IP prefixes to enable multicast routing and forwarding on all router interfaces, use the address-family command in multicast-routing configuration mode or multicast VRF configuration submode. To disable use of an IP address prefix for routing, use the no form of this command.

address-family
[ vrfvrf-name ]
{ ipv4 | ipv6 }

noaddress-family
[ vrfvrf-name ]
{ ipv4 | ipv6 }

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

Specifies IPv4 address prefixes.

ipv6

Specifies IPv6 address prefixes.

Command Default

No default behavior or values

Command Modes

Multicast routing configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Release 4.2.0

The ipv6 keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the address-family command either from multicast routing configuration mode or from multicast VRF configuration submode to enter either the multicast IPv4 or IPv6 address family configuration submode, depending on which keyword was chosen. Use the address-family command with the multicast-routingcommand to start the following multicast processes:

Multicast Routing Information Base (MRIB)

Multicast Forwarding Engine (MFWD)

Protocol Independent Multicast Sparse mode (PIM-SM)

Internet Group Management Protocol (IGMP)

Multicast Listener Discovery Protocol (MLD)

Basic multicast services start automatically when the multicast PIE is installed, without any explicit configuration required. The following multicast services are started automatically:

Multicast Routing Information Base (MRIB)

Multicast Forwarding Engine (MFWD)

Protocol Independent Multicast Sparse mode (PIM-SM)

Internet Group Management Protocol (IGMP)

Other multicast services require explicit configuration before they start. For example, to start the Multicast Source Discovery Protocol (MSDP) process, you must enter the router msdp command and explicitly configure it.

To enable multicast routing and protocols on interfaces, you must explicitly enable the interfaces using the interface command in multicast routing configuration mode. This action can be performed on individual interfaces or by configuring a wildcard interface using the alias command.

To enable multicast routing on all interfaces, use the interface all enable command in multicast routing configuration mode. For any interface to be fully enabled for multicast routing, it must be enabled specifically (or configured through the interface all enable command for all interfaces) in multicast routing configuration mode, and it must not be disabled in the PIM and IGMP configuration modes.

Note

The enable and disable keywords available under the IGMP and PIM interface configuration modes have no effect unless the interface is enabled in multicast routing configuration mode—either by default or by explicit interface configuration.

To allow multicast forwarding functionality, while turning multicast routing functionality off, interface-inheritance disable command on a per interface or interface all enable basis in PIM or IGMP configuration mode.

address-family ipv4 mvpn (bgp)

To enable Border Gateway Protocol (BGP) on a specific IPV4 unicast destination address prefix, use the address-family ipv4 mvpn command in the BGP sub-configuration mode. To disable this feature, use the no form of this command.

Command Default

Command Modes

Multicast routing configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Release 4.2.0

The ipv6 keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the address-family command either from multicast routing configuration mode or from multicast VRF configuration submode to enter either the multicast IPv4 or IPv6 address family configuration submode, depending on which keyword was chosen. Use the address-family command with the multicast-routingcommand to start the following multicast processes:

Multicast Routing Information Base (MRIB)

Multicast Forwarding Engine (MFWD)

Protocol Independent Multicast Sparse mode (PIM-SM)

Internet Group Management Protocol (IGMP)

Multicast Listener Discovery Protocol (MLD)

Basic multicast services start automatically when the multicast PIE is installed, without any explicit configuration required. The following multicast services are started automatically:

Multicast Routing Information Base (MRIB)

Multicast Forwarding Engine (MFWD)

Protocol Independent Multicast Sparse mode (PIM-SM)

Internet Group Management Protocol (IGMP)

Other multicast services require explicit configuration before they start. For example, to start the Multicast Source Discovery Protocol (MSDP) process, you must enter the router msdp command and explicitly configure it.

To enable multicast routing and protocols on interfaces, you must explicitly enable the interfaces using the interface command in multicast routing configuration mode. This action can be performed on individual interfaces or by configuring a wildcard interface using the alias command.

To enable multicast routing on all interfaces, use the interface all enable command in multicast routing configuration mode. For any interface to be fully enabled for multicast routing, it must be enabled specifically (or configured through the interface all enable command for all interfaces) in multicast routing configuration mode, and it must not be disabled in the PIM and IGMP configuration modes.

Note

The enable and disable keywords available under the IGMP and PIM interface configuration modes have no effect unless the interface is enabled in multicast routing configuration mode—either by default or by explicit interface configuration.

To allow multicast forwarding functionality, while turning multicast routing functionality off, interface-inheritance disable command on a per interface or interface all enable basis in PIM or IGMP configuration mode.

Syntax Description

Command Default

No default behavior or values

Command Modes

BGP MVPN address-family sub configuration mode

Command History

Release

Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operation

multicast

read, write

Examples

boundary

To configure the multicast boundary on an interface for administratively scoped multicast addresses, use the boundary command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

boundaryaccess-list

noboundaryaccess-list

Syntax Description

access-list

Access list specifying scoped multicast groups. The name cannot contain a space or quotation mark; it may contain numbers.

Command Default

A multicast boundary is not configured.

Command Modes

Multicast routing interface configuration

Multicast routing VRF interface configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The boundary command is used to set up a boundary to keep multicast packets from being forwarded.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to set up a boundary for all administratively scoped addresses:

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Syntax Description

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read, write, execute

Examples

The following example shows how to clear the Multicast Forwarding Information Base (MFIB) database on all nodes:

RP/0/RSP0/CPU0:router# clear mfib database location all

clear mfib hardware adjacency-counters

To clear the platform-specific information related to resource counters for the Multicast Forwarding Information Base, use the clear mfib hardware adjacency-counters command in EXEC mode.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 4.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the clear mfib hardware resource-counters to estimate resource usage for an operation.

Task ID

Task ID

Operations

multicast

read, write, execute

Examples

The following example shows how to clear all global resource counters:

Syntax Description

(Optional) Clears hardware statistics on both the incoming (ingress) and outgoing (egress) routes.

*

(Optional) Clears shared tree route statistics.

source-address

(Optional) IP address or hostname of the multicast route source.

group-address

(Optional) IP address or hostname of the multicast group.

/prefix-length

(Optional) Prefix length of the multicast group. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value.

location

(Optional) Clears route packet counters from the designated node.

node-id

The node-id argument is entered in the rack/slot/module notation.

all

The all keyword clears route packet counters on all nodes

Command Default

If not specified, IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs.

The Multicast Forwarding (MFWD) process exists on each line card and assigns hardware counters to each (S, G) route. Additionally, one global counter is assigned for all (*, G) routes, depending on resource availability.

To clear the set of counters for (*, G) routes, the MFWD process assigns a single set of counters to count packets that match (*, G) routes. Consequently, the clear mfib hardware route statistics command must be used in a form that either clears counters on all routes or matches all (*, G) routes.

disable (multicast)

To disable multicast routing and forwarding on an interface, use the disable command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

disable

nodisable

Syntax Description

This command has no keywords or arguments.

Command Default

Multicast routing and forwarding settings are inherited from the global interface enable all command. Otherwise, multicast routing and forwarding is disabled.

Command Modes

Multicast routing interface configuration

Multicast routing VRF interface configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The disable command modifies the behavior of a specific interface to disabled. This command is useful if you want to disable multicast routing on specific interfaces, but leave it enabled on all remaining interfaces.

The following guidelines apply when the enable and disable commands (and the no forms) are used in conjunction with the interface all enable command:

If the interface all enable command is configured:

The enable and no forms of the command have no additional effect on a specific interface.

The disable command disables multicast routing on a specific interface.

The no disable command enables a previously disabled interface.

If the interface all enable command is not configured:

The enable command enables multicast routing on a specific interface.

The no enable command enables the previously disabled interface.

The disable and no forms of the command have no additional effect on a specific interface.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable multicast routing on all interfaces and disable the feature only on GigabitEthernet interface 0/1/0/0:

Related Commands

Enables multicast routing and forwarding on all new and existing interfaces.

enable (multicast)

To enable multicast routing and forwarding on an interface, use the enable command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

enable

noenable

Syntax Description

This command has no keywords or arguments.

Command Default

Multicast routing and forwarding settings are inherited from the global interface enable all command. Otherwise, multicast routing and forwarding is disabled.

Command Modes

Multicast routing interface configuration

Multicast routing VRF interface configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The enable command modifies the behavior of a specific interface to enabled. This command is useful if you want to enable multicast routing on specific interfaces, but leave it disabled on all remaining interfaces.

The following guidelines apply when the enable and disable commands (and the no forms) are used in conjunction with the interface all enable command:

If the interface all enable command is configured:

The enable and no forms of the command have no additional effect on a specific interface.

The disable command disables multicast routing on a specific interface.

The no disable command enables a previously disabled interface.

If the interface all enable command is not configured:

The enable command enables multicast routing on a specific interface.

The no enable command enables a previously enabled interface.

The disable and no forms of the command have no additional effect on a specific interface.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable multicast routing on a specific interface only:

Related Commands

Enables multicast routing and forwarding on all new and existing interfaces.

forwarding-latency

To delay traffic being forwarded on a route, use the forwarding-latency command. To return to the default behavior, use the no form of this command.

forwarding-latency
[ delaymilliseconds ]

noforwarding-latency

Syntax Description

delaymilliseconds

(Optional) Specifies the delay time in miliseconds. Range is 5 - 500.

Command Default

The default delay time is 30 milliseconds.

Command Modes

Multicast routing configuration

IPv4 and IPv6 multicast routing configuration

Command History

Release

Modification

Release 3.8.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the forwarding-latency command when you expect a receiver to leave and rejoin the same multicast group within a very short period such as 20 or 30 milliseconds. The delay may be required to provide the router sufficient time to update its Multicast Forwarding Information Base (MFIB) table.

When the forwarding-latency command is enabled, each interface is allocated a separate table lookup unit (TLU) block in the output interface list (olist), thereby increasing TLU hardware resource usage, and, for this reason, it should be used with caution when many multicast routes are present.

When the forwarding-latency command is disabled, up to three interfaces may share a single TLU block in the olist.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to delay traffic from being forwarded for 120 milliseconds:

interface (multicast)

To configure multicast interface properties, use the interface command in the appropriate configuration mode. To disable multicast routing for interfaces, use the no form of this command.

interfacetypeinterface-path-id

nointerfacetypeinterface-path-id

Syntax Description

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note

Use the showinterfaces command in EXEC mode to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

No default behavior or values

Command Modes

Multicast routing configuration

IPv4 or multicast routing configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the interface command to configure multicast routing properties for specific interfaces.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable multicast routing on all interfaces and disable the feature only on GigabitEthernet interface 0/1/0/0:

Related Commands

Enables multicast routing and forwarding on all new and existing interfaces.

interface all enable

To enable multicast routing and forwarding on all new and existing interfaces, use the interface all enable command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

interfaceallenable

nointerfaceallenable

Syntax Description

This command has no keywords or arguments.

Command Default

Multicast routing and forwarding is disabled by default.

Command Modes

Multicast routing configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

This command modifies the default behavior for all new and existing interfaces to enabled unless overridden by the enable or disable keywords available in interface configuration mode.

The following guidelines apply when the enable and disable commands (and the no forms) are used in conjunction with the interface all enable command:

If the interface all enable command is configured:

The enable and no forms of the command have no additional effect on a specific interface.

The disable command disables multicast routing on a specific interface.

The no disable command enables a previously disabled interface.

If the interface all enable command is not configured:

The enable command enables multicast routing on a specific interface.

The no enable command enables a previously enabled interface.

The disable and no forms of the command have no additional effect on a specific interface.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable multicast routing on all interfaces and disable the feature only on GigabitEthernet interface 0/1/0/0:

Related Commands

interface-inheritance disable

To separate PIM and IGMP routing from multicast forwarding on all interfaces, use the interface-inheritance disable command under multicast routing address-family IPv4 submode. To restore the default functionality, use the no form of the command.

interface-inheritancedisable

nointerface-inheritancedisable

Syntax Description

This command has no keywords or arguments.

Command Default

This feature is not enabled by default.

Command Modes

Multicast routing configuration

Address- family IPv4 configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use of the interface-inheritance disable command together with the interfacetype interface-path-id or interfaceallenable command under multicast routing address-family IPv4 submode separates PIM and IGMP routing functionality from multicast forwarding on specified interfaces. You can nonetheless enable multicast routing functionality explicitly under PIM or IGMP routing configuration mode for individual interfaces.

Note

Although you can explicitly configure multicast routing functionality on individual interfaces, you cannot explicitly disable the functionality. You can only disable the functionality on all interfaces.

Used from the address-family ipv4 configuration submode, it prevents IGMP and PIM from inheriting the multicast-routing interface configuration.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following configuration disables PIM and IGMP routing functionality on all the interfaces using the interface-inheritance disable command, but multicast forwarding is still enabled on all the interfaces in the example, based on use of the keywords interface all enable.

PIM is enabled on Loopback 0 based on its explicit configuration (interfaceLoopback0enable) under router pim configuration mode.

IGMP protocol is enabled on GigabitEthernet0/6/0/3, because it too has been configured explicitly under router igmp configuration mode (interfaceGigabitEthernet0/6/0/3router enable):

log-traps

To enable logging of trap events, use the log-traps command in the appropriate configuration mode. To remove this functionality, use the no form of this command.

log-traps

nolog-traps

Syntax Description

This command has no keywords or arguments.

Command Default

This command is disabled by default.

Command Modes

Multicast routing configuration

Multicast routing address family IPv4 configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Examples

maximum disable

To disable maximum state limits, use the maximum disable command in the appropriate configuration mode. To remove this functionality, use the no form of this command.

maximumdisable

nomaximumdisable

Syntax Description

This command has no keywords or arguments.

Command Default

Maximum state limits are enabled.

Command Modes

Multicast routing configuration

Multicast routing address family IPv4 configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the maximum disable command to override the default software limit on the number of multicast routes.

Task ID

Task ID

Operations

multicast

read, write

Examples

mdt data

To configure multicast data to be part of a multicast distribution tree (MDT) data group for multicast VPN (MVPN), use the mdt data command in the appropriate configuration mode. To remove this functionality, use the no form of this command.

Command History

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When certain multicast streams exceed a configured bandwidth, the multicast data is moved to an MDT data group that is dynamically chosen from an available pool of multicast addresses. If the traffic bandwidth falls below the threshold, the source is switched back to the default MDT. To avoid transitions between the MDTs, traffic only reverts to the default MDT if traffic below the data MDT threshold is at least one minute old.

mdt default

To configure the default group address of the multicast VPN (MVPN) multicast distribution tree (MDT), use the mdt default command in the appropriate configuration mode. To remove this functionality, use the no form of this command.

mdtdefault
{ mdt-default-group-address | ipv4mdt-default-address }

nomdtdefault
{ mdt-default-group-address | ipv4mdt-default-address }

Syntax Description

mdt-default-group-address

IP address of the MDT default group entered in A.B.C.D. format.

ipv4

Specifies IPv4-encapsulated MDT.

mdt-default-address

MDT IPv4 default address entered in A.B.C.D. format

Command Default

The MDT default group address must be unique.

Command Modes

Multicast routing configuration

Multicast routing address family IPv4 and IPv6 configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.5.0

This command was introduced.

Release 3.7.0

Additional keyword information was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The default MDT has a unique group address used to create MVPN multicast tunnel interfaces.

Although within the multicast VRF configuration submode, the MDT configuration uses either the ipv4 or ipv6 keyword to distinguish the appropriate multicast VPN, the MDT core tree is IPv4.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to configure the MDT default group address from multicast routing configuration mode:

mdt mtu

To configure the maximum transmission unit (MTU) configuration of the multicast VPN (MVPN) multicast distribution tree (MDT), use the mdt mtu command in multicast VPN configuration mode. To remove this functionality, use the no form of this command.

mdtmtuvalue

nomdtmtuvalue

Syntax Description

value

Specifies the MTU value and ranges between 401 to 65535. The configured mdt mtu value includes 24 bytes of GRE encapsulation.

Command Default

The MDT tunnel default size is 1376.

Command Modes

Multicast VRF configuration

Command History

Release

Modification

Release 3.5.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to configure the MTU of the multicast distribution tree:

mdt source

To configure the interface used to set the multicast VPN (MVPN) data multicast distribution tree (MDT) source address, use the mdt source command in the appropriate configuration mode. To remove this functionality, use the no form of this command.

mdtsourcetypeinterface-path-id

nomdtsourcetypeinterface-path-id

Syntax Description

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note

Use the showinterfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

No default behavior or values

Command Modes

Multicast routing configuration

Multicast routing address family IPv4 configuration

Multicast VRF configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the mdt source command to identify the root of the multicast distribution tree in the service provider network. This address is used to update all MVPN peers through multiprotocol BGP.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to configure the interface used to set the MDT source address:

Per VRF MDT Source is a new feature introduced in IOS XR Software Release 3.9.0 apart from the existing default MDT source. Each VRF can have its own MDT source interface co-existing with the default MDT source to achieve core diversity.

mhost default-interface

To configure the default interface for IP multicast transmission and reception to and from the host stack, use the mhost default-interface command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

mhostipv4default-interfacetypeinterface-path-id

nomhostipv4default-interfacetypeinterface-path-id

Syntax Description

ipv4

Specifies IPv4 address prefixes.

ipv6

Specifies IPv6 address prefixes.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note

Use the showinterfaces command in EXEC mode to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

If no Multicast Host (MHost) default interface is configured, an arbitrary interface is selected as the active MHost default.

If multicast routing feature is enabled, a multicast-enabled interface is always selected as the MHost default interface.

Command Modes

Global configuration

Global VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The mhost default-interface command configures the interface that the automatic route processing (Auto-RP), ping, and mtrace applications use for multicast transmissions, and the interface to which multicast groups are joined for reception.

The ping and mtrace features may use the MHost default interface to process multicast messaging. When IP multicast routing is enabled, packets sent to the MHost default interface are switched on other interfaces with a matching forwarding state. In addition, an arbitrary interface may be chosen to be the active MHost default interface if the configured interface is not operational. If no MHost default interface is configured with this command, an arbitrary interface is selected as the active MHost default.

Note

The MHost default interface must be configured explicitly (preferably use a loopback interface).

If the MHost default interface is not configured explicitly, then the router picks an interface.

If the router picked multicast interface happens to be an ASBR link (on an ASBR router) and if that interface is configured with multicast boundary, then it may not work as intended beacuse there is an IC (Internal Copy) flag on the interface and it has to accept all multicast packets on the interface.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to configure Loopback interface 1 as the default interface:

Related Commands

multicast-routing

To enter multicast routing configuration mode, use the multicast-routing command in global configuration mode. To return to the default behavior, use the no form of this command.

multicast-routing

nomulticast-routing

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enter multicast routing configuration mode:

Related Commands

Enables multicast routing and forwarding on all new and existing interfaces.

multipath

To enable Protocol Independent Multicast (PIM) to divide the multicast load among several equal cost paths, use the multipath command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

[ address-familyipv4 ]
multipath
[ hash
{ source | sourcenext-hop } ]

nomultipath

Syntax Description

hash

(Optional) Enables multipath hashing.

source

Enables source-based multipath hashing.

source-nexthop

(Optional) Enables source with next-hop hashing.

Note

This option is available only for IPv6 addressing.

Command Default

This command is disabled by default.

Command Modes

Multicast routing configuration

Multicast routing address-family ipv4

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

By default, equal-cost multipath (ECMP) paths are not load balanced. A single path from each unicast route is used for all multicast routes (which is the equivalent of the no form of the multipath command).

Examples

next-hop-self

To disable the next hop calculation for a neighbor, use the next-hop-self command in the BGP neighbor address-family configuration mode. To disable this feature, use the no form of this command.

next-hop-self[ inheritance-disable ]

Syntax Description

inheritance-disable

(Optional) Prevents next-hop-self from being inherited from the parent.

Command Default

No default behavior or values

Command Modes

BGP Neighbor Address-family Configuration mode

Command History

Release

Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operation

multicast

read, write

Examples

nsf (multicast)

To turn on the nonstop forwarding (NSF) capability for the multicast routing system, use the nsf command in multicast routing configuration mode. To turn off this function, use the no form of this command.

nsf
[ lifetimeseconds ]

nonsf [lifetime]

Syntax Description

lifetimeseconds

(Optional) Specifies the maximum time (in seconds) for NSF mode. Range is 30 to 3600.

Command Default

This command is disabled by default.

Command Modes

Multicast routing configuration

Multicast routing address family ipv4 configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The nsf command does not enable or disable the multicast routing system, but just the NSF capability for all the relevant components. When the no form of this command is used, the NSF configuration is returned to its default disabled state.

Enable multicast NSF when you require enhanced availability of multicast forwarding. When enabled, failures of the control-plane multicast routing components Multicast Routing Information Base (MRIB) or Protocol Independent Multicast (PIM) will not cause multicast forwarding to stop. When these components fail or communication with the control plane is otherwise disrupted, existing Multicast Forwarding Information Base (MFIB) entries continue to forward packets until either the control plane recovers or the MFIB NSF timeout expires.

Enable multicast NSF when you upgrade control-plane Cisco IOS XR Software packages so that the live upgrade process does not interrupt forwarding.

When the MFIB partner processes enter NSF mode, forwarding on stale (nonupdated) MFIB entries continues as the control-plane components attempt to recover gracefully. Successful NSF recovery is signaled to the Multicast Forwarding Engine (MFWD) partner processes by MRIB. MRIB remains in NSF mode until Internet Group Management Protocol (IGMP) has recovered state from the network and host stack and until PIM has recovered state from the network and IGMP. When both PIM and IGMP have recovered and fully updated the MRIB, MRIB signals the MFIBs that NSF is ending, and begins updating the stale MFIB entries. When all updates have been sent, the MFWD partner processes delete all remaining stale MFIB entries and returns to normal operation, ending the NSF mode. MFIB NSF timeout prior to the signal from MRIB may cause NSF to end, and thus forwarding to stop.

When forwarding is in NSF mode, multicast flows may continue longer than necessary when network conditions change due to multicast routing protocols, unicast routing protocol reachability information, or local sender and receiver changes. The MFWD partner processes halt forwarding on stale MFIB entries when the potential for a multicast loop is detected by receipt of incoming data on a forwarding interface for the matching MFIB entry.

Note

For NSF to operate successfully in your multicast network, you must also enable NSF for the unicast protocols (such as Intermediate System-to-Intermediate System [IS-IS], Open Shortest Path First [OSPF] and Border Gateway Protocol [BGP]) that PIM relies on for Reverse Path Forwarding (RPF) information. See the appropriate configuration modules to learn how to configure NSF for unicast protocols.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable NSF for the multicast routing system:

oom-handling

To enable the out-of-memory (OOM) functionality on multicast routing software components, use the oom-handling command in multicast routing configuration mode. To remove this functionality, use the no form of this command.

oom-handling

nooom-handling

Syntax Description

This command has no keywords or arguments.

Command Default

This command is disabled by default.

Command Modes

Multicast routing configuration

Multicast routing address family ipv4 configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When the oom-handling command is enabled, and the router memory is low or in a warning state, the following states are not created:

Related Commands

rate-per-route

To enable individual (source, group [S, G]) rate calculations, use the rate-per-route command in the appropriate configuration mode. To remove this functionality, use the no form of this command.

rate-per-route

norate-per-route

Syntax Description

This command has no keywords or arguments.

Command Default

This command is disabled by default.

Command Modes

Multicast routing configuration

Multicast routing address family ipv4 configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to enable individual route calculations:

Related Commands

recursive-fec

To enable the MLDP Recursive FEC support, use the recursive-fec command in the MPLS LDP MLDP sub configuration mode.

recursive-fec

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values

Command Modes

MPLS LDP MLDP sub configuration mode

Command History

Release

Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Examples

retain route-target all

To accept or retain updates containing at least one route target for the specified bgp parameters, use the retain route-target all command in the BGP Address-family configuration mode. To disable this feature, use the no form of this command.

retainroute-targetall

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values

Command Modes

BGP Address-family Configuration mode

Command History

Release

Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

route-policy

To apply route policy to a neighbor, either to inbound routes or outbound routes, use the route-policy command in the BGP neighbor address-family configuration mode. To disable this feature, use the no form of this command.

route-policypolicy_name[ in| out]

Syntax Description

policy-name

Specifies the name of the route policy.

in

Applies route policy to inbound routes.

out

Applies route policy to outbound routes.

Command Default

No default behavior or values

Command Modes

BGP Neighbor Address-family Configuration mode

Command History

Release

Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

show mfib connections

To display the status of Multicast Forwarding Information Base (MFIB) connections to servers, use the show mfib connections command in EXEC mode.

showmfibipv4connections
[ locationnode-id ]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes.

locationnode-id

(Optional) Specifies MFIB connections associated with an interface of the designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show mfib connections command to display a list of servers connected to the MFIB and the status of the connections.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib connections command:

show mfib counter

To display Multicast Forwarding Information Base (MFIB) counter statistics for packets that have dropped, use the show mfib counter command in EXEC mode.

showmfib
[ vrfvrf-name ]
ipv4counter
[ locationnode-id ]

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

locationnode-id

(Optional) Specifies MFIB counter statistics associated with an interface of the designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mfib counter command displays packet drop statistics for packets that cannot be accounted for under route counters.

show mfib encap-info

To display the status of encapsulation information for Multicast Forwarding Information Base (MFIB), use the show mfib encap-info command in EXEC mode.

showmfib
[ vrfvrf-name ]
ipv4encap-info
[ locationnode-id ]

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

ipv6

(Optional) Specifies IPv6 address prefixes.

locationnode-id

(Optional) Specifies MFIB connections associated with an interface of the designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Syntax Description

(Optional) Interface type. For more information, use the question mark (?) online help function.

interface-path-id

(Optional) Physical interface or virtual interface.

Note

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

locationnode-id

(Optional) Specifies an MFIB-designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mfib hardware interface command displays multicast-specific information about the software switching interfaces of the router hardware. This command will not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib hardware interface command.

(Optional) Displays the traces in the reverse order starting with the latest events.

stats

(Optional) Displays the statistics.

tailf

(Optional) Displays the new traces as they are added.

unique

(Optional) Displays the unique entries with the counts.

verbose

(Optional) Displays the internal debugging information.

wrapping

(Optional) Displays the wrapping entries.

filefile-name

(Optional) Specifies the file name.

locationnode-id

Specifies an MFIB-designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 4.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Note

This command will not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib hardware ltrace command:

show mfib hardware resource-counters

To display the allocated and freed hardware resources for the Multicast Forwarding Information Base (MFIB) process, use the show mfib hardware resource-counters command in EXEC mode.

showmfib
[ vrfvrf-name ]
ipv4hardwareresource-counterslocationnode-id

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

locationnode-id

Specifies an MFIB-designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show mfib hardware resource-counters command to understand the table lookup unit (TLU) resource usage by MFIB.

Usage for each channel

Storing of specific data

Allocation counts for metro statistics

Failure counts for metro statistics

Note

Use the location option in the show mfib hardware resource-counters command to indicate for which linecard you need information. The command will not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following is a sample output from the show mfib hardware resource-counters command on the Cisco ASR 9000 Series SIP-700 line card:

(Optional) Prefix length of the multicast group. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value.

detail

(Optional) Detailed list of the routing database.

locationnode-id

(Optional) Specifies an MFIB-designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Note

The command does not display any useful output if only RSP is specified or if no location is specified.

Syntax Description

*

(Optional) Displays shared tree entries.

A.B.C.D

(Optional) Source IP address or hostname of the MFIB route.

A.B.C.D/length

(Optional) Group IP address or hostname of the MFIB route and the prefix length. Prefix length of the MFIB group address is a decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value.

detail

(Optional) Details of each route (requires 140 columns).

locationnode-id

(Optional) Specifies the MFIB location.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.9.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Note

The command does not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following example shows a sample output of the show mfib hardware route internal command:

show mfib hardware route mofrr

To display the platform-specific Multicast Forwarding Information Base (MFIB) information for the MoFRR (multicast only fast reroute)- enabled list stored in the hardware, use the show mfib hardware route mofrr command in EXEC mode.

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 3.9.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

MoFRR is a mechanism in which two copies of the same multicast stream flow through disjoint paths in the network. At the point in the network (usually the PE closer to the receivers) where the two streams merge, one of the streams is accepted and forwarded on the downstream links, while the other stream is discarded. When a failure is detected in the primary stream due to a link or node failure in the network, MoFRR instructs the forwarding plane to start accepting packets from the backup stream (which now becomes the primary stream).

MoFRR is triggered when the hardware detects traffic loss on the primary path of a given flow or route. Traffic loss is defined as no data packet having been received for 30 ms. When MoFRR is triggered, the primary and secondary reverse-path forwarding (RPF) interfaces are exposed to the forwarding plane and switchover occurs entirely at the hardware level.

The show mfib hardware route mofrr command displays the output MoFRR route list of the platform. If there is no MoFRR route enabled in the platform, then the output result is “There are no MoFRR routes configured”.

The command does not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following is a sample output from the show mfib hardware route mofrr command:

Monitoring state. It has three states. MS=0, indicates that the monitoring state disabled. MS=1, indicates that active RPF is monitoring traffic activity. MS=2, indicates that active RPF is monitoring traffic loss.

WDI

Watchdog Count Index. Each MoFRR route has two Line card specific watchdog indexes, associated with primary and backup RPF, respectively.

OIFS

Output Interfaces in the local line card.

Sequence num

MoFRR specific route sequence number.

Num of switchovers

Total number of switchovers triggered by traffic loss detection in the data plane.

Watchdog Counters

Internal Hardware watchdog counters

MoFRR Statistics

Internal software watchdog counters

If there is no MoFRR route enabled in the platform, the output result will be as follows:

(Optional) Prefix length of the multicast group. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value.

locationnode-id

Specifies an MFIB-designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mfib hardware route olist command displays the output interface list (olist) for each route. The Multicast Forwarding (MFWD) process stores olist interfaces in a table lookup unit (TLU) block (in groups of three). As such, the command displays each route three times. The command does not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib hardware route olist command. (The output fields are described in the header.)

(Optional) Prefix length of the multicast group. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value.

detail

(Optional) Displays a detailed list of the routing database.

locationnode-id

(Optional) Specifies an MFIB-designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show mfib hardware route statistics command to display the hardware packet and byte counter for a route. Route counters are kept for (S, G) routes only. A single set of counters is provided for all

(*, G) routes.

This command displays the hardware packet and bytes count on a per-route basis. Per-route hardware counters are kept for (S, G) routes only. However, counters are managed dynamically and allocated on a priority basis and may not be available for each (S, G) route. There is a single set of counters for all

Syntax Description

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show mfib hardware summary command to display hardware information for the route of the node.

The longest-prefix match route is displayed depending on the provided source and group addresses. The command does not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib hardware route summary command:

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.9.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Note

The command does not display any useful output if only RSP is specified or if no location is specified.

Task ID

Task ID

Operations

multicast

read

Examples

The following example shows a sample output of the show mfib hardware table command:

(Optional) Specifies a list of routes associated with the interface. This option is available if an interface type and instance are specified.

locationnode-id

(Optional) Specifies packet statistics associated with an interface of the designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mfib interface command displays counters for the number of packets and bytes that are handled by software switching. Counters for packets processed by hardware are displayed by the appropriate show mfib hardware command.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib interface command for the multicast route on node 0/2/CPU0 that is associated with the Gigabit Ethernet interface 0/2/0/2:

Related Commands

show mfib nsf

To display the state of a nonstop forwarding (NSF) operation for the Multicast Forwarding Information Base (MFIB) line cards, use the show mfib nsf command in EXEC mode.

showmfib
[ ipv4 ]
nsf
[ locationnode-id ]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes.

locationnode-id

(Optional) Specifies the MFIB NSF designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mfib nsf command displays the current multicast NSF state for the MFIB process contained on all line cards and route processors (RPs) in the router.

For multicast NSF, the state may be one of the following:

Normal—Normal operation: The MFIBs in the card contain only up-to-date MFIB entries.

Boot Card Booting—Card is initializing and has not yet determined its NSF state.

Not Forwarding—Multicast Forwarding Disabled: Multicast routing failed to recover from a failure-induced NSF state prior to the MFIB NSF timeout.

Non-stop Forwarding Activated—Multicast NSF active: The router is operating in NSF mode while attempting to recover from a control-plane failure. In this mode, data is forwarded based on MFIB entries that are either updated by the recovered Multicast Routing Information Base (MRIB), or MFIB entries that were marked stale when NSF mode began. The times remaining until multicast NSF and multicast-unicast NSF expiration are displayed.

MFIB NSF status of each node in the system: booting, normal, not forwarding, or activated.

NSF Time Remaining

If MSB NSF is activated, the time remaining until NSF fails and all routes are deleted displays. Before timeout, MRIB signals that NSF (in the control plane) is finished and new, updated routes are populated in the MFIB (which makes the transition to Normal status).

(Optional) Group IP prefix length of the multicast group. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). Format is: A.B.C.D/length

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

ipv6

(Optional) Specifies IPv6 address prefixes.

detail

(Optional) Specifies detailed route information.

locationnode-id

(Optional) Specifies an MFIB-designated node.

rate

(Optional) Displays individual (S, G) rates.

sources-only

(Optional) Restricts display of any shared-tree entries.

summary

(Optional) Displays a brief list of the routing database.

tech-support

(Optional) Displays technical support information.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

All entries in the MFIB table are derived from the Multicast Routing Information Base (MRIB). The flags have the same connotation as in the MRIB. The flags determine the forwarding and signaling behavior according to a set of forwarding rules for multicast packets. In addition to the list of interfaces and flags, each route entry shows various counters. Byte count is the number of total bytes forwarded. Packet count is the number of packets received for this entry.

The show mfib counter command displays global counters independent of the routes.

This command displays counters for the number of packets and bytes that are handled by software switching. Counters for packets processed by hardware are displayed by the appropriate show mfib hardware command.

The command displays the cumulative rates per route for all line cards in the Multicast Forwarding Information Base (MFIB) table when the rate keyword is used with the source and group IP addresses.

The show mfib route rate command is not supported on interfaces such as bundle virtual interfaces and Bridge Group virtual interfaces (BVIs).

The command displays the rate per route for one line card in Multicast Forwarding Information Base (MFIB) table when the statistics keyword is used.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mfib route command with the location keyword specified (the output fields are described in the header):

The following is sample output from the show mfib route command with the statistics and location keywords specified. If the hardware counters show N/A, it means no hardware statistic blocks were assigned to the route. However, routes may show that both hardware and software statistic blocks are assigned. The output fields are described in the header.

The detail option illustrates the MoFRR state of each MoFRR route. At any moment, only one RPF forwards the traffic to the egress. The inactive state means the primary RPF forwards the traffic to the egress. The active state means that the backup RPF forwards the traffic to the egress. The sequence number reflects the number of switchovers of the MoFRR route.

(Optional) Specifies MFIB connections associated with an interface of the designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Child routes shows the number of extranet routes in receiver VRFs that reference this source VRF.

Default MDT Encap

Default MDT encapsulation.

Default MDT Handle

Default MDT interface handle for this VRF.

MDT Master LC

Field contains "Y" if this line card is a master line card for this VRF.

Loopback (Encap Src)

Loopback (encapsulation source).

Local EG intf cnt

Shows the number of local egress interfaces for this VRF and location.

Data MDT

Routes for which multicast data for a multicast distribution tree (MDT) was triggered.

show mhost default-interface

To display the active default interface for the Multicast Host (MHost) process, use the show mhost default-interface command in EXEC mode.

showmhostipv4default-interface

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes.

ipv6

(Optional) Specifies IPv6 address prefixes.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs.

The show mhost default-interface command is used to show both the configured and active MHost default interfaces. The configured interface is the one specified by the mhost default-interface command; otherwise, the configured interface is displayed as none.

The active interface is the one currently being used as the default. The active interface may differ from the one configured when multicast routing is enabled and the configured interface is not operational. This command is useful when applications such as ping, or MTrace are not functioning as expected.

Task ID

Task ID

Operations

network

read

Examples

The following is sample output for the show mhost default-interface command that shows that loopback interface 0 was configured as the MHost default interface, and it is the active default interface:

Related Commands

Configures the default interface for IP multicast transmission and reception to and from the host stack.

show mhost groups

To display various multicast groups joined directly on the interface, use the show mhost groups command in EXEC mode.

showmhost
[ ipv4 ]
groupstypeinterface-path-id
[ locationnode-id ]

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes.

ipv6

(Optional) Specifies IPv6 address prefixes.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note

Use the showinterfaces command in EXEC mode to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

locationnode-id

(Optional) Specifies a designated node.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mhost groups command is used to display the groups joined by applications and verifies that the MHost application is functioning properly.

Task ID

Task ID

Operations

network

read

Examples

The following is sample output from the show mhost groups command that shows the MHost groups 239.1.1.1, 224.0.0.22, 224.0.0.2, 224.0.0.1, 224.0.0.13, and 224.0.1.40 have joined on loopback 0 interface:

show mrib client

To display the state of the Multicast Routing Information Base (MRIB) client connections, use the show mrib client command in EXEC mode.

showmrib
[ vrfvrf-name ]
ipv4client [filter] [client-name]

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

ipv6

(Optional) Specifies IPv6 address prefixes.

filter

(Optional) Displays route and interface level flag changes that various MRIB clients have registered and shows what flags are owned by the MRIB clients.

client-name

(Optional) Name of a multicast routing protocol that acts as a client of MRIB, such as Protocol Independent Multicast (PIM) or Internet Group Management Protocol (IGMP).

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mrib client command using the filter option:

Specifies all the route entry and interface-level flags that are owned by the client. As the owner of the flag, only the client can add or remove the flag. For example, only the Internet Group Management Protocol (IGMP) client can add the II flag on an interface. MRIB does not allow a non-owner to register or modify the same flag.

groups: include 0.0.0.0/0interfaces: include All

Groups and interfaces registered by the clients consisting of two lists. One is an include list (items for which the client requests to be notified.) The use of “All” implies all interfaces and 0.0.0.0/0 to indicate all groups. Not shown in this example is the exclude list. This list contains items for which the client requests not to be notified when modifications occur.

interface attributes:

II ID LI LD

Interface-level flags set on the interface belong to a route.

interest filter:

Specifies all the flags, groups, and interfaces from which the client requests information. When a flag of interest for a client is modified, the client is notified.

Syntax Description

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read

Examples

The following is a sample output from the show mrib mpls forwarding command:

show mrib mpls route

To display the Multicast Routing Information Base (MRIB) multicast groups to tunnels mappings, use the show mrib mpls route command in EXEC mode.

showmribmplsroute
[ interface | summary ]

Syntax Description

interface

(Optional) Specify the type of interface.

summary

(Optional) Displays the summary information.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

(Optional) Filter based on LSPs with specified FRR (fast-reroute) state

summary

(Optional) Summary of total active and ready FRR states in MRIB

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read

Examples

This is a sample output from the show mrib mpls traffic-eng fast-reroute command:

show mrib nsf

To display the state of nonstop forwarding (NSF) operation in the Multicast Routing Information Base (MRIB), use the show mrib nsf command in EXEC mode.

showmribipv4nsf

Syntax Description

ipv4

(Optional) Specifies IPv4 address prefixes.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show mrib nsf command displays the current multicast NSF state for the MRIB. The state may be normal or activated for NSF. The activated state indicates that recovery is in progress due to a failure in MRIB or Protocol Independent Multicast (PIM). The total NSF timeout and time remaining are displayed until NSF expiration.

Timeout for MRIB NSF, computed as the maximum of the PIM and Internet Group Management Protocol (IGMP) NSF lifetimes, plus 60 seconds.

NSF Time Remaining

If MRIB NSF state is activated, the time remaining until MRIB reverts to Normal mode displays. Before this timeout, MRIB receives notifications from IGMP and PIM, triggering a successful end of NSF and cause the transition to normal state. If notifications are not received, the timer triggers a transition back to normal mode, causing new routes to download to MFIB and old routes to be deleted.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read

Examples

The following example shows a sample output of show mrib platform trace command:

(Optional) Group IP address or hostname of the MRIB route. F ormat is:

A.B.C.Dor X:X::X.

/prefix-length

(Optional) Prefix length of the MRIB group address. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value. Format is:

A.B.C.Dor X:X::X.

outgoing-interface

(Optional) Displays the outgoing-interface information.

summary

(Optional) Displays a summary of the routing database.

detail

(Optional) Displays the routing database with the platform data.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Each line card has an individual Multicast Forwarding Information Base (MFIB) table. The MFIB table maintains a subset of entries and flags updated from MRIB. The flags determine the forwarding and signaling behavior according to a set of forwarding rules for multicast packets. In addition to the list of interfaces and flags, each route entry shows various counters. Byte count is the number of total bytes forwarded. Packet count is the number of packets received for this entry.

show mrib route-collapse

To display the contents of the Multicast Routing Information Base (MRIB) route-collapse database, use the show mrib route-collapse command in EXEC mode.

showmrib
[ vrfvrf-name ]
ipv4route-collapse [core-tree]

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

core-tree

(Optional) IPv4 Multicast Distribution Tree (MDT) group address.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mrib route-collapse command:

Syntax Description

(Optional) Group IP address or hostname of the MRIB route and the prefix length.

/prefix-length

(Optional) Prefix length of the MRIB group address. A decimal value that indicates how many of the high-order contiguous bits of the address compose the prefix (the network portion of the address). A slash must precede the decimal value. Format is:

A.B.C.D

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.9.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

multicast

read

Examples

The following is sample output from the show mrib route outgoing-interface command:

Syntax Description

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Related Commands

show mrib tlc

To display the contents of the Multicast Routing Information Base (MRIB) table-line card (TLC) database, use the show mrib tlc command in EXEC mode.

showmrib
[ vrfvrf-name ]
ipv4tlc

Syntax Description

vrfvrf-name

(Optional) Specifies a VPN routing and forwarding (VRF) instance.

ipv4

(Optional) Specifies IPv4 address prefixes.

Command Default

IPv4 addressing is the default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

show mrib vrf vrf_name route

To display the detail routing DB with platform data information for multicast routing information base, use the show mrib vrfvrf_nameroute command in the EXEC mode.

show mrib vrfvrf_namerouteip_addressdetail

Syntax Description

detail

Displays routing DB with platform data.

ip_address

Specifies the group IP address.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

static-rpf

To configure a static Reverse Path Forwarding (RPF) rule for a specified prefix mask, use the static-rpf command in an appropriate configuration mode. To return to the default behavior, use the no form of this command.

static-rpfprefix-addressprefix-masktypepath-idnext-hop-address

nostatic-rpf

Syntax Description

prefix-address

IP address of a prefix for an address range.

prefix-mask

Prefix mask for an address range. Range is 0 to 32 for IPv4 .

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note

Use the showinterfaces command in EXEC mode to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

next-hop-address

IP address for an RPF neighbor.

Command Default

A static RPF rule for a specified prefix mask is not configured.

Command Modes

Multicast routing configuration

Multicast VRF configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The static-rpf command is used to configure incompatible topologies for unicast and multicast traffic.

Use the static-rpf command to configure a static route to be used for RPF checking in Protocol Independent Multicast (PIM) instead of using the unicast routing table.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example configures the static RPF rule for IP address 10.0.0.1:

Related Commands

ttl-threshold (multicast)

To configure the time-to-live (TTL) threshold for packets being forwarded out an interface, use the ttl-threshold command in the appropriate configuration mode. To return to the default behavior, use the no form of this command.

ttl-thresholdttl

nottl-thresholdttl

Syntax Description

ttl

Time to live value. Range is 1 to 255.

Command Default

ttl: 0

Command Modes

Multicast routing interface configuration

Multicast routing VRF interface configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Only multicast packets with a TTL value greater than the threshold are forwarded out of the interface. The TTL threshold is compared to the TTL of the packet after it has been decremented by one and before being forwarded.

Configure the TTL threshold only on border routers.

Note

Do not confuse this command with the ttl-threshold(MSDP) command in router MSDP configuration mode that is used to confine the multicast data packet TTL to be sent by an Multicast Source Discovery Protocol (MSDP) Source-Active (SA) message.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to configure the TTL threshold to 23, which means that a multicast packet is dropped and not forwarded out of the GigE 0/1/0/0 interface:

Related Commands

Command

Description

ttl-threshold (MSDP)

Limits which multicast data packets are sent in SA messages to an MSDP peer.

vrf (multicast)

To configure a virtual routing and forwarding (VRF) instance for a VPN table, use the vrf command in multicast routing configuration mode. To remove the VRF instance from the configuration file and restore the system to its default condition, use the no form of this command.

vrfvrf-nameipv4

novrfvrf-nameipv4

Syntax Description

vrf-name

Name of the VRF instance. The following names cannot be used: all, default, and global.

ipv4

(Optional) Configures IPv4 address prefixes.

Command Default

No default behavior or values.

Command Modes

Multicast routing configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

A VRF instance is a collection of VPN routing and forwarding tables maintained at the provider edge (PE) router.

Task ID

Task ID

Operations

multicast

read, write

Examples

The following example shows how to configure a VRF instance and enter VRF configuration mode: