server task throttle

Places the server that is at this junction in a throttled operational state.

server task instance-webseald-host throttle [-i server_uuid] junction_point

The server task throttle command places the server that is at this junction in a throttled operational state. Users can create a session with WebSEAL before the invocation of this command. Only requests from such users are processed by the specified server. If a server is not specified, all servers that are at this junction are placed in a throttled operational state.

Options

-i server_uuid

UUID of the server to throttle. If a server is not specified, all servers that are at this junction are placed in a throttled operational state. Use the server task show command to determine the ID of a specific server. (Optional)

instance-webseald-host

Full server name of the installed WebSEAL server instance. Specify in the exact format as displayed in the output of the server list command.

The instance_name specifies the configured name of the WebSEAL server instance. The webseald designation indicates the WebSEAL service performs the command task. The host_name is the name of the physical computer where the WebSEAL server is installed. For example:

• The configured name of a single WebSEAL server instance is default.
• The host computer name where the WebSEAL server is installed is abc.ibm.com.

Then, the full WebSEAL server name is default-webseald-abc.ibm.com.

If an additional WebSEAL server instance is configured and named web2, the full WebSEAL server name is web2-webseald-abc.ibm.com.

junction_point

Name of the directory in the WebSEAL protected object space where the document space of the server is mounted.

Authorization

Users and groups that require access to this command must be given the c (control) permission in the ACL that governs the /WebSEAL/host_name-instance_name/junction_point object. For example, the sec_master administrative user is given this permission by default.

Return codes

0

The command completed successfully. For WebSEAL server task commands, the return code is 0 when the command is sent to the WebSEAL server without errors. However, even after the command was successfully sent, the WebSEAL server might not be able to successfully complete the command. The WebSEAL server returns 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. This reference provides a list of the ISAM error messages by decimal or hexadecimal codes.

This command is available only when WebSEAL is installed.

Example

The following example places the backappl server located at the /pubs junction point in a throttled operational state. To determine the UUID of this junctioned server, run the server task show command:

pdadmin> server task default-webseald-cruz show /pubs

Output is like:

Junction point: /pubs
...
Server 1:
ID: 6fc3187a-ea1c-11d7-8f4e-09267e38aa77
Server State: running
Operational State: Online
Hostname: backapp1.diamond.example.com
...
Current requests: 0
...

Place this server in a throttled operational state:

pdadmin> server task default-webseald-cruz throttle \
-i 6fc3187a-ea1c-11d7-8f4e-09267e38aa77 /pubs

See also

server task offline
server task online
server task virtualhost offline
server task virtualhost online
server task virtualhost throttle

Parent topic: pdadmin commands