Overview Package Class Deprecated Help

ethernetoam
CcTest

This class represents a Global MEG. This defines a group of MEPs in a network which exchange OAM ethernet CFM protocol packets. Each MEP object belongs to a Maintenance Entity Group. MEP objects exchange information with other MEPs in the same Maintenance Entity Group. Each Maintenance Entity Group is associated with a single Maintenance Domain. The MEG is identified by the combination of Maintenance Domain ID and Maintenance Entity Group ID. The CcTest lists all local site-level Maintenance Entity Groups which share the same Maintenance Entity Group Id.

public class CcTest

Properties
ccmInterval Specifies the ccm-interval for this CcTest.

type=ethernetoam.CCMIntervalNameType
access=read-create
default=CCM10
Displayed(tab/group)=Initial CCM Interval (/Initial MEG Configuration)
cfmHoldDownTimer Specifies the time, in centiseconds, that a MEP in the association will delay declaring a fault.

type=int
access=read-create
default=0
minimum=0
maximum=1000
units=Centiseconds
Displayed(tab/group)=Initial CFM Hold Down Timer (/Initial MEG Configuration)
ethernetoam.CcTestService-Set type=Children-Set
ethernetoam.MaintAssociation-Set type=Children-Set
ethernetoam.MegSubGroup-Set type=Children-Set
ethernetoam.UnManagedRemoteMep-Set type=Children-Set
ethernettunnel.CcTestEthernetPath-Set type=Children-Set
maintAssocName The Maintenance Entity Group Name.

type=string
access=read-create
default=
minimum=1
maximum=45
Mandatory on create
Displayed(tab/group)=Name (/Maintenance Entity Group)
maintAssocNameType Specifies the address type of the Maintenance Entity Group.

type=ethernetoam.MaintAssocNameType
access=read-create
default=string
Displayed(tab/group)=Name Format (/Maintenance Entity Group)
maintDomainName The MD Name associated with MEG.

type=string
access=read-only
maximum=43
maintDomainNameType The MD Name Type associated with MEG.

type=ethernetoam.MaintDomainNameType
access=read-only
maintenanceDomainPointer The local maintenanceDomainPointer for this MEG.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Maintenance Domain (/Maintenance Domain)
mgmtMaintAssocAdminName Used instead of id to uniquely identify an association.

type=string
access=read-create
default=
maximum=64
Mandatory on create
Displayed(tab/group)=Admin Name (/Maintenance Entity Group)
mhfCreation The mhf creation for this CcTest.

type=ethernetoam.MhfCreationEnum
access=read-create
default=1
Displayed(tab/group)=Initial MHF-Creation (/Initial MEG Configuration)
mipLtrPriority The value of mipLtrPriority specifies at what priority the link-trace response frames should be transmitted for a MIP request.

type=int
access=read-create
default=7
minimum=0
maximum=7
Displayed(tab/group)=Initial MIP LTR Priority (/Initial MEG Configuration)
numberOfChildren

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

DEPRECATED: 8.0.R5 - Use CcmTest Instead
type=Pointer
access=read-only
default=
scheduleTask The schedule task, if any, that specifies the binding between the cctest and the schedule.

DEPRECATED: 8.0.R5 - Use CcmTest Instead
type=Pointer
access=read-only
default=
temporary Created as part of "one time validation" this object should be deleted when validation is done.

type=boolean
access=read-only
default=false
timer The duration for the CC Test.

DEPRECATED: 8.0R5 - OBSOLETE: Use CcmTest.timer instead
type=int
default=0
minimum=0
maximum=1439
units=minutes
totalNumberOfMegs

type=int
access=read-only
default=0
Displayed(tab/group)=Number of Local MEGs (/Total Number of Local MEG/MEPs)
totalNumberOfMeps

type=int
access=read-only
default=0
Displayed(tab/group)=Number of MEPs (/Total Number of Local MEG/MEPs)
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 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

auditUnicastCCM

Attempts to discover Unicast Hub if possible, this will set hubMepPointers to match Remote Mep Lists. This method will also Create an UnmanagedRemoteMep if the remote list points to an unknown Unicast Hub. This will also clean up Unmanaged Unicast Hub targets that now have a Managed MEP, this can happen if a Unicast CCM Spoke MEP is discovered in NFM-P before the Hub MEP.
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

cancelCcTest

DEPRECATED - 8.0.R5 - Use CcmTest Instead
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

discoverSubGroups

Attempts to discover MEG Sub-Groups if possible, using Remote MEP lists.
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

discoverSubGroupsByDomainId

Attempts to discover MEG Sub-Groups if possible, using Domain IDs.
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

resyncRemoteMepDb

Re-synchronizes the Remote MEP DB for all Child MEG's.
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

synchronizeMeps

Synchronizes the local and remote MEP lists between all sites.
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
Exceptions:
ethernetoam.CcTest.synchronizeMepsException
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