Rfc3918Config Object

Description:

Configuration object for RFC 3918 tests.

Writable Attributes
Read-Only Attributes

Parents: Project

Children: BenchmarkEthernet10GigPortConfig, Rfc3918AggregatedMulticastThroughputTestCaseConfig, Rfc3918JoinLeaveLatencyTestCaseConfig, Rfc3918MixedClassThroughputTestCaseConfig, Rfc3918MulticastForwardingLatencyTestCaseConfig, Rfc3918MulticastGroupCapacityTestCaseConfig, Rfc3918ScaledGroupForwardingTestCaseConfig

Relations:

Side name (Type)	Relative	Description
MulticastDstDevice (MulticastDstBinding)	EmulatedDevice	Relation from Rfc3918Config to multicast destination endpoints.
MulticastGroups (MulticastGroupBinding)	Ipv4Group, Ipv6Group	Relation from Rfc3918Config to associated multicast groups.
MonitorPorts (MulticastMonitorPortBinding)	Port	Relation from Rfc3918Config to monitor ports.
ObservePorts (MulticastObservePortBinding)	Port	Relation from Rfc3918Config to observe ports.
MulticastSrcDevice (MulticastSrcBinding)	EmulatedDevice	Relation from Rfc3918Config to multicast source endpoints.
MulticastStreamBlocks (MulticastStreamBlockBinding)	StreamBlock	Relation from Rfc3918Config to associated multicast streamblocks.

Rfc3918Config Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

CustomMulticastFrameSizeList

Custom list of multicast frame sizes.

Type: u16

Default: 0

Range: 47 - 16383

CustomMulticastImixList

List of iMIX distributions.

Type: handle

Default: 0

DelayBeforeLearning

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

This property is deprecated.

Type: u16

Default: 2

Range: 0 - 3600

DisplayLoadUnit

Display units for load in results.

Type: enum

Default: PERCENT_LINE_RATE

Possible Values:

Value	Description
PERCENT_LINE_RATE	Rate in percentage.
FRAMES_PER_SECOND	Rate in frames per second.
INTER_BURST_GAP	Rate in Inter burst gaps.
MEGABITS_PER_SECOND	Rate in megabits per second.
KILOBITS_PER_SECOND	Rate in kilobits per second.
BITS_PER_SECOND	Rate in bits per second.

DisplayTrafficGroupLoadUnit

Display units for traffic group load in results.

Type: enum

Default: PERCENT_LINE_RATE

Possible Values:

Value	Description
PERCENT_LINE_RATE	Rate in percentage.
MEGABITS_PER_SECOND	Rate in megabits per second.
KILOBITS_PER_SECOND	Rate in kilobits per second.
BITS_PER_SECOND	Rate in bits per second.

Duration

Scalar value of duration.

Type: u32

Default: 60

Range: 1 - 5184000

DurationMode

Duration mode for each transmitted stream. Whether to measure test duration in seconds or number of frames.

Type: enum

Default: SECONDS

Possible Values:

Value	Description
SECONDS	Sets duration mode to time in seconds.
BURSTS	Sets duration mode to number of frames per transmission burst.

FixedMulticastFrameSize

Fixed frame size for multicast.

Type: u16

Default: 128

Range: 47 - 16383

IpTos

IP ToS Value.

Type: u8

Default: 0

Ipv6FlowLabel

IPv6 Flow Label.

Type: u32

Default: 0

Range: 0 - 1048575

L2LearningFrameRate

Rate at which learning frames are sent to the DUT/SUT during the learning phase of the test.

Type: u32

Default: 1000

Range: 1 - 4294967295

L2LearningFrameSize

L2 learning frame size if FrameSize is fixed.

Type: u16

Default: 128

Range: 64 - 16383

L2LearningFrameSizeMode

How to determine L2 learning frame size.

Type: enum

Default: SAME_AS_STREAM

Possible Values:

Value	Description
SAME_AS_STREAM	L2 learning frame size is the same as the test streams.
FIXED	L2 learning frame size will use a user defined fixed size.

L2LearningRepeatCount

Number of learning retries if transmission errors, learning verification errors, or link errors occur.

Type: u16

Default: 5

Range: 1 - 100

L3LearningEnableCyclicAddrResolution

Whether to perform cyclic address resolution or not.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Perform cyclic address resolution.
FALSE	Do not perform cyclic address resolution.

L3LearningRate

Maximum rate of L3 learning requests.

Type: u32

Default: 1000

Range: 1 - 4294967295

L3LearningRetryCount

Maximum number of retries for L3 learning.

Type: u16

Default: 5

Range: 1 - 100

L4DstPortBase

Base L4 destination port.

Type: u16

Default: 7

L4DstPortCount

Number of different L4 dst ports.

Type: u16

Default: 0

L4DstPortStep

Step value for subsequent L4 destination ports.

Type: u16

Default: 1

L4HeaderType

L4 Header.

Type: enum

Default: UDP

Possible Values:

Value	Description
NONE	No L4 header.
TCP	TCP
UDP	UDP

L4SrcPortBase

Base L4 source port.

Type: u16

Default: 7

L4SrcPortCount

Number of different L4 source ports.

Type: u16

Default: 0

L4SrcPortStep

Step value for subsequent L4 ports.

Type: u16

