mpls
Site

Site contains general information about the MPLS instance.



public class Site

Stats:
mpls.SiteStats

Properties
adminGroupFrr Specifies whether or not the use of administrative group constraints on a FRR backup LSP at a Point-of-Local Repair(PLR) node is enabled.

type=boolean
default=false
Displayed(tab/group)=Enable Administrative Group for FRR Path Computation (/Configuration)

autoBWAdjMul The value specifies the global default for collection intervals in an adjust interval.

type=int
default=288
minimum=1
maximum=16383
Displayed(tab/group)=Adjust Multiplier (/Auto Bandwidth Multipliers)

autoBWSampleMul The value specifies the global default for collection intervals in a sample interval.

type=int
default=1
minimum=1
maximum=511
Displayed(tab/group)=Sample Multiplier (/Auto Bandwidth Multipliers)

auxStats Specifies which types of labeled traffic are counted in the MPLS auxiliary statistics table. By default, all labeled traffic is counted in the default MPLS statistics table. If the 'sr' bit is set, Segment Routing traffic is counted in the MPLS auxiliary statistics table.

type=mpls.AuxStats
default=unspecified
Displayed(tab/group)=Auxiliary Statistics (/Configuration)

bgpLabelsHoldTimer Specifies the number of seconds to wait before deleting a BGP label entry based on next-hop from IOM.

type=int
default=0
minimum=0
maximum=255
units=seconds
Displayed(tab/group)=BGP Labels Hold Timer (/Configuration)

bypassResignalTimer Specifies the time, in minutes, before attempting to re-signal Bypass LSPs

type=int
default=0
minimum=0
maximum=10080
units=min
Displayed(tab/group)=Bypass Resignal Timer (/LSP Bypass Resignal)

cspfOnLooseHop The value specifies whether CSPF calculation is enabled or not for next hop.

type=boolean
default=false
Displayed(tab/group)=CSPF On Loose Hop (/Inter Area/Level Traffic Engineering)

dynamicBypass Specifies whether dynamic bypass tunnels are enabled

type=int
default=enabled
Displayed(tab/group)=Dynamic Bypass (/Configuration)
enums=
    1: enabled - Enabled
    2: disabled - Disabled

enableSrlgFrr Specifies whether Shared Risk Link Group (SRLG) constraint will be used in the computation of FRR bypass or detour to be associated with any primary LSP path on the system.

type=boolean
default=false
Displayed(tab/group)=Enable SRLG for FRR (/Shared Risk Link Group)

endSegmentRoutingLabel Specifies the end point of the Segment Routing Label range.

type=int
default=0
minimum=0
maximum=524287
Displayed(tab/group)=End Segment Routing Label (/Configuration)

entropyLblRsvpTe The value specifies whether the application takes into account the value of Entropy Label and Entropy Label Capability in the label stack for RSVP-TE LSPs.

type=mpls.EntropyLblCapForRsvpTe
default=enable
Displayed(tab/group)=Entropy Label for RSVP-TE LSPs (/Configuration)

entropyLblSrTe The value specifies whether the application takes into account the value of Entropy Label and Entropy Label Capability in the label stack for SR-TE LSPs.

type=mpls.EntropyLblCapForSrTe
default=enable
Displayed(tab/group)=Entropy Label for SR-TE LSPs (/Configuration)

expBackoffRetry Specifies the state of Exponential Backoff Retry mechanism."

type=boolean
default=false
Displayed(tab/group)=Exponential Backoff Retry (/Configuration)

frrSignalling

type=generic.TruthValue
default=true
Displayed(tab/group)=Fast Reroute Signaling (/Configuration)

holdTimer Specifies the time, in seconds, for which the ingress node holds a bit before programming its data plane and declaring the lsp up to the service module. A value of 0 indicates that the hold timer has been disabled.

type=int
default=1
minimum=0
maximum=1000
units=seconds
Displayed(tab/group)=Hold Timer (/Hold Timer)

ipv6OperDownReasonCode Indicates the reason due to which the MPLS instance is operationally down for SR-TE IPv6.

type=mpls.MplsOperDownReasonCode
access=read-only
default=operUp
Displayed(tab/group)=IPv6 Operational Down Reason (/States)

ipv6OperationalState Indicates the current operating state of MPLS protocol instance on this router for SR-TE IPv6.

type=netw.OperationalState
access=read-only
default=unknown
Displayed(tab/group)=IPv6 Operational State (/States)

leastFillMinThd Specifies in percentage the least minimum threshold parameter used in the least-fill path selection process

type=int
default=5
minimum=1
maximum=100
Displayed(tab/group)=Least Minimum Threshold (/Least-Fill)

leastFillReoptThd Specifies in percentage the least reoptimization threshold parameter used in the least-fill path selection process

type=int
default=10
minimum=1
maximum=100
Displayed(tab/group)=Least Reoptimization Threshold (/Least-Fill)

localTtlPropagate Enable/disable TTL propagation of locally generated IP packets.

type=boolean
default=true
Displayed(tab/group)=Shortcut Local TTL Propagate (/TTL Propagate)

logEventBundling Specifies whether or not the notification bundling mechanism is enabled.

type=boolean
default=false
Displayed(tab/group)=Logger Event Bundling (/Configuration)

lspBsidBlkName Specifies the name identifying the reserved label block for LSP binding SID.

type=Pointer
default=
Displayed(tab/group)=LSP BSID Block Name (/LSP BSID Block)

lspHistory Specifies whether or not LSP history is enabled.

type=boolean
default=false
Displayed(tab/group)=LSP History (/LSP History)

lspHistoryAdminState Specifies the current administrative state for LSP History. The value of lspHistoryAdminState specifies whether or not LSP history is being recorded. When the value of lspHistoryAdminState is set to 'inService', LSP history will be recorded. When the value of lspHistoryAdminState is set to 'outOfService', LSP history will stop being recorded and previously recorded history will remain intact. This variable is not valid if LSP history is disabled i.e. when Lsp history is set to 'false'.

type=netw.AdministrativeState
default=mplsUp
Displayed(tab/group)=Administrative State (/LSP History)

lspInitRetryTimeout Specifies the amount of time in seconds the software waits for an LSP path to come up after sending out the initial Path message. If the initial retry timeout period expires and the LSP path is not up, it is torn down and the LSP retry timer is started to schedule a new retry cycle using a new LSPId.

type=int
default=30
minimum=10
maximum=600
units=seconds
Displayed(tab/group)=LSP Init Retry Timeout (/Configuration)

lspSelfPingInterval Specifies the interval duration at which LSP self ping packets are sent until a reply is received from the far end of the session ID.

type=int
default=1
minimum=1
maximum=10
units=seconds
Displayed(tab/group)=Interval (/LSP Self Ping)

lspSelfPingRsvpTe Specifies whether the application takes into account the value of Self Ping in the label stack of RSVP-TE LSPs. When the value of lspSelfPingRsvpTe is set to 'true', the application will take into consideration the values of lspSelfPingInterval and lspSelfPingTimeout.

type=boolean
default=false
Displayed(tab/group)=Enable RSVP-TE (/LSP Self Ping)

lspSelfPingTimeout Specifies the value of timeout expiry duration up to which the lsp-self-ping packets will be sent. If the timeout expires before an LSP self ping has been received, then the system should tear down the path and go back to CSPF for a new path.

type=int
default=300
minimum=3
maximum=3600
units=seconds
Displayed(tab/group)=Timeout (/LSP Self Ping)

lspSelfPingTimeoutAction Specifies the timeout action of Self Ping for RSVP-TE LSPs. When the value is set to retry, the application tears down the LSP path, and starts to resignal the LSP path after the resignal timer expiry. When the value is set to switch, the application switches over to the candidate LSP path.

type=int
default=retry
Displayed(tab/group)=Timeout Action (/LSP Self Ping)
enums=
    1: retry - Retry
    2: switch - Switch

makeBeforeBreakPreferCurrentLspHops Specifies whether or not Constrained Shortest Path First (CSPF) for a Make-before-break (MBB) path should give preference to hops/links used by the current Labeled Switch Path (LSP).

type=boolean
default=false
Displayed(tab/group)=Make Before Break Prefer Current Lsp Hops (/Configuration)

maxBypassAssociation The value specifies the maximum number of LSP primary paths that can associate with each manual or dynamic bypass LSP.

type=int
default=1000
minimum=100
maximum=131072
Displayed(tab/group)=Maximum Bypass Associations (/Configuration)

maxBypassPlrAssociation Specifies the maxiumum bypass PLR assocations.

type=int
default=16
minimum=1
maximum=16
Displayed(tab/group)=Maximum Bypass PLR Associations (/Configuration)

maxStaticLspLabels Specifies the maximum number of Static LSP labels available on the system.

type=int
default=2016
minimum=0
maximum=262112
Displayed(tab/group)=Maximum Number of Static LSP Labels (/Configuration)

maxStaticSvcLabels Specifies the maximum number of Static SVC labels available on the system.

type=int
default=16384
minimum=0
maximum=262112
Displayed(tab/group)=Maximum Number of Static SVC Labels (/Configuration)

