2.5. Multicast Command Reference

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command.

The shutdown command administratively disables an entity. The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

Unlike other commands and parameters where the default state is not indicated in the configuration file, shutdown and no shutdown are always indicated in system-generated configuration files.

The no form of this command puts an entity into the administratively enabled state.

This command adds or removes ssm-translate group ranges.

This command adds or removes source addresses for the SSM translate group range.

This command adds or removes SSM translate group range entries.

This command specifies the maximum number of multicast routes that can be held within a VPN routing/forwarding (VRF) context. When this limit is reached, a log and SNMP trap are sent. If the log-only parameter is not specified and the maximum routes value is set below the existing number of routes in a VRF, no new joins are processed.

The no form of this command disables the limit of multicast routes within a VRF context. Issue the no form of this command only when the VPRN instance is shut down.

This command enables the Internet Group Management Protocol (IGMP) context. When the context is created, the IGMP protocol is enabled.

IGMP is used by IPv4 systems (hosts and routers) to report their IP multicast group memberships to neighboring multicast routers. An IP multicast router can be a member of one or more multicast groups, in which case it performs both the “multicast router part” of the protocol, which collects the membership information needed by its multicast routing protocol, and the “group member part” of the protocol, which informs itself and other neighboring multicast routers of its memberships.

The no form of this command disables the IGMP instance. To start or suspend execution of IGMP without affecting the configuration, use the no shutdown command.

This command enables the context to configure an IGMP interface. The interface is a local identifier of the network interface on which reception of the specified multicast address is enabled or disabled.

The no form of this command deletes the IGMP interface. The shutdown command in the config>router>igmp>interface context can be used to disable an interface without removing the configuration for the interface.

This command enables the router alert checking for IGMP messages received on this interface.

The no form of this command disables the IGMP router alert check option.

This command applies the referenced IGMP policy (filter) to an interface subscriber or a group interface. An IGMP filter is also known as a black/white list and is defined under the configure>router>policy-options context.

The no form of this command removes the policy association from the IGMP instance.

This command configures the maximum number of groups for which IGMP can have local receiver information based on received IGMP reports on this interface. When this configuration is changed dynamically to a value lower than the currently accepted number of groups, the groups that are already accepted are not deleted. Only new groups are not allowed. This command is applicable for IPv4 and IPv6.

This command configures the maximum number of group sources for this interface.

This command tests multicast forwarding on an interface without a receiver host. When enabled, data is forwarded to an interface without receiving membership reports from host members.

This command enables the context to add a static multicast group either as a (*,G) or one or more (S,G) records. Use IGMP static group memberships to test multicast forwarding without a receiver host. When IGMP static groups are enabled, data is forwarded to an interface without receiving membership reports from host members.

When static IGMP group entries on point-to-point links that connect routers to a rendezvous point (RP) are configured, the static IGMP group entries do not generate join messages toward the RP.

This command specifies the source IPv4 address (S) for the static IGMP group being configured. Multicast traffic to the group (G) will be forwarded out the interface on which this static group is configured if the source address in the IPv4 header of the multicast packets matches S.

The source command is mutually exclusive with the specification of individual sources for the same group.

The source command, in combination with the group command, is used to create a specific (S,G) static group entry.

The no form of this command removes the source from the configuration.

This command adds a static (*,G) entry. This command can be enabled only if no existing source addresses for this group are specified.

The no form of this command removes the starg entry from the configuration.

This command enables subnet checking for IGMP messages received on this interface. All IGMP packets with a source address that is not in the local subnet are dropped.

This command specifies the IGMP version. Routers that run different versions of IGMP negotiate the lowest common version of IGMP that is supported by hosts on their subnet and operate in that version. For IGMP to function correctly, all routers on a LAN should be configured to run the same version of IGMP on that LAN.

For IGMPv3, a multicast router that is also a group member performs both parts of IGMPv3, receiving and responding to its own IGMP message transmissions as well as those of its neighbors.

This command specifies the frequency that the querier router transmits general host-query messages. The host-query messages solicit group membership information and are sent to the all-systems multicast group address, 224.0.0.1.

This command configures the frequency at which the querier sends group-specific query messages, including messages sent in response to leave-group messages. The lower the interval, the faster the detection of the loss of the last member of a group.

This command specifies how long the querier router waits to receive a response to a host-query message from a host.

This command configures the robust count. The robust-count variable allows tuning for the expected packet loss on a subnet. If a subnet anticipates losses, the robust-count variable can be increased.

This command enables the context to configure group ranges that are translated to SSM (S,G) entries. If the static entry needs to be created, it must be translated from an IGMPv1 IGMPv2 request to a Source Specific Multicast (SSM) join. An SSM translate source can only be added if the starg command is not enabled. An error message is generated if you try to configure the source command with the starg command enabled.

