Update Db2 Password On All Masters REST Service

Use Update DB2 Password On All Masters REST Service to update Db2® password on all the IBM® Security Guardium® Key Lifecycle Manager masters in the multi-master cluster when the Db2 password is changed. You must run this REST service to ensure that Db2 is connected to Guardium Key Lifecycle Manager server agent after the Db2 password change.

Operation: POST
URL: https://<host>:<port>/SKLM/rest/v1/ckms/config/nodes/updateDB2PasswordForCluster

By default, Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM Security Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters

Parameter	Description
host	Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server.
port	Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests.

Request Headers

Header name	Value
Content-Type	`application/json`
Accept	`application/json`
Authorization	`SKLMAuth userAuthId=<authIdValue>`
Accept-Language	Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, `en` or `de`.

Request body

JSON object with the following specification:

Property name	Description
clusterName	Specify the Guardium Key Lifecycle Manager server multi-master cluster name.
newDb2Password	Specify the new DB2® password. Passwords must conform to rules that are described in the Updating Db2 password on a Windows system and Updating Db2 password on a Linux or AIX system topics.

Response

Response Headers

Header name	Value and description
Status Code	200 OK The request was successful. The response body contains the requested representation. 400 Bad Request The authentication information was not provided in the correct format. 401 Unauthorized The authentication credentials were missing or incorrect. 404 Not Found Error The processing of the request fails. 500 Internal Server Error The processing of the request fails because of an unexpected condition on the server.
Content-Type	`application/json`
Content-Language	Locale for the response message.

Success response body

JSON object with the following specification:

JSON property name	Description
code	Returns the code that is specified by the `status` property.
status	Returns the status to indicate whether the password of DB2 was successfully updated.

Error Response Body

JSON object with the following specification.

JSON property name	Description
code	Returns the application error code.
message	Returns a message that describes the error.

Examples

Service request to update DB2 password on all Guardium Key Lifecycle Manager server masters in the cluster

POST https://localhost:<port>/SKLM/rest/v1/ckms/config/nodes/updateDB2PasswordForCluster
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
{
"clusterName":"multimaster",
"newDb2Password":"SKLM@db2"
}

Success response

Status Code: 200 OK
{"code":"0","status":"CTGKM3014I DB2 password for SKLM Multi-Master cluster updated successfully."}

Error response

{"code":"CTGKM6002E",
"message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}