2.4. Multicast Command Reference

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).

This command is used to enable SPT switchover for default MDT.

The no form of this command disables SPT switchover for default MDT. If 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 creates a logical IP routing interface.

Interface names are case-sensitive and must be unique within the group of IP interfaces defined for config>router>interface and config>service>ies>interface. 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 periodic refreshes of PIM Assert messages on an interface.

The no form of this command removes the configuration.

This command enables the use of IPv4 bidirectional 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.

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

For information about the protocols and platforms that support BFD, refer to the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Router Configuration Guide.

This command enables the checking of the router alert option in the bootstrap messages received on this interface.

The no form of this command enables accepting of BSM packets without the router alert option.

This command enables multicast balancing of traffic over ECMP links. When this command is enabled, each multicast stream that needs to be forwarded over an ECMP link is reevaluated for the total multicast bandwidth utilization. Reevaluation occurs on the ECMP interface in question.

The no form of this command disables 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 IPv4 only.

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 advantages are that it eliminates duplicate traffic forwarding to the LAN. It also improves performance because it removes the required interaction between the control and data planes.

Note: The improved-assert command is still fully interoperable with the 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), implementations. However, there may be conformance tests that may 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 a 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: 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 sets 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 restores the default values.

This command enables the sticky-dr operation on this interface. When the operation is 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 an 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 the sticky-dr operation on this interface.

This command configures the compatibility mode to enable three-way hello. By default, the value is disabled on all interfaces, which specifies that the standard two-way hello is supported. When enabled, the three-way hello is supported.

This command sets the T bit in the LAN prune delay option of the hello message. This indicates that the router is capable of enabling 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 disabled, the router cannot become the RP.

This command configures a PIM anycast protocol instance for the RP being configured. 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 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.

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 control the flow of bootstrap messages from the RP and apply them to the PIM configuration. Up to five policy names can be specified.

This command applies import policies to control the flow of bootstrap messages to the RP, and apply them to the PIM configuration. 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 is used to configure 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 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 the candidate RP parameters.

Routers use a set of available rendezvous points distributed in bootstrap messages to get the proper group-to-RP mapping. A set of routers within a domain are also configured as candidate RPs (C-RPs); typically, these will be 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 rendezvous point (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 a rendezvous point (RP). This value is used to elect an RP for a group range.

This command enables the context to configure static rendezvous point (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 indicates the RP address that should be used by the router for the range of multicast groups configured by the group-range command.

This command configures the SSM multicast group address ranges for this router.

This command specifies the range of multicast group addresses that should be used by the router as the RP. The config router pim rp static address 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 configuration.

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

When this command is 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 interfaces) 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, the non-dr-attract-trafffic flag can be used in the PIM context to have the router ignore the DR state and attract traffic when not DR. While using this flag, the router may not send the stream down to the DSLAM while not DR.

When this command is enabled, the designated router state is ignored.

The no form of this command causes the router to honor the designated router value.

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 the RPF interface toward the source/rendezvous point. However, the operator can specify the use of the 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 should switch 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 the 7210 SAS, this command is used to enable or disable switch over to the SPT tree. To disable switch over to SPT, a threshold value of infinity must be configured (that is, to continue using the shared tree forever, configure the IP multicast prefix with this command and set the threshold to infinity). To use the SPT tree, 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 this command is enabled, packets are treated as if SPT bit was set regardless of whether it is set or not.

This command allows the user to disable 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 SSM group ranges.

This command displays relevant 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 by network operators 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 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).

This command is used to enable SPT switchover for default MDT.

The no form of this command disables SPT switchover for default MDT. If 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 creates a logical IP routing interface.

Interface names are case-sensitive and must be unique within the group of IP interfaces defined for config>router>interface and config>service>ies>interface. 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 periodic refreshes of PIM Assert messages on an interface.

The no form of this command removes the configuration.

This command enables the use of IPv4 bidirectional 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.

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

For information about the protocols and platforms that support BFD, refer to the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Router Configuration Guide.

This command enables the checking of the router alert option in the bootstrap messages received on this interface.

The no form of this command enables accepting of BSM packets without the router alert option.

This command enables multicast balancing of traffic over ECMP links. When this command is enabled, each multicast stream that needs to be forwarded over an ECMP link is reevaluated for the total multicast bandwidth utilization. Reevaluation occurs on the ECMP interface in question.

The no form of this command disables 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 IPv4 only.

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 advantages are that it eliminates duplicate traffic forwarding to the LAN. It also improves performance because it removes the required interaction between the control and data planes.

Note: The improved-assert command is still fully interoperable with the 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), implementations. However, there may be conformance tests that may 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 a 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: 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 sets 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 restores the default values.

This command enables the sticky-dr operation on this interface. When the operation is 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 an 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 the sticky-dr operation on this interface.

This command configures the compatibility mode to enable three-way hello. By default, the value is disabled on all interfaces, which specifies that the standard two-way hello is supported. When enabled, the three-way hello is supported.

This command sets the T bit in the LAN prune delay option of the hello message. This indicates that the router is capable of enabling 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 disabled, the router cannot become the RP.

This command configures a PIM anycast protocol instance for the RP being configured. 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 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.

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 control the flow of bootstrap messages from the RP and apply them to the PIM configuration. Up to five policy names can be specified.