HAManager MBean

Partial ObjectName:
WebSphere:*,type=HAManager


MBean HAManager

Management interface for the HA Manager services.

Since:
5.1 XD

Operation Summary
com.ibm.websphere.hamanager.jmx.CoreGroupInfogetCoreGroupInfo()
           Returns information about the core group.
com.ibm.websphere.hamanager.jmx.GroupData[]queryGroupState(java.lang.String groupNameProps, java.lang.Integer maxGroupsPerCoordinator, java.lang.Boolean includeMemberData)
           Returns group information for each group that matches the query criteria.
com.ibm.websphere.hamanager.jmx.GroupMemberData[]retrieveGroupMembers(com.ibm.wsspi.hamanager.GroupName groupName)
           Retrieve group member data for a specified group
com.ibm.websphere.hamanager.jmx.ServerWithActiveGroups[]queryCountActiveGroupsOnServers(java.lang.String groupNameProps, java.lang.Integer maxGroupsPerCoordinator)
           Report the number of active members on various servers
voidenableMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
           Enable the specified group member.
voiddisableMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
           Disable the specified group member.
voidactivateMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
           Activate the specified group member.
voiddeactivateMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
           Deactivate the specified group member.
voidenableGroup(com.ibm.wsspi.hamanager.GroupName groupName)
           Enable all of the members of the specified group.
voiddisableGroup(com.ibm.wsspi.hamanager.GroupName groupName)
           Disable all of the members of the specified group.
com.ibm.wsspi.hamanager.GroupNamecreateGroupName(java.lang.String groupNameCSV)
           Creates a group name from a comma separated String of Name=Value pairs
voidmigrateActiveMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String currMemberNodeName, java.lang.String currMemberServerName, java.lang.String futureMemberNodeName, java.lang.String futureMemberServerName)
           Move the the active state from one member of the group to another member of the group.
java.lang.String[]resolvePolicyForGroup(com.ibm.wsspi.hamanager.GroupName groupName)
           This returns the policy(s) matching the provided group name.
voidrunPolicy(com.ibm.wsspi.hamanager.GroupName groupName)
           This runs the policy associated with the specified group.
voidresetQuorumProviders()
           Request that quorum providers refresh all information and recalculate quorum based on latest data.

Operation Detail

getCoreGroupInfo

public com.ibm.websphere.hamanager.jmx.CoreGroupInfo getCoreGroupInfo()
Returns information about the core group.

queryGroupState

public com.ibm.websphere.hamanager.jmx.GroupData[] queryGroupState(java.lang.String groupNameProps, java.lang.Integer maxGroupsPerCoordinator, java.lang.Boolean includeMemberData)
Returns group information for each group that matches the query criteria.
Parameters:
groupNameProps - A comma delimited String of name=value pairs. Used for matching a group names.
maxGroupsPerCoordinator - At most this number of matching groups will be returned per coordinator. Use -1 for no maximum limit.
includeMemberData - A boolean to indicate whether group data or both group and member data should be returned.

retrieveGroupMembers

public com.ibm.websphere.hamanager.jmx.GroupMemberData[] retrieveGroupMembers(com.ibm.wsspi.hamanager.GroupName groupName)
Retrieve group member data for a specified group
Parameters:
groupName - GroupName of the group for which member data is desired.

queryCountActiveGroupsOnServers

public com.ibm.websphere.hamanager.jmx.ServerWithActiveGroups[] queryCountActiveGroupsOnServers(java.lang.String groupNameProps, java.lang.Integer maxGroupsPerCoordinator)
Report the number of active members on various servers
Parameters:
groupNameProps - A comma delimited String of name=value pairs. Used for matching a group names.
maxGroupsPerCoordinator - At most this number of matching groups will be returned per coordinator. Use -1 for no maximum limit.

enableMember

public void enableMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
Enable the specified group member. The member must currently be in the DISABLED state. If successful the member will transition to the IDLE state.
Parameters:
groupName - The name of the group containing the desired member.
nodeName - The name of the node hosting the server with the desired member
serverName - The name of the server hosting the member.

disableMember

public void disableMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
Disable the specified group member. Disabling an active member will result in it being deactivated. If successful the member will transition to the DISABLED state.
Parameters:
groupName - The name of the group containing the desired member.
nodeName - The name of the node hosting the server with the desired member
serverName - The name of the server hosting the member.

activateMember

public void activateMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
Activate the specified group member. The member must currently be in the IDLE state. If successful the member will transition to the ACTIVE state.
Parameters:
groupName - The name of the group containing the desired member.
nodeName - The name of the node hosting the server with the desired member
serverName - The name of the server hosting the member.

deactivateMember

public void deactivateMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String nodeName, java.lang.String serverName)
Deactivate the specified group member. The member must currently be in the ACTIVE state. If successful the member will transition to the IDLE state.
Parameters:
groupName - The name of the group containing the desired member.
nodeName - The name of the node hosting the server with the desired member
serverName - The name of the server hosting the member.

enableGroup

public void enableGroup(com.ibm.wsspi.hamanager.GroupName groupName)
Enable all of the members of the specified group. The members must currently be in the DISABLED state. If successful the members will transition to the IDLE state.
Parameters:
groupName - The name of the group to enable.

disableGroup

public void disableGroup(com.ibm.wsspi.hamanager.GroupName groupName)
Disable all of the members of the specified group. If successful the members will transition to the DISABLED state.
Parameters:
groupName - The name of the group to enable.

createGroupName

public com.ibm.wsspi.hamanager.GroupName createGroupName(java.lang.String groupNameCSV)
Creates a group name from a comma separated String of Name=Value pairs
Parameters:
groupNameCSV - A comma delimited String of name=value pairs (e.g. a=x,b=y,d=z)

migrateActiveMember

public void migrateActiveMember(com.ibm.wsspi.hamanager.GroupName groupName, java.lang.String currMemberNodeName, java.lang.String currMemberServerName, java.lang.String futureMemberNodeName, java.lang.String futureMemberServerName)
Move the the active state from one member of the group to another member of the group. Note: the policy always takes precedent over this method.
Parameters:
groupName - The name of the group containing the members.
currMemberNodeName - The name of the node hosting the current active member.
currMemberServerName - The name of the server hosting the current active member.
futureMemberNodeName - The name of the node hosting the desired future active member
futureMemberServerName - The name of the server hosting the desired future active member

resolvePolicyForGroup

public java.lang.String[] resolvePolicyForGroup(com.ibm.wsspi.hamanager.GroupName groupName)
This returns the policy(s) matching the provided group name.
Parameters:
groupName - The name of the group for which you wish to determine the associated policy.

runPolicy

public void runPolicy(com.ibm.wsspi.hamanager.GroupName groupName)
This runs the policy associated with the specified group.
Parameters:
groupName - The name of the group which the associated policy should be applied to.

resetQuorumProviders

public void resetQuorumProviders()
Request that quorum providers refresh all information and recalculate quorum based on latest data.

Copyright IBM Corp. 1996-2003