Rfc2544LatencyConfig Object

Description:

This test measures the minimum, maximum, and average latency of the DUT/SUT through a range of frame sizes and loads (rates).

Writable Attributes
Read-Only Attributes

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

Children: BenchmarkEthernet10GigPortConfig, Rfc2544LatencyProfile

Automatically created from: Rocev2PerfConfigGenParams

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.

Rfc2544LatencyConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AcceptableFrameLoss

Specifies the maximum frame loss you want Spirent TestCenter to allow before decide test failed

Type: double

Default: 0

Range: 0.0 - 100.0

Backoff

Specifies the percentage by which the transmission rate will be lowered if the test fails at the current rate

Type: double

Default: 50

Range: 0.001 - 99.999

CustomFrameSizeList

Frame sizes in custom mode. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or STEP or IMIX.

Type: u16

Default: 0

CustomLoadList

List of user defined load values.

Type: double

Default: 0

DelayAfterTransmission

Delay after transmission in seconds.

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

Enable collection of detailed results.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Deletes the detailed result iteration database file at the end of the test.
FALSE	Retains the detailed result iteration database file at the end of the test.

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	Display the sequence of component commands of the benchmarking test being configured.
FALSE	Display the monolithic sequencer command for the benchmarking test being configured.

EnableFrameSizeOnTest

Whether to use the test frame size value.

Type: bool

Default: TRUE

Possible Values:

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

EnableJitterMeasurement

Allow measuring min, maximum and average jitter values. This is done by running the test in 'Jitter' analyzer result view mode.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Measures minimum, maximum and average jitter values.
FALSE	Does not measure minimum, maximum and average jitter values.

EnableLearning

Whether to enable learning mode.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable learning mode.
FALSE	Disable learning mode.

EnablePauseBeforeTraffic

If enabled, port starting times will be staggered as specified by StaggerStartDelay.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Port starting times will be staggered as specified by StaggerStartDelay.
FALSE	Port starting times will not be staggered.

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 or IMIX.

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 or IMIX.

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 or IMIX.

Type: u16

Default: 128

Range: 1 - 16383

ImixDistributionList

iMIX distribution List. This attribute is ignored if FrameSizeIterationMode is set to RANDOM or CUSTOM or STEP.

Type: handle

Default: 0

ImixDistributionString

iMIX distribution string. For display purposes only.

Type: string

Default: "" (empty string)

IsRelativeToThroughputTestEnabled

Specifies whether Rfc2544LatencyTest is running with Rfc2544RelativeThroughputTest or not

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Rfc2544LatencyTest is running relative to Rfc2544ThroughputTest
FALSE	Rfc2544LatencyTest is not running relative to Rfc2544ThroughputTest

L2DelayBeforeLearning

Delay before learning in seconds.

Type: u16

Default: 2

Range: 0 - 3600

L2LearningFrameRate

Layer 2 learning rate for the test in frames per second.

Type: u32

Default: 1000

Range: 1 - 4294967295

L2LearningRepeatCount

Number of Ping packets to send to the Layer 2 destination address.

Type: u16

Default: 5

Range: 1 - 100

L3DelayBeforeLearning

Delay before L3 learning.

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	Cyclic address resolution is not enabled.

L3Rate

L3 learning rate.

Type: u32

Default: 1000

L3RetryCount

Number of Layer 3 retry attempts allowed.

Type: u16

Default: 5

Range: 1 - 100

LatencyDistributionList

List of latency distribution buckets.

Type: double

Default: 2

Range: 1 - 4294967296

LatencyType

Device latency type.

Type: enum

Default: LILO

Possible Values:

Value	Description
LILO	Last-In Last-Out latency.
LIFO	Last-In First-Out latency (store-and-forward devices).
FIFO	First-In First-Out latency (bit forwarding devices).
FILO	First In Last Out mode.

LearningFreqMode

Learning frequency.

Type: enum

Default: LEARN_ONCE

Possible Values:

Value	Description
LEARN_ONCE	Learn once.
LEARN_EVERY_TRIAL	Learn every trial.
LEARN_EVERY_FRAME_SIZE	Learn for every new frame size.
LEARN_EVERY_ITERATION	Learn 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.

LoadEnd

When using Step mode for load on the ports, the maximum load for each port. This attribute is ignored if LoadType is set to RANDOM or CUSTOM.

Type: double

Default: 50

LoadStart

