MBean

Partial ObjectName:
WebSphere:*,type=


MBean

PlacementController


Operation Summary
enable()
           Starts the PlacementController
disable()
           Stops the PlacementController
enableNode( nodeName)
           Enables the management of a node
enableNode( cellID,  cellName,  nodeName)
           Enables the management of a node
disableNodeAfterReplacement( nodeName)
           Disables the management of a node after replacement
disableNode( nodeName)
           Disables the management of a node
isNodeInUse( nodeName)
           Tests whether node is in use
disableNode( nodeGroupName,  nodeName)
           Disables the management of a node
disableNode( cellID,  cellName,  nodeName)
           Disables the management of a node
enableDynamicCluster( nodeGroupName,  dynamicClusterName)
           Enables the management of a dynamic cluster
enableDynamicCluster( cellKey,  dynamicClusterName,  opMode)
           Enables the management of a dynamic cluster
enableDynamicCluster( dynamicClusterName,  opMode)
           Enables the management of a dynamic cluster
enableDynamicCluster( dynamicClusterName)
           Enables the management of a dynamic cluster
disableDynamicCluster( nodeGroupName,  dynamicClusterName)
           Disables the management of a dynamic cluster
disableDynamicCluster( dynamicClusterName)
           Disables the management of a dynamic cluster
disableDynamicCluster( cellKey,  dynamicClusterName)
           Disables the management of a dynamic cluster
isEnabled()
           Tests whether Placement Controller is enabled
isPrimary()
           Tests whether Placement Controller is Primary or Backup
getNodeName()
           Gets Node Name where Placement Controller is runnning
findBestLocation( dynamicClusterName,  oldNodeName)
           Finds the best new location for a DC
findBestLocation( cellName,  nodeName,  serverName)
           Finds the best new server instance to replace a specified server instance
findBestNodeToDisable( nodeGroupName)
           Finds the best node to disable
isNodeInUse( nodeName)
           Determine if node is in use by placement controller.
recomputePlacement()
           Recomputes the placement
setMinTimeBetweenPlacementChange( minTimeBetweenPlacementChange,  minTimeBetweenPlacementChangeUnits)
           Changes minTimeBetweenPlacementChange
setServerOperationTimeOut( serverOperationTimeout)
           Changes serverOperationTimeout
setApprovalTimeOut( approvalTimeout)
           Changes approvalTimeout
getMinTimeBetweenPlacementChangeInMin()
           Obtains minTimeBetweenPlacementChange
getServerOperationTimeOut()
           Obtains serverOperationTimeout
getApprovalTimeOut()
           Obtains approvalTimeout
execute( actionPlan,  token,  id)
           Execute an action plan.
getActiveControllerLocation()
           Returns the active controller location.
anyFailedServerOperations()
           Reveals server APC was unable to start/stop
handleFailedServerOperations()
           Tell APC to take action on failed server operations
deferFailedServerOperations()
           Tell APC to defer action on failed server operations
unlockMultiAPCGate( remoteAPCID)
           Unlock the multi-APC gate for the remote APC
openMultiAPCGate( remoteAPCID)
           Open the multi-APC gate for the remote APC.
closeLockMultiAPCGate( remoteAPCID)
           Close and lock the multi-APC gate for the remote APC.
disableServer( serverName)
           Disables the management of a server or servers (server1 or server1,serverN)
enableServer( serverName)
           Enables the management of a server or servers (server1 or server1,serverN)
disableServer( serverName)
           Disables the management of a server or servers (server1 or server1,serverN)
enableServer( serverName)
           Enables the management of a server or servers (server1 or server1,serverN)
enableElasticity( toEnable)
           Informs APC whether or not to be in elasticity mode
isElasticityModeEnabled()
           Returns whether APC is in elasticity mode or not
elasticityMode( automaticOrSupervisedMode)
           Informs APC what mode elasticity is running in.
