sas
TWLSession

Defines the TWAMP Light test session



public class TWLSession

Stats:
sas.DelayTCAStats sas.LossTCAAgStats sas.LossTCAFwBwStats sas.PmSessionBaseStats sas.TWLSessionStats sas.TwlLossSessionStats saspm.TWLSessionAccStats saspm.TWLSessionLossAccStats

Properties
chliThreshold The value of chliThreshold specifies the MEF-35 Consecutive High Loss Interval (CHLI) threshold for the specified session's TWAMP-Light test.

type=int
default=5
minimum=1
maximum=9
Displayed(tab/group)=CHLI Threshold (/Loss Parameters)

clear.ClearRequest-Set type=Children-Set
consecutiveDelTs The value of consecutiveDelTs specifies the number of consecutive MEF-35 'delta_t's (also known as 'Small Time Intervals') which constitute a MEF-35 'Availability Window' when computing loss statistics for the specified session's TWAMP-Light test.

type=int
default=10
minimum=2
maximum=10
units=frames
Displayed(tab/group)=Consec Delta-T's (/Loss Parameters)

destIpAddress Specifies destination address

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Destination IP (/IP Session Details)

destIpAddressType Specifies the address type of the destIpAddress.

type=rtr.InetAddressType
default=ipv4

destUDPPort Specifies destination UDP Port

type=int
access=read-only
default=49224
minimum=0
maximum=65535
Displayed(tab/group)=Dest UDP Port (/IP Session Details)

flrThreshold The value of flrThreshold specifies the MEF-35 Frame Loss Ratio (FLR) threshold for the specified session's TWAMP-Light test.

type=int
default=50
minimum=0
maximum=100
units=percent
Displayed(tab/group)=FLR Threshold (/Loss Parameters)

framesPerDelT The value of framesPerDelT specifies the number of TWAMP-Light frames to send in one MEF-35 'delta_t' (also known as 'Small Time Interval') when computing loss statistics for the specified session's TWAMP-Light test.

type=int
default=1
minimum=1
maximum=50
units=frames
Displayed(tab/group)=Frames Per Delta-T (/Loss Parameters)

hliForceCountEnabled Specifies whether or not to count High Loss Intervals (HLIs) and Consecutive High Loss Intervals (CHLIs) when the TWAMP-Light test's MEF-35 Availability state is Unavailable. 'true(1)' breaks compliance with MEF-35 by ensuring HLIs and CHLIs are counted in Unavailable periods. 'false(2)' maintains compliance with MEF-35 by preventing HLIs and CHLIs from being counted in Unavailable periods.

type=boolean
default=false
Displayed(tab/group)=HLI Force Count (/Loss Parameters)

interval TWAMP Light interval

type=sas.TWLSessionInterval
default=1000
minimum=50
maximum=10000
Displayed(tab/group)=Interval (/Timing)

oamPmCfgTwampLtIPv6UdpCsZero The value of tmnxOamPmCfgTwampLtIPv6UdpCsZero specifies whether or not to allow the processing of IPv6 packets received with a UDP checksum of zero for the specified TWAMP-Light test. When tmnxOamPmCfgTwampLtIPv6UdpCsZero is false, IPv6 packets received with a UDP checksum of zero are discarded.

type=boolean
default=false
Displayed(tab/group)=TWAMP Light allow IPv6 udp checksum zero (/Timing)

padSize TWAMP Light pad size

type=int
default=0
minimum=0
maximum=2000
units=octets
Displayed(tab/group)=Data Padding Size (/Test Details)

padTlvSize The value of padTlvSize specifies the amount of padding added to each launched STAMP Session-Sender Packet for the specified session's STAMP test. Zero specifies that a Pad TLV should not be added. A value larger than zero specifies the total size (including the four octet header) of the Pad TLV added. The object used to specify the amount of padding for packets launched for a 'twampLight(3)' test varies with the test's sub-type, as shown in the following table. tmnxOamPmCfgTwampLtTestSubType Padding Size Object -------------------------------------------------------------- 'subTypeTwampLight' tmnxOamPmCfgTwampLtPadSize 'subTypeSTAMP' tmnxOamPmCfgTwampLtStpPadTlvSize

