MldHostConfig Object

Description:

Configures one or more host blocks on the MLD port.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: IgmpGroupMembership, MldGroupMembership

Automatically-created children: MldEotHostResults

Result children (automatically created): MldEotHostResults, MldHostResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	MPLS Control Plane Binding Result.
IptvParameter (MulticastParam)	IptvStbBlockConfig	Relationship between the IPTV set-top box block configuration object, and the MLD host configuration object.
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary Path.
ResultChild (ResultChild)	MldHostResults	Use this to connect a results object to an object.
VqAnalyzerChannelMembership (SubscribedHosts)	VqAnalyzerChannelMembershipGenParams	Relationship between an IGMP/MLD host and a Video Quality channel membership. Used exclusively in the Video Quality wizard.
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).

MldHostConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

ForceLeave

Affects all hosts except the last one, which is always required to send an MLDv1 leave report. MLDv1 hosts leaving a multicast group may optionally send a leave report to the all-routers multicast group. The ForceLeave flag controls whether or not all hosts are required to send leave reports when leaving the multicast group.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Force the MLDv1 host(s) to send a Leave Group message when leaving a multicast group.
FALSE	Do not force the MLDv1 host(s) to send a Leave Group message when leaving a multicast group.

ForceRobustJoin

When an MLDv1 host joins a multicast group, it immediately transmits an initial unsolicited membership report for that group, in case it is the first member of that group on the network. In case the initial report gets damaged or lost, a second unsolicited report is recommended be sent out. The ForceRobustJoin flag controls whether or not a second report is transmitted.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Forces the host to send a second MLDv1 join report.
FALSE	Does not force the host to send a second MLDv1 join report.

ForceSimpleJoin

Forces the MLD host(s) to send a single join report per group. Enabling this option effectively bypasses the RFC defined behavior of sending (Robustness Variable - 1) reports. Otherwise, MLD host(s) will behave according to RFC specification.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Force MLD host(s) to send a single join report per group.
FALSE	Default behavior that is compliant to RFC specification. MLD host(s) will send (Robustness Variable - 1) reports.

InsertCheckSumErrors

Controls the insertion of checksum errors into MLD messages by the hardware.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	MLD checksum of the transmitted packet is flipped by the protocol stack.
FALSE	MLD checksum of the transmitted packet is not modified.

InsertLengthErrors

Controls the insertion of message length errors into the MLD messages by the MLD stack.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Every MLD packet transmitted by the host will be 2 bytes shorter than normal.
FALSE	MLD packet lengths will not be modified.

Ipv6TrafficClass

Specifies the value of the Traffic Class field in the IPv6 header.

Type: u8

Default: 0

Range: 0 - 255

PackReports

Allows MLDv2 host(s) to send reports that contain multiple group records, to allow reporting of full current state using fewer packets.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Reports will contain multiple group records.
FALSE	An individual report will be sent for each group record.

RobustnessVariable

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

Type: u8

Default: 2

Range: 2 - 255

UnsolicitedReportInterval

Time between repetitions of a host's initial report of membership in a group.

Type: u32

Default: 10

Range: 0 - 604800

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.

MldHostConfig Read-Only Attributes

Read-Only Attribute

Description

BlockState

State of the IGMP/MLD host block.

Type: enum

Default: NON_MEMBER

Possible Values:

Value	Description
UNDEFINED	Undefined.
NON_MEMBER	No device in the block is joined to a group, and there are no initial unsolicited reports to be sent.
JOINING	At least one device in the block has yet to send its initial unsolicited non-Leave report.
MEMBER	At least one device in the block is joined to a group, and there are no initial unsolicited reports to be sent.
LEAVING	One or more devices in the block have yet to send their initial unsolicited Leave reports, and no device in the block is sending non-Leave reports.