mpls
BypassOnlyLsp

Represents the configuration of a bypass-only LSP (a.k.a. manual bypass LSP). A bypass-only LSP is used exclusively for bypass protection.



public class BypassOnlyLsp

Stats:
mpls.LspStats

Properties
adaptive The Make before Break parameter specifies the traffic rerouting method when you move traffic between primary and secondary LSP paths. The make-before-break functionality ensures that the transition to the new path does not cause any traffic disruption. For example, when the parameters of an already-established LSP are changed due to a user configuration modification, when the parameter is set to true the resources of the existing LSP are not released until a new path with the same LSP ID is established and passing the traffic seamlessly handed over from the old LSP. When enabled for the LSP, the make-before-break functionality is implemented for the primary path and all the secondary paths of the LSP.

type=generic.TruthValue
default=true
Displayed(tab/group)=Make before Break (Properties/Configuration)

addSpec Specifies whether inclusion of ADSPEC objects in RSVP messages is enabled

type=generic.TruthValue
default=false
Displayed(tab/group)=Include ADSPEC in RSVP (Properties/Signalling)

adminGroupExclude The Groups Excluded parameter is a bit-map that specifies a list of admin groups that should be excluded when this LSP is setup. If bit 'n' is set, then the admin group with value 'n' is excluded for this LSP. This implies that each link that this LSP goes through must not be associated with any of the admin groups in the exclude list.

type=long
default=0
units=bitmap
Displayed(tab/group)=Groups Excluded (Properties/Administrative Groups)

adminGroupInclude The Groups Included parameter is a bit-map that specifies a list of admin groups that should be included when this LSP is setup. If bit 'n' is set, then the admin group with value 'n' is included for this LSP. This implies that each link that this LSP goes through must be associated with at least one of the admin groups in the include list.

type=long
default=0
units=bitmap
Displayed(tab/group)=Groups Included (Properties/Administrative Groups)

cspfEnabled The Enable CSPF parameter specifies the CSPF routing algorithm to find a path that satisfies the constraints for the LSP. The constraints associated with the LSP can be related to admin groups, or the number of path hops. This attribute is deprecated since SR 19.7.R1. For SR nodes from 19.7.R1 onwards, please use mpls.BypassOnlyLsp.pathComputationMethod as a replacement. If one of the properties is updated the corresponding other property will also be updated.

type=generic.TruthValue
default=true
Displayed(tab/group)=Enable CSPF (Properties/Configuration)

cspfToFirstLooseHop The value specifies whether CSPF calculation until the first loose hop on ingress Label Edge Router (LER) is enabled or disabled for this Labeled Switched Path(LSP)

DEPRECATED: 11.0 - Deprecated in the SR 11.0 release.
type=boolean
default=false
Displayed(tab/group)=Inter Area CSPF To First Loose Hop (Properties/Configuration)

enableTeMetric Specifies whether the TE metric would be used for the purpose of the LSP path computation by CSPF. This attribute is deprecated since SR 19.7.R1. For SR nodes from 19.7.R1 onwards, please use mpls.BypassOnlyLsp.metricType as a replacement. If one of the properties is updated the corresponding other property will also be updated.

type=boolean
default=false
Displayed(tab/group)=Enable TE Metric (Properties/Configuration)

hopLimit The Hop Limit parameter specifies the maximum number of hops that a LSP will traverse including the ingress and egress nodes. An LSP will not be setup if the hop limit is exceeded. The range is 2 to 255. The default is 255.

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

metricType Specifies metric type. This property replaces mpls.BypassOnlyLsp.enableTeMetric for SR nodes from 19.7.R1 onwards. When the value is 'TE', the behavior will be same as mpls.BypassOnlyLsp.enableTeMetric is set to 'true'. If one of the properties is updated the corresponding other property will also be updated.

type=int
default=1
Displayed(tab/group)=Metric Type (Properties/Configuration)
enums=
    1: igp - IGP
    2: te - TE

mpls.LspPath-Set type=Children-Set
negotiatedMtu Specifies the MTU

type=int
access=read-only
default=0
units=bytes
Displayed(tab/group)=Maximum Transmitted Frame Size (MTU) (/Identity)

nodeInEROAddr The value specifies whether to include XRO object in bypass PATH message with the exclude-node ip address

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Exclude Node IP Address (Properties/Inter Area/Level Traffic Engineering)

nodeInEROAddrType

