server task sms session refresh all_sessions

Refreshes the credential for sessions for a specific user.

Syntax

server task server_namehost_name sms session refresh all_sessions user_name –realm realm_name

Options

–realm realm_name
Specifies that name of the realm. The credentials of only those sessions that belong to the specified realm are refreshed.
server_namehost_name
Specifies the name of the server or server instance. You must specify the server name in the exact format as it is shown in the output of the server list command.

For example, if the configured name of a single WebSEAL server on host example.dallas.ibm.com is default, the server_name would be default-webseald and the host_name would be example.dallas.ibm.com. For this example, the name of the server would be default-webseald-example.dallas.ibm.com.

If multiple server instances are configured on the same computer, for example:
  • The host isexample.dallas.ibm.com.
  • The configured name of the WebSEAL server instance is webseal2-webseald.
Then,
  • The server_name is webseal2-webseald.
  • The host_name is example.dallas.ibm.com.
  • The name of the server instance is webseal2-webseald-example.dallas.ibm.com.
user_name
Refreshes the credential for all sessions that are associated with the specified user. Examples of user names are dlucas, sec_master, and “Mary Jones".

Return codes

0
The command completed successfully.
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. This reference provides a list of the Security Access Manager error messages by decimal or hexadecimal codes.

Note: This command is available only when the session management command-line extensions are installed to a hosting authorization server.

Example

The following example refreshes all sessions for user johnq in the ibm.com realm:
pdadmin> server task default-webseald-cruz sms session refresh all_sessions johnq \
-realm ibm.com