mpls.ClassForwardingPolicy-Set type=Children-Set
mpls.Crossconnect-Set type=Children-Set
mpls.ForwardingPolicyGeneral-Set type=Children-Set
mpls.IngStatsPolicy-Set type=Children-Set
mpls.Interface-Set type=Children-Set
mpls.LspTemplateIngStatsPolicy-Set type=Children-Set
mpls.OutSegment-Set type=Children-Set
mpls.PceInitiatedLsp-Set type=Children-Set
mplsSegRouteNodeSid The value of mplsSegRouteNodeSid specifies the Node SID to be used along with Segment Routing Global Block to define label values to be assigned to static LSPs.

type=long
default=1
minimum=1
maximum=4294967295
Displayed(tab/group)=Node SID (/Configuration)

nextBypassResignal Indicates the time remaining, in minutes, for the bypass re-signal timer to expire

type=int
access=read-only
default=0
units=min
Displayed(tab/group)=Next Bypass Resignal (/LSP Bypass Resignal)

nextOutSegmentId

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

nextResignal Indicates the time remaining, in minutes, for the resignal timer to expire

type=int
access=read-only
default=0
units=min
Displayed(tab/group)=Next LSP Resignal (/LSP Resignal)

nextSrteResignal Indicates the time remaining, in minutes, for the SR-TE re-signal timer to expire.

type=int
access=read-only
default=0
units=min
Displayed(tab/group)=Next SR-TE Resignal (/SR-TE LSP Resignal)

nextXcId

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

operDownReasonCode Indicates the reason due to which the MPLS instance is operationally down

type=mpls.MplsOperDownReasonCode
access=read-only
default=operUp
Displayed(tab/group)=Operational Down Reason (/States)

p2mpNextResignal Indicates the time remaining, in minutes, for the p2mp resignal timer to expire

type=int
access=read-only
default=0
units=min
Displayed(tab/group)=Next P2MP Resignal (/P2MP LSP Resignal)

p2mpResignalTimer Specifies the value for the P2MP (point to multi point) LSP resignal timer, that is the time, in minutes, the software will wait before attempting to resignal the P2MP LSPs. When the resignal timer expires, an attempt to resignal the entire P2MP instance comprising all source to leaf (S2Ls) are done, the IGP or TE metric of the S2Ls are not taken into consideration. If the attempt to resignal an P2MP LSP fails, the P2MP LSP will continue to use the existing S2Ls and a resignal will be attempted the next time the timer expires. A value of 0 for the resignal timer indicates that timer-based P2MP LSP resignalling has been disabled. The valid range is [0|60..10080].

type=int
default=0
minimum=0
maximum=10080
units=min
Displayed(tab/group)=P2MP Resignal Timer (/P2MP LSP Resignal)

p2mpTtlPropagate Specifies whether or not to enable TTL Propogation for RSVP P2MP LSP.

type=boolean
default=true
Displayed(tab/group)=P2MP TTL Propagate (/P2MP LSP Resignal)

p2pPathFastRetryTimer Specifies the value, in seconds, for the P2P active path fast retry timer.

type=int
default=0
minimum=0
maximum=10
units=seconds
Displayed(tab/group)=Active Path Fast Retry Timer (/LSP Resignal)

pceReport Specifies the PCE report types for the MPLS instance.

type=mpls.PceReport
default=unspecified
Displayed(tab/group)=PCE Report (/Configuration)

resignalOnIgpOverload Specifies whether or not RSVP-TE LSPs will be resignaled when IGP overload bit is received. When the value of resignalOnIgpOverload is set to 'true' and a node reports that it is in IGP overload state, MPLS will force the expiry of P2P and/or P2MP resignal timers for RSVP-TE LSPs. When the value of resignalOnIgpOverload is set to 'false' and a node reports that it is in IGP overload state, MPLS will not force the expiry of P2P and/or P2MP resignal timers for RSVP-TE LSPs.

type=boolean
default=false
Displayed(tab/group)=Resignal on IGP Overload (/RSVP-TE LSP Resignal)

resignalTimer Specifies the value for the P2P (point-to-point) LSP resignal timer, that is the time, in minutes, the software will wait before attempting to resignal the P2P LSPs. When the resignal timer expires, if the new recorded hop list (RRO) for an P2P LSP has a better metric than the current recorded hop list, an attempt will be made to resignal that P2P LSP using the make-before-break mechanism. If the attempt to resignal an P2P LSP fails, the P2P LSP will continue to use the existing path and a resignal will be attempted the next time the timer expires. A value of 0 for the resignal timer indicates that timer-based P2P LSP resignalling has been disabled. The valid range is [0|30..10080].

type=int
default=0
minimum=0
maximum=10080
units=min
Displayed(tab/group)=LSP Resignal Timer (/LSP Resignal)

retryOnIgpOverload Specifies whether or not to teardown and re-signalling LSPs transiting through nodes that are in IGP overload state.

type=boolean
default=false
Displayed(tab/group)=Retry on IGP overload (/Configuration)

