server task virtualhost throttle

The server task virtualhost throttle command places the server located at this virtual host junction in a throttled operational state.

Requires authentication (administrator ID and password) to use.

server task instance-webseald-host virtualhost throttle [-i server_uuid] vhost_label

The server task virtualhost throttle command places the server located at this virtual host 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 virtual host 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 at this virtual host junction are placed in a throttled operational state. Use the server task virtualhost show command to determine the ID of a specific back-end server.

vhost_label

Label name of the virtual host junction.

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/@vhost_label 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

In the following example, the virtual host junction with the label support-vhost-https, configured on the WebSEAL server abc.ibm.com, supports the virtual host support.ibm.com, located on the back-end junctioned server int3.ibm.com. There is a requirement to place the int3.ibm.com server in a throttled operational state. To determine the UUID of this junctioned server, run the server task virtualhost show command:

pdadmin> server task default-webseald-abc.ibm.com virtualhost show support-vhost-https

Output is similar to:

Virtual Host label: support-vhost-https
Type: SSL
...
Virtual hostname: support.ibm.com
Alias: ibm.com
Alias: support
Virtual Host junction protocol partner: support-vhost-http
Server 1:
ID: bacecc66-13ce-11d8-8f0a-09267ea5aa77
Server State: running
Operational State: Online
Hostname: int3.ibm.com
Port: 443
Server DN: 
Query_contents URL: /cgi-bin/query_contents
Query-contents: unknown
Case insensitive URLs: no
Allow Windows-style URLs: yes
Current requests: 0
Total requests: 1

Place this server in a throttled operational state using the following command:

pdadmin> server task default-webseald-cruz virtualhost throttle -i bacecc66-13ce-11d8-8f0a-09267ea5aa77 support-vhost-https

See also

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

Parent topic: Command reference