Check Prerequisites REST Service

Use Check Prerequisites REST Service to verify whether the master server that you want to add to the cluster meets all requirements and conditions that are defined for IBM Security Key Lifecycle Manager multi-master configuration.

You can use Check Prerequisites REST Service to check whether the following conditions are met:

DB2 and operating system levels are the same as that of the primary master.
Database name and password are same on both the systems.
Ports of the master server that you want to add are valid and accessible.
The system has permission to read-write-execute on the /tmp folder.
IBM Security Key Lifecycle Manager master server is freshly installed.
Remote agent is accessible.
The specified IBM Security Key Lifecycle Manager user credentials are valid.

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

By default, IBM Security Key Lifecycle Manager server listens to non-secure port 80 (HTTP) and secure port 443 (HTTPS) for communication. During IBM Security Key Lifecycle Manager installation, you can modify these default ports. If you are using the default port for HTTP or HTTPS, the port is an optional part of the URL.

Request

Request Parameters

Parameter	Description
host	Specify the IP address or host name of the IBM Security Key Lifecycle Manager server.
port	Specify the port number on which the IBM Security 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 Key Lifecycle Manager. For example: `en` or `de`

Request body

JSON object with the following specification:

Property name	Description
ipHostname	Specify the IP address or host name of the IBM Security Key Lifecycle Manager server master server that you are adding.
clusterName	Specify the name for the multi-master cluster to which the master to be added.
sklmUsername	Specify the name of the IBM Security Key Lifecycle Manager server administrator.
sklmPassword	Specify the password for the IBM Security Key Lifecycle Manager server administrator.
wasUsername	Specify the WebSphere® Application Server login user ID for the IBM Security Key Lifecycle Manager server administrator profile.
wasPassword	Specify the password for the WebSphere Application Server login user ID.
sklmUIPort	Specify the port number on which the IBM Security Key Lifecycle Manager server listens for requests from devices that communicate by using the SSL protocol.
standbyHadrPort	Specify the HADR port of the standby server.

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. 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 configuration of masters in the cluster you specify was successful.

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 check whether the master server meets all the configuration conditions

POST https://localhost:<port>/SKLM/rest/v1/ckms/nodes/checkPreRequisite
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
{
  "ipHostname" : "civ4cez199",
  "clusterName" : "multimaster",
  "sklmUsername" : "sklmadmin",
  "sklmPassword" : "SKLM@admin123",
  "wasUsername" : "wasadmin",
  "wasPassword" : "WAS@admin123",
   "sklmUIPort" : "443",
  "standbyHadrPort" : "60020"
}

Success response

Status Code: 200 OK
{"code":"0","status":"CTGKM3002I civ4cez199 met all the pre requisites and can be added into the cluster."}

Error response

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