3.3. IGMP Configuration Command Reference

3.3.1. Command Hierarchies

3.3.1.1. IGMP Configuration Commands

config
— router
[no] igmp
[no] group-interface ip-int-name
import policy-name
— no import
max-groups value
— no max-groups
max-grp-sources value
max-sources value
query-src-ip ip-address
[no] shutdown
[no] subnet-check
version version
— no version
grp-if-query-src-ip ip-address
[no] interface ip-int-name
[no] group-interface ip-int-name
[no] shutdown
import policy-name
— no import
max-groups value
— no max-groups
max-grp-sources value
max-sources value
query-interval seconds
[no] shutdown
[no] grp-range start end
[no] source ip-address
static
[no] group grp-ip-address
[no] group start grp-ip-address end grp-ip-address [step ip-address]
[no] source ip-address
[no] starg
[no] subnet-check
version version
— no version
query-interval seconds
robust-count robust-count
[no] shutdown
[no] grp-range start end
[no] source ip-address
[no] tunnel-interface rsvp-p2mp lsp-name
[no] tunnel-interface ldp-p2mp p2mp-id sender ip-address
[no] shutdown
static
[no] group grp-ip-address
[no] source ip-address
[no] starg

3.3.2. Command Descriptions

3.3.2.1. Router IGMP Commands

igmp

Syntax 
[no] igmp
Context 
config>router
Description 

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