type=long
default=0
minimum=0
maximum=2000
units=seconds
Displayed(tab/group)=Pad TLV Size (/Test Details)

runtimeLeft TWAMP Light runtime left

type=int
access=read-only
default=0
minimum=0
maximum=86400
units=seconds

sas.LossTCAConfig-Set type=Children-Set
sas.TWLBin-Set type=Children-Set
serviceId Specifies the service Id

type=int
access=read-only
default=0
minimum=0
maximum=2147483647
Displayed(tab/group)=Service ID (/IP Session Details)

serviceSitePointer Pointer to VPRN Site.

type=Pointer
access=read-only
default=

sessionSenderType The value of sessionSenderType specifies the sub-type of the 'twampLight(3)' test. Code points: subTypeTwampLight(1) - the test uses the TWAMP-Light protocol specified in RFC 5357, Appendix I. subTypeSTAMP(2) - the test uses the STAMP protocol specified in RFC 8762.

type=sas.TwampSessionSenderType
default=1
Displayed(tab/group)=Session Sender Type (/Test Details)

sourceIpAddress Specifies source address

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Source IP (/IP Session Details)

sourceIpAddressType Specifies the address type of the sourceIpAddress.

type=rtr.InetAddressType
default=ipv4

statsTypeToCollect Configures the test session to collect delay, loss, or delay and loss statistics.

type=sas.TwampLightTestType
default=delay
Displayed(tab/group)=TWAMP Light Statistics Type to Collect

streamingDelayTemplate The pointer to the Streaming Delay Template this Session will use.

type=Pointer
default=
Displayed(tab/group)=Streaming Delay Template

streamingMeasurementName

type=string
access=read-only

testDuration TWAMP Light test duration

type=int
default=0
minimum=0
maximum=86400
units=seconds

timeStampFormat

type=sas.TwampTimeStampFormat
default=0
Displayed(tab/group)=Time Stamp Format (/Test Details)

twampController Pointer to TCC Test. For TWAMP Light to TWAMP server communications

type=Pointer
access=read-only
default=
Displayed(tab/group)=TCC Test (/TWAMP)

twlSessionReflector Pointer to TWAMP Light Reflector.

type=Pointer
access=read-only
default=
Displayed(tab/group)=TWAMP Light Reflector

virtualRouterPointer Pointer to Virtual Router.

type=Pointer
access=read-only
default=

  
Properties inherited from sas.PMSessionTest
administrativeState, aggregatedWith, applicationId, autoTestId, detectTxErr, fromNodeId, id, lastGeneratedTime, onDemandStatus, pmSession, publishTopic, schedule, scheduleTask, serviceType, sessionName, sessionTestDuration, sessionType, siteId, testDefinition, testFamily, testId, testIdInUse, testPolicyUsage, testSuite, testSuiteId, testSuiteTestedEntity, testedEntityName, testedObject, toNodeId, writeAccountingResultsToDb
 
Properties inherited from sas.AbstractTest
administrativeState, description, displayedName, failures, globalId, id, lastRunResult, runs, weight
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

requestClearOamPmTwlRawStats

Request clearing of Oam Pm Raw Stats. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Methods inherited from sas.PMSessionTest
stopTest
 
Methods inherited from sas.AbstractTest
execute, stop
 
Supported Network Elements
7450 ESS Supported from 12.0.R4
  • Excluded chassis types: 7450-ESS6, 7450-ESS6V
7750 SR Supported from 12.0.R4
  • Excluded chassis types: VSR, VSR-I
7705 SAR Gen 2
7950 XRS Supported from 12.0.R4
7210 SAS M Supported from 9.0.R1
7210 SAS X Supported from 9.0.R1
7210 SAS T Supported from 9.0.R1
7210 SAS Mxp Supported from 9.0.R1
7210 SAS S/Sx Supported from 9.0.R1
7210 SAS R Supported from 9.0.R1
7210 SAS K Supported from 9.0.R1
7250 IXR Supported from 13.1.R4
7210 SAS Dxp
Product Specifics
7210 SAS Dxp (all versions)
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS (all versions)
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 (all versions)
7705 SAR Gen 2 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0