Dynamic server trace extended operation

Edit online

The dynamic server trace extended operation explains its use with the server and provides the results.

Description
Use this extended operation to do the following actions:
  • Start or stop server-tracing dynamically
  • Set the level of debug data collected
  • Name the debug output file
This extended operation depends on the LDAP Trace Facility to be initialized with either the ldtrc command or the successful completion of the LDAP trace facility extended operation request on IBM® Verify Directory. See LDAP trace facility extended operation.
Note:
  1. This extended operation is always enabled.
  2. Global administrative group members have authority to run the dynamic server trace extended operation when it is directed to the directory server. However, global administrative group members do not have this authority when they request the extended operation against the Administration Server.
Request
OID
1.3.18.0.2.12.40
Syntax
The value consists of two integer values and an optional string. The first integer turns on tracing (1) or off (0). The second integer sets the debug level (0 to 65535) that controls the debug data that is directed to standard error (stderr) or a file. If the integers are missing, the request fails. If the value is -1, no change is made. The string value provides the file name and is optional. If no name is provided, the name is unchanged. If no name is ever provided, the debug output goes to stderr.
Response
OID
1.3.18.0.2.12.42
Syntax
The response is a string: 
Trace settingsactual: enable=%d%d trcEvents=%ld%ld
	level=0x%x0x%x log=[%s]%s
where values in the brackets show that the state after the extended operation is attempted. If the tracing is on, enable is 1. The trcEvents is 0 if the LDAP Trace Facility is not enabled. Non-zero values indicate that the server was successful in attaching to the LDAP Trace Facility shared memory buffer. The debug level is shown in hex. The log values is the name of the file that is used to collect the debug output. It might show stderr if the output is going to the console.
Behavior
This extended operation changes the global variables that are used to control debugging and tracing in the server. If trace is enabled but the debug level is 0, trace data (function entry and exit points, and other data) is captured in shared memory and nothing is written to the debug file or stderr. If the debug level is between 0 to 65535, different levels of debug data are output to the debug file or stderr. If the LDAP Trace facility is not initialized, no trace output is captured and no debug output is written.
The following persons are enabled to call the extended operation:
  • Primary Directory Administrator
  • Local Administration Group members with DirDataAdmin role
Note: If the extended operation is called by a user who does not have access, LDAP_INSUFFICIENT_ACCESS is returned.
This extended operation has the following possible return codes:
  • LDAP_SUCCESS
  • LDAP_INSUFFICIENT_ACCESS
  • LDAP_PROTOCOL_ERROR
This extended operation is not supported by the Administration Server.
Scope
Only the current server session is affected by this operation.
Auditing
The additional information in the audit log is: 
Trace=%d [1=on|0=off] debug=0x%x log=[%s]