Overview Package Class Deprecated Help

service
Y1564Test

This class represents a Y1564 Test to validate customer service level Agreement(SLA).

public abstract class Y1564Test

Properties
accountingPolicyId

type=int
access=read-only
default=0
accountingPolicyObjectPointer

type=Pointer
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
enableTestCompletionTrap Specifies whether notification is sent to the NFM-P when the test is complete

type=generic.TruthValue
default=true
Displayed(tab/group)=Enable Test Completion Trap
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)
publishTopic Specifies whether this test should publish test results to Kafka.

type=boolean
default=false
siteId The site ID for the originating Test.

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

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Network Element (/Site)
startStopTest To be set to start(true)/stop(false) the test.

type=generic.TruthValue
default=false
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)
testId The identifier for the Y1564 test.

type=long
access=read-create
minimum=1
maximum=1000
Mandatory on create
Displayed(tab/group)=Test ID
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 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)
testedEntityName Displays the service name of the tested entity

type=string
access=read-only
default=
testedObject The managed object being tested.

type=Pointer
access=read-only
default=
 
Overridden Properties
administrativeState The administrative state of the test. Disabled tests cannot be executed (even if it is a scheduled execution).

default=disabled
description Specifies the name of the Y1564 Test.

displayedName Uniquely identifies each service test configured on the system.

maximum=64
id The identifier for the Y1564 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 Y1564 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
7210 SAS K Supported from 10.0.R1
7210 SAS Dxp Supported from 23.3.R1
7250 IXR Supported from 21.5.R1
7750 SR Supported from 23.10.R1
7950 XRS Supported from 23.10.R1
7450 ESS Supported from 23.10.R1