Overview Package Class Deprecated Help

netw
TopologyGroup

The Topology Group object. This object can be create using generic configure methods however they will no be visible until a netw.TopologyGroupBinding object is created placing them in the appropriate view. This object should not be deleted directly using generic configure methods, you should only use netw.TopologyGroup.deleteTopologyGroupAndBindings() method.

public class TopologyGroup

Properties
applianceVersion Specifies the component or appliance node version of this group.

type=string
default=
Displayed(tab/group)=Appliance Version
application Specifies the application to which this group belongs.

type=netw.TopologyGroupApplication
access=read-only
default=sam
Displayed(tab/group)=Application
backgroundImage Background image of the topology group

type=string
default=
minimum=0
maximum=254
Displayed(tab/group)=Background Image
compoundGroupType Specifies the type of the group if compound.

type=netw.CompoundGroupType
access=read-create
default=none
contextObjectPointer The context object pointer is an application specific pointer. The groups belonging to a specific application may use this field to identify the context.

type=Pointer
access=read-only
customName Name of the custom Router Group provided by the user. This field can be localized.

type=string
default=
minimum=0
maximum=25
Displayed(tab/group)=Custom Name
description Description of the router group provided by the user

type=string
default=
minimum=0
maximum=252
Displayed(tab/group)=Description
displayedName Name of the Router Group provided by the user

type=string
access=read-create
default=
minimum=1
maximum=40
Mandatory on create
Displayed(tab/group)=Group Name
elementCount Contains the element count for this group.

type=int
default=0
minimum=0
groupType Specifies the type of the topology group.

type=netw.TopologyGroupType
access=read-create
default=normal
netw.TopologyGroupBinding-Set type=Children-Set
spanObjectPointer A pointer to the parent spanEnabled object.

type=string
access=read-only
default=
minimum=0
maximum=252
viewName Name of the topology map that the group will be located in

type=string
default=
maximum=252
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

delete

DEPRECATED - 8.0.R3
Use generic.GenericObject.deleteInstance() instead.
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
Exceptions:
netw.TopologyGroup.deleteNonEmptyGroupException
netw.TopologyGroup.deleteDefaultGroupDeletionException

deleteTopologyGroupAndBindings

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.
topologyGroupName : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

getBindingsForTopologyGroup

Input Parameters:
topologyGroupName : string -
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 : List (generic.CommonManagedEntityInformation) -