Rfc2544ThroughputConfig Object

Description:

This test determines the maximum forwarding rate at which the DUT/SUT can forward traffic without frame loss (or with a user-specified acceptable frame loss).

Writable Attributes
Read-Only Attributes

Parents: AccessConcentratorGenParams, Project, Rfc2544Back2BackTestResult, Rfc2544FrameLossTestResult, Rfc2544LatencyTestResult, Rfc2544ThroughputTestResult, Rfc2544TrafficGroupConfig, Rfc5180Config

Children: BenchmarkEthernet10GigPortConfig, Rfc2544ThroughputProfile, TimeToTestConfig

Relations:

Side name (Type)	Relative	Description
SequencerRootCommand (BenchmarkingTestCaseRootCommand)		Sequencer test config.
GroupType (BenchmarkSideGroupType)	GroupType, GroupType	Type of side group.
TrafficDescriptorGroup (TrafficDescriptorGroupBinding)	TrafficDescriptorGroup	Relation describing the binding to the Traffic Descriptor Group.

Rfc2544ThroughputConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AcceptableFrameLoss

Maximum percentage of frames that can be lost during an iteration in order for the iteration to be considered successful.

Type: double

Default: 0

Range: 0.0 - 100.0

AsymmetricTrafficBackoffMode

How the rates will be backed off.

Type: enum

Default: FAILED_RATES

Possible Values:

Value	Description
ALL_RATES	Back off all rates.
FAILED_RATES	Back off failed rates.

Backoff

Rate at which the load decreases after the DUT fails at the current load. Applicable when SearchMode is BINARY or COMBO.

Type: double

Default: 50

Range: 0.001 - 99.999

CustomFrameSizeList

List of custom frame sizes to iterate.

Type: u16

Default: 0

DelayAfterTransmission

Delay provides additional time to transmit test frames during one test iteration and allows all frames to be transmitted.

Type: u16

Default: 15

Range: 1 - 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.

DurationBursts

Transmission length in number of frames.

Type: u32

Default: 1000

Range: 1 - 16777215

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.

DurationSeconds

Transmission time in seconds.

Type: u32

Default: 60

Range: 1 - 5184000

EnableDetailedResultsCollection

Collect Detailed Results.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Collection of Detailed Results.
FALSE	Disable Collection of Detailed Results.

EnableExposedInternalCommands

Whether to display the expanded sequence of component commands of the benchmarking test being configured.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Displays the sequence of component commands of the benchmarking test being configured.
FALSE	Displays the monolithic sequencer command for the benchmarking test being configured.

EnableFrameSizeOnTest

Whether to use frame size on test.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use frame size on test.
FALSE	Do not use frame size on test.

EnableJitterMeasurement

Whether to enable or disable jitter measurements.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Test is run in 'Jitter' analyzer result view mode.
FALSE	Test is not run in 'Jitter' analyzer result view mode. The default analyzer result view mode for the test is used.

EnableLearning

Whether to enable or disable L2L3 learning.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable learning.
FALSE	Disable learning.

EnableMaxLatencyThreshold

Whether the search algorithm uses the maximum latency per stream to determine the throughput.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Search uses the maximum latency to determine the throughput.
FALSE	Search does not use the maximum latency to determine the throughput.

EnableOutOfSeqThreshold

Whether the search algorithm uses the out-of-sequence frame count per stream to determine the throughput.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Search uses the out-of-sequence frame count to determine the throughput.
FALSE	Search does not use the out-of-sequence frame count to determine the throughput.

EnablePauseBeforeTraffic

Whether to pause before starting.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	A breakpoint is inserted in the sequence requiring user intervention in order to continue the traffic start.
FALSE	No breakpoint is inserted and flow continues as normal.

EnableTrafficVerification

Boolean to control whether to add verification commands to the test sequence.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Add commands to verify traffic forwarding to the test sequence.
FALSE	Do not add commands to verify traffic forwarding to the test sequence.

FrameSizeEnd

Maximum frame size when using Step mode for incrementing the frame size. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM.

Type: u16

Default: 256

Range: 47 - 16383

FrameSizeIterationMode

Mode for adjusting the frame size from iteration to iteration.

Type: enum

Default: CUSTOM

Possible Values:

Value	Description
RANDOM	Random mode. The frame size is randomly chosen within the range set by RandomMinFrameSize and RandomMaxFrameSize.
STEP	Step mode. The frame size increases by FrameSizeStep with each test iteration, beginning with FrameSizeStart and increasing to FrameSizeEnd.
CUSTOM	Custom mode. CustomFrameSizeList specifies the frame sizes.
IMIX	iMIX mode.
NONE	Frame size mode not specified.

FrameSizeStart

Starting frame size when using Step mode for incrementing the frame size. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM.

Type: u16

Default: 128

Range: 47 - 16383

FrameSizeStep

Step value for incrementing the frame size for Step mode from FrameSizeStart to FrameSizeEnd. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM.

Type: u16

Default: 128

Range: 1 - 16383

IgnoreMinMaxLimits

Whether the search stops at the specified RateLowerLimit or RateUpperLimit value, or whether it continues beyond those limits if an acceptable load has not yet been found.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Continues beyond minimum and maximum limits to find acceptable load.
FALSE	Search stops at the RateLowerLimit or RateUpperLimit value.

ImixDistributionList

List of iMIX distributions to iterate.

Type: handle

Default: 0

ImixDistributionString

For display purposes only.

Type: string

Default: "" (empty string)

L2DelayBeforeLearning