getElasticityMode()
           Returns 0 or 1 for whether the elasticity mode is automatic or supervised respectively
elasticityModeTimeOut( timeOutOfOperation,  timeOutOfOperationUnits)
           Sets the timeout value and the units associated with the value
getElasticityTimeOutMins()
           Returns the timeout value in minutes for an operation executed by APC in elasticity mode

Operation Detail

enable

public  enable()
Starts the PlacementController

disable

public  disable()
Stops the PlacementController

enableNode

public  enableNode( nodeName)
Enables the management of a node
Parameters:
nodeName - node name

enableNode

public  enableNode( cellID,  cellName,  nodeName)
Enables the management of a node
Parameters:
cellID - cell id
cellName - node key
nodeName - node key

disableNodeAfterReplacement

public  disableNodeAfterReplacement( nodeName)
Disables the management of a node after replacement
Parameters:
nodeName - node name

disableNode

public  disableNode( nodeName)
Disables the management of a node
Parameters:
nodeName - node name

isNodeInUse

public  isNodeInUse( nodeName)
Tests whether node is in use
Parameters:
nodeName - node name

disableNode

public  disableNode( nodeGroupName,  nodeName)
Disables the management of a node
Parameters:
nodeGroupName - node group name
nodeName - node name

disableNode

public  disableNode( cellID,  cellName,  nodeName)
Disables the management of a node
Parameters:
cellID - cell id
cellName - node key
nodeName - node key

enableDynamicCluster

public  enableDynamicCluster( nodeGroupName,  dynamicClusterName)
Enables the management of a dynamic cluster
Parameters:
nodeGroupName - node group name
dynamicClusterName - DC name

enableDynamicCluster

public  enableDynamicCluster( cellKey,  dynamicClusterName,  opMode)
Enables the management of a dynamic cluster
Parameters:
cellKey - cell id
dynamicClusterName - DC name
opMode - Operation Mode of Dynamic Cluster

enableDynamicCluster

public  enableDynamicCluster( dynamicClusterName,  opMode)
Enables the management of a dynamic cluster
Parameters:
dynamicClusterName - DC name
opMode - Operation Mode of Dynamic Cluster

enableDynamicCluster

public  enableDynamicCluster( dynamicClusterName)
Enables the management of a dynamic cluster
Parameters:
dynamicClusterName - DC name

disableDynamicCluster

public  disableDynamicCluster( nodeGroupName,  dynamicClusterName)
Disables the management of a dynamic cluster
Parameters:
nodeGroupName - node group name
dynamicClusterName - DC name

disableDynamicCluster

public  disableDynamicCluster( dynamicClusterName)
Disables the management of a dynamic cluster
Parameters:
dynamicClusterName - DC name

disableDynamicCluster

public  disableDynamicCluster( cellKey,  dynamicClusterName)
Disables the management of a dynamic cluster
Parameters:
cellKey - cell id
dynamicClusterName - DC name

isEnabled

public  isEnabled()
Tests whether Placement Controller is enabled

isPrimary

public  isPrimary()
Tests whether Placement Controller is Primary or Backup

getNodeName

public  getNodeName()
Gets Node Name where Placement Controller is runnning

findBestLocation

public  findBestLocation( dynamicClusterName,  oldNodeName)
Finds the best new location for a DC
Parameters:
dynamicClusterName - DC name
oldNodeName - old node name

findBestLocation

public  findBestLocation( cellName,  nodeName,  serverName)
Finds the best new server instance to replace a specified server instance
Parameters:
cellName - cell name
nodeName - node name
serverName - server name

findBestNodeToDisable

public  findBestNodeToDisable( nodeGroupName)
Finds the best node to disable
Parameters:
nodeGroupName - node group name

isNodeInUse

public  isNodeInUse( nodeName)
Determine if node is in use by placement controller.
Parameters:
nodeName - Node name

recomputePlacement

public  recomputePlacement()
Recomputes the placement

