Cluster administration scripts

The scripting library provides multiple script procedures to automate your application server configurations. Use the scripts in this topic to start and stop cluster processes with a variety of options. You can run each script individually or combine procedures to create custom automation scripts.

The AdminClusterManagement script procedures are located in the app_server_root/scriptLibraries/server/V70 directory.

Use the following script procedures to start cluster processes in your environment:
Use the following script procedures to stop cluster processes in your environment:

rippleStartAllClusters

This script stops and restarts each cluster within a cell configuration.

Syntax

AdminClusterManagement.rippleStartAllClusters()

Example usage

AdminClusterManagement.rippleStartAllClusters()

rippleStartSingleCluster

This script stops and restarts the cluster members within a specific cluster configuration.

Table 1. rippleStartSingleCluster argument description . To run the script, specify the cluster name argument, as defined in the following table:
Argument Description
clusterName Specifies the name of the cluster to stop and restart.

Syntax

AdminClusterManagement.rippleStartSingleCluster(clusterName)

Example usage

AdminClusterManagement.rippleStartSingleCluster("myCluster")

startAllClusters

This script starts each cluster within a cell configuration.

Syntax

AdminClusterManagement.startAllClusters()

Example usage

AdminClusterManagement.startAllClusters()

startSingleCluster

This script starts a specific cluster in your configuration.

Table 2. startSingleCluster argument description . To run the script, specify the cluster name argument, as defined in the following table:
Argument Description
clusterName Specifies the name of the cluster of interest.

Syntax

AdminClusterManagement.startSingleCluster(clusterName)

Example usage

AdminClusterManagement.startSingleCluster("myCluster")

immediateStopAllRunningClusters

This script stops the server cluster members for each active cluster within a specific cell. The server ignores any current or pending tasks. When the stop operation begins, the cluster state changes to partially stopped. After all servers stop, the cluster state becomes stopped.

Syntax

AdminClusterManagement.immediateStopAllRunningClusters()

Example usage

AdminClusterManagement.immediateStopAllRunningClusters()

immediateStopSingleCluster

This script stops the server cluster members for a specific cluster within a cell. The server ignores any current or pending tasks. When the stop operation begins, the cluster state changes to partially stopped. After all servers stop, the cluster state becomes stopped.

Table 3. immediateStopSingleCluster argument description . To run the script, specify the cluster name argument, as defined in the following table:
Argument Description
clusterName Specifies the name of the cluster to stop.

Syntax

AdminClusterManagement.immediateStopSingleCluster(clusterName)

Example usage

AdminClusterManagement.immediateStopSingleCluster("myCluster")

stopAllClusters

This script stops the server cluster members of each active cluster within a specific cell. Each server stops so that the server can complete existing requests and allow failover to another member of the cluster. When the stop operation begins the cluster state changes to partially stopped. After all servers stop, the cluster state becomes stopped.

Syntax

AdminClusterManagement.stopAllClusters()

Example usage

AdminClusterManagement.stopAllClusters()

stopSingleCluster

This script stops the server cluster members of a specific active cluster within a cell. Each server stops so that the server can complete existing requests and allow failover to another member of the cluster. When the stop operation begins the cluster state changes to partially stopped. After all servers stop, the cluster state becomes stopped.

Table 4. stopSingleCluster argument description . To run the script, specify the cluster name argument, as defined in the following table:
Argument Description
clusterName Specifies the name of the cluster to stop.

Syntax

AdminClusterManagement.stopSingleCluster(clusterName)

Example usage

AdminClusterManagement.stopSingleCluster("myCluster")