Delay in seconds before address resolution begins.

Type: u16

Default: 2

Range: 0 - 3600

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

L2LearningRepeatCount

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

Type: u16

Default: 5

Range: 1 - 100

L3DelayBeforeLearning

Delay in seconds before address resolution begins.

Type: u16

Default: 2

Range: 0 - 3600

L3EnableCyclicAddrResolution

Whether to enable Layer 3 cyclic address resolution.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable Layer 3 cyclic address resolution.
FALSE	Disable cyclic address resolution.

L3Rate

Rate to send ARP requests.

Type: u32

Default: 1000

L3RetryCount

Number of Layer 3 retry attempts allowed.

Type: u16

Default: 5

Range: 1 - 100

LatencyType

How latency results are calculated and displayed.

Type: enum

Default: LILO

Possible Values:

Value	Description
LILO	Last In Last Out mode.
LIFO	Last In First Out mode.
FIFO	First In First Out mode.
FILO	First In Last Out mode.

LearningFreqMode

Learning frequency.

Type: enum

Default: LEARN_ONCE

Possible Values:

Value	Description
LEARN_ONCE	Learning occurs only once per test.
LEARN_EVERY_TRIAL	Learning occurs on every trial.
LEARN_EVERY_FRAME_SIZE	Learning occurs for every frame size.
LEARN_EVERY_ITERATION	Learning occurs for every iteration.

LearningMode

Learning mode.

Type: enum

Default: L3_LEARNING

Possible Values:

Value	Description
L2_LEARNING	Layer 2 learning mode.
L3_LEARNING	Layer 3 learning mode.

MaxLatencyThreshold

Maximum latency per stream that can be reached during an iteration in order for the iteration to be considered successful.

Type: double

Default: 30

Range: 0.01 - 4294967295.0

NumOfTrials

Number of trials to run.

Type: u16

Default: 1

Range: 1 - 60

OutOfSeqThreshold

Maximum out-of-sequence frames per stream that can be received during an iteration in order for the iteration to be considered successful.

Type: u32

Default: 0

Range: 0 - 2147483647

ProfileConfigGroupType

Group type used to assign profiles.

Type: string

Default: "" (empty string)

ProfileConfigMode

Mode used for creating profiles.

Type: enum

Default: MANUAL

Possible Values:

Value	Description
MANUAL	User configures profiles.
PER_PORT	One profile per port.
PER_SIDE	One profile per side.
PER_GROUP	One profile per group.

RandomMaxFrameSize

When using random mode for setting frame sizes, the maximum frame size. This attribute is ignored if FrameSizeIterationMode is set to STEP or CUSTOM.

Type: u16

Default: 256

Range: 47 - 16383

RandomMinFrameSize

When using random mode for setting frame sizes, the minimum frame size. This attribute is ignored if FrameSizeIterationMode is set to STEP or CUSTOM.

Type: u16

Default: 128

Range: 47 - 16383

RateInitial

If SearchMode is set to BINARY, the load rate at the beginning of the test. This attribute is ignored if SearchMode is set to STEP.

Type: double

Default: 10

Range: 0.001 - 100.0

RateLowerLimit

If SearchMode is set to STEP, the starting load rate for each port. This attribute is ignored if SearchMode is set to BINARY.

Type: double

Default: 1

Range: 0.001 - 100.0

RateStep

If SearchMode is set to STEP, the amount the load increases from iteration to iteration. This attribute is ignored if SearchMode is set to BINARY.

Type: double

Default: 10

Range: 0.001 - 100.0

RateUpperLimit

If SearchMode is set to STEP, the maximum load rate for each port. This attribute is ignored if SearchMode is set to BINARY.

Type: double

Default: 100

Range: 0.001 - 100.0

Resolution

Finest adjustment possible for the load from iteration to iteration. If the required adjustment to the current load for the next iteration is less than the resolution, the search stops. Applicable when SearchMode is BINARY or COMBO.

Type: double

Default: 1

Range: 0.001 - 100.0

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

SearchMode

Mode used to vary the load.

Type: enum

Default: BINARY

Possible Values:

Value	Description
BINARY	Binary mode. The test searches for the throughput value using a binary search algorithm.
STEP	Step mode. The test load increases with each iteration as set by RateStep.
COMBO	Combo mode. The test begins in step mode and then switches to binary mode when an iteration fails.

StaggerStartDelay

Delay (milliseconds) between the start of transmission of test traffic by individual ports.

Type: u16

Default: 0

Range: 0 - 65535

TrafficStartDelay

Provides additional time to transmit test frames during one test iteration and allows all frames to be transmitted.

Type: double

Default: 2

Range: 0.005 - 3600

TrafficStartDelayMode

Mode for traffic start delay.

Type: enum

Default: AFTER_TEST

Possible Values:

Value	Description
AFTER_TEST	After the test.
AFTER_USER_RESPONSE	After the user response.

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

Specifies when to perform traffic verification during the test.

Type: enum

Default: VERIFY_EVERY_ITERATION

Possible Values:

Value	Description
VERIFY_EVERY_TRIAL	Verify traffic forwarding at the beginning of every trial.
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: u16

Default: 100

Range: 1 - 32767

TrafficVerificationTxFrameRate

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

Type: u32

Default: 1000

Range: 1 - 14880952

UseExistingStreamBlocks

Use Existing Stream Blocks.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Uses existing stream blocks for the test.
FALSE	Automatically generates new stream blocks for the test.

Rfc2544ThroughputConfig Read-Only Attributes

There are no read-only attributes.