This command configures group ranges that are translated to SSM (S,G) entries.

This command configures the source IP address for the group range. Whenever a (*,G) report is received in the range specified by grp-range start and end parameters, it is translated to an (S,G) report with the value of this object as the source address.

This command configures a Protocol Independent Multicast (PIM) instance.

PIM is used for multicast routing within the network. Devices in the network can receive the multicast feed requested, and non-participating routers can be pruned. The router OS supports PIM sparse mode (PIM-SM). By default, this command is not enabled.

This command configures a logical IP routing interface.

Interface names are case-sensitive and must be unique within the group of IP interfaces defined for the config router interface and config service ies interface commands. Interface names must not be in the dotted decimal notation of an IP address. For example, the name “1.1.1.1” is not allowed, but “int-1.1.1.1” is allowed. Show commands for router interfaces use either the interface names or the IP addresses. Ambiguity can exist if an IP address is used as an IP address and an interface name. Duplicate interface names can exist in different router instances, although this is not recommended because it is confusing.

The no form of this command removes the IP interface and all the associated configurations.

This command configures the period for refreshes of PIM Assert messages on an interface.

The no form of this command removes the assert period from the configuration.

This command enables the use of IPv4 bi-directional forwarding (BFD) to control the state of the associated protocol interface. By enabling BFD on a specific protocol interface, the state of the protocol interface is tied to the state of the BFD session between the local node and the remote node. The parameters used for the BFD are set using the BFD command under the IP interface.

For information about the protocols and platforms that support BFD, refer to the 7210 SAS-M, T, R6, R12, Mxp, Sx, S Router Configuration Guide.

The no form of this command removes BFD from the associated IGP protocol adjacency.

This command enables SPT switchover for default MDT. When enabled, the PIM instance resets all MDTs and reinitiates setup.

The no form of this command disables SPT switchover for default MDT. When disabled, the PIM instance resets all MDTs and reinitiates setup.

This command specifies the import route policy to be used. Route policies are configured in the config>router>policy-options context.

When an import policy is not specified, BGP routes are accepted by default. Up to five import policy names can be specified.

The no form of this command removes the policy association from the instance.

This command enables multicast balancing of traffic over ECMP links. When enabled, each multicast stream that needs to be forwarded over an ECMP link is re-evaluated for the total multicast bandwidth utilization. Re-evaluation occurs on the specified ECMP interface.

The no form of this command disables the multicast balancing.

This command configures the hold time for multicast balancing over ECMP links.

This command enables hash-based multicast balancing of traffic over ECMP links and causes PIM joins to be distributed over the multiple ECMP paths based on a hash of S and G (and possibly next-hop IP). When a link in the ECMP set is removed, the multicast streams that were using that link are redistributed over the remaining ECMP links using the same hash algorithm. When a link is added to the ECMP set, new joins may be allocated to the new link based on the hash algorithm, but existing multicast streams using the other ECMP links stay on those links until they are pruned.

Hash-based multicast balancing is supported for both IPv4 and IPv6.

This command is mutually exclusive with the mc-ecmp-balance command in the same context.

The no form of this command disables the hash-based multicast balancing of traffic over ECMP links.

This command configures the frequency at which PIM Hello messages are transmitted on this interface.

The no form of this command reverts to the default value.

This command configures the multiplier to determine the hold time for a PIM neighbor on this interface.

The hello-multiplier in conjunction with the hello-interval determines the hold time for a PIM neighbor.

The PIM assert process establishes a forwarder for a LAN and requires interaction between the control and forwarding planes. The assert process is started when data is received on an outgoing interface, meaning that duplicate traffic is forwarded to the LAN until the forwarder is negotiated among the routers.

When the improved-assert command is enabled, the PIM assert process is done entirely in the control plane. The advantage is that it eliminates duplicate traffic forwarding to the LAN. It also improves performance by removing the required interaction between the control and data planes.

Note: This command is still fully interoperable with the implementations described in draft-ietf-pim-sm-v2-new-xx, Protocol Independent Multicast - Sparse Mode (PIM-SM): Revised, and RFC 2362, Protocol Independent Multicast-Sparse Mode (PIM-SM). However, there may be conformance tests that fail if the tests expect control-data plane interaction in determining the assert winner. Nokia recommends disabling the improved-assert command when performing conformance tests.

This command enables the PIM router to echo the PIM prune message received from a downstream router. It is typically used in a multi-access broadcast network, for example in an Ethernet LAN, to reduce the probability of loss of PIM prune messages.

