PlacementControllerMBean MBean

Partial ObjectName:
WebSphere:*,type=PlacementControllerMBean


MBean PlacementControllerMBean

PlacementController


Operation Summary

voidenable()
           Starts the PlacementController
voiddisable()
           Stops the PlacementController
voidenableNode(java.lang.String nodeName)
           Enables the management of a node
voidenableNode(java.lang.Integer cellID, java.lang.String cellName, java.lang.String nodeName)
           Enables the management of a node
voiddisableNodeAfterReplacement(java.lang.String nodeName)
           Disables the management of a node after replacement
voiddisableNode(java.lang.String nodeName)
           Disables the management of a node
booleanisNodeInUse(java.lang.String nodeName)
           Tests whether node is in use
voiddisableNode(java.lang.String nodeGroupName, java.lang.String nodeName)
           Disables the management of a node
voiddisableNode(java.lang.Integer cellID, java.lang.String cellName, java.lang.String nodeName)
           Disables the management of a node
voidenableDynamicCluster(java.lang.String nodeGroupName, java.lang.String dynamicClusterName)
           Enables the management of a dynamic cluster
voidenableDynamicCluster(com.ibm.ws.xd.admin.utils.CellKey cellKey, java.lang.String dynamicClusterName, java.lang.Object opMode)
           Enables the management of a dynamic cluster
voidenableDynamicCluster(java.lang.String dynamicClusterName, java.lang.Object opMode)
           Enables the management of a dynamic cluster
voidenableDynamicCluster(java.lang.String dynamicClusterName)
           Enables the management of a dynamic cluster
voiddisableDynamicCluster(java.lang.String nodeGroupName, java.lang.String dynamicClusterName)
           Disables the management of a dynamic cluster
voiddisableDynamicCluster(java.lang.String dynamicClusterName)
           Disables the management of a dynamic cluster
voiddisableDynamicCluster(com.ibm.ws.xd.admin.utils.CellKey cellKey, java.lang.String dynamicClusterName)
           Disables the management of a dynamic cluster
booleanisEnabled()
           Tests whether Placement Controller is enabled
booleanisPrimary()
           Tests whether Placement Controller is Primary or Backup
java.lang.StringgetNodeName()
           Gets Node Name where Placement Controller is runnning
java.lang.StringfindBestLocation(java.lang.String dynamicClusterName, java.lang.String oldNodeName)
           Finds the best new location for a DC
java.lang.StringfindBestLocation(java.lang.String cellName, java.lang.String nodeName, java.lang.String serverName)
           Finds the best new server instance to replace a specified server instance
java.lang.StringfindBestNodeToDisable(java.lang.String nodeGroupName)
           Finds the best node to disable
booleanisNodeInUse(java.lang.String nodeName)
           Determine if node is in use by placement controller.
voidrecomputePlacement()
           Recomputes the placement
voidsetMinTimeBetweenPlacementChange(int minTimeBetweenPlacementChange, int minTimeBetweenPlacementChangeUnits)
           Changes minTimeBetweenPlacementChange
voidsetServerOperationTimeOut(int serverOperationTimeout)
           Changes serverOperationTimeout
voidsetApprovalTimeOut(int approvalTimeout)
           Changes approvalTimeout
intgetMinTimeBetweenPlacementChangeInMin()
           Obtains minTimeBetweenPlacementChange
intgetServerOperationTimeOut()
           Obtains serverOperationTimeout
intgetApprovalTimeOut()
           Obtains approvalTimeout
voidexecute(com.ibm.ws.taskmanagement.task.TaskActionPlan actionPlan, long token, long id)
           Execute an action plan.
StringgetActiveControllerLocation()
           Returns the active controller location.
java.lang.StringanyFailedServerOperations()
           Reveals server APC was unable to start/stop
voidhandleFailedServerOperations()
           Tell APC to take action on failed server operations
