Cluster MBean

Partial ObjectName:
WebSphere:*,type=Cluster

ResourceInstanceIdentifier:

The resource being modified for the MBean is of type Cluster
The instance is identified by the value of key name in the MBean's Object Name


MBean Cluster

The Cluster MBean provides a management interface for a cluster in a cell. It supports typical operations like starting and stopping of the cluster along with the abilty to dynamically modify attributes such as the table of server weights in the cluster.


Attribute Summary
java.lang.StringclusterName
           The name of this cluster.
java.lang.BooleanpreferLocal
           Enable or disable Host scoped routing optimization.
java.lang.StringwlcID
           The currently registered workload controller (WLC) id for this cluster.
java.lang.Stringstate
           The current state of the cluster.
java.lang.StringbackupName
           The name of the cluster to use as a backup to the cluster represented by this MBean.
java.lang.StringbackupBootstrapHost
           The BOOTSTRAP host name of the deployment manager for the backup cluster.
java.lang.IntegerbackupBootstrapPort
           The BOOTSTRAP port of the deployment manager for the backup cluster.

Operation Summary
com.ibm.websphere.management.wlm.ClusterMemberData[]getClusterMembers()
           Retrieve the array of members contained by the cluster.
com.ibm.websphere.management.wlm.ClusterMemberDatagetClusterMember(java.lang.String memberName, java.lang.String nodeName)
           Retrieve the cluster member data for the specified member.
com.ibm.websphere.management.wlm.ClusterWeightTableEntry[]getWeightTable()
           Retrieve the current in memory weight table.
com.ibm.websphere.management.wlm.ClusterWeightTableEntrygetWeightTableEntry(java.lang.String memberName, java.lang.String nodeName)
           Retrieve the in memory weight table entry for the specified cluster member.
voidsetWeightTable(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] weightTable)
           Replace the weight table in memory with the one provided.
voidsetWeightTableEntry(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry weightTableEntry)
           Replace the weight table entry in memory with the one provided.
java.lang.Longregister(java.lang.String wlcName)
           Register as the workload controller for this cluster.
com.ibm.websphere.management.wlm.ClusterDatarefresh()
           Refresh cluster and member information.
voidstart()
           Start the cluster of servers.
voidstop()
           Stop the cluster of servers.
voidstopImmediate()
           Stop the cluster of servers.
voidrippleStart()
           Stop and re-start the servers in the cluster.
java.lang.StringexportRouteTable()
           Exports the routing information to the cluster configuration directory for use by the cluster members at bootstrap when the dmgr is not available.
java.lang.booleanremoveRouteTable()
           Removes the static route table that is created by the exportRouteTable method.
java.lang.StringdumpClusterInfo()
           Returns a formatted string with available Cluster, ClusterMember and WeightTable data.
java.lang.BooleangetAvailable(java.lang.String memberName, java.lang.String nodeName)
           Get availability of a cluster member.
voidsetBackup(java.lang.String clusterName, java.lang.String host, java.lang.Integer port)
           Sets the backup reference to the cluster specified with the parameters.
setAvailable(java.lang.String memberName, java.lang.String nodeName)
           Marks a member of the cluster as available to take requests.
setUnavailable(java.lang.String memberName, java.lang.String nodeName)
           Marks a member of the cluster as unavailable to requests.

Notification Summary
websphere.cluster.weight.table.change
           Notify listeners that the Cluster weight table was changed.
websphere.cluster.weight.table.entry.change
           Notify listeners that a Cluster weight table entry was changed.
websphere.cluster.starting
           This cluster is being started.
websphere.cluster.partial.start
           All members of the cluster have been requested to start, but all servers are not yet running.
websphere.cluster.running
           All members in the cluster are now running.
websphere.cluster.stopping
           This cluster is being stopped.
websphere.cluster.partial.stop
           All servers in this cluster have been requested to stop.
websphere.cluster.stopped
           All servers in the cluster are now stopped.
cluster.member.unusable
           Notify listeners that a member of the cluster was marked as unavailable to take requests.
