TwampTestSession Object


Description:

Defines the characteristics of an emulated TWAMP test session. This is the TWAMP test session configuration object.

Parents: TwampClientConfig

Result children (automatically created): TwampTestSessionResults

Relations:

Side name
(Type)
Relative Description
ResultChild
(ResultChild)

TwampTestSessionResults

Use this to connect a results object to an object.

TwampTestSession Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
DSCP

Diffserv code point.

Type: u8

Default: 0

Range: 0 - 63

DstUdpPort

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

Destination UDP port.

Type: u16

Default: 123

Range: 1 - 65535

Duration

Duration

Type: u32

Default: 60

DurationMode

Duration mode.

Type: enum

Default: SECONDS

Possible Values:

Value Description
SECONDS

Seconds

PACKETS

Packets

CONTINUOUS

Continuous

FrameRate

Frame rate (f/sec).

Type: u32

Default: 10

Range: 1 - 1000

PacketCount

Packet count.

Type: u32

Default: 100

PaddingLength

Padding length.

Type: u16

Default: 128

Range: 27 - 9000

PaddingPattern

Padding pattern.

Type: enum

Default: RANDOM

Possible Values:

Value Description
RANDOM

Random

USER_DEFINED

User defined.

USER_DEFINED_HEX

User defined to input a hex value.

PaddingUserDefinedPattern

User-defined padding pattern.

Type: string

Default: spirent

PaddingUserDefinedPatternHex

User-defined padding pattern to be Hex.

Type: u8

Default: 0

ScalabilityMode

Scalability mode, enable or disable test session result collection.

Type: enum

Default: NORMAL

Possible Values:

Value Description
NORMAL

Normal

DISCARD_TEST_SESSION_STATISTICS

Discard test session statistics.

SessionDstUdpPort

Destination UDP port.

Type: u16

Default: 5450

Range: 1 - 65535

SessionSrcUdpPort

Source UDP port.

Type: u16

Default: 5450

Range: 1 - 65535

SrcUdpPort

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

Source UDP port.

Type: u16

Default: 123

Range: 1 - 65535

StartDelay

Start delay (sec).

Type: u32

Default: 5

Timeout

Timeout (sec).

Type: u32

Default: 30

Ttl

Time to live.

Type: u8

Default: 255

Range: 1 - 255

TwampTestSession Read-Only Attributes

Read-Only Attribute Description
SessionState

State of the TWAMP test session.

Type: enum

Default: IDLE

Possible Values:

Value Description
IDLE

No test session has been requested.

REQUESTED

Request-Session messages have been sent to the server.

ACCEPTED

Accept-Session messages with a zero value in the Accept field have been received from the server.

REJECTED

Accept-Session messages with a non-zero value in the Accept field have been received from the server.

INPROGRESS

Start-Session messages have been sent to the server.