MulticastHostGenProtocolParams Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Multicast Host generator parameters.

Parents: EmulatedDeviceGenParams, HostGenParams, RouterGenParams

Children: DeviceGenLinkedStep

Relations:

Side name
(Type)		 Relative Description
MulticastSource
(SubscribedSources)

EmulatedDevice

Sources to subscribe to for multicast traffic.

MulticastHostGenProtocolParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
DeleteExistingGroups

Whether to delete the existing multicast groups in the system

Type: enum

Default: PROMPT

Possible Values:

Value Description
PROMPT

Prompt
YES

Yes
NO

No
DeviceGroupMapping

Specifies the mapping between the device and subscribed multicast group within their respective blocks.

Type: enum

Default: MANY_TO_MANY

Possible Values:

Value Description
MANY_TO_MANY

Creates a full mesh of devices and groups.
ONE_TO_ONE

Assigns one device to each group. The mapping stops when it reaches the end of either devices or groups. The extra devices or groups are not mapped.
ROUND_ROBIN

Creates a round robin of devices and groups.
FilteredSources

Mode for specifying filtered sources.

Type: enum

Default: NONE

Possible Values:

Value Description
EXISTING

Use existing sources (Hosts).
CUSTOM

Specify sources by entering starting source IP, count, and step.
NONE

Specifies an empty source list.
FilterMode

Specifies an explicit set of sources from which the multicast group is interested in receiving data.

Type: enum

Default: EXCLUDE

Possible Values:

Value Description
INCLUDE

Data from the specified sources are filtered and forwarded to the hosts by the multicast router.
EXCLUDE

Data from the specified sources are filtered and not forwarded to the hosts by the multicast router.
IgnoreMemberships

IGMP/MLD Host-only creation from wizard. Skip configuration of group memberships.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Specifies that IGMP/MLD hosts will be created without memberships.
FALSE

Specifies that IGMP/MLD hosts will be created with memberships.
McastGroupCount

Number of multicast groups to subscribe to.

Type: u32

Default: 1

Range: 1 - 32000
McastIpv4Addr

IPv4 multicast group address.

Type: ip

Default: 225.0.0.1
McastIpv4AddrPortStep

Step to apply to the IPv4 multicast group for each subsequent port.

Type: ip

Default: 0.0.0.0
McastIpv6Addr

IPv6 multicast group address.

Type: ipv6

Default: ff1e::1
McastIpv6AddrPortStep

Step to apply to the IPv6 multicast group for each subsequent port.

Type: ipv6

Default: ::0
RouterAlert

enable/disable router alert option

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

force the IPv4 header to add Router Alert Option in igmp packet
FALSE

the IPv4 header don't add Router Alert Option in igmp packet
SrcCount

Number of multicast sources.

Type: u32

Default: 1

Range: 1 - 4294967295
SrcIpv4Addr

Multicast source IPv4 address.

Type: ip

Default: 1.0.0.2
SrcIpv4Prefix

Multicast source IPv4 prefix length.

Type: u8

Default: 24

Range: 1 - 32
SrcIpv6Addr

Multicast source IPv6 address.

Type: ipv6

Default: 2001::2
SrcIpv6Prefix

Multicast source IPv6 prefix length.

Type: u8

Default: 64

Range: 1 - 128
SrcStep

Step for the multicast source address.

Type: u32

Default: 1

Range: 0 - 4294967295
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.

MulticastHostGenProtocolParams Read-Only Attributes

There are no read-only attributes.