sas
PMSessionTest

Defines a specific type of Performance Monitoring Session to managed object.



public abstract class PMSessionTest

Properties
aggregatedWith Specifies if/how the test is aggregated with others tests.

type=sas.AggregationType
access=read-only
default=none
Displayed(tab/group)=Aggregated With (Test Suite)

applicationId Specifies which application created this test.

type=string
access=read-create
default=NFM-P
maximum=20

autoTestId Specifies whether the system auto assigns an available test identifier to be used for this session's test.

type=boolean
default=false
Displayed(tab/group)=Auto Test ID

detectTxErr Indicates the reason for the inability (if any) to launch test frames for the specified test.

type=sas.DetectTxErrorEnum
access=read-only
default=none
Displayed(tab/group)=Detectable Transmit Error

fromNodeId The STM test originates from the site specified in this property.

type=string
access=read-only
default=0.0.0.0
maximum=50

lastGeneratedTime Date (time from January 1st, 1970) when this test was last generated. This attribute has value only when this test is bound to a Test Suite.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Generated (Test Suite)

onDemandStatus Specifies the status of the on-demand test for the specified session

type=sas.OnDemandSessionStatus
access=read-only
default=disabled

pmSession The pointer to the sas.PMSession,that is associated to this object.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=PM Session

publishTopic Specifies whether this test should publish results/alarms to Kafka.

type=boolean
default=false
Displayed(tab/group)=Publish to Kafka Topic

schedule The schedule, if any, that specifies when the test suite executes.

type=Pointer
access=read-only
default=

scheduleTask The schedule task, if any, that specifies the binding between the test suite and the schedule.

type=Pointer
access=read-only
default=

serviceType Specifies the service type.

type=service.ServiceType
access=read-only
default=unknown

sessionName

type=string
access=read-only
default=
maximum=32
Displayed(tab/group)=Session Name

sessionTestDuration Specifies the test duration for the specified session's test.

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

sessionType The session type. Proactive: test runs continuously OnDemand: Test runs when executed and then stops.

type=sas.SessionType
access=read-only
default=proactive

siteId The site ID for the originating Test.

type=string
access=read-only
default=0.0.0.0
maximum=50

testDefinition The pointer to the sas.TestDefinition, if any, that this test was created from. Only applicable when aggregatedWith is "testSuite".

type=Pointer
access=read-only
default=
Displayed(tab/group)=Test Definition (Test Suite)

testFamily The Test Family parameter specifies the type of tests that the PM Session being configured will contain. The choices are: Ethernet (default) MPLS IP

type=sas.TestFamily
access=read-only
default=ethernet

testId The identifier for the PM Session test.

type=long
default=0
minimum=1
maximum=4294967295
Displayed(tab/group)=Test ID

testIdInUse Indicates the test identifier copied into the Test ID field of the test PDUs.

type=long
access=read-only
minimum=0
maximum=4294967295
Displayed(tab/group)=Test Id In Use

testPolicyUsage The pointer to the sas.TestPolicyUsage, if any, that this test was created from. Only applicable when aggregatedWith is "testSuite".

type=Pointer
access=read-only
default=
Displayed(tab/group)=Test Policy (Test Suite)

testSuite The pointer to the sas.TestSuite, if any, that owns this test. Only applicable when aggregatedWith is "testSuite".

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

testSuiteId The test suite ID. A value of 0 means no associated test suite.

type=long
access=read-only
default=0

testSuiteTestedEntity The pointer to the sas.TestedEntity, if any, that is associated to this object. Only applicable when aggregatedWith is "testSuiteGenerated".

type=Pointer
access=read-only
default=
Displayed(tab/group)=Tested Entity (Test Suite)

testedEntityName Displays the service name of the tested entity

type=string
access=read-only
default=
Displayed(tab/group)=Originating Tested Entity

testedObject The managed object being tested.

type=Pointer
access=read-only
default=

toNodeId The STM test targets the site specified in this property. (If target site is managed by NFM-P)

type=string
access=read-only
default=0.0.0.0
maximum=50

writeAccountingResultsToDb Specifies whether this test should publish accounting results to the database.

type=sas.WriteAccountingResultsToDbType
default=unlessLogToFile
Displayed(tab/group)=Write Accounting Results to Database

 
Overridden Properties
administrativeState The administrative state of the test. Disabled tests cannot be executed (even if it is a scheduled execution).

default=disabled

id The identifier for the PM Session test.

default=1
maximum=2147483647

 
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

stopTest

Stop the PM Session Test
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Methods inherited from sas.AbstractTest
execute, stop
 
Supported Network Elements
7450 ESS Supported from 12.0.R1
7750 SR Supported from 12.0.R1
7705 SAR Gen 2
7705 SAR Hm
7950 XRS Supported from 12.0.R1
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
7210 SAS Dxp
Wavence SM Supported from 20.1.0
Product Specifics
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 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 20.0
7210 SAS M 21.0
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 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 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 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
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 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
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 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