Overview Package Class Deprecated Help

tunnelmgmt
RuleBasedGroup

Base rule-based group. A rule-based group can be ordered or unordered and can contain members of one type only.

public abstract class RuleBasedGroup

Properties
displayedName Displayed Name of the rule-based group.

type=string
access=read-create
default=
minimum=1
maximum=80
Mandatory on create
Displayed(tab/group)=Group Name
groupDescription Optional description.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Description
groupMemberType All group members have to be of a common type. Property specifies this type.

type=string
access=read-only
default=
groupOrderType Specifies whether group is ordered or unordered.

type=netw.GroupOrderType
access=read-create
default=unordered
Displayed(tab/group)=Order
groupType Specifies that this is a rule-based group.

type=netw.GroupType
access=read-only
default=rulebased
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addMember

OSS method to add a member to a rule-base group.
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.
aInMemberFdn : Pointer - FDN of the new member.
aInPosition : int - Position of the member between the existing members (only relvant in ordered group and value will be ignored for unordered group): If the value is higher than the current number of members, the new member will be appended.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

findPotentialMembersIfg

Find members that potentially can be added to this group.
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) -

removeMember

OSS method to remove a member from a rule-base group
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.
aInMemberFdn : Pointer - FDN of the member
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false