This command configures how traffic from directly-attached multicast sources should be treated on broadcast interfaces. It can also be used to treat all traffic received on an interface as traffic coming from a directly-attached multicast source. This is particularly useful if a multicast source is connected to a point-to-point or unnumbered interface.

This command configures the priority value to elect the designated router (DR). The DR election priority is a 32-bit unsigned number, and the numerically larger priority is always preferred.

The no form of this command reverts to the default values.

This command enables sticky-dr operation on this interface. When enabled, the priority in PIM Hello messages sent on this interface when elected as the designated router (DR) are modified to the value configured in dr-priority. This is done to avoid the delays in forwarding caused by DR recovery, when switching back to the old DR on a LAN when it comes back up.

By enabling sticky-dr on this interface, it will continue to act as the DR for the LAN even after the old DR comes back up.

The no form of this command disables sticky-dr operation on this interface.

This command enables three-way hello. By default, the three-way-hello command is disabled on all interfaces and the standard two-way hello is supported.

This command sets the T bit in the LAN Prune Delay option of the Hello Message. This indicates the capability of the router to enable join message suppression. This capability allows for upstream routers to explicitly track join membership.

This command enables the context to configure rendezvous point (RP) parameters. The address of the root of the group shared multicast distribution tree is known as its RP. Packets received from a source upstream, and join messages from downstream routers, rendezvous at this router.

If this command is not enabled, the router cannot become the RP.

This command configures a PIM anycast protocol instance for the configured RP. Anycast enables fast convergence when a PIM RP router fails by allowing receivers and sources to rendezvous at the closest RP.

The no form of this command removes the anycast instance from the configuration.

This command configures a peer in the anycast RP set. The ip-address identifies the address used by the other node as the RP candidate address for the same multicast group address range as configured on this node.

Caution: This is a manual procedure. Caution should be taken to produce a consistent configuration of an RP set for a specific multicast group address range. The priority should be identical on each node and be a higher value than any other configured RP candidate that is not a member of this RP set.

Although there is no set maximum number of addresses that can be configured in an RP set, up to 15 IP addresses is recommended.

The no form of this command removes an entry from the list.

This command applies export policies to the PIM configuration. The policies control the flow of bootstrap messages from the RP. Up to five policy names can be specified.

This command to applies import policies to the PIM configuration. The policies control the flow of bootstrap messages to the RP. Up to 5 policy names can be specified.

This command enables the context to configure Candidate Bootstrap (BSR) parameters.

This command configures the candidate BSR IP address. This address is for bootstrap router election.

This command configures the length of a mask that is to be combined with the group address before the hash function is called. All groups with the same hash result will map to the same RP. For example, if the hash-mask-length value is 24, only the first 24 bits of the group addresses matter. This mechanism is used to map one group or multiple groups to an RP.

This command configures the bootstrap priority of the router. The RP is sometimes called the bootstrap router. The priority determines if the router is eligible to be a bootstrap router. In the case of a tie, the router with the highest IP address is elected to be the bootstrap router.

This command enables the context to configure candidate RP parameters.

Routers use a set of available rendezvous points distributed in bootstrap messages to get the correct group-to-RP mapping. A set of routers within a domain are also configured as candidate RPs (C-RPs); typically, these are the same routers that are configured as candidate BSRs.

Every multicast group has a shared tree through which receivers learn about new multicast sources, and new receivers learn about all multicast sources. The RP is the root of this shared tree.

This command configures the local RP address. This address is sent in the RP candidate advertisements to the bootstrap router.

This command configures the address ranges of the multicast groups for which this router can be an RP.

This command configures the length of time, in seconds, that neighbors should consider the sending router to be operationally up. A local RP cannot be configured on a logical router.

This command configures the candidate RP priority for becoming an RP. This value is used to elect RP for a group range.

This command enables the context to configure static RP addresses for a multicast group range.

Entries can be created or destroyed. If no IP addresses are configured in the config>router>pim>rp>static>address context, the multicast group to RP mapping is derived from the RP set messages received from the bootstrap router.

This command configures the RP address used by the router for the range of multicast groups configured by the range command.

This command specifies the range of multicast group addresses to be used by the router as the RP. The config>router>pim>rp>static>address a.b.c.d command implicitly defaults to deny all for all multicast groups (224.0.0.0/4). A group-prefix must be specified for that static address. This command does not apply to the whole group range.

The no form of this command removes the group-prefix from the configuration.

This command changes the precedence of static RP over dynamically learned RP.

When enabled, the static group-to-RP mappings take precedence over the dynamically learned mappings.

This command specifies whether the router should ignore the designated router state and attract traffic even when it is not the designated router.

An operator can configure an interface (router, IES, or VPRN) to IGMP and PIM. The interface state is synchronized to the backup node if it is associated with the redundant peer port. The interface can be configured to use PIM, which causes multicast streams to be sent to the elected DR only. The DR is also the router sending traffic to the DSLAM. Because it may be required to attract traffic to both routers, a non-dr-attract-traffic flag can be used in the PIM context to have the router ignore the DR state and attract traffic when it is not the DR. When using this flag, the router may not send the stream down to the DSLAM while it is not the DR.

When enabled, the designated router state is ignored. When disabled, the designated router value is honored.

This command configures the sequence of route tables used to find a Reverse Path Forwarding (RPF) interface for a particular multicast route.

By default, only the unicast route table is looked up to calculate RPF interface towards the source/rendezvous point. However, the operator can specify to use unicast route table (rtable-u).

This command configures the shortest path tree (SPT) switchover thresholds for group prefixes.

PIM-SM routers with directly connected routers receive multicast traffic initially on a shared tree rooted at the RP. When the traffic arrives on the shared tree and the source of the traffic is known, a switchover to the SPT tree rooted at the source is attempted.

For a group that falls in the range of a prefix configured in the table, the corresponding threshold value determines when the router switches over from the shared tree to the source specific tree. The switchover is attempted only if the traffic rate on the shared tree for the group exceeds the configured threshold.

Note: On 7210 SAS, this command enables or disables switchover to the SPT. To disable switchover to SPT, a threshold value of infinity must be configured (that is, to continue using the shared tree for ever, configure the IP multicast prefix with this command and set the threshold to infinity). To use the SPT, do not configure the IP multicast address prefix using this command, and the default behavior will apply to the multicast group. The default behavior is to switch over to SPT when the first packet is received.

In the absence of any matching prefix in the table, the default behavior is to switch over when the first packet is seen. In the presence of multiple prefixes matching a specific group, the most specific entry is used.

When enabled, this command treats packets as if the SPT bit is set, regardless of whether it is set.

This command enables and disables the reservation and allows PIM to accept and create (*,G) entries for addresses in this range on receiving IGMPv2 reports. PIM SSM has a default range of 232/8 (232.0.0.0 to 232.255.255.255) reserved by IANA. These addresses are not used by PIM ASM.

This command enables the context to configure an SSM group instance.

This command configures the address ranges of the multicast groups for this router. When there are parameters present, the command configures the SSM group ranges for IPv6 addresses and netmasks.

This command displays multicast information from the target multicast router. Information displayed includes adjacency information, protocol, metrics, thresholds, and flags from the target multicast router. This information can be used to determine whether bidirectional adjacencies exist.

This command traces the multicast path from a source to a receiver by passing a trace query hop-by-hop along the reverse path from the receiver to the source. At each hop, information such as the hop address, routing error conditions, and packet statistics are gathered and returned to the requester. A network administrator can determine where multicast flows stop and verify the flow of the multicast stream.

This command displays the multicast group and (S,G) addresses. If no grp-ip-address parameters are specified, all IGMP group, (*,G), and (S,G) addresses are displayed.

This command displays IGMP SSM translate configuration information.

This command displays IGMP interface information.

This command displays static IGMP, (*,G), and (S,G) information.

This command displays IGMP statistics information.

This command displays IGMP status information.

If IGMP is not enabled, the following message appears:

This command enables debugging for IGMP interfaces.

The no form of this command disables the IGMP interface debugging for the specified interface name or IP address.

This command enables debugging for IGMP miscellaneous.

The no form of this command disables debugging.

This command enables and disables debugging for IGMP packets.

This command enables and disables debugging for PIM adjacencies.

This command enables and disables debugging for all the PIM modules.

This command enables and disables debugging for PIM assert mechanism.

This command enables and disables debugging for PIM/BGP specific interoperation.

This command enables debugging for PIM bootstrap mechanism.

The no form of this command disables debugging.

This command enables and disables debugging for PIM data exception.

This command enables and disables debugging for PIM database.

This command enables and disables debugging for dynamic MLDP.

This command enables and disables debugging for PIM interface.

This command enables and disables debugging for PIM Join-Prune mechanism.

This command enables and disables debugging for PIM MRIB.

This command enables and disables debugging for PIM messaging.

This command enables and disables debugging for the PIM MVPN route cache.

This command enables and disables debugging for PIM packets.

This command enables and disables debugging for PIM redundancy messages to the standby CPM.

This command enables and disables debugging for PIM Register mechanism.

This command enables the disables debugging for PIM RTM.

This command enables debugging for PIM selective provider multicast service interface.

The no form of this command disables the debugging.

This command enables and disables the debugging for PIM tunnel interfaces.