PIM commands

pim

Syntax

[no] pim

Context

config>service>vprn

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures a Protocol Independent Multicast (PIM) instance in the VPRN service. When an PIM instance is created, the protocol is enabled. 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 supports PIM sparse mode (PIM-SM).

The no form of this command deletes the PIM protocol instance removing all associated configuration parameters.

import

Syntax

import {join-policy | register-policy} [policy-name [.. policy-name] policy-name...up to 5 max]

no import {join-policy | register-policy}

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command specifies the import route policy to be used for determining which routes are accepted from peers. Route policies are configured in the config>router>policy-options context. When an import policy is not specified, BGP routes are accepted by default.

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

Default

no import join-policy

no import register-policy

Parameters

join-policy

Filters PIM join messages which prevents unwanted multicast streams from traversing the network.

register-policy

Filters register messages. PIM register filters prevent register messages from being processed by the RP. This filter can only be defined on an RP. When a match is found, the RP immediately sends back a register-stop message.

policy-name

Specifies the route policy name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Route policies are configured in the config>router>policy-options context.

interface

Syntax

[no] interface ip-int-name

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables PIM on an interface and enables the context to configure interface-specific parameters. By default interfaces are activated in PIM based on the apply-to command, and do not have to be configured on an individual basis unless the default values must be changed.

The no form of this command deletes the PIM interface configuration for this interface. If the no command parameter is configured, the no interface form must be saved in the configuration to avoid automatic (re)creation after the next no is executed as part of a reboot.

The shutdown command can be used to disable an interface without removing the configuration for the interface.

Default

Interfaces are activated in PIM based on the apply-to command.

Parameters

ip-int-name

Specifies the interface name. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

assert-period

Syntax

assert-period assert-period

no assert-period

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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

The no form of this command reverts to the default.

Default

60

Parameters

assert-period

Specifies the period, in seconds, for periodic refreshes of PIM Assert messages on an interface.

Values

1 to 300

bfd-enable

Syntax

[no] bfd-enable [ipv4]

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables the use of 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 via the BFD command under the IP interface.

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

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

Default

no bfd-enable

bsm-check-rtr-alert

Syntax

[no] bsm-check-rtr-alert

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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

Default

no bsm-check-rtr-alert

hello-interval

Syntax

hello-interval hello-interval

no hello-interval

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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.

Default

30

Parameters

hello-interval

Specifies the hello interval in seconds. A 0 (zero) value disables the sending of hello messages.

Values

0 to 255 seconds

hello-multiplier

Syntax

hello-multiplier deci-units

no hello-multiplier

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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

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

Parameters

deci-units

Specifies the value, specified in multiples of 0.1, for the formula used to calculate the hello-holdtime based on the hello-multiplier:

(hello-interval * hello-multiplier) / 10

This allows the PIMv2 default timeout of 3.5 seconds to be supported.

Values

20 to 100

Default

35

improved-assert

Syntax

[no] improved-assert

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables improved assert processing on this interface. 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. This could impact performance if data is continuously received on an outgoing interface.

When enabled, the PIM assert process is done entirely on the control-plane with no interaction between the control and forwarding plane.

Default

enabled

instant-prune-echo

Syntax

[no] instant-prune-echo

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables 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.

Default

no instant-prune-echo

max-groups

Syntax

max-groups value

no max-groups

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures the maximum number of groups for which PIM can have downstream state based on received PIM Joins on this interface. This does not include IGMP local receivers on the 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. When this object has a value of 0, there is no limit to the number of groups.

Parameters

value

Specifies the maximum number of groups for this interface.

Values

1 to 16000

multicast-senders

Syntax

multicast-senders {auto | always | never}

no multicast-senders

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures the way subnet matching is done for incoming data packets on this interface. An IP multicast sender is a user entity to be authenticated in a receiving host.

Parameters

auto

Specifies that subnet matching is automatically performed for incoming data packets on this interface.

always

Specifies that subnet matching is always performed for incoming data packets on this interface.

never

Specifies that subnet matching is never performed for incoming data packets on this interface.

priority

Syntax

priority dr-priority

no priority

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command sets the priority value to become the rendezvous point (RP) that is included in bootstrap messages sent by the router. The RP is sometimes called the bootstrap router. The priority command indicates whether the router is eligible to be a bootstrap router.

The no form of this command disqualifies the router to participate in the bootstrap election.

The default value means the router is the least likely to become the designated router.

Default

1

Parameters

dr-priority

Specifies the priority to become the designated router. The higher the value, the higher the priority.

Values

1 to 4294967295

sticky-dr

Syntax

sticky-dr [priority dr-priority]

no sticky-dr

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables sticky-dr operation on this interface. When enabled, the priority in PIM hellos sent on this interface when elected as the Designated Router (DR) is 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, this interface continues 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.

