Overview Package Class Deprecated Help

sas
MplsDmSession

Defines the OAM-PM MPLS DM (delay measurement) Session Test.

public class MplsDmSession

Stats:
sas.DelayTCAStats sas.MplsDmSessionStats sas.PmSessionBaseStats saspm.MplsDmSessionAccStats

Properties
clear.ClearRequest-Set type=Children-Set
detectRxStatus Indicates the most recent receive status for an OAM-PM MPLS-DM test.

type=sas.OamPmMplsTestRxStatus
access=read-only
default=none
Displayed(tab/group)=Detectable Receive Error
interval Specifies the elapsed time between transmission of MPLS DM queries for the specified session's MPLS DM test. Valid values (1000 | 2000 | 3000 | 4000 | 5000 | 6000 | 7000 | 8000 | 9000 | 10000).

type=sas.DmSessionInterval
default=1000
minimum=1000
maximum=10000
Displayed(tab/group)=Interval (/Timing)
queryPadSize Specifies the amount of padding to be added to each launched MPLS DM query for the specified session's MPLS DM test. Zero specifies that a Pad TLV should not be added to each launched MPLS DM query. A value larger than zero specifies the total size (including the two octet header) of the Pad TLV added to each launched MPLS DM query. Valid values (0 | 2..257).

type=int
default=0
minimum=0
maximum=257
Displayed(tab/group)=Padding Size (/Test Details)
reflectPad Specifies whether or not to copy the Padding TLV from an MPLS DM query to the response. Within the MPLS DM protocol, this value controls whether the Type field of each transmitted Padding TLV of each MPLS DM query is 0: Padding - copy in response, or 128: Padding - do not copy in response.

type=boolean
default=false
Displayed(tab/group)=Reflect Padding (/Test Details)
runtimeLeft MPLS DM Session runtime left

type=int
access=read-only
default=0
minimum=0
maximum=86400
units=seconds
sas.MplsDmBin-Set type=Children-Set
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
  
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

requestClearOamPmDmRawStats

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 16.0.R6
7750 SR Supported from 16.0.R6
  • Excluded chassis types: VSR, VSR-I
7705 SAR Gen 2
7950 XRS Supported from 16.0.R6
Product Specifics
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 25.0
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 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0