server task help
Lists detailed help information about a specific server task command.Requires authentication (administrator ID and password) to use.
server task instance-webseald-host help task
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.
- task
- Lists detailed help for the specified task, such as the command syntax, the description, and the valid options.
Authorization
No special authorization required.
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 which provides a list of the ISAM error messages by decimal or hexadecimal codes.
Examples
- The following example displays output after requesting help for the server task add command at the abc.ibm.com WebSEAL server:
pdadmin> server task default-webseald-abc.ibm.com help add
Output is similar to:
Command: add <options> <junction point> Description: Adds an additional server to a junction Usage: TCP and SSL Junction Flags -iServer treats URLs as case insensitive. -h <hostname>Target host (required flag). -p <port>TCP port of server. Default is 80 for TCP junctions 443 for SSL junctions. -H <hostname>Proxy hostname. -P <port>Port of proxy server. -D <"DN">The Distinguished Name of the server -q <relative url> URL for query_contents script. -u <UUID>(stateful junctions only). -v <hostname>Virtual hostname for server. -wWin32 file system support. -jScripting support for junction. Common Flags <junction point>Where to create the junction
The following example displays the output after requesting help for the server task create command at the abc.ibm.com WebSEAL server: pdadmin> server task default-webseald-abc.ibm.com help createOutput is similar to:Command: create -t <type> <options> <junction point> Description: Creates a new junction Usage: create -t <type> <options> <junction point> TCP and SSL Junction Flags ... Common Flags -t <type>Type of junction. One of: tcp, tcpproxy, ssl, sslproxy, local. -fForce the creation: overwrite existing junction. -RWebSEAL will send the Boolean Rule Header to these junctions when a rule failure reason is provided. <junction point>Where to create the junction
See also
helpParent topic: Command reference