server task trace

Edit online

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 trace 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 generally undocumented and is intended to be used for debugging purposes only. The format and content of trace messages might vary between product releases.

Options

component

Specifies the component for which to enable (set) tracing.

destination

Specifies where the gathered statistics are written, where destination can be one of the following:

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

level

Specifies the level of tracing. The supported values for this option are 1 through 9, with 9 reporting the most detailed level of information in the trace log.

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 Reverse Proxy server on host cruz.dallas.ibm.com is default, the server_name would be default-webseald and the host_name would be cruz.dallas.ibm.com. For this example, the name of the server would be default-webseald-cruz.dallas.ibm.com.

If there are multiple configured server instances on the same machine, for example, the host cruz.dallas.ibm.com, and the configured name of the Reverse Proxy server instance is webseal2-webseald, the server_name would be webseal2-webseald and the host_name would be cruz.dallas.ibm.com. For this example, the name of the server instance would be webseal2-webseald-cruz.dallas.ibm.com.

trace 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.

trace 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.

trace 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). For more information, refer to the Messages topics in the Knowledge Center.

Examples

The following example enables the pdweb.debug trace component to level 2. Then displays the output for all enabled components. Note that Reverse Proxy–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 similar to:
```
pdweb.debug 2
```
The following example enables the pdwebpi.module.session-cookie trace component to level 9. Then displays the output for all enabled components. 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 similar to:
```
pdwebpi.module.session-cookie 9
```