Overview Package Class Deprecated Help

svt
AbstractTunnel

Represents an abstract tunnel (or SDP) object.

public abstract class AbstractTunnel

Stats:
service.CompleteSdpEgressPacketOctets service.CompleteSdpIngressPacketOctets

Properties
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)
operationalFlags Specifies all the conditions that affect the operating status of this tunnel.

type=svt.TunnelOperFlags
access=read-only
Displayed(tab/group)=State Cause (/States)
sasEntityName Attribute used for SAS.

type=string
access=read-only
minimum=0
maximum=350
sasTestSuiteCount

type=int
access=read-only
default=0
minimum=0
Displayed(tab/group)=Test Suite Count (/Identity)
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=sdp
Displayed(tab/group)=Tunnel Type (/Service Tunnel)
templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)
underlyingTransport

type=svt.PathTransport
default=unknown
Displayed(tab/group)=Underlying Transport (/Identity)
 
Overridden Properties
description

minimum=0
maximum=80
displayedName

minimum=0
pathId

minimum=1
maximum=17407
pathMtu The Administrative MTU parameter specifies the maximum packet size that is supported by the network interface. The range is 0 to 9782. The default is 0. A value of zero indicates that the MTU should be computed dynamically from the corresponding MTU of the tunnel.

maximum=9782
sourceNodeId

 
Properties inherited from netw.SignalledPath
encapsulationType, signallingType
 
Properties inherited from netw.UnidirectionalPath
actualPathMtu, description, destinationNodeId, destinationNodeIdAddrType, destinationNodeMisconfigured, displayedName, forwardingClasses, loadFactor, pathId, pathMtu, sourceNodeId, sourceNodeIdAddrType, sourceNodeMisconfigured
 
Properties inherited from netw.PointToPointSubnetworkConnection
fromCtp, fromNodeId, fromNodeName, toCtp, toNodeId, toNodeName
 
Properties inherited from netw.SubnetworkConnection
domain
 
Properties inherited from netw.Connection
administrativeState, application, connectionId, operationalState
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

findCircuits

Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

findServices

Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

findSubscribers

Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

rediscoverTunnelDestination

Rediscover the destinations for the tunnels in the specified list, where the tunnels destination node ID is not set.
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.
aInSdpFdns : Set (Pointer) - A list of tunnel FDNs that need to rediscover the destination node ID.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (string) - A list of error messages.

shutDown

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

turnUp

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