mpls
Tunnel

Tunnel represents a tunnel object on the node.



public class Tunnel

Properties
actualNumberOfLsps

type=int
access=read-only
default=0

actualPathId

type=long
access=read-only
default=0
minimum=0
maximum=2147483647

cspfPathId

type=long
access=read-only
default=0
minimum=0
maximum=2147483647

customProperties This is used for any custom properties for this object.

type=Map (string to string)

destinationIpAddress

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=IP Address (/Termination)

egressLabelSwitchRouterId Specify the egress LSR associated with this tunnel instance

type=long
default=0
minimum=0
maximum=4294967295

hopIdToAddressList This is used for MV nodes. The mapping of an Id to an address is required for deployment.

type=List (string)

ingressLabelSwitchRouterId Specify the ingress LSR associated with this tunnel instance

type=long
default=0
minimum=0
maximum=4294967295

instance

type=int
access=read-only
default=1
minimum=1
maximum=1

isSIDConfiguredOnHops Specifies whether SID is configured on the underlying Hops for this Tunnel. From 19.10 onwards, a hop can be configured with SID or IP Address for a Path.

type=boolean
default=false

lspId Specify the Id of an LSP that use this tunnel if tunnel can not be shared.

type=int
default=0
minimum=0
maximum=65535

numberOfLsps

type=int
access=read-only
default=0

primaryInstance Specifies the instance index of the primary instance of this tunnel. More details of the definition of tunnel instances and the primary tunnel instance can be found in the description of the TEXTUAL-CONVENTION MplsTunnelInstanceIndex.

type=int
access=read-only
default=0
minimum=0
maximum=65535

priority

type=long
default=0
minimum=0
maximum=2147483647

provisionedPathId

type=long
default=0
minimum=0
maximum=2147483647

role Specify the tunnel's role. (head, transit, tail)

type=mpls.RoleType
access=read-only
default=head

sessionAttributes This bit mask indicates optional session values for this tunnel.

type=mpls.SessionAttributeFlags
access=read-only
default=0

tunnelIdType This is used for Multi Vendor. Some nodes allow a number for the ID of the tunnel and others allow a string. This information is needed in NFM-P in order to do a correct deployment.

type=mpls.PathIdType
access=read-only

tunnelInstance

type=int
default=0
minimum=0

virtualRouterId

type=int
access=read-only
default=1
minimum=1
maximum=1

 
Overridden Properties
description

displayedName

minimum=0
maximum=64

pathId

minimum=1

 
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

configure

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.
configInfo : config(mpls.Tunnel) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
dn : Pointer -
Exceptions:
mpls.Tunnel.configureException

configureTunnelAndPath

Create the mpls.Tunnel and mpls.ProvisionedPath in conjunction with each other. This method should only be used to create, not modify, the tunnel and path. Use the generic configure methods in generic.GenericObject. NOTE: Only paths with hops are actually created. A hop-less path will result in no object being created and the returned pathDn being set to nothing.
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.
pathConfigInfo : config(mpls.Path) -
tunnelConfigInfo : config(mpls.Tunnel) -
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:
result : mpls.TunnelAndPathResult -
Exceptions:
mpls.Tunnel.configureTunnelAndPathException

delete

DEPRECATED - 8.0.R1
Use
generic.GenericObject.deleteInstance() instead.
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

find

DEPRECATED - 8.0.R1
Use root find instead.
Input Parameters:
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:
siteInfoList : List (generic.CommonManagedEntityInformation) -

findActualPath

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:
info : summary(mpls.Path) -

findLspPaths

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

findLsps

Input Parameters:
instanceFullName : string - the full name of the object.
lspPathFilter : FilterHolder -
lspFilter : 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) -

findP2mpLsps

Input Parameters:
instanceFullName : string - the full name of the object.
s2lPathFilter : FilterHolder -
lspFilter : 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) -

findProvisionedPath

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:
info : summary(mpls.Path) -

findS2lPaths

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) -
Supported Network Elements
7450 ESS
7210 SAS X
7210 SAS M Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS T Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS K Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
Generic NE 1.0.0
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Wavence SM
Product Specifics
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 Gen 2 (all versions)
7705 SAR Gen 2 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 (all versions)
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 (all versions)
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 (all versions)
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 (all versions)
DC VSA8 5.0
DC VSA8 6.0
DC VSC (all versions)
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE 1.0.0