The Internet Group Management Protocol (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 the command disables the IGMP instance. To start or suspend execution of IGMP without affecting the configuration, use the no shutdown command.

group-interface

Syntax 
[no] group-interface ip-int-name
Context 
config>router>igmp
config>router>igmp>if
Description 

This command enables IGMP on a group-interface in a VRF context. Activating IGMP under the group-interface is a prerequisite for subscriber replication. The group-interface is also needed so that MCAC can be applied and various IGMP parameters defined.

This command can be used in a regular, wholesaler or retailer type of VRF. The retailer VRF does not have the concept of group-interfaces under the subscriber-interface hierarchy. In the case that this command is applied to a retailer VRF instance, the optional fwd-service command must be configured. The fwd-service command is referencing the wholesaler VRF in which the traffic is ultimately replicated. Redirection in the retailer VRF is supported.

This command enables IGMP on a group-interface in the Global Routing Table (GRT). The group-interface in GRT is defined under the IES service. Activating IGMP under the group-interface is a prerequisite for subscriber replication. The group-interface is also needed so that MCAC can be applied and various IGMP parameters defined.

Parameters 
ip-int-name—
Specifies the name of the group interface.

disable-router-alert-check

Syntax 
[no] disable-router-alert-check
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

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

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

import

Syntax 
import policy-name
no import
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

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 it is defined under the config>router>policy-options.

When redirection is applied, only the import policy from the subscriber will be in effect. The import policy under the group interface is applicable only for IGMP states received directly on the SAP (AN in IGMP proxy mode).

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

Default 

no import

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

max-groups

Syntax 
max-groups value
no max-groups
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

This command specifies 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 will not be allowed. This command is applicable for IPv4 and IPv6.

The no form of the command sets no limit to the number of groups.

Default 

no max-groups

Parameters 
value—
Specifies the maximum number of groups for this interface.
Values—
1 to 16000

 

max-grp-sources

Syntax 
max-grp-sources value
no max-grp-sources
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

This command configures the maximum number of group sources 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 currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed.

The no form of the command reverts to the default.

Default 

no max-grp-sources

Parameters 
value—
Specifies the maximum number of group sources.
Values—
1 to 32000

 

max-sources

Syntax 
max-sources value
no max-sources
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

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

Parameters 
value—
Specifies the maximum number of group sources.
Values—
1 to 1000

 

query-src-ip

Syntax 
query-src-ip ip-address
no query-src-ip
Context 
config>router>igmp>group-interface
Description 

This command configures the query source IP address for the group interface. This IP address overrides the source IP address configured at the router level.

The no form of the command removes the IP address.

Parameters 
ip-address—
Sets the source IPv4 address for all subscriber’s IGMP queries.

shutdown

Syntax 
[no] shutdown
Context 
config>router>igmp
config>router>igmp>group-interface
config>router>igmp>if
config>router>igmp>tunnel-interface
Description 

The shutdown 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 and 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 the command puts an entity into the administratively enabled state.

Default 

no shutdown

sub-hosts-only

Syntax 
[no] sub-hosts-only
Context 
config>router>igmp>group-interface
Description 

This command disables the processing of IGMP messages outside of the subscriber-host context. No other hosts outside of the subscriber-hosts can create IGMP states.

Disabling this command allows the creation of the IGMP states that correspond to the AN that operate in IGMP proxy mode. In this mode, the AN will hide source IP addresses of IGMP messages and will source IGMP messages with its own IP address. In this case, an IGMP state can be created under the sap context. This IGMP state creation under the SAP is controlled via the import policy under the group-interface.

The IGMP state processing for regular subscriber-hosts is unaffected by this command.

The no form of the command disables the command.

Default 

sub-hosts-only

subnet-check

Syntax 
[no] subnet-check
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

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.

Default 

subnet-check

version

Syntax 
version version
no version
Context 
config>router>igmp>group-interface
config>router>igmp>if
Description 

This command specifies the IGMP version. If routers run different versions of IGMP, they will 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.

Default 

version 3

Parameters 
version—
Specifies the IGMP version number.
Values—
1, 2, 3

 

grp-if-query-src-ip

Syntax 
grp-if-query-src-ip ip-address
no grp-if-query-src-ip
Context 
config>router>igmp
Description 

This command configures the query source IP address for all group interfaces.

The no form of the command removes the IP address.

Parameters 
ip-address—
Sets the query source IP address.

interface

Syntax 
[no] interface ip-int-name
Context 
config>router>igmp
Description 

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 to be enabled or disabled.

The no form of the 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.

Default 

no interface

Parameters 
ip-int-name—
The IP interface name. Interface names must be unique within the group of defined IP interfaces for config router interface and config service ies interface commands. An interface name cannot be in the form of an IP address. Interface names can be any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

If the IP interface name does not exist or does not have an IP address configured an error message will be returned.

If the IP interface exists in a different area it will be moved to this area.

query-interval

Syntax 
query-interval seconds
no query-interval
Context 
config>router>igmp
config>router>igmp>if
Description 

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.

Default 

query-interval 125

Parameters 
seconds—
Specifies the frequency, in seconds, that the router transmits general host-query messages.
Values—
2 to 1024

 

query-last-member-interval

Syntax 
query-last-member-interval seconds
no query-last-member-interval
Context 
config>router>igmp
config>router>igmp>if
Description 

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.

Default 

query-last-member-interval 1

Parameters 
seconds—
Specifies the frequency, in seconds, at which query messages are sent.
Values—
1 to 1023

 

query-response-interval

Syntax 
query-response-interval seconds
no query-response-interval
Context 
config>router>igmp
config>router>igmp>if
Description 

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

Default 

query-response-interval 10

Parameters 
seconds—
Specifies the length of time to wait to receive a response to the host-query message from the host.
Values—
1 to 1023

 

redundant-multicast

Syntax 
[no] redundant-multicast
Context 
config>router>igmp>if
Description 

This command configures the interface as a member of a redundant pair for multicast traffic.

The no form of the command removes the configuration.

ssm-translate

Syntax 
ssm-translate
Context 
config>router>igmp
config>router>igmp>if
Description 

This command enables the context to configure group ranges which are translated to SSM (S,G) entries. If the static entry needs to be created, it has to be translated from a 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 starg command enabled.

grp-range

Syntax 
[no] grp-range start end
Context 
config>router>igmp>if>ssm-translate
config>router>igmp>ssm-translate
Description 

This command is used to configure group ranges which are translated to SSM (S,G) entries.

Parameters 
start—
An IP address that specifies the start of the group range.
end—
An IP address that specifies the end of the group range. This value should always be greater than or equal to the value of the start value.

source

Syntax 
[no] source ip-address
Context 
config>router>igmp>if>ssm-translate>grp-range
config>router>igmp>ssm-translate>grp-range
Description 

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

Parameters 
ip-address—
Specifies the IP address that will be sending data.

static

Syntax 
static
Context 
config>router>igmp>if
Description 

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.

group

Syntax 
[no] group grp-ip-address
[no] group start grp-ip-address end grp-ip-address [step ip-address]
Context 
config>router>igmp>if>static
Description 

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.

Parameters 
ip-address—
Specifies an IGMP multicast group address that receives data on an interface. The IP address must be unique for each static group.
start grp-ip-address
Specifies the start multicast group address.
end grp-ip-address
Specifies the end multicast group address.
step ip-address
Specifies the step increment.

source

Syntax 
[no] source ip-address
Context 
config>router>igmp>if>static>group
Description 

This command specifies a IPv4 unicast address that sends data on an interface. This enables a multicast receiver host to signal a router the group to receive multicast traffic from, and from the source(s) that the traffic is expected.

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

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

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

Parameters 
ip-address—
Specifies the IPv4 unicast address.

starg

Syntax 
[no] starg
Context 
config>router>igmp>if>static>group
Description 

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

Use the no form of the command to remove the (*,G) entry from the configuration.

robust-count

Syntax 
robust-count robust-count
no robust-count
Context 
config>router>igmp
Description 

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.

Default 

robust-count 2

Parameters 
robust-count—
Specify the robust count value.
Values—
2 to 10

 

tunnel-interface

Syntax 
[no] tunnel-interface {rsvp-p2mp lsp-name | ldp-p2mp p2mp-id sender sender-address [root-node]}
Context 
config>router>igmp
Description 

This command creates a tunnel interface associated with an RSVP P2MP LSP. IPv4 multicast packets are forwarded over the P2MP LSP at the ingress LER based on a static join configuration of the multicast group against the tunnel interface associated with the originating P2MP LSP. At the egress LER, packets of a multicast group are received from the P2MP LSP via a static assignment of the specific <S,G> to the tunnel interface associated with a terminating LSP.

At ingress LER, the tunnel interface identifier consists of a string of characters representing the LSP name for the RSVP P2MP LSP. The user can create one or more tunnel interfaces in PIM and associate each to a different RSVP P2MP LSP. P2mp-ID is required to configure LDP P2MP LSP tunnel interfaces. Sender address for a tunnel interface must be specified only on the leaf node.

At egress LER, the tunnel interface identifier consists of a couple of string of characters representing the LSP name for the RSVP P2MP LSP followed by the system address of the ingress LER. The LSP name must correspond to a P2MP LSP name configured by the user at the ingress LER. The LSP name string must not contain “::” or “:” at the end of the LSP name. However, a single “:” can be used anywhere in the string except at the end of the name.

Parameters 
rsvp-p2mp lsp-name
Specifies the LSP. The LSP name can be up to 32 characters long and must be unique.
ldp-p2mp p2mp-id
Identifier used for signaling MLDP P2MP LSP.
Values—
1 to 4294967296 (on leaf node)
1 to 8192 (on root node)

 

sender sender-address
Specifies the sender IP address: a.b.c.d.

static

Syntax 
static
Context 
config>router>igmp>tunnel-interface
Description 

This command provides the context to configure static multicast receiver hosts on a tunnel interface associated with an RSVP P2MP LSP.

When enabled, data is forwarded to an interface without receiving membership reports from host members.

group

Syntax 
[no] group grp-ip-address
Context 
config>router>igmp>tunnel-interface>static
Description 

This command enables the context to add a static multicast group either as a (*,G) or one or more (S,G) records.

The user can assign static multicast group joins to a tunnel interface associated with an RSVP P2MP LSP.

A given <*,G> or <S,G> can only be associated with a single tunnel interface.

A multicast packet which is received on an interface and which succeeds the RPF check for the source address will be replicated and forwarded to all OIFs which correspond to the branches of the P2MP LSP. The packet is sent on each OIF with the label stack indicated in the NHLFE of this OIF. The packets will also be replicated and forwarded natively on all OIFs which have received IGMP or PIM joins for this <S,G>.

The multicast packet can be received over a PIM or IGMP interface which can be an IES interface, a spoke SDP terminated IES interface, or a network interface.

Parameters 
grp-ip-address —
Specifies a multicast group address that receives data on a tunnel interface. The IP address must be unique for each static group.

source

Syntax 
[no] source ip-address
Context 
config>router>igmp>tunnel-interface>static>group
Description 

This command specifies a IPv4 unicast address of a multicast source. The source command is mutually exclusive with the specification of individual sources for the same group. The source command in combination with the group is used to create a specific (S,G) group entry in a static group join on a tunnel interface associated with a P2MP RSVP LSP.

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

Parameters 
ip-address —
Specifies the IPv4 unicast address.

starg

Syntax 
[no] starg
Context 
config>router>igmp>tunnel-interface>static>group
Description 

This command adds a static (*,G) group entry in a static group join on a tunnel interface associated with a P2MP RSVP LSP.

This command can only be enabled if no existing source addresses for this group are specified.

The no form of the command removes the (*,G) entry from the configuration.