Overview Package Class Deprecated Help

ethring
Path

The Path object defines a network-wide Ethernet Ring Path, consisting of two Ethernet Ring Path Endpoints.

public class Path

Properties
endpointAElementId

type=int
access=read-only
default=0
endpointAElementType

type=ethring.PathElementType
default=sr
Displayed(tab/group)=Element Type (Endpoints/Endpoint A )
endpointAInnerEncapValue The R-APS Tag (Inner Encapsulation Value) parameter specifies the inner encapsulation value for the R-APS tag property of Path Endpoint A. The range is 0 to 4094. The default value is 0.

type=int
access=read-create
default=0
minimum=0
maximum=4094
Displayed(tab/group)=R-APS Tag (Inner Encapsulation Value) (Endpoints/Endpoint A )
endpointAOuterEncapValue The R-APS Tag (Outer Encapsulation Value) parameter specifies the outer encapsulation value for the R-APS tag property of Path Endpoint A. The range is 0, and 1 to 4094. The default value is 0.

type=int
access=read-create
default=0
minimum=1
maximum=4094
Displayed(tab/group)=R-APS Tag (Outer Encapsulation Value) (Endpoints/Endpoint A )
endpointAPathId

type=ethring.RingPathEndpointIndexType
access=read-create
default=pathA
Displayed(tab/group)=Path ID (Endpoints/Endpoint A )
endpointARplType

type=ethring.RplPathEndpointType
default=normal
Displayed(tab/group)=Ring Protection Link Type (Endpoints/Endpoint A )
endpointBElementId

type=int
access=read-only
default=0
endpointBElementType

type=ethring.PathElementType
default=sr
Displayed(tab/group)=Element Type (Endpoints/Endpoint B )
endpointBInnerEncapValue

type=int
access=read-create
default=0
minimum=0
maximum=4094
Displayed(tab/group)=R-APS Tag (Inner Encapsulation Value) (Endpoints/Endpoint B )
endpointBOuterEncapValue

type=int
access=read-create
default=0
minimum=1
maximum=4094
Displayed(tab/group)=R-APS Tag (Outer Encapsulation Value) (Endpoints/Endpoint B )
endpointBPathId

type=ethring.RingPathEndpointIndexType
access=read-create
default=pathA
Displayed(tab/group)=Path ID (Endpoints/Endpoint B )
endpointBRplType

type=ethring.RplPathEndpointType
default=normal
Displayed(tab/group)=Ring Protection Link Type (Endpoints/Endpoint B )
ethernettunnel.EthPathComponent-Set type=Children-Set
mepDirection

type=ethernetoam.Direction
default=down
Displayed(tab/group)=Mep Direction (CFM Continuity Check)
pathType

type=ethring.PathTypeEnum
access=read-only
default=unknown
Displayed(tab/group)=Path Type
 
Overridden Properties
endpointAAdministrativeState

default=tmnxOutOfService
endpointBAdministrativeState

default=tmnxOutOfService
id

minimum=1
 
Properties inherited from ethernettunnel.AbstractPath
aggrPathEndptOperationalState, autoCreateGlobalMeg, autoRunCCM, ccProtocolState, ccTestPointer, ccmInterval, createMepsOnSelection, description, endpointAAdministrativeState, endpointACtpPointer, endpointASiteId, endpointBAdministrativeState, endpointBCtpPointer, endpointBSiteId, id, maintDomainPointer, operationalFlags, pathEndpointAMepPointer, pathEndpointAPointer, pathEndpointBMepPointer, pathEndpointBPointer, runCCOnSelection
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

createMEPs

Auto-creates MEPs on the two path endpoints.
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

deleteEthernetPath

Deletes the Ethernet Path from the Ethernet Ring with the option to also delete the Path Endpoints from the database
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.
aInShouldDeleteEndpoints : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

executeCCProtocol

Auto-creates MEPs on the two Path Endpoints. Synchronizes the local and remote MEP lists between the two Path Endpoints. Enables the CC protocol on the MEPs
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