When using Step mode for load on the ports, the starting load for each port. This attribute is ignored if LoadType is set to RANDOM or CUSTOM.

Type: double

Default: 10

LoadStep

Step value for incrementing the load for Step mode from LoadStart to LoadEnd. This attribute is ignored if LoadType is set to RANDOM or CUSTOM.

Type: double

Default: 10

Range: 0.001 - 100000000000.0

LoadType

Mode for adjusting the load from iteration to iteration.

Type: enum

Default: STEP

Possible Values:

Value	Description
RANDOM	Random load type. The load rate is randomly chosen within the range set by RandomMinLoad and RandomMaxLoad.
STEP	Step load type. The load increases by LoadStep with each test iteration, beginning with LoadStart and increasing to LoadEnd.
CUSTOM	Custom mode. CustomLoadList specifies the load rates.

LoadUnits

Unit of measurement for the load parameter, applied to all ports and streams in the test.

Type: enum

Default: PERCENT_LINE_RATE

Possible Values:

Value	Description
PERCENT_LINE_RATE	Percentage of the line rate.
FRAMES_PER_SECOND	Frames per second.
INTER_BURST_GAP	Inter burst gap.
MEGABITS_PER_SECOND	Megabits per second.
KILOBITS_PER_SECOND	Kilobits per second.
BITS_PER_SECOND	Bits per second.

NumOfTrials

Number of times the test repeats with its initial configuration. Each trial is based on the same parameter values. Within a trial, certain parameter values vary with each iteration, according to the test methodology and setup. At the start of the next trial, these parameters revert to their initial values.

Type: u16

Default: 1

Range: 1 - 60

ProfileConfigGroupType

Group type used to assign profiles.

Type: string

Default: "" (empty string)

ProfileConfigMode

Profile configuration mode.

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 frame sizes, the maximum frame size. This attribute is ignored if FrameSizeIterationMode is set to STEP or CUSTOM or IMIX.

Type: u16

Default: 256

Range: 47 - 16383

RandomMaxLoad

When using random mode for load on the ports, the maximum load for each port. This attribute is ignored if LoadType is set to STEP or CUSTOM.

Type: double

Default: 50

RandomMinFrameSize

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

Type: u16

Default: 128

Range: 47 - 16383

RandomMinLoad

When using random mode for load on the ports, the minimum load for each port. This attribute is ignored if LoadType is set to STEP or CUSTOM.

Type: double

Default: 10

RateInitial

Specifies the transmission rate for the first iteration of the test, use this for both Binary and step modes

Type: double

Default: 10

Range: 0.001 - 100.0

RateLowerLimit

Specifies the lowest transmission rate at which the application will send traffic, this one applicable for Binary mode only

Type: double

Default: 1

Range: 0.001 - 100.0

RateStep

Specifies the percent by which Spirent TestCenter will increase the current transmission rate, use only for step mode only

Type: double

Default: 10

Range: 0.001 - 100.0

RateUpperLimit

Specifies the maximum rate at which Spirent TestCenter will send traffic, use it for both Binary and step modes

Type: double

Default: 100

Range: 0.001 - 100.0

Resolution

Specifies the minimum allowable delta between the highest passed transmission rate and the lowest failed transmission rate,this option used only for Binary mode selection

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

Specifies ThroughputLoad mode selection whenever enabling of RunTestRelativeToThroughput option

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 between starting successive ports, in milliseconds. Ignored when EnablePauseBeforeTraffic is FALSE.

Type: u16

Default: 0

Range: 0 - 65535

ThroughputRatePercent

Throughput rate percentage to use. Applicable only for asymmetric tests only.

Type: double

Default: 100.0

TrafficStartDelay

Traffic start delay in seconds.

Type: double

Default: 2

Range: 0.005 - 3600

TrafficStartDelayMode

When to begin the traffic start delay.

Type: enum

Default: AFTER_TEST

Possible Values:

Value	Description
AFTER_TEST	Start traffic after test begins.
AFTER_USER_RESPONSE	Start traffic after 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

Enables or disables the use of existing pre-configured stream blocks for the test.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use existing stream blocks for the test.
FALSE	Allow the application to generate new stream blocks to be used for the test.

UseThroughputRates

Specifies that the test will use rates derived from the throughput test. Applicable only for asymmetric tests only.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Test will use rates derived from the throughput test.
FALSE	Test will use user defined rates.

Rfc2544LatencyConfig Read-Only Attributes

There are no read-only attributes.