Rfc2889ForwardingConfig Object

Description:

Configuration object for RFC 2889 Forwarding test.

Writable Attributes
Read-Only Attributes

Parents: Project

Children: BenchmarkEthernet10GigPortConfig

Relations:

Side name (Type)	Relative	Description
TrafficDescriptorGroup (TrafficDescriptorGroupBinding)	TrafficDescriptorGroup	Relation to describe the binding with the traffic descriptor group.

Rfc2889ForwardingConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AcceptableFrameLoss

Maximum frame loss you want Spirent TestCenter to allow before stopping the test. This value represents the aggregate loss from all flows averaged across each all ports in the test.

Type: double

Default: 0

Range: 0.0 - 100.0

Backoff

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

BurstSizeEnd

Final burst size when the burst size mode is set to STEP.

Type: u32

Default: 1

Range: 1 - 4294967295

BurstSizeIterationMode

Mode for adjusting the burst size over all iterations.

Type: enum

Default: STEP

Possible Values:

Value	Description
STEP	Burst size is adjusted in steps starting from BurstSizeStart up to and including BurstSizeEnd.
CUSTOM	Burst size is adjusted as per a user specified list of burst sizes.

BurstSizeStart

Initial burst size when burst size mode is set to STEP.

Type: u32

Default: 1

Range: 1 - 4294967295

BurstSizeStep

Step value for the burst size when going from the initial burst size to final burst size over different iterations.

Type: u32

Default: 1

Range: 1 - 4294967295

CustomBurstSizeList

User defined list of burst sizes used when Burst size mode is set to CUSTOM.

Type: u32

Default: 0

Range: 1 - 4294967295

CustomFrameSizeList

User defined list of frame sizes.

Type: u16

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

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 frame size specified in the test-level attributes.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use the test-level frame size.
FALSE	Do not use the test-level 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

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 in the sequence.

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.

ExternalProcessCommand

Command to run an user specified external process.

Type: string

Default: "" (empty string)

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: 64 - 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.

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

Enable the application to automatically define a Min Rate /Max Rate range that successfully yields throughput.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Continue Beyond Min or Max.
FALSE	Restricted between Min and Max.

L2DelayBeforeLearning

Time in seconds prior to the commencement of training.

Type: u16

Default: 2

Range: 0 - 3600

L2LearningFrameRate

Layer 2 learning rate in frames per second for 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 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	Disable cyclic address resolution.

L3LearningRate

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

Latency type for different devices.

Type: enum

Default: LILO

Possible Values:

Value	Description
LILO	Last in, last out.
LIFO	Last in, first out (store-and-forward devices).
FIFO	First in, first out (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 per test.
LEARN_EVERY_TRIAL	Learn every trial.
LEARN_EVERY_FRAME_SIZE	Learn every frame size.
LEARN_EVERY_ITERATION	Learn every iteration.

LearningMode

Learning mode.

Type: enum

Default: L2_LEARNING

Possible Values:

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

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

RandomMaxFrameSize

When using Random Mode for FrameSizeIterationMode, the maximum frame size. This attribute is ignored if FrameSizeIterationMode is set to STEP or CUSTOM.

Type: u16

Default: 256

Range: 64 - 16383

RandomMinFrameSize

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

Type: u16

Default: 128

Range: 64 - 16383

RateInitial

Transmission rate for the first iteration of the test. This is a percentage of the full wire rate.

Type: double

Default: 10

Range: 0.001 - 100.0

RateLowerLimit

Lowest transmission rate at which the application will send traffic during any test iteration, as a percentage of the total wire rate.

Type: double

Default: 1

Range: 0.001 - 100.0

RateStep

Percent by which Spirent TestCenter will increase the current transmission rate, as a percentage of the total wire rate. The transmission rate increases until the maximum rate is reached, even if there is frame loss.

Type: double

Default: 10

Range: 0.001 - 100.0

RateUpperLimit

Maximum rate at which Spirent TestCenter will send traffic during the test,as a percentage of the total wire rate.

Type: double

Default: 100

Range: 0.001 - 100.0

Resolution

Finest adjustment possible, in number of frames, for the duration of transmitted frames from iteration to iteration.

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

RunExternalProcessBeforeTraffic

Allows user to run an external process before generating and transmitting traffic.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Runs the user specified external process.
FALSE	No external process is run.

SearchMode

Mode used to find the throughput rate.

Type: enum

Default: BINARY

Possible Values:

Value	Description
BINARY	Test searches for the throughput value by using a binary search algorithm.
STEP	Test load increases with each iteration by the percentage specified by step load.
COMBO	Mode begins in Step mode, then changes to Binary mode when the step adjustment causes failure.

StaggerStartDelay

Delay between starting successive ports, in milliseconds.

Type: u16

Default: 0

Range: 0 - 65535

TrafficStartDelay

When to begin the traffic start delay.

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

Rfc2889ForwardingConfig Read-Only Attributes

There are no read-only attributes.