+

Search Tips   |   Advanced Search

Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, z/OS

 

Dynamic cluster administrative tasks


Use the dynamic cluster commands to view or edit the dynamic clusters, without using the administrative console. Use the following commands to create dynamic clusters, add or remove servers from clusters, list dynamic clusters, or modify dynamic clusters:

 

createDynamicCluster

The createDynamicCluster command creates a new dynamic cluster.

Required parameters

-membershipPolicy
Specifies the membership policy. (String, required)

Optional parameters

-dynamicClusterProperties
Dynamic cluster properties. (String, optional)You can specify the following parameters:

operationalMode
Specifies the operational mode. The valid values are: manual, supervised, and automatic.
minInstances
Specifies the minimum number of cluster instances as an integer.
serverInactivityTime
Specifies the time to wait before stopping instances, in minutes. This value is valid only when the minInstances parameter value is set to 0.
maxInstances
Specifies the maximum number of cluster instances as an integer. If you do not want a limit to the number of cluster instances that can start, specify -1.
numVerticalInstances
Number of instances that can start on the same node by creating vertical instances. Specify an integer value.
-clusterProperties
Specifies the cluster properties. (String, optional)You can specify the following parameters:

preferLocal
Specifies whether enterprise bean requests are routed to the node on which the client resides when possible. The valid values are true or false.
createDomain
Specifies that a replication domain is created for this cluster. Replication domains can be created only for WebSphere® Application Server application servers. The valid values are true or false.
coreGroup
Name of the core group for the dynamic cluster. You only need to specify the core group for WebSphere Application Server application servers. The value can be DefaultCoreGroup or the core group name.
templateName
Name of the server template. The valid input includes the following values:

  • For WebSphere Application Server dynamic clusters: defaultXD, defaultXDZOS, cell_name/node_name/was_server_name

Return value

The command returns javax.management.ObjectName value of the dynamic cluster that you created.

Batch mode example usage

Interactive mode example usage

 

createPHPDynamicCluster

The createPHPDynamicCluster command creates a new PHP dynamic cluster.

Required parameters

-membershipPolicy
Specifies the membership policy subexpression. (String, required)

Optional parameters

-dynamicClusterProperties
Dynamic cluster properties. (String, optional)You can specify the following parameters:

operationalMode
Specifies the operational mode. The valid values are: manual, supervised, and automatic.
minInstances
Specifies the minimum number of cluster instances as an integer.
serverInactivityTime
Specifies the time to wait before stopping instances, in minutes. This value is valid only when the minInstances parameter value is set to 0.
maxInstances
Specifies the maximum number of cluster instances as an integer. If you do not want a limit to the number of cluster instances that can start, specify -1.
numVerticalInstances
Number of instances that can start on the same node by creating vertical instances. Specify an integer value.
-clusterProperties

templateName
Name of the server template. The valid input includes the following values:

  • For PHP dynamic clusters: APACHE13_PHP4, APACHE13_PHP5, APACHE20_PHP4, APACHE20_PHP5, APACHE22_PHP4, APACHE22_PHP5, cellName/nodeName/php_serverName.

Return value

The command returns javax.management.ObjectName value of the dynamic cluster that you created.

Batch mode example usage

Interactive mode example usage

 

createDynamicClusterFromStaticCluster

The createDynamicClusterFromStaticCluster command creates a new dynamic cluster from an existing static cluster.

Optional parameters

-templateName
Name of the existing static cluster member template. The format of the name must be in cell_name/node_name/server_name format. If the template is not specified, then an existing static cluster member template is randomly chosen. If no members exist, the defaultXD server template is used. (String, optional)
-dynamicClusterProperties
Dynamic cluster properties. (String, optional) You can specify the following parameters:

operationalMode
Specifies the operational mode. The valid values are: manual, supervised, and automatic.
minInstances
Specifies the minimum number of cluster instances as an integer.
serverInactivityTime
Specifies the time to wait before stopping instances, in minutes. This value is valid only when the minInstances parameter value is set to 0.
maxInstances
Specifies the maximum number of cluster instances as an integer. If you do not want a limit to the number of cluster instances that can start, specify -1.

Return value

The command returns the javax.management.ObjectName value of the dynamic cluster that you created.

Batch mode example usage

Interactive mode example usage

 

createDynamicClusterFromForeignServers

