ethernettunnel
EthernetPath

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



public class EthernetPath

Properties
activeStdby

type=ethernettunnel.ActiveStdbyEnum
access=read-only
default=active
Displayed(tab/group)=Active/Standby

endpointAControlTag The Control Tag (Outer Encapsulation Value) parameter specifies the outer encapsulation value for the control tag property of Path Endpoint A. The parameter is configurable only on Release 8.0 and later NEs, and only when the Ethernet tunnel endpoint Encap Type value is QinQ. The range is -1 to 4095. The default is -1. The parameter specifies the VLAN ID for Ethernet CFM and G.8031 control plane exchanges, and cannot be modified after it is set. To replace an existing control tag, you must delete and recreate the parent path, and then specify a new control tag.

type=int
default=-1
minimum=-1
maximum=4095
Displayed(tab/group)=Control Tag (Outer Encapsulation Value) (Endpoints/Endpoint A )

endpointAInnerControlTag The Control Tag (Inner Encapsulation Value) parameter specifies the inner encapsulation value for the control tag property of Path Endpoint A. The parameter is configurable only on Release 8.0 and later NEs, and only when the Ethernet tunnel endpoint Encap Type value is QinQ. The range is 0 to 4095. The default is 0. The parameter cannot be modified after it is set. To replace an existing control tag, you must delete and recreate the parent path, and then specify a new control tag.

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Control Tag (Inner Encapsulation Value) (Endpoints/Endpoint A )

endpointAPathId

type=int
default=1
minimum=1
maximum=16
Displayed(tab/group)=Path ID (Endpoints/Endpoint A )

endpointAPrecedence The Precedence parameter specifies the precedence of the first Ethernet endpoint path.

type=ethernettunnel.EthTunnelPrecedenceType
default=primary
Displayed(tab/group)=Precedence (Endpoints/Endpoint A )

endpointATunnelId

type=int
access=read-only
default=0

endpointBControlTag The Control Tag (Outer Encapsulation Value) parameter specifies the outer encapsulation value for the control tag property of Path Endpoint B. The parameter is configurable only on Release 8.0 and later NEs, and only when the Ethernet tunnel endpoint Encap Type value is QinQ. The range is -1 to 4095. The default is -1. The parameter cannot be modified after it is set. To replace an existing control tag, you must delete and recreate the parent path, and then specify a new control tag.

type=int
default=-1
minimum=-1
maximum=4095
Displayed(tab/group)=Control Tag (Outer Encapsulation Value) (Endpoints/Endpoint B )

endpointBInnerControlTag The Control Tag (Inner Encapsulation Value) parameter specifies the inner encapsulation value for the control tag property of Path Endpoint B. The parameter is configurable only on Release 8.0 and later NEs, and only when the Ethernet tunnel endpoint Encap Type value is QinQ. The range is 0 to 4095. The default is 0. The parameter cannot be modified after it is set. To replace an existing control tag, you must delete and recreate the parent path, and then specify a new control tag.

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Control Tag (Inner Encapsulation Value) (Endpoints/Endpoint B )

endpointBPathId

type=int
default=1
minimum=1
maximum=16
Displayed(tab/group)=Path ID (Endpoints/Endpoint B )

endpointBPrecedence The Precedence parameter specifies the precedence of the second Ethernet endpoint path.

type=ethernettunnel.EthTunnelPrecedenceType
default=primary
Displayed(tab/group)=Precedence (Endpoints/Endpoint B )

endpointBTunnelId

type=int
access=read-only
default=0

ethernettunnel.EthPathComponent-Set type=Children-Set
 
Overridden Properties
id

minimum=1
maximum=16

 
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 tunnel 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