| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| accountingFiles |
Specifies whether this test uses SAA Accounting
type=boolean default=false |
| accountingPolicyObjectPointer |
type=Pointer access=read-only default= |
| 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 |
| continuousExec |
This value specifies whether or not the OAM NE Schedulable test is to be executed indefinitely.
type=boolean default=false |
| continuously |
Specifies whether this test is currently being continuously executed by the node.
type=boolean access=read-only default=false |
| executionState |
Specifies the desired execution state of this test.
This value is set automatically using the
sas.AbstractTest.execute method.
type=sas.ExecutionStateaccess=read-only default=notRunning |
| 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) |
| neDeployedTest |
The deployed NE test that remains on the node. The sas.DeployedTest
is created as a side-effect of enabling the
sas.est.neSchedulable flag.
type=Pointer access=read-only default= |
| nePersistent |
Used to make this test NE persistent. An NE persistent
test is installed onto the node after its first execution
type=boolean access=read-create default=false |
| neSchedulable |
Used to make this test NE schedulable. An NE schedulable
test is immediately installed onto the node, and may
use the node's CRON feature to schedule its executions.
type=boolean access=read-create default=false Displayed(tab/group)=NE Schedulable |
| neSchedulableDeployedTest |
The deployed NE schedulable test. The sas.DeployedTest
is created as a side-effect of enabling the
sas.Test.neSchedulable flag.
type=Pointer access=read-only default= |
| neSchedulableTest |
The NE schedulable test. The sas.NeSchedulableTest
is created as a side-effect of enabling the
sas.Test.neSchedulable flag.
type=Pointer access=read-only default= |
| nmUser |
The pointer to the NFM-P user that created the test.
type=Pointer access=read-only default= |
| oneTimeValidate |
Indicates that the related test suite is a one time validation test suite.
type=boolean access=read-only default=false |
| probeHistory |
The value of probeHistory indicates whether or not
per-probe history will be kept for this test.
type=sas.ProbeHistoryType default=auto Displayed(tab/group)=Probe History (Test Parameters/Execution Details) |
| publishTopic |
Specifies whether this test should publish results/alarms to Kafka.
type=boolean default=false |
| sas.NmThresholdEvent-Set |
type=Children-Set |
| suppressAccounting |
The value of tmnxOamSaaCtlSuppressAccounting specifies whether or
not the updating of accounting files is suppressed. The value of
'true (1)' is applicable only when an accounting policy has been
specified by tmnxOamSaaCtlAcctPolicyId.
type=boolean access=read-only default=false |
| targetIp |
The STM test target site specified in this property.
type=string access=read-only default= 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) |
| 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) |
| testResultStorage |
This value specifies whether or not the OAM NE Schedulable test results
are to be logged to a file, stored in the DB, or both
type=sas.TestResultStorageEnum default=logToDB |
| 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) |
| testType |
type=sas.TestType access=read-only default=ping |
| 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= |
| Overridden Properties | |
|---|---|
| id |
The identifier for the STM test.
maximum=99999999 |
| weight |
Specifies the relative load that execution of this
test affects the server.
default=10 |
| 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 |
|---|
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.
testedObject
: Pointer - The object under test or system Address of your node.
test
: config(sas.Test) - The test parameters to execute.
timeout
: long - The number of milliseconds to wait before
receiving the results. If no results are
received in the given time, the method returns.
keepTest
: boolean - Setting this parameter to false means that any
test created for the purposes of execution
will be deleted after the results are received
from the network.
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
result
: sas.TestResult - The final result of the test execution.
sas.Test.adhocExecuteAndWaitException
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.
timeout
: long - The number of milliseconds to wait before
receiving the results. If no results are
received in the given time, the method returns.
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
result
: sas.TestResult - The final result of the test execution.
sas.Test.executeAndWaitException
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.
aInValue
: int -
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 |