setMinTimeBetweenPlacementChange

public  setMinTimeBetweenPlacementChange( minTimeBetweenPlacementChange,  minTimeBetweenPlacementChangeUnits)
Changes minTimeBetweenPlacementChange
Parameters:
minTimeBetweenPlacementChange - new value
minTimeBetweenPlacementChangeUnits - new value

setServerOperationTimeOut

public  setServerOperationTimeOut( serverOperationTimeout)
Changes serverOperationTimeout
Parameters:
serverOperationTimeout - new value

setApprovalTimeOut

public  setApprovalTimeOut( approvalTimeout)
Changes approvalTimeout
Parameters:
approvalTimeout - new value

getMinTimeBetweenPlacementChangeInMin

public  getMinTimeBetweenPlacementChangeInMin()
Obtains minTimeBetweenPlacementChange

getServerOperationTimeOut

public  getServerOperationTimeOut()
Obtains serverOperationTimeout

getApprovalTimeOut

public  getApprovalTimeOut()
Obtains approvalTimeout

execute

public  execute( actionPlan,  token,  id)
Execute an action plan.
Parameters:
actionPlan - The action plan to be executed.
token - The execution token for this action plan.
id - The global id of the task - the task identifier.

getActiveControllerLocation

public  getActiveControllerLocation()
Returns the active controller location.

anyFailedServerOperations

public  anyFailedServerOperations()
Reveals server APC was unable to start/stop

handleFailedServerOperations

public  handleFailedServerOperations()
Tell APC to take action on failed server operations

deferFailedServerOperations

public  deferFailedServerOperations()
Tell APC to defer action on failed server operations

unlockMultiAPCGate

public  unlockMultiAPCGate( remoteAPCID)
Unlock the multi-APC gate for the remote APC
Parameters:
remoteAPCID - Gate network ID of remote APC

openMultiAPCGate

public  openMultiAPCGate( remoteAPCID)
Open the multi-APC gate for the remote APC.
Parameters:
remoteAPCID - Gate network ID of remote APC

closeLockMultiAPCGate

public  closeLockMultiAPCGate( remoteAPCID)
Close and lock the multi-APC gate for the remote APC.
Parameters:
remoteAPCID - Gate network ID of remote APC

disableServer

public  disableServer( serverName)
Disables the management of a server or servers (server1 or server1,serverN)
Parameters:
serverName - server name

enableServer

public  enableServer( serverName)
Enables the management of a server or servers (server1 or server1,serverN)
Parameters:
serverName - server name

disableServer

public  disableServer( serverName)
Disables the management of a server or servers (server1 or server1,serverN)
Parameters:
serverName - server name

enableServer

public  enableServer( serverName)
Enables the management of a server or servers (server1 or server1,serverN)
Parameters:
serverName - server name

enableElasticity

public  enableElasticity( toEnable)
Informs APC whether or not to be in elasticity mode
Parameters:
toEnable - true or false

isElasticityModeEnabled

public  isElasticityModeEnabled()
Returns whether APC is in elasticity mode or not

elasticityMode

public  elasticityMode( automaticOrSupervisedMode)
Informs APC what mode elasticity is running in.
Parameters:
automaticOrSupervisedMode - elasticity mode automatic(0) or supervised(1)

getElasticityMode

public  getElasticityMode()
Returns 0 or 1 for whether the elasticity mode is automatic or supervised respectively

elasticityModeTimeOut

public  elasticityModeTimeOut( timeOutOfOperation,  timeOutOfOperationUnits)
Sets the timeout value and the units associated with the value
Parameters:
timeOutOfOperation - the numeric value of the timeout
timeOutOfOperationUnits - the numbers presenting minutes(0) or hours(1)

getElasticityTimeOutMins

public  getElasticityTimeOutMins()
Returns the timeout value in minutes for an operation executed by APC in elasticity mode

Copyright IBM Corp. 1996 - 2007