ethernetoam
CfmLoopback

Defines the 802.1ag loopback. Each loopback test is sent from a MEP to a destination MAC address of another node in the system. This test can be used to verify MEP-MEP connectivity in the network.



public class CfmLoopback

Properties
lbmInterval The value of tmnxDot1agCfmMepTxLbmInterval specifies the duration, in deciseconds, between loopback PDU transmissions. A value of zero is only valid if there are 5 or fewer loopbacks in the test (as defined by dot1agCfmMepTransmitLbmMessages).

type=int
default=0
minimum=0
maximum=600
units=deciseconds
Displayed(tab/group)=LBM Interval (/MEP Transmit LBM Information)

lbmPadOrSize This non-deployed property exists in the model to distinguish whether to use the lbmPadding (tmnxDot1agCfmMepLbmPaddingSize) or mepTransmitLbmDataTlv (Dot1agCfmmepTransmitLbmDataTlv) property.

type=ethernetoam.LbmPadOrSize
default=size
Displayed(tab/group)=Data TLV Size or Padding (/MEP Transmit LBM Information)

lbmPadding The value of tmnxDot1agCfmMepLbmPaddingSize specifies the number of additional octets inserted into the LBM PDU for the Data TLV padding. If tmnxDot1agCfmMepLbmPaddingSize is set to zero (0), no Data TLV will be added to the LBM PDUs. Note that setting this value is mutually exclusive with setting dot1agCfmMepTransmitLbmDataTlv.

type=int
default=0
minimum=0
maximum=9778
units=bytes
Displayed(tab/group)=LBM Padding Size (/MEP Transmit LBM Information)

lbmTimeout The value of tmnxDot1agCfmMepTxLbmTimeout specifies the duration, in seconds, a loopback PDU sent by the node is considered to be timed out.

type=int
default=5
minimum=1
maximum=10
units=seconds
Displayed(tab/group)=LBM Timeout (/MEP Transmit LBM Information)

mepLbrBadMsdu Specifies number incorrect LB messages received.

type=int
access=read-only
default=0

mepLbrIn Specifies the number of received loopback.

type=int
access=read-only
default=0

mepLbrInOutOfOrder Specifies the number of valid, out of order LB.

type=int
access=read-only
default=0

mepLbrOut Specifies the number of loopback replies transmitted.

type=int
access=read-only
default=0

mepTransmitLbmDataTlv Specifies the size of the loopback message.

type=int
default=0
minimum=0
maximum=1500
units=bytes
Displayed(tab/group)=Data Size (/MEP Transmit LBM Information)

mepTransmitLbmDestMacAddress Specifies the destination MAC address for the LB.

DEPRECATED: 7.0R4 - OBSOLETE: Use AbstractCfmDiagnostic.mepTargetMacAddr instead
type=MacAddress
default=00-00-00-00-00-00

mepTransmitLbmMessages Specifies the number of loopback messages to be transmitted.

type=int
default=1
minimum=1
maximum=5
Displayed(tab/group)=Number of Test Packets (/MEP Transmit LBM Information)

mepTransmitLbmResultOK Specifies LBM result

type=boolean
access=read-only
default=false

mepTransmitLbmStatus Specifies whether the loopback is currently transmitting.

type=boolean
default=false

mepTransmitLbmTargetIsMepId Specifies if the target is a MEP ID.

type=boolean
access=read-only
default=false

mepTransmitLbmVlanDropEnable Drop Enable bit value to be used in the VLAN tag, if present in the transmitted frame

type=boolean
default=true
Displayed(tab/group)=VLAN Drop Enable (/MEP Transmit LBM Information)

mepTransmitLbmVlanPriority Specifies the priority of the loopback message.

type=int
default=0
minimum=0
maximum=7
Displayed(tab/group)=VLAN Priority (/MEP Transmit LBM Information)

multicast Set to true for CFM Loopback multicast tests.

type=boolean
default=false
Displayed(tab/group)=Multicast (/MEP Transmit Information)

packetSize Specifies the size of the OAM Echo message. This parameter is optional and is valid only if tmnxOamPingCtlTestMode has a value of 'sdpPing', 'macPing', 'lspPing', 'vprnPing', 'mfibPing', 'vccvPing', 'icmpPing', 'p2mpLspPing', 'ethCfmLoopback' or 'ethCfmTwoWaySlm'. The minimum, maximum, and default values for the tmnxOamPingCtlTestMode cases are: 'ethCfmLoopback' : 0, 1500, 0 'ethCfmTwoWaySlm': 0, 1500, 0

type=int
default=0
minimum=0
maximum=1500
units=octets
Displayed(tab/group)=Size (Test Parameters/Execution Details)

testInterval Specifies the interval for this test.

type=int
default=10
minimum=10
maximum=1500
units=minutes
Displayed(tab/group)=Test Interval (Test Parameters/Execution Details)

trapGenerationPolicy Specifies when the node sends traps while executing the test.

type=sas.PingTrapGenerationPolicy
default=testCompletion
Displayed(tab/group)=Trap Generation (Results Configuration)

  
Properties inherited from ethernetoam.AbstractCfmDiagnostic
maintenanceAssociationId, maintenanceDomainId, mepId, mepIdEnabled, mepTargetMacAddr, mepTargetMepId, originatingMep, originatingNode, serviceId, serviceType, siteId, targetMep, targetName, toNodeId
 
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

stopCfmLoopBackTest

Stop the CfmLoopBack Ping (AOS nodes).
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
OS9700E/9800E
OS6250
OS6450
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
Product Specifics
7210 SAS D (all versions)
7210 SAS D 20.0.0
7210 SAS D 21.0.0
7210 SAS D 22.0.0
7210 SAS D 23.0.0
7210 SAS D 24.0.0
7210 SAS D 25.0.0
7210 SAS Dxp (all versions)
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS (all versions)
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6400 6.4.3
OS6400 6.4.4
OS6400 6.4.5
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 8.10
OS6465 8.10
OS6465 8.6
OS6465 8.7
OS6465 8.8
OS6465 8.8
OS6465 8.9
OS6465 8.9
OS6465 8.9
OS6560/OS6560E 8.10
OS6560/OS6560E 8.10
OS6560/OS6560E 8.6
OS6560/OS6560E 8.7
OS6560/OS6560E 8.8
OS6560/OS6560E 8.8
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E 6.4.2
OS6850/6850E 6.4.3
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.6
OS6860E/OS6860N 8.7
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6865 8.10
OS6865 8.10
OS6865 8.6
OS6865 8.7
OS6865 8.8
OS6865 8.8
OS6865 8.9
OS6865 8.9
OS6865 8.9
OS6870 8.10
OS6900 8.10
OS6900 8.10
OS6900 8.6
OS6900 8.7
OS6900 8.8
OS6900 8.8
OS6900 8.9
OS6900 8.9
OS6900 8.9
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0