Overview Package Class Deprecated Help

ethernetoam
CcmTest

This class represents a CcmTest (Continuity Check) on a Global MEG. The Global MEG defines a group of MEPs in a network which exchange OAM ethernet CFM protocol packets. The test execution enables and disables the CFM protocol on the MEPs. An alarm is raised on a MEP if it is missing a periodic CFM update from a neighbouring MEP while the protocol is running. MEP objects exchange information with other MEPs in the same Maintenance Entity Group. The test is identified by the combination of Maintenance Domain ID and Maintenance Entity Group ID. CFM protocol packets exchanged between MEP objects are identified by the unique network wide combination of Maintenance Domain Id and Maintenance Entity Group Id.

public class CcmTest

Properties
dualEndedLossClearThreshold Specifies the loss threshold, in hundredths of a percent, at which an alarm is cleared for Y1731 Dual-Ended Loss Test.

type=float
default=0
minimum=0
maximum=100
units=%
Displayed(tab/group)=Alarm Clearing Threshold (/Initial Dual Ended Loss Test Options)
dualEndedLossEnable Specifies whether Y1731 Dual-Ended Loss Test is enabled when CC messages are enabled.

type=boolean
default=false
Displayed(tab/group)=Enable Test (/Initial Dual Ended Loss Test Options)
dualEndedLossRaiseThreshold Specifies the loss threshold, in hundredths of a percent, at which an alarm is raised for Y1731 Dual-Ended Loss Test.

type=float
default=0.25
minimum=0
maximum=100
units=%
Displayed(tab/group)=Alarm Threshold (/Initial Dual Ended Loss Test Options)
numberOfChildren

type=int
access=read-only
default=0
schedule The schedule, if any, that specifies when the cctest executes.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Schedule (Schedule)
scheduleTask The schedule task, if any, that specifies the binding between the cctest and the schedule.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Scheduled Task (Schedule)
timer The duration for the CC Test.

type=int
default=0
minimum=0
maximum=1439
units=minutes
Displayed(tab/group)=Duration (/Connectivity Check Timer)
vlanId VLAN ID of the VLAN Element object.

type=int
access=read-create
default=0
minimum=0
maximum=4094
 
Overridden Properties
id Global NFM-P Test ID (can be used as MAid)

maximum=4294967295
 
Properties inherited from ethernetoam.AbstractCfmTest
globalMA
 
Properties inherited from sas.PseudoTest
assurance, fcQueue, forwardingClass, maxHistoryRows, packetFailureThreshold, packetInterval, packetTimeout, packetsToSend, profile, testFailureThreshold
 
Properties inherited from sas.Test
accountingFiles, accountingPolicyObjectPointer, aggregatedWith, applicationId, continuousExec, continuously, executionState, fromNodeId, id, lastGeneratedTime, neDeployedTest, nePersistent, neSchedulable, neSchedulableDeployedTest, neSchedulableTest, nmUser, oneTimeValidate, probeHistory, publishTopic, sas.NmThresholdEvent-Set, suppressAccounting, targetIp, testDefinition, testPolicyUsage, testResultStorage, testSuite, testSuiteId, testSuiteTestedEntity, testType, testedEntityName, testedObject, weight
 
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

cancelCcmTest

Cancels the CcmTest.
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.Test
adhocExecuteAndWait, executeAndWait, setNeSchedulableAdminState
 
Methods inherited from sas.AbstractTest
execute, stop
 
Supported Network Elements
7450 ESS
7750 SR
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS M
7210 SAS X
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
OS6850/6850E
OS6855
OS6400
OS6250
OS6450
OS9700E/9800E
7705 SAR H
7705 SAR Supported from 2.1.R1
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
OS6900 Supported from 7.3.1
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6360 Supported from 8.9.1
OS6465
Wavence SM Supported from 20.1.0