Overview Package Class Deprecated Help

mplstp
GlobalTPLsp

This objects combines two MPLS-TP LER LSPs into a bidrectional MPLS-TP LSP.

public class GlobalTPLsp

Properties
destinationGlobalIdA Specifies the global identifier of the destination in LER LSP A

type=long
default=0
minimum=0
maximum=4294967295
destinationGlobalIdB Specifies the global identifier of the destination in LER LSP B

type=long
default=0
minimum=0
maximum=4294967295
destinationNodeIdA This is for internal use

type=string
access=read-only
default=0.0.0.0
destinationNodeIdB This is for internal use

type=string
access=read-only
default=0.0.0.0
destinationTunnelNumberA Specifies the tunnel number of the destination in LER LSP A

type=long
default=0
minimum=0
maximum=61440
destinationTunnelNumberB Specifies the tunnel number of the destination in LER LSP B

type=long
default=0
minimum=0
maximum=61440
displayedName

type=string
access=read-create
default=
minimum=1
maximum=64
Mandatory on create
Displayed(tab/group)=Name
fromNodeIdA The node ID of the LER Node A

type=InetAddress
default=0.0.0.0
fromNodeIdB The node ID of the LER Node B

type=InetAddress
default=0.0.0.0
globalTPLspId

type=long
access=read-create
default=0
minimum=1
maximum=1000000999999
Displayed(tab/group)=ID
ipAddressType

type=rtr.InetAddressType
default=ipv4
lspIdAutoAssigned Specifies whether the LSP ID auto assigned is enabled or not.

type=boolean
default=true
Displayed(tab/group)=TP-LSP ID Auto-Assigned
mplstp.GlobalTPLspPath-Set type=Children-Set
pathIdA

type=long
access=read-create
default=0
minimum=0
maximum=65535
Displayed(tab/group)=TP-LSP ID (/LER A)
pathIdB

type=long
access=read-create
default=0
minimum=0
maximum=65535
Displayed(tab/group)=TP-LSP ID (/LER B)
sourceGlobalIdA This is for internal use

type=long
access=read-only
default=0
sourceGlobalIdB This is for internal use

type=long
access=read-only
default=0
sourceNodeIdA

type=InetAddress
access=read-create
default=0.0.0.0
sourceNodeIdB

type=InetAddress
access=read-create
default=0.0.0.0
sourceNodePointerA The network element that is the source of the Lsp LER A.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Source Site (/LER A)
sourceNodePointerB The network element that is the source of the Lsp LER B.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Source Site (/LER B)
toNodeIdA The node ID of the destination in LER LSP A

type=InetAddress
default=0.0.0.0
toNodeIdB The node ID of the destination in LER LSP B

type=InetAddress
default=0.0.0.0
tpLspNameA Specifies LER LSP A

type=Pointer
tpLspNameB Specifies LER LSP B

type=Pointer
type

type=mpls.LspType
access=read-only
default=mplstp
Displayed(tab/group)=Type
virtualRouterId

type=int
access=read-only
default=1
minimum=1
maximum=1
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

createWithAutoFillForCompleteConnections

Creates a global TP LSP object including all its children. Note, this method is for the global TP LSP creation only, furthermore, this method should only be used if the network is fully connected. For updates, please use the generic.configureInstance method instead.

Following is an example, we will use this example to explain some of the parameters.

Suppose you want to create a global TP LSP between A and B in the following network: A-a1======C-c=====D-d=======B (working path), A-a2======E-e=====B (protecting path), where A and B are LERs, C, D, and E are LSRs, and a1, c, d, a2 and e are reverse out-link interfaces.

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(mplstp.GlobalTPLsp) - Configuration info for the GlobalTPLsp object, and its GlobalTPLspPath children (working path/protecting path), if needed. Note, there is no need to specify any TPStaticHop children explicitly. Static Hops will be automatically created by this method based on the egress interface specified on the previous node and the network connection.
workingPathReverseOutLinkPointerList : List (Pointer) - An ordered list of reverse out-link interface pointers for the working path (from LER A towards LER B, one direction only), if the working path is configured.

