Overview Package Class Deprecated Help

tunnelmgmt
TopologyRule

Base for all topology rules:

public abstract class TopologyRule

Properties
description Description of the topology rule

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
displayedName Name of the topology rule

type=string
access=read-create
minimum=0
maximum=80
Mandatory on create
Displayed(tab/group)=Name
id Id of the topology rule

type=long
access=read-create
default=0
minimum=1
maximum=2147483647
Displayed(tab/group)=ID
namingFormat Specifies the naming format for the generated tunnel elements

type=int
access=read-create
default=systemGenerated
Displayed(tab/group)=Naming Format (/Preferences for Auto-Tunnel Created Objects)
enums=
    1: systemGenerated - System Generated
    2: userSpecified - User Specified
pacingCreationInProgress Specifies whether tunnel pacing creation is in progress.

type=boolean
access=read-only
default=false
pacingInterval Specifies the pacing interval used between the creations of the tunnel elements.

type=int
access=read-create
default=0
minimum=0
maximum=300
units=seconds
Displayed(tab/group)=Tunnel Creation Pacing Interval (/Preferences for Auto-Tunnel Created Objects)
ruleSetName The ruleset this topology rule is linked to

type=string
access=read-only
default=
minimum=0
maximum=80
templateVersionsPreference The Template Versions parameter specifies which version of the template is to be used for the rule. This option is necessary since a template can be updated after it has been applied to a rule. Rule configuration provides two options, it is recommended that you use the version initially assigned to the rule. If you choose the latest version, ensure that the version and the rule are compatible.

type=int
access=read-create
default=useVersionsInitiallyAssigned
Displayed(tab/group)=Template Versions (/Preferences for Auto-Tunnel Created Objects)
enums=
    1: useVersionsInitiallyAssigned - Apply Version Initially Assigned
    2: useLatestVersions - Apply Latest Version
userSpecifiedNamingPrefix Specifies the naming prefix when naming format is set to 'userSpecified'.

type=string
access=read-create
default=
minimum=0
maximum=20
Mandatory on create
Displayed(tab/group)=User Specified Naming Prefix (/Preferences for Auto-Tunnel Created Objects)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

applyRule

(Re)apply the topologyrule and create missing topology elements. Requires the topologyrule to be enabled.
Should only be called on a main topology rule and not on one of the sub-topology rules.
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

convertOldDefinitions

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.
convertOldDefinitionStructList : List (tunnelmgmt.ConvertOldDefinitionStruct) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
tunnelmgmt.TopologyRule.convertOldDefinitionsException

deleteCreatedTunnels

Deletes ALL tunnels created by the topologyrule and which are not in use by other entities (e.g. services)
Should only be called on a main topology rule and not on one of the sub-topology rules.
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

deleteUnusedTunnels

Deletes the tunnels created by the topologyrule AND which are not used by the topologyrule to maintain the current connectivity AND which are not in use by other entities.
Should only be called on a main topology rule and not on one of the sub-topology rules.
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

findCreatedTunnels

Retrieves a list of tunnel elements created by the topologyrule.
Should only be called on a main topology rule and not on one of the sub-topology rules.
Input Parameters:
instanceFullName : string - the full name of the object.
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:
aOutInfoList : List (generic.CommonManagedEntityInformation) - A list of CreatedTunnelElements

findMissingTunnels

Retrieves a list of tunnel elements that are missing in the topology maintained by the topologyrule.
Should only be called on a main topology rule and not on one of the sub-topology rules.
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.
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:
aOutStringList : List (generic.CommonManagedEntityInformation) - A list of MissingTunnelElements.

importNetwork

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.
infoList : List (generic.CommonManagedEntityInformation) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
tunnelmgmt.TopologyRule.importNetworkException