Default

disabled

Parameters

priority dr-priority

Sets the DR priority to be sent in PIM Hello messages following the election of that interface as the DR, when sticky-dr operation is enabled.

Values

1 to 4294967295

three-way-hello

Syntax

three-way-hello

no three-way-hello

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures the compatibility mode for enabling the three-way hello.

tracking-support

Syntax

[no] tracking-support

Context

config>service>vprn>pim>if

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command sets the T bit in the LAN Prune Delay option of the Hello Message. This indicates the router's capability to disable Join message suppression.

Default

no tracking-support

non-dr-attract-traffic

Syntax

[no] non-dr-attract-traffic

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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 or IES or VPRN interfaces) to IGMP and PIM. The interface IGMP 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 flag non-dr-attract-trafffic can be used in the PIM context to have the router ignore the DR state and attract traffic when not DR. Note that while using this flag the router may not send the stream down to the DSLAM while not DR.

When enabled, the designated router state is ignored. When disabled, no non-dr-attract-traffic, the designated router value is honored.

Default

no non-dr-attract-traffic

rp

Syntax

rp

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables access to the context to configure the rendezvous point (RP) of a PIM protocol instance.

A Nokia PIM router acting as an RP must respond to a PIM register message specifying an SSM multicast group address by sending to the first hop router stop register messages. It does not build an (S, G) shortest path tree toward the first hop router. An SSM multicast group address can be either from the SSM default range of 232/8 or from a multicast group address range that was explicitly configured for SSM.

Default

rp enabled when PIM is enabled.

anycast

Syntax

[no] anycast rp-ip-address

Context

config>service>vprn>pim>rp

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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.

Parameters

rp-ip-address

Specifies the loopback IP address shared by all routes that form the RP set for this anycast instance. Only a single address can be configured. If another anycast command is entered with an address, the old address is replaced with the new address. If no ip-address is entered, the command is simply used to enter the anycast CLI level.

Values

Any valid loopback address configured on the node.

rp-set-peer

Syntax

[no] rp-set-peer ip-address

Context

config>service>vprn>pim>rp>anycast

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures a peer in the anycast rp-set. The address identifies the address used by the other node as the RP candidacy 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 of addresses that can be configured in an rp-set, up to 15 multicast addresses is recommended.

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

Parameters

ip-address

Specifies the address used by the other node as the RP candidacy address for the same multicast group address range as configured on this node.

bootstrap-export

Syntax

bootstrap-export policy-name [policy-name... up to five]

no bootstrap-export

Context

config>service>vprn>pim>rp

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command exports policies to control the flow of bootstrap messages from the RP. Up to five policies can be defined.

The no form of this command removes the specified policy names from the configuration.

Parameters

policy-name

Specifies the policy name. The policy statement must already be configured in the config>router>policy-options context.

bootstrap-import

Syntax

bootstrap-import policy-name [policy-name... up to 5 max]

no bootstrap-import policy-name [policy-name... up to 5 max]

Context

config>service>vprn>pim>rp

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command imports policies to control the flow of bootstrap messages into the RP. Up to five policies can be defined.

The no form of this command removes the specified policy names from the configuration.

Parameters

policy-name

Specifies the policy name. The policy statement must already be configured in the config>router>policy-options context.

bsr-candidate

Syntax

bsr-candidate

Context

config>service>vprn>pim>rp

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

Commands in this context configure a local rendezvous point (RP) of a PIM protocol instance.

Default

Enabled when PIM is enabled.

address

Syntax

[no] address ip-address

Context

config>service>vprn>pim>rp>bsr-candidate

config>service>vprn>pim>rp>rp-candidate

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures a static bootstrap or rendezvous point (RP) as long as the source is not directly attached to this router.

The no form of this command removes the static RP from the configuration.

Default

No IP address is specified.

Parameters

ip-address

Specifies the static IP address of the RP. The ip-address portion of the address command specifies the IP host address that is used by the IP interface within the subnet. This address must be unique within the subnet and specified in dotted decimal notation.

Values

a.b.c.d

hash-mask-len

Syntax

hash-mask-len hash-mask-length

no hash-mask-len

Context

config>service>vprn>pim>rp>bsr-candidate

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

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

Parameters

hash-mask-length

The hash mask length.

Values

0 to 32

priority

Syntax

priority bootstrap-priority

Context

config>service>vprn>pim>rp>bsr-candidate

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command defines the priority used to become the rendezvous point (RP) . The higher the priority value the more likely that this router becomes the RP. If there is a tie, the router with the highest IP address is elected.

Parameters

bootstrap-priority

The priority to become the bootstrap router.

Values

0 to 255

Default

0 (the router is not eligible to be the bootstrap router)

rp-candidate

Syntax

rp-candidate

Context