type=rtr.InetAddressType
default=ipv4

operationMetric The cost of the traffic engineered path returned by the IGP."

type=long
access=read-only
Displayed(tab/group)=Operational Metric (Properties/Traffic Engineering And Protection)

pathComputationMethod Specifies LSP path computation method. This property replaces mpls.BypassOnlyLsp.cspfEnabled for SR nodes from 19.7.R1 onwards. When the value is 'Local CSPF', the behavior will be same as mpls.BypassOnlyLsp.cspfEnabled is set to 'true'. To match the mpls.BypassOnlyLsp.cspfEnabled value, the default is set to 'Local CSPF' mapping to mpls.BypassOnlyLsp.cspfEnabled 'true'. If one of the properties is updated the corresponding other property will also be updated.

type=int
default=2
Displayed(tab/group)=Path Computation Method (Properties/Configuration)
enums=
    1: none - None
    2: localCspf - Local CSPF
    3: pce - PCE

propAdminGroup The value specifies whether the propagation of session attribute object with resource affinity (C-type 1) in PATH message is enabled.

type=boolean
default=false
Displayed(tab/group)=Propagate Administrative Groups via Session Attribute Object (Properties/Signalling)

record The Record Actual Path parameter specifies whether the labels at each NE are recorded and displayed for the LSP path, to indicate the hops in the LSP path.

type=generic.TruthValue
default=true

retryLimit Specifies the max number of attempts made to reestablish the LSP after is has failed

type=int
default=0
minimum=0
maximum=10000
Displayed(tab/group)=Retry Limit (Properties/Signalling)

retryTimer Specifies the time between attempts to reestablish the LSP after it has failed

type=int
default=30
minimum=1
maximum=600
units=seconds
Displayed(tab/group)=Retry Timer (Properties/Signalling)

rsvpStyle The RSVP Reserve Style parameter specifies the RSVP reservation style. A reservation style is a set of control options that specify a number of supported parameters. The style information is part of the LSP configuration. The parameter options are as follows: Shared-Explicit (default) - This option specifies a shared reservation environment with an explicit reservation scope. A single reservation is created on a link that is shared by an explicit list of senders. Because each sender is explicitly listed in the RESV message, different labels can be assigned to different sender receiver pairs, thereby creating separate LSPs. Fixed-Filter - Specifies a single reservation with an explicit scope. This reservation style specifies an explicit list of senders and a distinct reservation for each. A specific reservation request is created for data packets from a specific sender. The reservation scope is determined by an explicit list of senders.

type=mpls.RsvpStyle
default=se
Displayed(tab/group)=RSVP Reserve Style (Properties/Signalling)

tunnelDestinationMatching Specifies, when selecting an MPLS path, whether NFM-P UI should only provide paths that have the same destination as the LSP's. This is used on the UI only.

type=mpls.TunnelDestinationMatching
default=destinationSite

 
Overridden Properties
destinationIpAddressType
valid enums=ipv4 (Where parent is one of (mpls.LspManager))
destinationNodeIdAddrType
valid enums=ipv4 (Where parent is one of (mpls.LspManager))
displayedName

access=read-create
minimum=1
maximum=64

sourceIpAddressType
valid enums=ipv4 (Where parent is one of (mpls.LspManager))
sourceNodeIdAddrType
valid enums=ipv4 (Where parent is one of (mpls.LspManager))
type

default=bypassOnly

 
Properties inherited from mpls.Lsp
description, destinationInterfaceId, destinationInterfaceName, destinationIpAddress, destinationIpAddressType, destinationNodeId, displayedName, egressInterfaceId, egressInterfaceName, egressInterfacePointer, egressLabel, ingressInterfaceId, ingressInterfaceName, ingressInterfacePointer, ingressLabel, numberOfPaths, numberOfPrimaryPaths, operationalFlags, pathId, preference, sas.OneTimeValidationResult-Set, sasEntityName, sasTestSuiteCount, sourceInterfaceId, sourceInterfaceName, sourceIpAddress, sourceIpAddressType, sourceNodeId, ttmTunnelId, tunnelId, type, virtualRouterId
 
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 inherited from mpls.Lsp
findLdpTargetedPeers, findServiceCircuits, findServicePaths, findServices, findSubscribers
 
Supported Network Elements
7450 ESS
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
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 X
7210 SAS R
7250 IXR
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
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 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 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
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 25.0
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 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 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
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 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0