voiddeferFailedServerOperations()
           Tell APC to defer action on failed server operations
booleanunlockMultiAPCGate(java.lang.String remoteAPCID)
           Unlock the multi-APC gate for the remote APC
booleanopenMultiAPCGate(java.lang.String remoteAPCID)
           Open the multi-APC gate for the remote APC.
booleancloseLockMultiAPCGate(java.lang.String remoteAPCID)
           Close and lock the multi-APC gate for the remote APC.
voiddisableServer(java.lang.String serverName)
           Disables the management of a server or servers (server1 or server1,serverN)
voidenableServer(java.lang.String serverName)
           Enables the management of a server or servers (server1 or server1,serverN)
voiddisableServer(java.lang.String serverName)
           Disables the management of a server or servers (server1 or server1,serverN)
voidenableServer(java.lang.String serverName)
           Enables the management of a server or servers (server1 or server1,serverN)
voidenableElasticity(boolean toEnable)
           Informs APC whether or not to be in elasticity mode
booleanisElasticityModeEnabled()
           Returns whether APC is in elasticity mode or not
voidelasticityMode(int automaticOrSupervisedMode)
           Informs APC what mode elasticity is running in.
intgetElasticityMode()
           Returns 0 or 1 for whether the elasticity mode is automatic or supervised respectively
voidelasticityModeTimeOut(int timeOutOfOperation, int timeOutOfOperationUnits)
           Sets the timeout value and the units associated with the value
intgetElasticityTimeOutMins()
           Returns the timeout value in minutes for an operation executed by APC in elasticity mode

Operation Detail

enable

public void enable()

     Starts the PlacementController

Security Roles:

     administrator
     operator


disable

public void disable()

     Stops the PlacementController

Security Roles:

     administrator
     operator


enableNode

public void enableNode(java.lang.String nodeName)

     Enables the management of a node

Parameters:

     nodeName - node name

Security Roles:

     administrator
     operator


enableNode

public void enableNode(java.lang.Integer cellID, java.lang.String cellName, java.lang.String nodeName)

     Enables the management of a node

Parameters:

     cellID - cell id
     cellName - node key
     nodeName - node key

Security Roles:

     administrator
     operator


disableNodeAfterReplacement

public void disableNodeAfterReplacement(java.lang.String nodeName)

     Disables the management of a node after replacement

Parameters:

     nodeName - node name

Security Roles:

     administrator
     operator


disableNode

public void disableNode(java.lang.String nodeName)

     Disables the management of a node

Parameters:

     nodeName - node name

Security Roles:

     administrator
     operator


isNodeInUse

public boolean isNodeInUse(java.lang.String nodeName)

     Tests whether node is in use

Parameters:

     nodeName - node name

Security Roles:

     administrator
     operator


disableNode

public void disableNode(java.lang.String nodeGroupName, java.lang.String nodeName)

     Disables the management of a node

Parameters:

     nodeGroupName - node group name
     nodeName - node name

Security Roles:

     administrator
     operator


disableNode

public void disableNode(java.lang.Integer cellID, java.lang.String cellName, java.lang.String nodeName)

     Disables the management of a node

Parameters:

     cellID - cell id
     cellName - node key
     nodeName - node key

Security Roles:

     administrator
     operator


enableDynamicCluster

public void enableDynamicCluster(java.lang.String nodeGroupName, java.lang.String dynamicClusterName)

     Enables the management of a dynamic cluster

Parameters:

     nodeGroupName - node group name
     dynamicClusterName - DC name

Security Roles:

     administrator
     operator


enableDynamicCluster

public void enableDynamicCluster(com.ibm.ws.xd.admin.utils.CellKey cellKey, java.lang.String dynamicClusterName, java.lang.Object opMode)

     Enables the management of a dynamic cluster

Parameters:

     cellKey - cell id
     dynamicClusterName - DC name
     opMode - Operation Mode of Dynamic Cluster

Security Roles:

     administrator
     operator


enableDynamicCluster

public void enableDynamicCluster(java.lang.String dynamicClusterName, java.lang.Object opMode)

     Enables the management of a dynamic cluster

Parameters:

     dynamicClusterName - DC name
     opMode - Operation Mode of Dynamic Cluster

Security Roles:

     administrator
     operator


enableDynamicCluster

public void enableDynamicCluster(java.lang.String dynamicClusterName)

     Enables the management of a dynamic cluster

Parameters:

     dynamicClusterName - DC name

Security Roles:

     administrator
     operator


disableDynamicCluster

public void disableDynamicCluster(java.lang.String nodeGroupName, java.lang.String dynamicClusterName)

     Disables the management of a dynamic cluster

Parameters:

     nodeGroupName - node group name
     dynamicClusterName - DC name

Security Roles:

     administrator
     operator


disableDynamicCluster

public void disableDynamicCluster(java.lang.String dynamicClusterName)

     Disables the management of a dynamic cluster

Parameters:

     dynamicClusterName - DC name

Security Roles:

     administrator
     operator


disableDynamicCluster

public void disableDynamicCluster(com.ibm.ws.xd.admin.utils.CellKey cellKey, java.lang.String dynamicClusterName)

     Disables the management of a dynamic cluster

Parameters:

     cellKey - cell id
     dynamicClusterName - DC name

Security Roles:

     administrator
     operator


isEnabled

public boolean isEnabled()

     Tests whether Placement Controller is enabled

Security Roles:

     administrator
     operator


isPrimary

public boolean isPrimary()

     Tests whether Placement Controller is Primary or Backup

Security Roles:

     administrator
     operator


getNodeName

public java.lang.String getNodeName()

     Gets Node Name where Placement Controller is runnning

Security Roles:

     administrator
     operator


findBestLocation

public java.lang.String findBestLocation(java.lang.String dynamicClusterName, java.lang.String oldNodeName)

     Finds the best new location for a DC

Parameters:

     dynamicClusterName - DC name
     oldNodeName - old node name

Security Roles:

     administrator
     operator


findBestLocation

public java.lang.String findBestLocation(java.lang.String cellName, java.lang.String nodeName, java.lang.String serverName)

     Finds the best new server instance to replace a specified server instance

Parameters:

     cellName - cell name
     nodeName - node name
     serverName - server name

Security Roles:

     administrator
     operator


findBestNodeToDisable

public java.lang.String findBestNodeToDisable(java.lang.String nodeGroupName)

     Finds the best node to disable

Parameters:

     nodeGroupName - node group name

Security Roles:

     administrator
     operator


isNodeInUse

public boolean isNodeInUse(java.lang.String nodeName)

     Determine if node is in use by placement controller.

Parameters:

     nodeName - Node name

Security Roles:

     administrator
     operator


recomputePlacement

public void recomputePlacement()

     Recomputes the placement

Security Roles:

     administrator
     operator


setMinTimeBetweenPlacementChange

public void setMinTimeBetweenPlacementChange(int minTimeBetweenPlacementChange, int minTimeBetweenPlacementChangeUnits)

     Changes minTimeBetweenPlacementChange

Parameters:

     minTimeBetweenPlacementChange - new value
     minTimeBetweenPlacementChangeUnits - new value

Security Roles:

     administrator
     operator


setServerOperationTimeOut

public void setServerOperationTimeOut(int serverOperationTimeout)

     Changes serverOperationTimeout

Parameters:

     serverOperationTimeout - new value

Security Roles:

     administrator
     operator


setApprovalTimeOut

public void setApprovalTimeOut(int approvalTimeout)

     Changes approvalTimeout

Parameters:

     approvalTimeout - new value

Security Roles:

     administrator
     operator


getMinTimeBetweenPlacementChangeInMin