config>service>vprn>pim>rp

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

Commands in this context configure the candidate rendezvous point (RP) parameters.

Default

Enabled when PIM is enabled.

group-range

Syntax

[no] group-range {grp-ip-address/mask | grp-ip-address [netmask]}

Context

config>service>vprn>pim>rp>rp-candidate

config>service>vprn>pim>ssm

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures the group address or range of group addresses for which this router can be the rendezvous point (RP).

The no form of this command removes the group address or range of group addresses for which this router can be the RP from the configuration.

Parameters

group-ip-address

Specifies the addresses or address ranges that this router can be an RP.

mask

Specifies the address mask with the address to define a range of addresses.

netmask

Specifies the subnet mask in dotted decimal notation.

Values

a.b.c.d (network bits all 1 and host bits all 0)

holdtime

Syntax

holdtime holdtime

no holdtime holdtime

Context

config>service>vprn>pim>rp>rp-candidate

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command to defines the length of time neighboring routers consider this router to be up.

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

Default

150

Parameters

holdtime

Specifies the length of time, in seconds, that neighbor should consider the sending router to be operational.

Values

0 to 255

priority

Syntax

priority priority

no priority priority

Context

config>router>pim>rp>local

config>service>vprn>pim>rp>rp-candidate

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command defines the priority used to become the rendezvous point (RP). The higher the priority value, the more likely that this router becomes the RP.

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

Default

1

Parameters

priority

Specifies the priority to become the designated router. The higher the value the more likely the router becomes the RP.

Values

0 to 255

static

Syntax

static

Context

config>service>vprn>pim>rp

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command enables access to the context to configure a static rendezvous point (RP) of a PIM-SM protocol instance.

address

Syntax

[no] address ip-address

Context

config>service>vprn>pim>rp>static

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures the static rendezvous point (RP) address.

The override option specifies that dynamically learned RPs have less priority this static entry, by default dynamic learned RPs take preference over static configured RPs.

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

group-prefix

Syntax

[no] group-prefix {grp-ip-address/mask | grp-ip-address netmask}

Context

config>service>vprn>pim>rp>static

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command defines a range of multicast-ip-addresses for which a certain RP is applicable.

The no form of this command removes the criterion.

Parameters

grp-ip-address

Specifies the multicast IP address.

mask

Specifies the mask of the multicast-ip-address.

Values

4 to 32

netmask

Specifies the subnet mask in dotted decimal notation.

Values

a.b.c.d (network bits all 1 and host bits all 0)

override

Syntax

[no] override

Context

config>service>vprn>pim>rp>static

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command changes the precedence of static RP over dyanamically learned Rendezvous Point (RP).

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

Default

no override

spt-switchover-threshold

Syntax

spt-switchover-threshold {grp-ip-address/mask | grp-ip-address netmask} spt-threshold

no spt-switchover-threshold {grp-ip-address/mask | grp-ip-address netmask}

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures a shortest path tree (SPT tree) switchover threshold for a group prefix.

Parameters

grp-ip-address

Specifies the multicast group address.

mask

Specifies the mask of the multicast-ip-address.

Values

4 to 32

netmask

Specifies the subnet mask in dotted decimal notation.

Values

0.0.0.0 to 255.255.255.255 (network bits all 1 and host bits all 0)

spt-threshold

Specifies the configured threshold in kilo-bits per second(kbps) for the group to which this (S,G) belongs. For a group G configured with a threshold, switchover to SPT for an (S,G) is attempted only if the (S,G)'s rate exceeds this configured threshold.

ssm-assert-compatible-mode

Syntax

ssm-assert-compatible-mode [enable | disable]

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command specifies whether SSM assert is enabled in compatibility mode for this PIM protocol instance. When enabled for SSM groups, PIM considers the SPT bit to be implicitly set to compute the value of CouldAssert (S,G,I) as defined in RFC 4601, Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised). When disabled, for SSM groups, PIM does not assume the SPT bit to be set. The SPT bit is set by the Update_SPTbit(S,G,iif) macro defined in RFC 4601.

Default

disable

Parameters

enable

Enables SSM assert in compatibility mode for this PIM protocol instance.

disable

Disables SSM assert in compatibility mode for this PIM protocol instance.

ssm-default-range-disable

Syntax

ssm-default-range-disable ipv4

Context

config>service>vprn>pim

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command specifies whether to disable the use of default range (232/8) for SSM so that it can be used by ASM to process (*,G). When enabled, the use of default range is disabled for SSM and it can be used by ASM. When disabled, the SSM default range is enabled.

Default

disable

ssm-groups

Syntax

[no] ssm-groups

Context

config>service>vprn

Platforms

7210 SAS-T (network operating mode) and 7210 SAS-Mxp

Description

This command configures a source-specific multicast (SSM) configuration instance.