server task trace

Enables the gathering of trace information for components of installed Security Verify Access servers or server instances.

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

Syntax

server task server_name–host_name trace list [component]

server task server_name–host_name trace set component level [destination]

server task server_name–host_name trace show [component]

Description

The server task stats command enables the gathering of trace information for components of installed Security Verify Access servers or server instances that support debug event tracing. The content of trace messages is undocumented and is intended to be used for debugging purposes only. The format and content of trace messages might vary between product releases.

Options

list [component]

Lists all enabled trace components that are available to gather and report trace information. If you specify the component option and the component is enabled, the output lists that component; otherwise, no output is displayed. If you do not specify the component option, the output lists all enabled components.

server_name–host_name

Specifies the name of the server or server instance. You must specify the server name in the exact format as it is shown in the output of the server list command.

For example, if the configured name of a single WebSEAL server on host example.dallas.ibm.com is default, the server_name would be default-webseald and the host_name would be example.dallas.ibm.com. For this example, the name of the server would be default-webseald-example.dallas.ibm.com.

If multiple server instances are configured on the same computer, for example:

The host is example.dallas.ibm.com.
The configured name of the WebSEAL server instance is webseal2-webseald.

Then,

The server_name is webseal2-webseald.
The host_name is example.dallas.ibm.com.
The name of the server instance is webseal2-webseald-example.dallas.ibm.com.

set component level [destination]

Sets the trace level and trace message destination for a specific component and its subordinates. The value for the level option is a single integer from 1 to 9, with 9 reporting the most detailed level of information. The destination option specifies where the gathered trace information is written and can be one of the following options:

file path=file_name: Specifies the fully qualified file name.
log_agent: Specifies a destination for the statistics information that is gathered for the specified component. For more information about logging events, see the Administering topics in the IBM Knowledge Center.

show [component]

Shows the names and levels for all enabled trace components. If you specify the component option, the output lists the name and level for the specified component.

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 Verify Access error messages by decimal or hexadecimal codes.

Examples

The following example enables the pdweb.debug trace component to level 2 and then displays the output for all enabled components. WebSEAL–specific components are prefixed with pdweb.
```
pdadmin sec_master> server task webseald-instance_name trace set
pdweb.debug 2

pdadmin sec_master> server task webseald-instance_name trace show
```
Output from the trace show command is like:
```
pdweb.debug 2
```
The following example enables the pdwebpi.module.session-cookie trace component to level 9. Then, the output for all enabled components is displayed. Components that are specific to the web server plug-ins are prefixed with pdwebpi.
```
pdadmin sec_master> server task pdwpi-tivoli.com trace set
pdwebpi.module.session-cookie 9

pdadmin sec_master> server task pdwpi-tivoli.com trace show
```
Output from the trace show command is like:
```
pdwebpi.module.session-cookie 9
```