Specifying settings for debug information

You can change the default setting that IBM Security Key Lifecycle Manager uses to collect debug information. Debug log files provide additional information to analyze and troubleshoot IBM Security Key Lifecycle Manager problems.

About this task

You can use the Debug section of the Audit page to specify settings for generating debug information. Alternatively, you can use the following CLI commands or the REST interfaces to list or change the debug property in the SKLMConfig.properties file:

tklmConfigGetEntry and tklmConfigUpdateEntry
Get Single Config Property REST Service and Update Config Property REST Service

Your role must have a permission to the configure action.

Note: Enabling debug logging might affect IBM Security Key Lifecycle Manager performance. Enable this option only under the guidance of your IBM support representative.

Procedure

Go to the appropriate page or directory:
- Graphical user interface:
  Log on to the graphical user interface. Click IBM Security Key Lifecycle Manager > Configuration > Audit and Debug.
- Command-line interface
  1. Go to the <WAS_HOME>/bin directory. For example,
    
    Windows
    
    cd drive:\Program Files\IBM\WebSphere\AppServer\bin
    
    Linux
    
    cd /opt/IBM/WebSphere/AppServer/bin
  2. Start the wsadmin interface by using an authorized user ID, such as SKLMAdmin. For example,
    Windows
    
    wsadmin.bat -username SKLMAdmin -password mypwd -lang jython
    
    Linux
    
    ./wsadmin.sh -username SKLMAdmin -password mypwd -lang jython
- REST interface:
  - Open a REST client.
Change the settings to generate debug information:
- In the graphical user interface:
  1. Select Enable debug to set the following property values in the SKLMConfig.properties file:
```
debug=all
```
  2. Click OK.
- Command-line interface:
  1. Type the tklmConfigGetEntry command on one line to get the current value of the target property in the SKLMConfig.properties file. For example, to determine the value of debug, type on one line:
```
wsadmin>print AdminTask.tklmConfigGetEntry 
	('[-name debug]')
```
    An example response might be:
```
none
```
  2. Specify a new value for the property. For example, to specify the value all for generating debug logs, type on one line:
```
print AdminTask.tklmConfigUpdateEntry 
	('[-name debug -value all]')
```
- REST interface:
  1. Obtain a unique user authentication identifier to access IBM Security Key Lifecycle Manager REST services. For more information about the authentication process, see Authentication process for REST services.
  2. To run Get Single Config Property REST Service, send the HTTP GET request. Pass the user authentication identifier that you obtained in Step a along with the request message as shown in the following example.
```
GET https://localhost:<port>/SKLM/rest/v1/configProperties/debug
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
```
    Success response might be:
```
Status Code : 200 OK
Content-Language: en
{"property":"debug","value":"none"}
```
  3. Specify a new value for the property. Then, send the following HTTP request:
```
PUT https://localhost:<port>/SKLM/rest/v1/configProperties
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth authId=139aeh34567m
Accept-Language: en
{ "debug": "all"}
```
A success indicator varies, depending on the interface: