You can use the Jython or Jacl scripting languages to cluster servers
using scripting. The commands and parameters in the ClusterConfigCommands
group can be used to create and delete server clusters and groups of application
servers known as cluster members.
The ClusterConfigCommands command group for the AdminTask object includes
the following commands:
changeClusterShortName
The createCluster command
change the short name that is associated with the cluster.
Target
object
None
Steps
- -clusterName (required)
- Specifies the name of the server cluster. (String)
- -shortName (optional)
- Specifies the new short name that you want to associate with the cluster.
Every cluster must have a unique short name. If this parameter is not specified,
a unique short name is automatically assigned. The value that you specify
for this parameter must be 8 characters or less in length and all of the characters
must be in uppercase.
Examples
Batch mode
example usage:
Using Jacl:
$AdminTask changeClusterShortName {-clusterName cluster1 -shortName newshortname}
- Using Jython string:
AdminTask.changeClusterShortName('[-clusterName mycluster -ShortName newshortname]')
- Using Jython list:
AdminTask.changeClusterShortName(['-clusterName', 'mycluster', '-ShortName', 'newshortname'])
Interactive mode example usage:
Using Jacl:
$AdminTask changeClusterShortName {-interactive}
Using Jython:
AdminTask.changeClusterShortName ('-interactive')
- Using Jython list:
AdminTask.changeClusterShortName (['-interactive'])
createCluster
The
createCluster command creates a new server cluster. A server cluster consists
of a group of application servers that are referred to as cluster members.
Optionally, a replication domain can be created for the new cluster, and an
existing server can be included as the first cluster member. You can also
use the createCluster command to apply proxy server settings to the cluster.
Target object
None
Steps
- -clusterConfig (required)
- Specifies the following configuration information for the new server cluster:
- -clusterName
- Specifies the name of the server cluster. (String)
- -preferLocal
- Optionally specifies whether to enable or disable node-scoped routing
optimization within the cluster. The default value is false. Specify true to
enable node-scoped routing optimization. (Boolean)
- -clusterType
- Optionally specifies the type of the server cluster to create. The default
type is APPLICATION_SERVER. Valid values for this parameter include: APPLICATION_SERVER, PROXY_SERVER,
and ONDEMAND_ROUTER. (String)
- -shortName
- Specifies the specific short name of the server. Each server should have
a specific short name. The value of this parameter must be 8 uppercase characters
or less. If you do not specify a value for the specificShortName parameter,
the system generates a unique short name. (String)
- -replicationDomain (optional)
- The system uses the replication domain properties for HTTP session data
replication.
- -createDomain
- Specifies whether to create a replication domain in your cluster configuration.
The default value is false. Specify true to create a replication
domain in your cluster configuration. (Boolean)
- -convertServer (optional)
- Specifies information about an existing application server to convert
to be the first member of the cluster. This command step is optional. The
following parameters can be specified for this step:
- -serverNode
- The name of the node with the server to be converted to the first cluster
member. You must also specify the serverName parameter. (String)
- -serverName
- The name of the application server to be converted to the first cluster
member. You must also specify the serverNode parameter. (String)
- -memberWeight
- The weight of the cluster member. The weight controls the amount of work
directed to the application server. If the weight is greater than the weight
assigned to other cluster members, the server will receive a larger share
of the workload. The value is a number between 0 and 100. If none is specified,
the default is 2. (Integer)
- -nodeGroup
- The name of the node group which this cluster member"s node, and all future
cluster members" nodes, must belong to. All cluster members must reside on
nodes in the same node group. If specified, it must be one of the node groups
which this member"s node belongs to. If not specified, the default value will
be the first node group listed for this member's node. (String)
- -replicatorEntry
- Specifies whether to enable HTTP session data replication. The default
value is false. Specify true to enable HTTP session data
replication. You must specify this parameter if the createDomain parameter
was set to true in the replicationDomain command step. (String)
Examples
Batch mode
example usage:
Using Jacl:
$AdminTask createCluster {-clusterConfig {{-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER}}}
$AdminTask createCluster {-clusterConfig {{-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER}} -replicationDomain {{-createDomain true}}}
$AdminTask createCluster {-clusterConfig {{-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER}} -convertServer {{-serverNode node1 -serverName server1}}}
Using Jython string:
AdminTask.createCluster('[-clusterConfig [[-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER]]]')
AdminTask.createCluster('[-clusterConfig [[-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER]] -replicationDomain [[true]]]')
AdminTask.createCluster('[-clusterConfig [[-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER]] -convertServer [[-serverNode node1 -serverName server1]]]')
Using Jython list:
AdminTask.createCluster(['-clusterConfig', '[[-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER]]'])
AdminTask.createCluster(['-clusterConfig', '[[-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER]]', '-replicationDomain', '[[-createDomain true]]'])
AdminTask.createCluster(['-clusterConfig', '[[-clusterName cluster1 -preferLocal true -clusterType APPLICATION_SERVER]]', '-convertServer', '[[-serverNode node1 -serverName server1]]'])
Interactive mode example usage:
Using Jacl:
$AdminTask createCluster {-interactive}
Using Jython:
AdminTask.createCluster ('-interactive')
createClusterMember
The
createClusterMember command creates a member of a server cluster. A cluster
member is an application server that belongs to a cluster. If this is the
first member of the cluster, you must specify a template to use as the model
for the cluster member. The template can be either a default server template,
or an existing application server.
The first cluster
member is used as a template to create subsequent members in the cluster.
When you create a first cluster member, the template of the cluster member
is stored under the scope of the cluster.
Since a
cluster can contain members from nodes that run different versions of the
application server, the following conditions apply:
- The system stores one template for each version of the node that is already
configured as a cluster member.
- The cluster member template will not exist for a given version of node
until a first member is created in any node of the same version. For example,
if a cluster contains some V6.1 nodes and some V6.0.x nodes, there will be
one cluster member template for the V6.1 node and one cluster member template
for the V6.0.x node.
- The following template will be used for members that are created for a
V6.1 node: $WAS_HOME/config/templates/clusters/clusterName/servers/V6.1MemberTemplate.
- The following template will be used for members that are created for a
V6.0.x node: $WAS_HOME/config/templates/clusters/clusterName/servers/V6MemberTemplate.
- The following template will be used for members that are created for a
V5.x node: $WAS_HOME/config/clusters/clusterName/servers/V5MemberTemplate.
- When you make a configuration change to members in a cluster, you must
make the same configuration change to the template that is stored in the cluster
scope that corresponds.
Target object
Optionally specifies
the configuration ID of the cluster to which the new member belongs. If you
do not specify the configuration ID, you must specify the clusterName parameter.
Use the getid command for the AdminConfig object to get the configuration
ID of the cluster of interest.
Required parameters
- -clusterName
- The name of the cluster to which the new member will belong. If you do
not specify this parameter, you must specify the cluster object ID in the
command target. (String)
Steps
- -memberConfig (required)
- Specifies the configuration of a new member of the cluster.
- memberNode
- Specifies the node on which the system creates the cluster member. (String)
- memberName
- Specifies the name of the new cluster member. (String)
- memberWeight
- Optionally specifies the starting weight of the cluster member. (Integer)
- memberUUID
- Optionally specifies the UUID of the cluster member. (String)
- genUniquePorts
- Optionally specifies whether the system generates unique port numbers
for each HTTP transport defined in the server. The new server will not have
HTTP transports which conflict with any other servers defined on the same
node. The default value is true. If you do not want to generate unique
port numbers, specify the value as false. (Boolean)
- replicatorEntry
- Optionally specifies whether the system creates a replicator entry for
the new cluster member in the cluster replication domain. A replicator entry
is used to provide HTTP session data replication. This command parameter is
optional. The value is true or false which indicates whether the entry will
be created. The default value is false. You can specify this parameter
only if a replication domain has been created for the cluster. (Boolean)
- -firstMember (optional)
- Specifies additional information required to configure the first member
of the cluster.
- templateName
- Optionally specifies The name of an application server template to use
when creating the new cluster member. If you specify a template, you cannot
specify the templateServerNode and templateServerName parameters to use an
existing application server as a template. You are required to specify either
the templateName parameter, or the templateServerNode and templateServerName
parameters in this step. (String)
- templateServerNode
- Optionally specifies the name of the node with an existing application
server to use as the template when creating the new cluster member. If you
specify the templateServerNode parameter, you must also specify the templateServerName
parameter, and you cannot specify the templateName parameter. You are required
to specify either the templateName parameter, or the templateServerNode and
templateServerName parameters, in this step. (String)
- templateServerName
- Optionally specifies the name of the existing application server to use
as the model when creating the new cluster member. If you specify the templateServerName
parameter, you must also specify the templateServerNode parameter, and you
cannot specify the templateName parameter. You are required to specify either
the templateName parameter, or the templateServerNode and templateServerName
parameters, in this command step. (String)
- nodeGroup
- Optionally specifies the name of the node group to which the new cluster
member and each additional cluster member belongs. Each cluster member must
reside on nodes in the same node group. If specified, it must be one of the
node groups which this member node belongs to. If you do not specify this
parameter, the system assigns the first node group listed for the member node.
(String)
- coreGroup
- Optionally specifies the name of the core group to which the new cluster
member and each additional cluster member belongs. Each cluster members must
belong to the same core group. If you do not specify this parameter, the system
assigns the default core group in the cell. (String)
Examples
Batch mode
example usage:
Using Jacl:
First member creation using template name:
$AdminTask createClusterMember {-clusterName cluster1 -memberConfig {{-memberNode node1 -memberName member1 -genUniquePorts true -replicatorEntry false}} -firstmember {{-templateName serverTemplateName}}}
First member creation using server and node for template:
$AdminTask createClusterMember {-clusterName cluster1 -memberConfig {{-memberNode node1 -memberName member1 -genUniquePorts true -replicatorEntry false}} -firstmember {{-templateServerNode node1 -templateServerName server1}}}
Second member creation:
$AdminTask createClusterMember {-clusterName cluster1 -memberConfig {{-memberNode node1 -memberName member2 -genUniquePorts true -replicatorEntry false}}}
Using Jython string:
First member creation using template name:
AdminTask.createClusterMember('[-clusterName cluster1 -memberConfig [[-memberNode node1 -memberName member1 -genUniquePorts true -replicatorEntry false]] -firstMember [[-templateName serverTemplateName]]]')
First member creation using server and node for template:
AdminTask.createClusterMember('[-clusterName cluster1 -memberConfig [[-memberNode node1 -memberName member1 -genUniquePorts true -replicatorEntry false]] -firstMember [[-templateServerNode node1 -templateServerName server1]]]')
Second member creation:
AdminTask.createClusterMember('[-clusterName cluster1 -memberConfig [[-memberNode node1 -memberName member1 -genUniquePorts true -replicatorEntry false]]]')
deleteCluster
The
deleteCluster command deletes the configuration of a server cluster. A server
cluster consists of a group of application servers that are referred to as
cluster
members. The system deletes each cluster member for the cluster of interest.
Use
the deleteClusterMember command to delete the configuration of an individual
cluster member.
Target object
Optionally
specifies the configuration object ID of the cluster to delete. If you do
not specify the object ID for the cluster, then you must specify the clusterName
parameter. Use the getid command for the AdminConfig object to get the configuration
ID of the cluster.
Required parameters
- -clusterName
- Specifies the name of the cluster to delete. If you specify the configuration
ID of the cluster, do not specify a value for the clusterName parameter. (String)
Steps
- -replicationDomain (optional step)
- -deleteRepDomain
- Specifies whether to delete the replication domain. The default value
is false. Specify true to delete the replication domain.
(Boolean)
Examples
Batch mode
example usage:
Using Jacl:
$AdminTask deleteCluster {-clusterName cluster1 }
$AdminTask deleteCluster {-clusterName cluster1 -replicationDomain {{-deleteRepDomain true}}}
Using Jython string:
AdminTask.deleteCluster('[-clusterName cluster1]')
AdminTask.deleteCluster('[-clusterName cluster1 -replicationDomain [[-deleteRepDomain true]]]')
Using Jython list:
AdminTask.deleteCluster(['-clusterName', 'cluster1'])
AdminTask.deleteCluster(['-clusterName', 'cluster1', '-replicationDomain', '[[-deleteRepDomain true]]'])
Interactive mode example usage:
Using Jacl:
$AdminTask deleteCluster -interactive
Using Jython:
AdminTask.deleteCluster ('-interactive')
deleteClusterMember
The
deleteClusterMember command deletes the configuration of a cluster member.
A cluster member is an application server that belongs to a server cluster.
Use the deleteCluster command to delete the configuration of a cluster.
Target object
Optionally specifies the configuration
object ID of the cluster member to delete. If you do not specify the configuration
ID, then you must specify the clusterName, memberNode and memberName parameters.
Use the getid command for the AdminConfig object to get the configuration
ID of the cluster.
Required parameters
- -clusterName
- Specifies the name of the cluster to which the member of interest belongs.
If this parameter is specified, then the memberName and memberNode parameters
must also be specified. If this is not specified, then the member object ID
must be specified in the command target. (String)
- -memberNode
- Specifies the name of the node to which the cluster member belongs. If
this parameter is specified, then the memberName and clusterName parameters
must also be specified. If this is not specified, then the cluster member
object ID must be specified in the command target. (String)
- -memberName
- Specifies the server name of the member to delete from the cluster. If
this parameter is specified, then the clusterName and memberNode parameters
must also be specified. If this is not specified, then the member object ID
must be specified in the command target. (String)
Steps
- replicatorEntry (optional)
- Specifies the removal of a replicator entry for this cluster member. This
command step is optional. The following parameters can be specified for this
step:
- -deleteEntry
- Delete the replicator entry having the cluster member name from the cluster
replication domain. Specify the value as true to delete the replicator
entry. The default value is false.
Examples
Batch mode
example usage:
Using Jacl:
$AdminTask deleteClusterMember {-clusterName cluster1 -memberNode node1 -memberName member1}
$AdminTask deleteClusterMember {-clusterName cluster1 -memberNode node1 -memberName member2 -replicatorEntry {{-deleteEntry true}}}
Using Jython string:
AdminTask.deleteClusterMember('[-clusterName cluster1 -memberNode node1 -memberName member1]')
AdminTask.deleteClusterMember('[-clusterName cluster1 -memberNode node1 -memberName member2 -replicatorEntry [[-deleteEntry true]]]')
Using Jython list:
AdminTask.deleteClusterMember(['-clusterName', 'cluster1', '-memberNode', 'node1', '-memberName', 'member1'])
AdminTask.deleteClusterMember(['-clusterName', 'cluster1', '-memberNode', 'node1', '-memberName', 'member2', '-replicatorEntry', '[[-deleteEntry true]]'])
Interactive mode example usage:
Using Jacl:
$AdminTask deleteClusterMember -interactive
Using Jython:
AdminTask.deleteClusterMember ('-interactive')