topologysim
LspPath

An LSP path is a binding of an LSP to a provisioned path. An LSP path is either primary or secondary within the context of the parent LSP.

A history of the actual path of the LSP is kept.



public class LspPath

Properties
adaptive Specifies whether the make-before-break functionality for the LSP is enabled

type=boolean
access=read-only
default=true
Displayed(tab/group)=Make before Break (Properties/Behavior)

adminGroupExclude The Admin Groups Excluded parameter contains a bit mask. Each set bit corresponds to one administrative group of interfaces that the LSP must NOT cross. An LSP may exclude multiple groups. By convention, the least significant bit is referred to as 'group 0', and the most significant bit is referred to as 'group 31'. The Administrative Group is also called Resource Class/Color.

type=long
default=0
Displayed(tab/group)=Admin Groups Excluded (Properties/Traffic Engineering)

adminGroupInclude TThe Admin Groups Included parameter contains a bit mask. Each set bit corresponds to one administrative group of interfaces that the LSP is permitted to cross. An LSP may exclude multiple groups. By convention, the least significant bit is referred to as 'group 0', and the most significant bit is referred to as 'group 31'. The Administrative Group is also called Resource Class/Color

type=long
default=0
Displayed(tab/group)=Admin Groups Included (Properties/Traffic Engineering)

bandwidth The bandwidth (in Mbps) to be reserved for paths in this LSP. Specific LSP paths within the LSP may specify a different bandwidth.

Bandwidth is only applicable when CSPF is enabled.

type=float
minimum=0
maximum=100000
units=Mbps
Displayed(tab/group)=Reserved Bandwidth (Properties/Traffic Engineering)

cspfEnabled Specifies whether this LSP path is setup using constrained shortest path first (CSPF). Using CSPF allows for traffic engineering.

type=boolean
access=read-only
default=true
Displayed(tab/group)=Enable CSPF (Properties/Traffic Engineering)

destinationIpAddress The destination IP address.

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

destinationSystemIp Specifies the system IP address of the destination router of the LSP path.

type=string
access=read-only
maximum=50
Displayed(tab/group)=Destination System IP (/Destination)

ecmpPathSelector Specifies the algorithm the LSP simulator uses to choose from multiple equal cost paths. When Random is selected, a random number generator is used to select one of the paths. When Least-Fill is selected, the path with the link with the least percentage bandwidth used is selected. When Hash is selected, a hash of the source and destination of the LSP is used to select one of the paths.

type=topologysim.EcmpPathSelector
access=read-only
Displayed(tab/group)=ECMP Tie Breaker (Properties/Behavior)

enableTeMetric Specifies whether this LSP path is setup using constrained shortest path first (CSPF) using the TE metric rather than the IGP metric.

type=boolean
access=read-only
default=true
Displayed(tab/group)=Enable TE Metric (Properties/Traffic Engineering)

holdPriority Used for LSP path preemption. Preemption is only available on LSP paths that have CSPF enabled, have make-before-break (adaptive) enabled, and whose requested bandwidth is greater than 0.

Each LSP path is configured with a setup and holding priority. Priority values are 0 (highest priority) to 7 (lowest priority).

If there is not enough bandwidth to satisfy another new LSP setup and this LSP has a strictly lower holding priority (numerically higher) than the setup priority of new LSP, the simulation will attempt to tear down the this LSP to allow the new LSP to come up.

type=int
access=read-only
default=0
minimum=0
maximum=7
Displayed(tab/group)=Hold Priority (Properties/Path Preemption)

hopLimit Specifies the maximum number of hops for the simulated LSP path. An LSP is not set up if the hop limit is exceeded. This parameter controls the number of loose hops associated with MPLS paths. If there is an associated Inherit Value parameter, then the Hop Limit parameter is configurable only when you set the Inherit Value parameter to Disabled.

type=int
default=255
minimum=2
maximum=255
Displayed(tab/group)=Hop Limit (Properties/Traffic Engineering)

id System generated ID.

type=long
access=read-create
default=0
minimum=1
maximum=4611686018427387903
Displayed(tab/group)=LSP Path ID

lspId The LSP ID.

type=long
access=read-only
Displayed(tab/group)=LSP ID (/LSP)

lspName The LSP name.

type=string
access=read-only
minimum=0
maximum=252
Displayed(tab/group)=LSP (/LSP)

propertyInheritance Mask used to specify if the property corresponding to bit should takes its value from the parent LSP or be configured on the LSP path.

type=long
default=unspecified
bits=
    0x1: adaptive
    0x2: adminGroupInclude
    0x4: adminGroupExclude
    0x8: hopLimit
    0x10: bandwidth

provisionedPath Pointer to the provisioned path of the LSP.

type=Pointer
access=read-create
Mandatory on create
Displayed(tab/group)=Provisioned MPLS Path

rsvpStyle The RSVP reservation style.

type=mpls.RsvpStyle
access=read-only
default=se
Displayed(tab/group)=RSVP Reserve Style (Properties/Behavior)

setupPriority Used for LSP path preemption. Preemption is only available on LSP paths that have CSPF enabled, have make-before-break (adaptive) enabled, a0nd whose requested bandwidth is greater than 0.

Each LSP path is configured with a setup and holding priority. Priority values are 0 (highest priority) to 7 (lowest priority).

If there is not enough bandwidth to satisfy an LSP setup and there are other LSPs with a strictly lower holding priority (numerically higher) than the setup priority of this LSP, the simulation will attempt to tear down the other LSP to allow this LSP to come up.

type=int
access=read-only
default=7
minimum=0
maximum=7
Displayed(tab/group)=Setup Priority (Properties/Path Preemption)

sourceIpAddress Specifies the IP address of an interface on the source router of the LSP path.

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

sourceSystemIp Specifies the system IP address of the source router of the LSP path.

type=string
access=read-only
maximum=50
Displayed(tab/group)=Source System IP (/Source)

standby Specifies if the secondary path is standby or not. If the path is primary, the standby is always false.

type=boolean
default=false
Displayed(tab/group)=Standby

status Specifies whether this LSP path is the active path or not.

type=mpls.LspPathState
access=read-only
default=unknown
Displayed(tab/group)=Status (/States)

topologysim.LspPathMonitor-Set type=Children-Set
topologysim.MplsActualPath-Set type=Children-Set
type Specifies if the path is primary or secondary.

type=topologysim.LspPathType
access=read-create
default=secondary
Displayed(tab/group)=Type

  
Properties inherited from simulator.Element
administrativeState, description, displayedName, modelPointer, modelType, operationalState, scenarioId, scenarioName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed