StepTestConfig Object


Description:

Configuration for the custom step test.

Parents: Project

StepTestConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
CustomFrameSizeList

List of frame sizes in the format of a comma-delimited string. Applicable when FrameSizeType is CUSTOM.

Type: u16

Default: 0

CustomLoadList

List of load rates in the format of a comma-delimited string. Applicable when LoadType is CUSTOM.

Type: double

Default: 0

DelayAfterTransmission

Length of time you want to wait, after the test is complete, for all traffic to be received.

Type: u16

Default: 15

Range: 0 - 3600

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: double

Default: 10

Range: 0.000064 - 4398046.0

EnableArp

Whether to enable or disable ARP. Enabling will append ARPing commands into the sequencer.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

ARP is enabled.

FALSE

ARP is disabled.

EnableDhcp

Whether to enable or disable DHCP. Enabling will append DHCP related commands into the sequencer.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

DHCP is enabled.

FALSE

DHCP is disabled.

EnableL2Learning

Whether to enable Layer 2 learning mode.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Layer 2 learning mode.

FALSE

Disable Layer 2 learning mode.

EnableL2tp

Flag to add L2TP commands.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Adds L2TP commands.

FALSE

Does not add L2TP commands.

EnableOOSasFrameLoss

Whether to enable or disable out of sequence frame as frame loss in the test.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

EnableOOSasFrameLoss is enabled.

FALSE

EnableOOSasFrameLoss is disabled.

EnablePauseBeforeTraffic

If this option is enabled, this will pause the sequencer prior to starting traffic. This pause allows you time to do a final DUT check (for example, check routes) before Spirent TestCenter proceeds with traffic start.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable pause before starting traffic.

FALSE

No pause before starting traffic.

EnablePpp

Whether to enable or disable PPP. Enabling will append PPP related commands into the sequencer.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

PPP is enabled.

FALSE

PPP is disabled.

EnableRouter

Whether to enable or disable router. Enabling will append commands into the sequencer to start and stop all routers.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Router is enabled.

FALSE

Router is disabled.

EnableSavePortPairLatencyResults

Enable Save Port Pair Latency Results in custom throughput test.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Save port pair latency results is enabled.

FALSE

Save port pair latency results is disabled.

EnableWaitAfterAdvertisement

Whether to wait until advertisement completes. Enabling will append commands into the sequencer to wait for routing events and states.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Wait until advertisement completes.

FALSE

Do not wait until advertisement completes.

EnableWaitForMplsBinding

Flag to indicate whether to wait for MPLS binding. If enabled, traffic waits for MPLS streams to bind.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Traffic waits for MPLS streams to bind.

FALSE

Traffic does not wait for MPLS streams to bind.

FixedInterburstGapValue

Constant inter-burst gap value for all iterations. This attribute is ignored when InterBurstGapMode is RANDOM.

Type: u8

Default: 0

Range: 0 - 100

FrameSizeEnd

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

Type: u16

Default: 256

Range: 40 - 16383

FrameSizeStart

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

Type: u16

Default: 128

Range: 40 - 16383

FrameSizeStep

Step value for incrementing the frame size from StartFrameSize to StopFrameSize. This attribute is ignored if FrameSizeType is set to RANDOM, FIXED or CUSTOM.

Type: u16

Default: 128

Range: 1 - 16383

FrameSizeType

Method of setting the frame size.

Type: enum

Default: STEP

Possible Values:

Value Description
STEP

Frame size increases by StepFrameSize with each test iteration, beginning with StartFrameSize and increasing to StopFrameSize.

CUSTOM

Customized frame sizes. CustomFrameSizeList specifies all frame sizes.

IMIX

Frame sizes is defined by existing iMIX distribution.

RANDOM

Frame size is randomly chosen within the range set by RandomMinFrameSize and RandomMaxFrameSize.

ImixDistributionList

Specifies the selected iMIX distribution to be used from the available iMIX distributions in Spirent TestCenter.

Type: handle

Default: 0

InterburstGapMode

Specifies the Inter-burst gap mode, the idle time between packets, as either fixed or random.

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

Specifies that the inter-burst gap is a fixed value.

RANDOM

Specifies that the inter-burst gap is set randomly each iteration, between the range of RandomMinInterburstGapValue and RandomMaxInterburstGapValue.

LatencyDistributionList

List of up to 16 time intervals (latency buckets) into which received-frame latency values will be directed.

Type: u16

Default: 2

LoadEnd

When LoadType is STEP, the maximum load for each port. This attribute is ignored if LoadType is set to RANDOM or CUSTOM.

Type: double

Default: 50

LoadStart

When LoadType is STEP, 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 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

Method of setting the load rate.

Type: enum

Default: STEP

Possible Values:

Value Description
RANDOM

Load rate is randomly chosen within the range set by RandomMinLoad and RandomMaxLoad.

STEP

Load rate increases by LoadStep with each test iteration, beginning with LoadStart and increasing to LoadEnd.

CUSTOM

Customized load rates. CustomLoadList specifies all 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, or idle time between packets.

MEGABITS_PER_SECOND

Megabits per second.

KILOBITS_PER_SECOND

Kilobits per second.

BITS_PER_SECOND

Bits per second.

PerformL2Learning

Specifies when to perform Layer 2 learning.

Type: enum

Default: BEFORE_TEST

Possible Values:

Value Description
BEFORE_TEST

Perform Layer 2 learning before the test.

EACH_ITERATION

Perform Layer 2 learning for each iteration.

RandomMaxFrameSize

Maximum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP, FIXED or CUSTOM.

Type: u16

Default: 256

Range: 40 - 16383

RandomMaxInterburstGapValue

Maximum inter-burst gap value for all iterations. This attribute is ignored when InterBurstGapMode is FIXED.

Type: u8

Default: 12

Range: 0 - 100

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

Minimum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP, FIXED or CUSTOM.

Type: u16

Default: 128

Range: 40 - 16383

RandomMinInterburstGapValue

Minimum inter-burst gap value for all iterations. This attribute is ignored when InterBurstGapMode is FIXED.

Type: u8

Default: 12

Range: 0 - 100

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

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

StartTrafficDelay

This is the number of seconds to wait before sending traffic. This setting gives you the flexibility to start traffic a specific number of seconds after test start, or after advertisement is complete.

Type: u16

Default: 2

Range: 0 - 3600

TrafficStartMode

Traffic start mode to use.

Type: enum

Default: SYNCHRONOUS

Possible Values:

Value Description
SYNCHRONOUS

Traffic start is synchronous.

NONSYNCHRONOUS

Traffic start is nonsynchronous.

StepTestConfig Read-Only Attributes

Read-Only Attribute Description
TestType

Test type is custom.

Type: string

Default: Custom