| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| aossas.CPETestGroupHead-Set |
type=Children-Set |
| aossas.CPETestHead-Set |
type=Children-Set |
| contextNonSapMax |
The Maximum number of Bindings/LSPs/SDPs permissible to be added to a single Oam Context.
type=int default=10 minimum=1 maximum=100 Displayed(tab/group)=Max Bindings/LSPs/SDPs for OAM Context (Test Manager) |
| contextSapMax |
The Maximum number of SAPs permissible to be added to a single Oam Context.
type=int default=10 minimum=1 maximum=100 Displayed(tab/group)=Max SAPs for OAM Context (Test Manager) |
| defaultTestResultStorage |
This value specifies the default value for test result storage
for test policies, test suites, and tests
type=sas.TestResultStorageEnum default=logToDB Displayed(tab/group)=Default Test Result Storage (Test Manager) |
| defaultWriteAccountingResultsToDb |
Specifies whether PM Session tests should publish accounting results to the database by default.
DEPRECATED: 19.11 - no longer required because the default of 'only write to db if not log-to-file' is more backwards-compatible type=boolean default=true Displayed(tab/group)=Write OAM-PM Accounting Results to DB default (Test Manager) |
| ethernetoam.CcTest-Set |
type=Children-Set |
| ethernetoam.CcmTest-Set |
type=Children-Set |
| incomingRate |
Incoming rate of sas test results.
type=long default=0 |
| loadPoolSize |
Specifies the current size of the load pool.
The SAM-A system uses the load pool to control the
number of executing STM tasks. The task is only
executed if the size of the load pool is greater than or
equal to the task's loadFactor. When the task is
executing, its loadFactor is subtracted from load pool.
type=long access=read-only default=0 |
| maxNumObjectTokeep |
This is the maximum number of Results object.
type=long default=1000000 minimum=60000 maximum=20000000 |
| nextExecutionId |
Next Execution Id for Test Suites
type=long default=0 |
| sas.ArchiveGenerationLog-Set |
type=Children-Set |
| sas.PMSession-Set |
type=Children-Set |
| sas.TWAMPClientController-Set |
type=Children-Set |
| sas.TestPolicy-Set |
type=Children-Set |
| sas.TestSuite-Set |
type=Children-Set |
| sasAuxDbNumberOfDays |
The DB Test Result Retention Time (hours) parameter specifies the default
maximum time, in days, to keep STM test results in the auxiliary database. Test results that
are older than this value will be automatically purged. The range is 1 to 366. The
default is 30.
type=long default=30 minimum=1 maximum=366 units=days Displayed(tab/group)=Aux DB Test Result Retention Time (Test Manager) |
| sasNumberOfHours |
The DB Test Result Retention Time (hours) parameter specifies the default
maximum time, in hours, to keep STM test results in the main database. Test results that
are older than this value will be automatically purged. The range is 1 to 720. The
default is 24.
The NFM-P will automatically try to optimize the configured retention time
upwards or downwards. In either case, the NFM-P will ensure that the number of
results stored in the database does not exceed a base of 20 000 000. If the retention
time is automatically reduced, an alarm is generated to notify the user. For the
retention of 20 000 000 results over the maximum retention time of 720 hours, the
incoming results rate is 27 778 results per hour (463 results per minute). If the
incoming results rate exceeds this value, the retention time is reduced accordingly.
Any alarms generated during retention time adjustment will be cleared once the
retention time is changed back to original value.
type=long default=24 minimum=1 maximum=720 units=hours Displayed(tab/group)=Main DB Test Result Retention Time (Test Manager) |
| sasRetention |
Time to keep the STM test result log files on disk before purging them.
type=long default=120 minimum=5 maximum=1440 units=minutes Displayed(tab/group)=Log Retention Time (Test Manager) |
| sasRollover |
Time to rollover the temporary STM test result log files.
DEPRECATED: 11.0 - OBSOLETE - Logs are auto closed after parsing is done. This parameter no longer has any effect type=long default=15 minimum=5 maximum=240 units=minutes |
| service.Y1564Test-Set |
type=Children-Set |
| targetSasRetentionHours |
Target Number of hours to keep test results in the main database.
type=long access=read-only default=24 minimum=1 maximum=720 units=hours Displayed(tab/group)=Main DB Target Test Result Retention (Test Manager) |
| validationTestSuiteTestLimit |
Specifies the maximum number of generated tests allowed for a Validation Test Suite
type=int default=500 minimum=10 maximum=5000 Displayed(tab/group)=Max Tests per Validation Test Suite (Test Manager) |
| 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.
neFullName
: Pointer - Fully distinguished name of the Network Element.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
siteFullName
: Pointer - Fully distinguished name of the Service Site.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
InfoList
: Set (Pointer) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
testFdn
: string -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
lTestResultStructObjectId
: long -
testFdn
: string -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
tests
: Set (Pointer) - 'tests' is a list containing the name of the tests to delete.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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.
contextType
: sas.OAMContextType - This defines the type of object selected by user for OAM Context test generation.
testType
: sas.OAMTestType - The type of test to run on the objects provided in the entity/object list.
testedEntities
: Set (Pointer) - List of Entity FDN to be tested in this request, applicability of these object types depend on the testType requested.
objectList
: Set (Pointer) - (Optional) List of Object FDNs to test within the Entity, Used for CFM tests to specify specific Sites, SAPs and SdpBindings.
for example: List of SAPs inside a VPLS entity, will only test between the specified SAPs.
testSuiteName
: string - (Optional) This defines the Test Suite name to use for this context request.
continuous
: boolean - (Optional) This create tests as continuously executed, only applicable to CFM and IcmpPing type tests.
schedulePointer
: Pointer - (Optional) This provides the FDN of the execution schedule to use on the generated Test Suite.
parameterList
: List (string) - (Optional) The parameterList is a list of property and value pairs, in order
for example: [Test.ATTR_displayedName, "Test Name", Test.ATTR_PacketsToSend, "5"]
generated tests will use the properties in the list set if applicable.
cfmLevel
: int - (Optional) The CFM Maintenance Domain Level the tests will execute on, this is only applicable to CFM test types. Default: 7
timeout
: int - (Optional) The length of time to wait for the results to be collected (in minutes). Default: 2
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
testSuitePointer
: Pointer -
sas.TestManager.executeOamTestContextException
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.
testedEntities
: List (Pointer) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
executedTestedEntities
: List (Pointer) -
testedEntities
: Set (Pointer) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
testSuitesWithoutTests
: Set (Pointer) -
filter
: FilterHolder -
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
networkElements
: List (generic.CommonManagedEntityInformation) -
filter
: FilterHolder -
serviceId
: long -
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
networkElements
: List (generic.CommonManagedEntityInformation) -
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.
testedEntities
: Set (Pointer) -
testedEntityType
: int -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
generatedTestSuites
: Set (Pointer) -
sas.TestManager.generateStmDefaultsException
Tests that are no longer relevant (based on the latest test policies in the suite) are removed.
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.
testSuites
: Set (Pointer) -
testedEntity
: Set (Pointer) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
sas.TestManager.generateTeTestsException
Tests that are no longer relevant (based on the latest test policies in the suite) are removed.
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.
testSuites
: Set (Pointer) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
sas.TestManager.generateTestsException
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.
testedEntity
: Pointer -
testPolicy
: Pointer -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
resultPointer
: Pointer -
sas.TestManager.oneTimeValidateException
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
: Pointer - Fully distinguished name of the object (Site/SAP) whose MEP Test Options should be propagated to underlying MEPs.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
targetFdn
: List (string) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
result
: List (string) -
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.
tests
: Set (Pointer) -
testOrTestsuite
: int -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
continuouslyExecuted
: Set (Pointer) -
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.
tests
: Set (Pointer) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false