The createDynamicClusterFromForeignServers command creates a new dynamic cluster of assisted lifecycle servers. Create representations of these servers with an administrative task or in the administrative console before you create a dynamic cluster.

Required parameters

-foreignServers [[node_name1 server_name1 ][node_name2 server_name2] ...]
Node and server names of the existing other middleware servers. (String, required)

Optional parameters

-dynamicClusterProperties
Dynamic cluster properties. (String, optional) You can specify the following parameters:

operationalMode
Specifies the operational mode. The valid values are: manual, supervised, and automatic.
minInstances
Specifies the minimum number of cluster instances as an integer.
serverInactivityTime
Specifies the time to wait before stopping instances, in minutes. This value is valid only when the minInstances parameter value is set to 0.
maxInstances
Specifies the maximum number of cluster instances as an integer. If you do not want a limit to the number of cluster instances that can start, specify -1.

Return value

The command returns the javax.management.ObjectName identification of the server type that you updated.

Batch mode example usage

Interactive mode example usage

 

addForeignServersToDynamicCluster

The addForeignServersToDynamicCluster command adds foreign servers to an existing dynamic cluster.

Required parameters

-foreignServers [[node_name1 server_name1 ][node_name2 server_name1] ...]
Node and server names of the existing other middleware servers. (String, required)

Return value

The command returns the javax.management.ObjectName identification of the server type that you updated.

Batch mode example usage

Interactive mode example usage

 

removeForeignServersFromDynamicCluster

The removeForeignServersFromDynamicCluster command removes foreign servers from the dynamic cluster

Required parameters

-foreignServers [[node_name1 server_name1 ][node_name2 server_name1] ...]
Node and server names of the existing other middleware servers. (String, required)

Return value

The command returns the javax.management.ObjectName identification of the server type that you updated.

Batch mode example usage

Interactive mode example usage

 

deleteDynamicCluster

The deleteDynamicCluster deletes a dynamic cluster from the configuration.

Return value

The command returns the javax.management.ObjectName identification of the dynamic cluster that you deleted.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterMembers

The getDynamicClusterMembers command displays the members of the specified dynamic cluster and node name. If the node name is not specified, then all of the members of the dynamic cluster are displayed.

Optional parameters

-nodeName
Name of a node. (String, optional)

Return value

The command returns a list of ClusterMember objects.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterOperationalMode

The getDynamicClusterOperationalMode command displays the operational mode of the dynamic cluster.

Return value

The command returns the value of operationalMode. String.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterMembershipPolicy

The getDynamicClusterMembershipPolicy command displays the dynamic cluster membership policy.

Return value

The command returns the value of membershipPolicy. String.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterServerType

The getDynamicClusterServerType command displays the dynamic cluster server type.

Return value

The command returns the value of serverType. String.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterMinInstances

The getDynamicClusterMinInstances command displays the minimum number of cluster instances for the specified dynamic cluster.

Return value

The command returns the value of minInstances. Integer.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterMaxInstances

The getDynamicClusterMaxInstances command displays the maximum number of cluster instances for the specified dynamic cluster.

Return value

The command returns the value of maxInstances. Integer.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterVerticalInstances

The getDynamicClusterVerticalInstances command displays the number of dynamic cluster vertical stacking of instances on the node.

Return value

The command returns the value of numVerticalInstances. Integer.

Batch mode example usage

Interactive mode example usage

 

getDynamicClusterIsolationProperties

The getDynamicClusterVerticalInstances command displays the dynamic cluster isolation properties.

Return value

The command returns the value of isolationGroup and strictIsolationEnabled. String.

Batch mode example usage

Interactive mode example usage

 

listDynamicClusters

The listDynamicClusters command displays all the dynamic clusters in the cell.

Return value

The command returns each of the dynamic cluster names. String.

Batch mode example usage

Interactive mode example usage

 

listDynamicClusterIsolationGroups

The listDynamicClusterIsolationGroups command displays all the dynamic cluster isolation groups in the cell.

Return value

The command returns a list of the dynamic cluster isolation groups. String.

Batch mode example usage

Interactive mode example usage

 

listDynamicClusterIsolationGroupMembers

The listDynamicClusterIsolationGroupMembers command displays the dynamic cluster isolation group members for the specified isolation group.

Return value

The command returns a list of the dynamic cluster isolation group members. String.

Batch mode example usage