cluster.member.usable
           Notify listeners that a member of the cluster was marked as available to take requests.
websphere.cluster.backup.set
           Emitted when the backup cluster has been set.
websphere.cluster.controller.registered
           Emitted when a controller has been registered to control the cluster.
websphere.cluster.controller.identified
           Deprecated.  Use the websphere.cluster.controller.registered notification

Attribute Detail

clusterName

public java.lang.String clusterName
The name of this cluster.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

preferLocal

public java.lang.Boolean preferLocal
Enable or disable Host scoped routing optimization. If true, WLM will always route an EJB request to the host on which the client resides if it is possible to do so.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

wlcID

public java.lang.String wlcID
The currently registered workload controller (WLC) id for this cluster. If no WLC has registered yet this value will be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

state

public java.lang.String state
The current state of the cluster.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

backupName

public java.lang.String backupName
The name of the cluster to use as a backup to the cluster represented by this MBean.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

backupBootstrapHost

public java.lang.String backupBootstrapHost
The BOOTSTRAP host name of the deployment manager for the backup cluster.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

backupBootstrapPort

public java.lang.Integer backupBootstrapPort
The BOOTSTRAP port of the deployment manager for the backup cluster.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

getClusterMembers

public com.ibm.websphere.management.wlm.ClusterMemberData[] getClusterMembers()
Retrieve the array of members contained by the cluster.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getClusterMember

public com.ibm.websphere.management.wlm.ClusterMemberData getClusterMember(java.lang.String memberName, java.lang.String nodeName)
Retrieve the cluster member data for the specified member.
Parameters:
memberName - Cluster member name.
nodeName - The name of the node where the cluster member is configured.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getWeightTable

public com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] getWeightTable()
Retrieve the current in memory weight table.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getWeightTableEntry

public com.ibm.websphere.management.wlm.ClusterWeightTableEntry getWeightTableEntry(java.lang.String memberName, java.lang.String nodeName)
Retrieve the in memory weight table entry for the specified cluster member.
Parameters:
memberName - Cluster member name.
nodeName - The name of the node where the cluster member is configured.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

setWeightTable

public void setWeightTable(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] weightTable)
Replace the weight table in memory with the one provided. If no key is provided, or another WLC has registered to control this cluster than an exception will be thrown.
Parameters:
key - The key obtained from the register() method.
weightTable - Desired weight table for this cluster.
Security Roles:
administrator
operator

setWeightTableEntry

public void setWeightTableEntry(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry weightTableEntry)
Replace the weight table entry in memory with the one provided. If no key is provided, or another WLC has registered to control this cluster than an exception will be thrown.
Parameters:
key - The key obtained from the register() method.
weightTableEntry - Desired weight table entry for particular member of the cluster.
Security Roles:
administrator
operator

register

public java.lang.Long register(java.lang.String wlcName)
Register as the workload controller for this cluster. The caller should provide an ID string and will be returned a key that can be used to modify server weight values for this cluster.
Parameters:
wlcName - The Workload Controller ID or name.
Security Roles:
administrator
operator

refresh

public com.ibm.websphere.management.wlm.ClusterData refresh()
Refresh cluster and member information. If a change was made to the static configuration data, this method can be called to refresh (or resync) the in-memory data held by this cluster with the static configuration data.
Security Roles:
administrator
operator

start

public void start()
Start the cluster of servers.
Security Roles:
administrator
operator

stop

public void stop()
Stop the cluster of servers.
Security Roles:
administrator
operator

stopImmediate

public void stopImmediate()
Stop the cluster of servers.
Security Roles:
administrator
operator

rippleStart

public void rippleStart()
Stop and re-start the servers in the cluster.
Security Roles:
administrator
operator

exportRouteTable

public java.lang.String exportRouteTable()
Exports the routing information to the cluster configuration directory for use by the cluster members at bootstrap when the dmgr is not available. The export is a snapshot in time. Static ports should be used with this functionality.
Security Roles:
administrator
operator