s2lPathFastRetryTimer Specifies the value, in seconds, for the P2MP S2L active path fast retry timer

type=int
default=0
minimum=0
maximum=10
units=seconds
Displayed(tab/group)=S2L Active Path Fast Retry Timer (/P2MP LSP Resignal)

secFastRetryTimer Specifies the value, in seconds, used as fast retry timer for a secondary path.

type=int
default=0
minimum=0
maximum=10
units=seconds
Displayed(tab/group)=Secondary Fast Retry Timer (/Configuration)

srlgStrict Specifies whether to associate the LSP with a bypass or signal a detour if a bypass or detour satisfies all other constraints except the SRLG constraints.

type=boolean
default=false
Displayed(tab/group)=Strict (/Shared Risk Link Group)

srteResignalOnIgpEvent Specifies whether re-optimization of SR-TE LSPs triggered by IGP events is enabled or disabled.

type=boolean
default=false
Displayed(tab/group)=Resignal SR-TE LSPs On IGP Event (/SR-TE LSP Resignal)

srteResignalOnIgpOverload Specifies whether or not RSVP-TE LSPs will be resignaled when IGP event is received.

type=boolean
default=false
Displayed(tab/group)=Resignal SR-TE LSPs On IGP Overload (/SR-TE LSP Resignal)

srteResignalTimer Specifies the value for the SR-TE LSPs resignal timer, that is the time, in minutes, the software will wait before attempting to resignal the SR-TE LSPs. A value of 0 for the resignal timer indicates that timer-based SR-TE LSP resignalling has been disabled. The valid range is [0|30..10080].

type=int
default=0
minimum=0
maximum=10080
units=min
Displayed(tab/group)=SR-TE Resignal Timer (/SR-TE LSP Resignal)

startSegmentRoutingLabel Specifies the starting point of the Segment Routing Label range.

type=int
default=0
minimum=0
maximum=524287
Displayed(tab/group)=Start Segment Routing Label (/Configuration)

staticLabelRange Specifies the number of static labels available for all applications. The maximum value can be 131040 for Chaiss Mode non-D and 262112 for Chaiss Mode D. Since SR16.0R1, the maximum value can be maximum value can be 524256 or 1048544 depending on the system profile value. For a system configured with system profile as 'profileB', the maximum value is 1048544 labels (1024 * 1024 less 32 reserved labels). Otherwise, the maximum value is 524256 labels (512 * 1024 less 32 reserved labels).

type=int
default=18400
minimum=0
maximum=1048544
Displayed(tab/group)=Static Label Range (/Configuration)

staticLspFRTimer Specifies the value, in seconds, used as fast retry timer for static LSPs which are not currently up.

type=int
default=30
minimum=1
maximum=30
units=seconds
Displayed(tab/group)=Static LSPs Fast Retry Timer (/Configuration)

strictEroNhopDirectRes Specifies whether the route to a strict next-hop in ERO of RSVP LSPs must be resolved using only direct routes.

type=boolean
default=false
Displayed(tab/group)=Strict ERO Next-hop Direct Resolution (/Configuration)

transitTtlPropagate Enable/disable TTL propagation of transit IP packets.

type=boolean
default=true
Displayed(tab/group)=Shortcut Transit TTL Propagate (/TTL Propagate)

tunnelTablePreferenceRsvpTe Specifies the tunnel table preference in RSVP-TE LSPs.

type=int
default=7
minimum=1
maximum=255
Displayed(tab/group)=RSVP-TE (/Tunnel Table Preference)

tunnelTablePreferenceSrTe Specifies the tunnel table preference in SR-TE LSPs.

type=int
default=8
minimum=1
maximum=255
Displayed(tab/group)=SR-TE (/Tunnel Table Preference)

useSrlgDB Specifies whether to use SRLG Static Configuration.

type=boolean
default=false
Displayed(tab/group)=Use SRLG Static Configuration (/Shared Risk Link Group)

 
Overridden Properties
displayedName

default=MPLS

siteId

default=

siteName

 
Properties inherited from rtr.ProtocolSite
creationOrigin, serviceId, serviceType, subscriberId
 
Properties inherited from rtr.RouterSite
routerId, routerName, routingInstancePointer
 
Properties inherited from netw.NetworkSite
displayedName, siteId, siteName
 
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.
instanceFullName : string - the full name of the object.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -
Exceptions:
mpls.Site.configureException

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:
infoList : List (generic.CommonManagedEntityInformation) -
Methods inherited from rtr.ProtocolSite
shutDown, turnUp
 
Supported Network Elements
7450 ESS
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
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
Generic NE 1.0.0
OS9700E/9800E
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Wavence SM Supported from 18.1.0
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 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 (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 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 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
OS9700E/9800E (all versions)
Wavence SM 19A.0.0
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0