server task throttle
The server task throttle command places the server located at this junction in a throttled operational state.
Requires authentication (administrator ID and password) to use.
server task instance-webseald-host throttle [-i server_uuid] junction_point
The server task throttle command places the server located at this junction in a throttled operational state. Only requests from users who have created a session with WebSEAL prior to the invocation of this command continue to have their requests processed by the specified server. If a server is not specified, all servers that are located at this junction are placed in a throttled operational state.
Options
- instance-webseald-host
- Full server name of the installed WebSEAL 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 instance. The webseald designation indicates the WebSEAL service performs the command task. The host_name is the name of the physical machine where the WebSEAL server is installed.
For example, if the configured name of a single WebSEAL instance is default, and host machine name where the WebSEAL server is installed is abc.ibm.com, the full WebSEAL server name is default-webseald-abc.ibm.com.
If an additional WebSEAL instance is configured and named web2, the full WebSEAL server name is web2-webseald-abc.ibm.com.
- -i server_uuid
- UUID of the server to throttle. If a server is not specified, all servers that are located at this junction are placed in a throttled operational state. Use the server task show command to determine the ID of a back-end server.
- junction_point
- Name of the directory in the WebSEAL protected object space where the document space of the back-end 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 has permission by default.
Return codes
- 0
- The command completed successfully. For WebSEAL server task commands, the return code becomes 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 ISAM error messages by decimal or hexadecimal codes.
Examples
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 similar to:
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 throttleParent topic: Command reference