removeRouteTable

public java.lang.boolean removeRouteTable()
Removes the static route table that is created by the exportRouteTable method.
Security Roles:
administrator
operator

dumpClusterInfo

public java.lang.String dumpClusterInfo()
Returns a formatted string with available Cluster, ClusterMember and WeightTable data.
Security Roles:
administrator
operator

getAvailable

public java.lang.Boolean getAvailable(java.lang.String memberName, java.lang.String nodeName)
Get availability of a cluster member.
Parameters:
memberName -
nodeName -
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

setBackup

public void setBackup(java.lang.String clusterName, java.lang.String host, java.lang.Integer port)
Sets the backup reference to the cluster specified with the parameters.
Parameters:
clusterName - The name of the cluster that should be associated as a backup to the cluster represented by this MBean. A null value effectively removes the backup.
host - The BOOTSTRAP host of the machine where the deployment manager resides that manages the backup cluster.
port - The BOOTSTRAP port used by the deployment manager where the backup cluster resides.
Security Roles:
administrator
operator

setAvailable

public  setAvailable(java.lang.String memberName, java.lang.String nodeName)
Marks a member of the cluster as available to take requests. Calling this method will indicate to the router that this member should be considered for work when possible.
Parameters:
memberName -
nodeName -
Security Roles:
administrator
operator

setUnavailable

public  setUnavailable(java.lang.String memberName, java.lang.String nodeName)
Marks a member of the cluster as unavailable to requests. Calling this method will indicate to the router that this member should be avoided when possible.
Parameters:
memberName -
nodeName -
Security Roles:
administrator
operator

Notification Detail

websphere.cluster.weight.table.change

Notify listeners that the Cluster weight table was changed. The notification includes a copy of the updated Cluster weight table.
Severity:
5  (Warning)

websphere.cluster.weight.table.entry.change

Notify listeners that a Cluster weight table entry was changed. The notification includes a copy of the updated Cluster weight table entry.
Severity:
5  (Warning)

websphere.cluster.starting

This cluster is being started. The object name of the cluster being started is passed in the user data.
Severity:
5  (Warning)

websphere.cluster.partial.start

All members of the cluster have been requested to start, but all servers are not yet running. The object name of the cluster being started is passed in the user data.
Severity:
5  (Warning)

websphere.cluster.running

All members in the cluster are now running. The object name of the cluster is passed in the user data. Due to the asynchronous nature of the cluster MBean and its corresponding notifications, a notification may be received before the actual operation that caused the notification is complete.
Severity:
5  (Warning)

websphere.cluster.stopping

This cluster is being stopped. The object name of the cluster being stopped is passed in the user data.
Severity:
5  (Warning)

websphere.cluster.partial.stop

All servers in this cluster have been requested to stop. The object name of the cluster being stopped is passed in the user data.
Severity:
5  (Warning)

websphere.cluster.stopped

All servers in the cluster are now stopped. The object name of the cluster is passed in the user data.
Severity:
5  (Warning)

cluster.member.unusable

Notify listeners that a member of the cluster was marked as unavailable to take requests. Due to the asynchronous nature of the cluster MBean and its corresponding notifications, a notification may be received before the actual operation that caused the notification is complete.
Severity:
1  (Non recoverable)

cluster.member.usable

Notify listeners that a member of the cluster was marked as available to take requests. Due to the asynchronous nature of the cluster MBean and its corresponding notifications, a notification may be received before the actual operation that caused the notification is complete.
Severity:
1  (Non recoverable)

websphere.cluster.backup.set

Emitted when the backup cluster has been set.
Severity:
5  (Warning)

websphere.cluster.controller.registered

Emitted when a controller has been registered to control the cluster.
Severity:
5  (Warning)

websphere.cluster.controller.identified

Deprecated.  Use the websphere.cluster.controller.registered notification

Emitted when a controller has been identified for the cluster.
Severity:
5  (Warning)

Copyright IBM Corp. 1996-2005