server task help

Lists detailed help information about a specific server task command.

Requires authentication (administrator ID and password) to use this command.

Syntax

server task instance_name-webseald-host_name help task

Options

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.

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. This reference provides a list of the Security Access Manager error messages by decimal or hexadecimal codes.

Examples

  • The following example displays output after help is requested 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 like: 
    Command:
add <options> <junction point>
Description:
Adds an additional server to a junction
Usage:
TCP and SSL Junction Flags
-i Server 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.
-w Win32 file system support.
-j Scripting support for junction.
Common Flags
<junction point> Where to create the junction
  • The following example displays the output after help is requested for the server task create command at the abc.ibm.com WebSEAL server: 
    pdadmin> server task default-webseald-abc.ibm.com help create
    Output is like: 
    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.
-f Force the creation: overwrite existing junction.
-R WebSEAL 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

help