Interactive mode example usage

 

modifyDynamicClusterIsolationProperties

The modifyDynamicClusterIsolationProperties command modifies dynamic cluster isolation properties.

Optional parameters

-isolationGroup
Name of the isolation group. (String, optional)
-strictIsolationEnabled
Indicates if strict isolation is enabled. (String, optional)

Return value

The return value is void.

Batch mode example usage

Interactive mode example usage

 

setDynamicClusterOperationalMode

The setDynamicClusterOperationalMode command sets the operational mode for the dynamic cluster.

Required parameters

-operationalMode
Specifies the operational mode of the dynamic cluster. The values can be: automatic, manual, or supervised. (String, required)

Return value

The return value is void.

Batch mode example usage

Interactive mode example usage

 

setDynamicClusterMembershipPolicy

The setDynamicClusterMembershipPolicy command sets the membership policy for the dynamic cluster.

Required parameters

-membershipPolicy
Specifies the membership policy subexpression. (String, required)

Return value

The return value is void.

Batch mode example usage

Interactive mode example usage

 

setDynamicClusterMinInstances

The setDynamicClusterMinInstances command sets the minimum number of cluster instances for the dynamic cluster.

Required parameters

-minInstances
Specifies the minimum number of cluster instances. (Integer, required)

Return value

The return value is void.

Batch mode example usage

Interactive mode example usage

 

setDynamicClusterMaxInstances

The setDynamicClusterMaxInstances command sets the maximum number of cluster instances for the dynamic cluster.

Required parameters

-maxInstances
Specifies the minimum number of cluster instances. (Integer, required)

Return value

The return value is void.

Batch mode example usage

Interactive mode example usage

 

setDynamicClusterVerticalInstances

The setDynamicClusterVerticalInstances command sets the number of dynamic cluster vertical stacking instances on the node.

Required parameters

-numVerticalInstances
Number of vertical stacking of instances on a node.(Integer, required)

Return value

The return value is void.

Batch mode example usage

Interactive mode example usage

 

testDynamicClusterMembershipPolicy

The testDynamicClusterMembershipPolicy command tests the dynamic cluster membership policy to see which nodes are returned.

Required parameters

-membershipPolicy
Specifies the membership policy subexpression. (String, required)

Return value

The command returns a String [] list of node names.

Batch mode example usage

Interactive mode example usage

 

createNonWASDynamicCluster

The createNonWASDynamicCluster command creates a new dynamic cluster of complete lifecycle management servers.

Required parameters

-serverType
Specifies the server type. (String, required)

To see the server types, view the install_root\profiles\dmgr_profile\config\templates\servertypes directory.

-membershipPolicy
Specifies the membership policy subexpression. (String, required)

Optional parameters

-dynamicClusterProperties
Dynamic cluster properties. (String, optional)You can specify the following parameters:

operationalMode
Specifies the operational mode. The valid values are: manual, supervised, and automatic.
minInstances
Specifies the minimum number of cluster instances as an integer.
serverInactivityTime
Specifies the time to wait before stopping instances, in minutes. This value is valid only when the minInstances parameter value is set to 0.
maxInstances
Specifies the maximum number of cluster instances as an integer. If you do not want a limit to the number of cluster instances that can start, specify -1.
numVerticalInstances
Number of instances that can start on the same node by creating vertical instances. Specify an integer value.
-clusterProperties
Specifies the cluster properties (String, optional)

templateName
Name of the server template. The valid input includes the following values:

  • For PHP dynamic clusters: APACHE13_PHP4, APACHE13_PHP5, APACHE20_PHP4, APACHE20_PHP5, APACHE22_PHP4, APACHE22_PHP5, cellName/nodeName/php_serverName.

  • For WebSphere Application Server Community Edition dynamic clusters: wasce20, cell_name/node_name/wasce_server_name

Return value

The command returns the javax.management.ObjectName value of the dynamic cluster that you created.

Batch mode example usage

Interactive mode example usage

 

Edit the dynamic cluster server template

Identify the dynamic cluster server template and assign the template to the serverid variable.

Batch mode example usage

You can use the serverid variable to modify, create, or delete configuration objects in the dynamic cluster server template.



Related tasks

Use the AdminTask object for scripted administration
Creating dynamic clusters
Configure vertical stacking

 

Related reference


Commands for the AdminConfig object