public int getMinTimeBetweenPlacementChangeInMin()

     Obtains minTimeBetweenPlacementChange

Security Roles:

     administrator
     operator


getServerOperationTimeOut

public int getServerOperationTimeOut()

     Obtains serverOperationTimeout

Security Roles:

     administrator
     operator


getApprovalTimeOut

public int getApprovalTimeOut()

     Obtains approvalTimeout

Security Roles:

     administrator
     operator


execute

public void execute(com.ibm.ws.taskmanagement.task.TaskActionPlan actionPlan, long token, long 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.

Security Roles:

     administrator
     operator


getActiveControllerLocation

public String getActiveControllerLocation()

     Returns the active controller location.

Security Roles:

     administrator
     operator


anyFailedServerOperations

public java.lang.String anyFailedServerOperations()

     Reveals server APC was unable to start/stop

Security Roles:

     administrator
     operator


handleFailedServerOperations

public void handleFailedServerOperations()

     Tell APC to take action on failed server operations

Security Roles:

     administrator
     operator


deferFailedServerOperations

public void deferFailedServerOperations()

     Tell APC to defer action on failed server operations

Security Roles:

     administrator
     operator


unlockMultiAPCGate

public boolean unlockMultiAPCGate(java.lang.String remoteAPCID)

     Unlock the multi-APC gate for the remote APC

Parameters:

     remoteAPCID - Gate network ID of remote APC

Security Roles:

     administrator
     operator


openMultiAPCGate

public boolean openMultiAPCGate(java.lang.String remoteAPCID)

     Open the multi-APC gate for the remote APC.

Parameters:

     remoteAPCID - Gate network ID of remote APC

Security Roles:

     administrator
     operator


closeLockMultiAPCGate

public boolean closeLockMultiAPCGate(java.lang.String remoteAPCID)

     Close and lock the multi-APC gate for the remote APC.

Parameters:

     remoteAPCID - Gate network ID of remote APC

Security Roles:

     administrator
     operator


disableServer

public void disableServer(java.lang.String serverName)

     Disables the management of a server or servers (server1 or server1,serverN)

Parameters:

     serverName - server name

Security Roles:

     administrator
     operator


enableServer

public void enableServer(java.lang.String serverName)

     Enables the management of a server or servers (server1 or server1,serverN)

Parameters:

     serverName - server name

Security Roles:

     administrator
     operator


disableServer

public void disableServer(java.lang.String serverName)

     Disables the management of a server or servers (server1 or server1,serverN)

Parameters:

     serverName - server name

Security Roles:

     administrator
     operator


enableServer

public void enableServer(java.lang.String serverName)

     Enables the management of a server or servers (server1 or server1,serverN)

Parameters:

     serverName - server name

Security Roles:

     administrator
     operator


enableElasticity

public void enableElasticity(boolean toEnable)

     Informs APC whether or not to be in elasticity mode

Parameters:

     toEnable - true or false

Security Roles:

     administrator
     operator


isElasticityModeEnabled

public boolean isElasticityModeEnabled()

     Returns whether APC is in elasticity mode or not

Security Roles:

     administrator
     operator


elasticityMode

public void elasticityMode(int automaticOrSupervisedMode)

     Informs APC what mode elasticity is running in.

Parameters:

     automaticOrSupervisedMode - elasticity mode automatic(0) or supervised(1)

Security Roles:

     administrator
     operator


getElasticityMode

public int getElasticityMode()

     Returns 0 or 1 for whether the elasticity mode is automatic or supervised respectively

Security Roles:

     administrator
     operator


elasticityModeTimeOut

public void elasticityModeTimeOut(int timeOutOfOperation, int 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)

Security Roles:

     administrator
     operator


getElasticityTimeOutMins

public int getElasticityTimeOutMins()

     Returns the timeout value in minutes for an operation executed by APC in elasticity mode

Security Roles:

     administrator
     operator


Copyright IBM Corp. 1996-2005