sas
AbstractTest

Defines an executable service assurance test entity.



public abstract class AbstractTest

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

type=sas.TestAdminState
default=enabled
Displayed(tab/group)=Administrative State

description The description of the test. Not interpreted by NFM-P.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description

displayedName The display name of the test. Not interpreted by NFM-P.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Name

failures

type=int
access=read-only
default=0

globalId The display global name of the test.

type=string
access=read-only
default=
minimum=0
maximum=252
Displayed(tab/group)=Global ID

id The identifier for the STM test.

type=long
access=read-create
default=0
minimum=1
Displayed(tab/group)=ID

lastRunResult

type=sas.LastRunResult
access=read-only
default=undetermined

runs

type=int
access=read-only
default=0

weight Specifies the relative load that execution of this test affects the server.

type=int
access=read-only
default=0
Displayed(tab/group)=Weight

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

execute

Immediately starts running the STM test. The test will only execute if it is administratively enabled.
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

stop

Immediately cancels/stops running the STM test. The test can only stopped if it is supported by the node.
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
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
OS6850/6850E
OS6855
OS6400
OS6250
OS6450
OS9700E/9800E
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
OS6900 Supported from 7.3.1
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
Wavence SM