Default: 1

L4UseRandomPorts

Whether to use random L4 ports.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use random L4 ports.
FALSE	Do not use random L4 ports.

LatencyType

Method for latency measurements.

Type: enum

Default: FIFO

Possible Values:

Value	Description
FIFO	First in, first out (bit forwarding devices).
FILO	First in, last out.
LIFO	Last in, first out (store-and-forward devices).
LILO	Last in, last out.

LearningFreqMode

Learning frequency.

Type: enum

Default: LEARN_EVERY_TOPOLOGY_CHANGE

Possible Values:

Value	Description
NONE	Never perform learning.
LEARN_EVERY_TOPOLOGY_CHANGE	Learn on every topology change.
LEARN_EVERY_FRAME_SIZE	Learn on every frame size iteration.
LEARN_EVERY_ITERATION	Learn every iteration.

MulticastClientVersion

Protocol to use for multicast clients.

Type: enum

Default: IGMP_V3

Possible Values:

Value	Description
IGMP_V1	IGMP, version 1.
IGMP_V2	IGMP, version 2.
IGMP_V3	IGMP, version 3.
MLD_V1	MLD, version 1.
MLD_V2	MLD, version 2.

MulticastFrameSizeEnd

Final multicast frame size used when stepping.

Type: u16

Default: 1518

Range: 48 - 16383

MulticastFrameSizeMode

Method used to adjust multicast frame size.

Type: enum

Default: CUSTOM

Possible Values:

Value	Description
FIXED	Fixed multicast frame size.
STEP	Step multicast frame size.
CUSTOM	Use values in custom multicast frame size list.
IMIX	Use iMIX frame size values in custom multicast iMIX list.
RANDOM	Use random multicast frame size values.

MulticastFrameSizeStart

Initial multicast frame size used when stepping.

Type: u16

Default: 128

Range: 47 - 16382

MulticastFrameSizeStep

Multicast step frame size used when stepping.

Type: u16

Default: 128

Range: 1 - 16383

MulticastGroupBaseIpAddr

Base IP address for multicast group block.

Type: ip

Default: 225.0.0.1

MulticastGroupBaseIpStep

Step value between IPv4 Multicast Group Blocks (if necessary).

Type: ip

Default: 0.1.0.0

MulticastGroupBaseIpv6Addr

Base IPv6 address for multicast group block.

Type: ipv6

Default: ff1e::1

MulticastGroupBaseIpv6Step

Step value between IPv6 Multicast Group Blocks (if necessary).

Type: ipv6

Default: 0:0:0:1::0

MulticastGroupIncrement

Step value for subsequent groups.

Type: u32

Default: 1

Range: 1 - 4294967295

MulticastJoinGroupDelay

DUT group join processing delay.

Type: u32

Default: 15

Range: 0 - 2147483647

MulticastLeaveGroupDelay

DUT group leave processing delay.

Type: u32

Default: 15

Range: 0 - 2147483647

MulticastMsgTxRate

Per port Tx rate for multicast messages.

Type: u32

Default: 1000

NumOfTrials

Number of trial iterations.

Type: u16

Default: 1

Range: 1 - 60

RandomMaxMulticastFrameSize

Upper bound for random multicast frame sizes.

Type: u16

Default: 1518

Range: 47 - 16383

RandomMinMulticastFrameSize

Lower bound for random multicast frame sizes.

Type: u16

Default: 128

Range: 47 - 16382

ResultsCollectionDelay

Interval in seconds between test stop and result collection.

Type: u32

Default: 15

Range: 0 - 2147483647

ResultsOption

Results Option for the test

Type: enum

Default: CLASSIC

Possible Values:

Value	Description
CLASSIC	Test will collect results with Classic Results
ENHANCED	Test will collect results with TestCenter IQ

TestStartDelay

Delay before starting test.

Type: u16

Default: 2

Range: 0 - 3600

TrafficVerificationAbortOnFail

Test behavior when traffic verification fails.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Abort the test and set the sequencer status mode to FAIL if traffic verification is not successful.
FALSE	Do nothing. Test continues without interruption.

TrafficVerificationFreqMode

When to perform traffic verification during the test.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	Do not perform traffic verification.
VERIFY_EVERY_TOPOLOGY_CHANGE	Verify traffic forwarding after the topology changes.
VERIFY_EVERY_FRAME_SIZE	Verify traffic forwarding after changing the frame size.
VERIFY_EVERY_ITERATION	Verify traffic forwarding at the beginning of every iteration.

TrafficVerificationTxFrameCount

Number of frames to use for traffic verification.

Type: u32

Default: 100

Range: 1 - 32767

TrafficVerificationTxFrameRate

Traffic rate in frames per second to use for traffic verification.

Type: u32

Default: 1000

Range: 1 - 14880952

Ttl

Time To Live.

Type: u8

Default: 10

UDPRandomHeaderStartPort

UDP Random Header Start Port

Type: enum

Default: 0

Possible Values:

Value	Description
START_FROM_0	UDP Random Header starts from 0
START_FROM_1024	UDP Random Header starts from 1024

VlanPriority

Sets the VLAN priority for multicast traffic (if VLANs are present).

Type: u8

Default: 0

Range: 0 - 7

Rfc3918Config Read-Only Attributes

There are no read-only attributes.