Overview Package Class Deprecated Help

mpls
LspPathOptimizationPolicy

Execution Policy is used during LSP Path Optimization. Upon processing potential LSP Path resignal candidates using Filter Policies, execution of resignal from NFM-P are issued in a orderly fashion described in Execution Policy. This policy can be scheduled

public class LspPathOptimizationPolicy

Properties
description

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
displayedName The displayed name.

type=string
default=
minimum=0
maximum=32
dynamicLspPointer

type=Pointer
default=
Displayed(tab/group)=Dynamic LSP Filter (Candidate Definition)
executionState Current State of Optimization

type=mpls.LspPathOptimizationState
access=read-only
default=ready
Displayed(tab/group)=Optimization
id

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

type=Pointer
default=
Displayed(tab/group)=LSP Path Filter (Candidate Definition)
pacingInterval Time to wait in seconds between two consecutive Lsp Path Resignaling.

type=long
default=5
minimum=0
maximum=300
units=seconds
Displayed(tab/group)=Pacing Interval (Execution Rules/Pacing)
ruleBasedGroupPointer

type=Pointer
default=
Displayed(tab/group)=Rule-Based Group (Candidate Definition)
schedule The schedule, if any, that specifies when the policy gets created.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Schedule (Execution Rules/Schedule)
scheduleTask The schedule task, if any, that specifies the binding between the policy and the schedule.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Scheduled Task (Execution Rules/Schedule)
sequencingOrder Execution order can either ascending or descending

type=mpls.LspPathOptimizationSequencingOrder
default=ascend
Displayed(tab/group)=Sequencing Order (Execution Rules/Sequencing)
sequencingTarget Execution order can be based on "source address", "operational bandwidth" or "cspf metric"

type=mpls.LspPathOptimizationSequencingTarget
default=none
Displayed(tab/group)=Sequencing Target (Execution Rules/Sequencing)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

execute

Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and Rule-Based Group Binding and then flag them if possible. Execute resignal of eligible and flagged lspPaths in accordance to this policy.
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.
filter : FilterHolder -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
numberOfLspPath : long -

executeFromList

Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and Rule-Based Group Binding and then flag them if possible. Execute resignal of eligible and flagged lspPaths in accordance to this policy.
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.
candidateList : List (generic.CommonManagedEntityInformation) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
numberOfLspPath : long -

findPathWithJoin

Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and MPLS.Tunnel.
Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
fields : Set (string) - Fields to fetch
sortFields : List (string) - Sorting fields
pageNumber : int - Page number
pageSize : int - The number of entries to return
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 : generic.PagingResult -

terminateCurrentExecution

Terminate all active execution of optimization, this method will withdraw the task from timer thread
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