Overview Package Class Deprecated Help

ethernettunnel
EthernetTunnel

The EthernetTunnel object defines a network-wide Ethernet Tunnel.

public class EthernetTunnel

Properties
accessAdaptQos Specifies how the Ethernet Tunnel SAP queue and virtual scheduler buffering and rate parameters are adapted over multiple active MDAs.

type=ethernettunnel.AccessAdaptQosEnum
default=distribute
Displayed(tab/group)=Access Adapt QoS (/Load Sharing)
autoCreateGlobalMeg Specifies if the Path should automatically Generate Global MEG during creation.

type=boolean
default=false
Displayed(tab/group)=Auto Create Global MEG (/Path CFM Defaults)
autoRunCCM When the Global MEG is created, setting this property to 'true' will create Maintenance Entity Groups, MEPs and synchronize Remote MEPs on the two path endpoints. On the MEPs, the administrativeState property will be set to 'Up', controlMep property will be set to 'true' and ccEnable will be set to 'true'.

type=boolean
default=false
Displayed(tab/group)=Run CCM On Create (/Path CFM Defaults)
ccTestPtrs The list of Global MEGs used by this Ring.

type=Set (Pointer)
access=read-only
ccmInterval Specifies the ccm-interval to use on the Generated MEGs.

type=ethernettunnel.CCMInterval
default=CCM100ms
Displayed(tab/group)=CCM Interval (/Path CFM Defaults)
encapType

type=equipment.PortEncapType
default=qEncap
Displayed(tab/group)=Encap Type (/Endpoints)
endpointAEncapType

type=equipment.PortEncapType
access=read-only
default=unknown
endpointASiteId

type=string
access=read-only
default=0.0.0.0
Displayed(tab/group)=Endpoint A (/Endpoints)
endpointATunnelId

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

type=equipment.PortEncapType
access=read-only
default=unknown
endpointBSiteId

type=string
access=read-only
default=0.0.0.0
Displayed(tab/group)=Endpoint B (/Endpoints)
endpointBTunnelId

type=int
access=read-only
default=0
ethernettunnel.EthernetPath-Set type=Children-Set
flowThruSvcPtrs The list of Services that are using this tunnel.

type=Set (Pointer)
access=read-only
isTunnelBeingUsed This property specifies whether a service tunnel is being used or not.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Used By a Service (/Service Tunnel)
maintDomainPointer The pointer to the Maintenance Domain.

type=Pointer
default=
Displayed(tab/group)=Maintenance Domain (/Path CFM Defaults)
numberOfEndpoints Number of endpoints in this Ethernet Tunnel.

type=int
access=read-only
default=0
Displayed(tab/group)=Number Of Endpoints (/Status)
operationalFlags Specifies the conditions that affect the operating status of this Ethernet Tunnel.

type=ethernettunnel.TunnelOperFlags
access=read-only
Displayed(tab/group)=Operational Flags (/Status)
pathThreshold The Operational Path Endpoint Threshold parameter specifies how many paths must be operationally up for the Ethernet tunnel to be operationally up. When the number of operationally up paths is less than or equal to this threshold, the tunnel will become operationally down. This parameter is only available when the Protection Type parameter is set to Load Sharing. The range is 0 to 15. The default is 0.

type=int
default=0
minimum=0
maximum=15
Displayed(tab/group)=Operational Path Endpoint Threshold (/Load Sharing)
perFpIngQueuing The Enable Per Forwarding Path Ingress Queue parameter specifies whether or not a more efficient method of queue allocation for Ethernet Tunnel Group SAPs should be utilized. This parameter is only available when the Protection Type parameter is set to Load Sharing.

type=boolean
default=false
Displayed(tab/group)=Enable Per Forwarding Path Ingress Queue (/Load Sharing)
protectionType The Protection Type parameter specifies the protection mode for the global tunnel and the tunnel endpoints.

type=ethernettunnel.ProtectionType
default=g8031_1to1
Displayed(tab/group)=Protection Type (/Endpoints)
svcConnectionType The connection between the service and the service tunnel

type=svt.ConnectionType
access=read-only
default=p2p
Displayed(tab/group)=Connection Type (/Service Tunnel)
svcTunnelType The type of service tunnel

type=svt.TunnelType
access=read-only
default=ethTunnel
Displayed(tab/group)=Tunnel Type (/Service Tunnel)
tunnelId

type=int
access=read-create
default=0
minimum=1
maximum=1024
Displayed(tab/group)=Tunnel ID
 
Overridden Properties
holdTimeDown The Hold Time Down (centiseconds) parameter specifies the delay between detecting that the member path is down and reporting the status to the G.8031 protection module. The parameter applies only to member path CCM and not to the member port link state. The parameter applies to both the global tunnel and the tunnel endpoint. The range is 0 to 1000. The default is 0.

holdTimeUp The Hold Time Up parameter specifies the delay, in deciseconds, used for the hold-timer for associated CC Session up event dampening. The parameter refers to both the global tunnel/ring and the tunnel/ring endpoint.

id

 
Properties inherited from ethernettunnel.AbstractAPSGroup
aggrEndPtOperationalState, description, displayedName, holdTimeDown, holdTimeUp, id, numberOfPaths, revertTime
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addEthernetTunnelEndpoint

adds EthernetTunnelEndpoint(s) to this EthernetTunnel
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.
aInFdns : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

createEthernetTunnelEndpoint

creates a EthernetTunnelEndpoint and it add the endpoint to this Ethernet Tunnel
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.
aInEthernetTunnelEndpoint : config(ethernettunnel.EthernetTunnelEndpoint) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
aInFullName : string -

removeEthernetTunnelEndpoint

removes EthernetTunnelEndpoint(s) from this EthernetTunnel
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.
aInFdns : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false