server task cluster restart

Edit online

The server task cluster restart command applies any configuration changes to the entire cluster and restarts the updated servers.

Requires authentication (administrator ID and password) to use this command.

Syntax

server task server_name cluster restart [-ripple|-status]

Description

If the -status option is used then the command provides a status update on the most recent cluster restart.

If the -status option is not used then the command causes each server in the cluster to examine the master for configuration updates. If required, the server updates its configuration data to synchronize with the master configuration information. If updates are applied then the server is restarted. The master server is restarted after all of the replica servers in the cluster have been updated and restarted as required.

Note: This command is only available on the configured cluster master server.

Options

server_name

Specifies the name of the master authorization server on which the configuration data resides.

-ripple

Indicates that each WebSEAL server in the cluster must restart in sequence rather than being restarted in parallel.

-status

Monitors the progress of a cluster restart. This option returns one of the following messages based on the current status of the cluster:

DPWAD0444I   The cluster has been restarted.	

DPWAD0443I   The cluster is in the process of being restarted.

Authorization

Users and groups that require access to this command must be given the s (server administration) permission in the ACL that governs the master /WebSEAL/host_name-instance_name/ object. For example, the sec_master administrative user has permission by default.

Note:

An error is returned if the server is not configured as the master of the cluster. Before executing this command, you must ensure that the cluster is configured correctly using appropriate [cluster] stanza entries. For more information, see [cluster] stanza.

You cannot use the two options -ripple and -status at the same time. The -ripple option is available when initiating a cluster restart, while the -status option monitors the progress of the most recent cluster restart request.

Return codes

0: The command completed successfully.
Note: For WebSEAL server task commands, the return code will be 0 when the command is sent to the WebSEAL server without errors. Even if the command was successfully sent, the WebSEAL server might not be able to successfully complete the command and can return an error message.
1: The command failed. When a command fails, the pdadmin command provides a description of the error and an error status code in hexadecimal format (for example, 0x14c012f2).
See "Error messages" in the IBM Knowledge Center which provides a list of the Verify Identity Access error messages by decimal or hexadecimal codes.

Default value

By default the cluster is restarted in parallel.

Examples

The following example restarts the cluster in sequence. This command must be executed on the cluster master server, which in this example is default-webseald-master.ibm.com.

server task default-webseald-master.ibm.com cluster restart -ripple

In this example, the following command can be used at any time after the previous request to monitor the progress of the cluster restart:

server task default-webseald-master.ibm.com cluster restart -status