Tracing data for the API

Edit online

You can enable tracing for the application programming interface (API).

To enable tracing for the IBM Storage Protect API, add the following lines to the dsm.opt file or another file designated as the client options file: 
TRACEFILE trace_file_name
TRACEFLAGS trace_flags
trace_file_name
The name of the file where you want to write the trace data.
trace_flags
The list of trace flags to enable. Separate each trace flag by a space. The following trace flags are specific to the IBM Storage Protect API:
api
Information about the API function calls
api_detail
Detailed information about the API function calls
You can also specify other backup-archive client and IBM Storage Protect API trace flags. For the list of other available trace classes, see Client trace classes. For example:
  • TRACEFILE /log/trace.out
  • TRACEFLAGS api api_detail pid tid verbinfo verbdetail
Important: If you do not have write permission for the file specified by the TRACEFILE option, the API calls such as dsmSetup, dsmInitEx, or dsmInit fail with return code DSM_RC_CANNOT_OPEN_TRACEFILE (426).

To enable tracing for the multithreaded API after an application is started, use the dsmtrace utility. The dsmtrace utility lets you turn on tracing while the problem is occurring, without having trace constantly enabled. Refer to the dsmtrace section.