In the given example above, the workingPathReverseOutLinkPointerList will contain MPLS interface pointers for a1, c and d.
workingPathStaticHopNameList : List (string) - An ordered list of names for the static hops to be created for the working path (from LER A towards LER B, one direction only), if the working path is configured.

In the given example above, the workingPathStaticHopNameList will contain the LSR path names for C and D.
protectingPathReverseOutLinkPointerList : List (Pointer) - An ordered list of reverse out-link interface pointers for the protecting path (from LER A towards LER B, one direction only), if the protecting path is configured.

In the given example above, the protectingPathReverseOutLinkPointerList will contain MPLS interface pointers for a2, and e.
protectingPathStaticHopNameList : List (string) - An ordered list of names for the static hops to be created for the protecting path (from LER A towards LER B, one direction only), if the protecting path is configured.

In the given example above, the protectingPathStaticHopNameList will contain LSR path name for E.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

Exceptions:
mplstp.GlobalTPLsp.createWithAutoFillForCompleteConnectionsException

createWithAutoFillForIncompleteConnections

Creates a global TP LSP object including all its children. Note, this method is for the global TP LSP creation only, furthermore, this method is used if the network is not fully connected. For updates, please use the generic.configureInstance method instead.

Following is an example, we will use this example to explain some of the parameters.

Suppose you want to create a global TP LSP between A and B in the following network: A-a1======c1-C-c2=====d1-D-d2=====b1-B (working path), A-a2======e1-E-e2=====b2-B (protecting path), where A and B are LERs, C, D, and E are LSRs, a1, c2, d2, a2 and e2 are reverse out-link interfaces, and c1, d1, b1, e1 and b2 are forward out-link interfaces.

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(mplstp.GlobalTPLsp) - Configuration info for the GlobalTPLsp object, and its GlobalTPLspPath children (working path/protecting path), if needed. Note, there is no need to specify any TPStaticHop children explicitly. Static Hops will be automatically created by this method based on the reverse and forward out-link interfaces specified.
workingPathReverseOutLinkPointerList : List (Pointer) - An ordered list of reverse out-link interface pointers for the working path (from LER A towards LER B, one direction only), if the working path is configured.

In the given example above, the workingPathReverseOutLinkPointerList will contain MPLS interface pointers for a1, c2 and d2.
workingPathForwardOutLinkPointerList : List (Pointer) - An ordered list of forward out-link interface pointers for the working path (from LER A towards LER B, one direction only), if the working path is configured.

In the given example above, the workingPathForwardOutLinkPointerList will contain MPLS interface pointers for c1, d1 and b1.
workingPathStaticHopNameList : List (string) - An ordered list of names for the static hops to be created for the working path (from LER A towards LER B, one direction only), if the working path is configured.

In the given example above, the workingPathStaticHopNameList will contain LSR path names for C and D.
protectingPathReverseOutLinkPointerList : List (Pointer) - An ordered list of reverse out-Link interface pointers for the protecting path (from LER A towards LER B, one direction only), if the protecting path is configured.

In the given example above, the protectingPathReverseOutLinkPointerList will contain MPLS interface pointers for a2 and e2.
protectingPathForwardOutLinkPointerList : List (Pointer) - An ordered list of forward out-link interface pointers for the protecting path (from LER A towards LER B, one direction only), if the protecting path is configured.

In the given example above, the protectingPathForwardOutLinkPointerList will contain MPLS interface pointers for e1 and b2.
protectingPathStaticHopNameList : List (string) - An ordered list of names for the static hops to be created for the protecting path (from LER A towards LER B, one direction only), if the protecting path is configured.

In the given example above, the protectingPathStaticHopNameList will contain LSR path name for E.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

Exceptions:
mplstp.GlobalTPLsp.createWithAutoFillForIncompleteConnectionsException
Supported Network Elements
7450 ESS Supported from 11.0.R4
  • Excluded chassis types: 7450-ESS6, 7450-ESS6V
7750 SR Supported from 11.0.R4
7210 SAS R
7950 XRS Supported from 12.0.R1
7210 SAS T Supported from 7.0.R1
  • Required Capabilities: NetworkMode