service
MacPing

Represents an MAC ping operation used to test the connectivity in a VLL or VPLS service by verifying a remote MAC address.



public class MacPing

Properties
forwardingClass Specifies the forwarding class the MAC ping will use.

type=qos.FcEnum
default=be
Displayed(tab/group)=Forwarding Class (Test Parameters/Test Probe)

labeltimeout Specifies the vc-label time-to-live value

type=long
default=5
minimum=1
maximum=255
Displayed(tab/group)=Time To Live (Test Parameters/Test Probe)

packetData An arbitrary amount of data to be included in the Data TLV, if the Data TLV is selected to be sent.

type=string
access=read-create
default=
maximum=255
Mandatory on create
Displayed(tab/group)=Packet Data (/VLAN Information)

profile Specifies the profile value to be used with the forwarding class specified in forwardingClass.

type=qos.Profile
default=out
Displayed(tab/group)=Forwarding Profile (Test Parameters/Test Probe)

replyControl The Reply Control parameter specifies whether the OAM response arrives on the control plane. The options are: Enabled Disabled (default)

type=boolean
default=false
Displayed(tab/group)=Reply Control (Test Parameters/Test Probe)

sendControl

type=boolean
default=false
Displayed(tab/group)=Send Control (Test Parameters/Test Probe)

serviceId

type=long
access=read-only
default=0

servicePointer

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Service (/Service)

sitePointer

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Site (/Site)

sourceMacAddress

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Source MAC Address (/Test Object)

targetMacAddress

type=MacAddress
default=FF-FF-FF-FF-FF-FF
Displayed(tab/group)=Target MAC Address (/Test Object)

testInterval Specifies the interval for this Test

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

testTargetType

type=sas.TestTarget
access=read-create
Mandatory on create
Displayed(tab/group)=Target Type (/Test Object)

type

type=service.ElementalType
default=vplsSite

vlanDropEnable Drop Enable bit value to be used in the VLAN tag.

type=boolean
access=read-create
default=false
Displayed(tab/group)=Drop Enable (/VLAN Information)

vlanPriority Specifies the priority.

type=int
access=read-create
default=0
minimum=0
maximum=7
Displayed(tab/group)=Priority (/VLAN Information)

 
Overridden Properties
packetSize mrinfo ping does not use this field.

minimum=1

 
Properties inherited from sas.Ping
assurance, maxHistoryRows, packetFailureThreshold, packetInterval, packetSize, packetTimeout, packetsToSend, testFailureThreshold, trapGenerationPolicy
 
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

cancelMacPingTest

Stop the Mac Ping.
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
7210 SAS M Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS T Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Dxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS K Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7210 SAS X
7210 SAS R
7250 IXR
7750 SR
7705 SAR Hm
OS6250
OS6450
7705 SAR H
7705 SAR Supported from 4.0.R1
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
OS6900 Supported from 7.3.1
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
Product Specifics
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 (all versions)
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 Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR (all versions)
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 (all versions)
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6360 (all versions)
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6450 (all versions)
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 (all versions)
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 (all versions)
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 (all versions)
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6860E/OS6860N (all versions)
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 (all versions)
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 (all versions)
OS6870 8.10
OS6900 (all versions)
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