IgmpRouterConfig Object


Description:

Configures an IGMP querier on the port.

Parents: EmulatedDevice

Result children (automatically created): IgmpRouterResults

Relations:

Side name
(Type)
Relative Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

MPLS Control Plane Binding Result.

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

Primary Path.

ResultChild
(ResultChild)

IgmpRouterResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

IgmpRouterConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
IgnoreV1Reports

Specifies whether to ignore IGMPv1 messages on the interface. Valid only for IGMPv2.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Ignores IGMPv1 messages.

FALSE

Processes IGMPv1 messages.

Ipv4DontFragment

Controls the fragmentation of packets larger than the MTU (Maximum Transmission Unit) size.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Packets larger than the allowable MTU are not fragmented.

FALSE

Packets larger than the allowable MTU will be divided into fragments.

Ipv4Tos

Specifies the value of the TOS field in the IPv4 header.

Type: u8

Default: 192

Range: 0 - 255

LastMemberQueryCount

Value for the Max Response Time field (in milliseconds) that is inserted into Group-Specific and Group-and-Source-Specific Query messages in response to Leave Group messages. This value also specifies the interval between transmissions of Group-Specific and Group-and-Source-Specific Query messages. This field does not apply to IGMPv1.

Type: u8

Default: 2

LastMemberQueryInterval

Maximum amount of time between group-specific query messages, including those sent in response to leave-group messages.

Type: u32

Default: 1000

QueryInterval

Duration (in seconds) between transmissions of General Query messages. General Query messages are used to learn which multicast groups have members on a connected network.

Type: u32

Default: 125

QueryResponseInterval

Value for the Max Response Time field (in milliseconds) that is inserted into the General Query messages. This time is the maximum amount allowed for a host to send a responding report to the General Query message. This interval must be less than the Query Interval. This field does not apply to IGMPv1.

Type: u32

Default: 10000

RobustnessVariable

Specifies the variable used in the calculation of default values for various timers and counters.

Type: u8

Default: 2

Range: 2 - 255

RouterAlert

enable/disable router alert option in the IPv4 header for IGMP Query packet.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

force the IPv4 header to add Router Alert Option information in IGMP Query packet

FALSE

the IPv4 header don't add Router Alert Option information in IGMP Query packet

StartupQueryCount

Number of queries sent out on startup, separated by the Startup Query Interval.

Type: u8

Default: 2

Range: 1 - 255

TosType

Formatting of the TOS value.

Type: enum

Default: TOS

Possible Values:

Value Description
TOS

TOS

DIFFSERV

DiffServ

UsePartialBlockState

Controls the usage of partial block state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables the usage of partial block state.

FALSE

Disables the usage of partial block state.

Version

Selects the multicast protocol used to manage multicast group memberships.

Type: enum

Default: IGMP_V2

Possible Values:

Value Description
IGMP_V1

Second version (obsoleted IGMPv0) of IGMP, specified in RFC 1112.

IGMP_V2

IGMP version specified in RFC 2236. Improved IGMP version that adds leave messages, shortening the amount of time required for a router to determine that no stations are in a particular group.

IGMP_V3

Specified in RFC 3376, this major revision of the IGMP protocol adds the ability to specify the source(s) that a receiver is willing to listen to.

MLD_V1

Initial multicast protocol version for IPv6, similar to IGMPv2. It is specified in RFC 2710.

MLD_V2

Version of MLD, specified in RFC 3810, that adds the "include" and "exclude" filter functionality as in IGMPv3.

IgmpRouterConfig Read-Only Attributes

Read-Only Attribute Description
BlockState

State of the IGMP/MLD querier block.

Type: enum

Default: NOT_STARTED

Possible Values:

Value Description
UNDEFINED

Undefined.

NOT_STARTED

Not started.

UP

Already started and up.