server task virtualhost online
Places the server that is at this virtual host junction in an online operational state.
Requires authentication (administrator ID and password) to use this command.
Syntax
server task instance_name-webseald-host_name virtualhost online [–i server_uuid] vhost_label
Description
The server task virtualhost online command places the server that is at this virtual host junction in an online operational state. The server now resumes normal operation. If a server is not specified, all servers that are at this virtual host junction are placed in an online operational state.
Options
- –i server_uuid
- UUID of the server to place in an online operational state. If a server is not specified, all servers that are at this virtual host junction are placed in an online operational state. Use the server task virtualhost show command to determine the ID of a specific server. (Optional)
- instance_name-webseald-host_name
- Specifies the full server name of the installed WebSEAL server
instance. You must specify this full server name 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 that 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.
- vhost_label
- Specifies the 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 is given this permission by default.
Return codes
- 0
- The command completed successfully. Note: 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 Security Access Manager error messages by decimal or hexadecimal codes.
Example
- The virtual host junction:
- Has the label support-vhost-https.
- Is configured on the WebSEAL server abc.ibm.com.
- Supports the virtual host support.ibm.com
- The virtual host support.ibm.com is on the junctioned server int3.ibm.com.
pdadmin> server task default-webseald-abc.ibm.com \
virtualhost show support-vhost-https 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: Offline
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: 1pdadmin> server task default-webseald-cruz virtualhost online \
-i bacecc66-13ce-11d8-8f0a-09267ea5aa77 support-vhost-https