Overview Package Class Deprecated Help

server
AuxServerPair

The AuxServerPair class represents a pair of servers where one is preferred and the other is reserved.

public class AuxServerPair

Properties
assignedObjects List of ManagedObject(s) that are assigned to this server pair.

type=Set (Pointer)
auxServer1ExtraInfo Extra Info on the auxiliary server.

type=string
access=read-only
default=N/A
Displayed(tab/group)=Extra Info on Server One
auxServer1Pointer Reference to the auxiliary server.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Auxiliary Server One
auxServer2ExtraInfo Extra Info on the auxiliary server.

type=string
access=read-only
default=N/A
Displayed(tab/group)=Extra Info on Server Two
auxServer2Pointer Reference to the auxiliary server.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Auxiliary Server Two
id

type=int
access=read-create
default=0
minimum=1
maximum=65535
Displayed(tab/group)=Server Pair ID
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

assignedObjects

To be able to assign objects to the server pair.
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.
assignedObjects : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
server.AuxServerPair.assignedObjectsException

unAssignedObjects

To be able to unassign objects from the server pair.
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.
unassignedObjects : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
server.AuxServerPair.unAssignedObjectsException