WebSphere:*,type=Cluster
ResourceInstanceIdentifier:
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.String | clusterName The name of this cluster. |
java.lang.Boolean | preferLocal Enable or disable Host scoped routing optimization. |
java.lang.String | wlcID The currently registered workload controller (WLC) id for this cluster. |
java.lang.String | state The current state of the cluster. |
java.lang.String | backupName The name of the cluster to use as a backup to the cluster represented by this MBean. |
java.lang.String | backupBootstrapHost The BOOTSTRAP host name of the deployment manager for the backup cluster. |
java.lang.Integer | backupBootstrapPort 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.ClusterMemberData | getClusterMember( 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.ClusterWeightTableEntry | getWeightTableEntry( Retrieve the in memory weight table entry for the specified cluster member. |
void | setWeightTable( Replace the weight table in memory with the one provided. |
void | setWeightTableEntry( Replace the weight table entry in memory with the one provided. |
java.lang.Long | register( Register as the workload controller for this cluster. |
com.ibm.websphere.management.wlm.ClusterData | refresh() Refresh cluster and member information. |
void | start() Start the cluster of servers. |
void | stop() Stop the cluster of servers. |
void | stopImmediate() Stop the cluster of servers. |
void | rippleStart() Stop and re-start the servers in the cluster. |
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. |
java.lang.boolean | removeRouteTable() Removes the static route table that is created by the exportRouteTable method. |
java.lang.String | dumpClusterInfo() Returns a formatted string with available Cluster, ClusterMember and WeightTable data. |
java.lang.Boolean | getAvailable( Get availability of a cluster member. |
void | setBackup( Sets the backup reference to the cluster specified with the parameters. |
| setAvailable( Marks a member of the cluster as available to take requests. |
| setUnavailable( 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 |
public java.lang.String clusterName
public java.lang.Boolean preferLocal
public java.lang.String wlcID
public java.lang.String state
public java.lang.String backupName
public java.lang.String backupBootstrapHost
public java.lang.Integer backupBootstrapPort
Operation Detail |
public com.ibm.websphere.management.wlm.ClusterMemberData[] getClusterMembers()
public com.ibm.websphere.management.wlm.ClusterMemberData getClusterMember(java.lang.String memberName,
java.lang.String nodeName
)
memberName
-
Cluster member name.nodeName
-
The name of the node where the cluster member is configured.
public com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] getWeightTable()
public com.ibm.websphere.management.wlm.ClusterWeightTableEntry getWeightTableEntry(java.lang.String memberName,
java.lang.String nodeName
)
memberName
-
Cluster member name.nodeName
-
The name of the node where the cluster member is configured.
public void setWeightTable(java.lang.Long key,
com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] weightTable
)
key
-
The key obtained from the register() method.weightTable
-
Desired weight table for this cluster.
public void setWeightTableEntry(java.lang.Long key,
com.ibm.websphere.management.wlm.ClusterWeightTableEntry weightTableEntry
)
key
-
The key obtained from the register() method.weightTableEntry
-
Desired weight table entry for particular member of the cluster.
public java.lang.Long register(java.lang.String wlcName
)
wlcName
-
The Workload Controller ID or name.
public com.ibm.websphere.management.wlm.ClusterData refresh()
public void start()
public void stop()
public void stopImmediate()
public void rippleStart()
public java.lang.String exportRouteTable()
public java.lang.boolean removeRouteTable()
public java.lang.String dumpClusterInfo()
public java.lang.Boolean getAvailable(java.lang.String memberName,
java.lang.String nodeName
)
memberName
-
nodeName
-
public void setBackup(java.lang.String clusterName,
java.lang.String host,
java.lang.Integer port
)
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.
public setAvailable(java.lang.String memberName,
java.lang.String nodeName
)
memberName
-
nodeName
-
public setUnavailable(java.lang.String memberName,
java.lang.String nodeName
)
memberName
-
nodeName
-
Notification Detail |