Use the Test Connection REST Service to test whether the communication
between the Guardium® Key Lifecycle Manager server master that you are
adding and the current master server is successful.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/ckms/nodes/testNodeConnection
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 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 name of the multi-master cluster to which the master is
added. |
ipHostname |
Specify the IP address or host name of the Guardium Key Lifecycle Manager server master server. |
sklmUsername |
Specify the name of the Guardium Key Lifecycle Manager server administrator. |
sklmPassword |
Specify the password for the Guardium Key Lifecycle Manager server administrator. |
httpPort |
Specify the port number on which the Guardium Key Lifecycle Manager server listens for requests from devices that
communicate by using the TLS protocol. |
type |
Specify the Guardium Key Lifecycle Manager server
instance type. For example, Primary, Standby, or
Node. |
autoaccept |
Specify whether the cluster automatically accepts the certificate of the
master server that is being added. This property has two values: true,
false. The default value is false, which indicates
that the cluster does not automatically accept the certificate of the master server that is being
added. |
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 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 run a test connection between masters
POST https://localhost:<port>/SKLM/rest/v1/ckms/nodes/testNodeConnection
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
[
{
"clusterName" : "multimaster"
},
{
"ipHostname" : "cimkc2b151",
"sklmUsername" : "sklmadmin",
"sklmPassword" : "your_sklmadmin_password",
"httpPort" : "443",
"type" : "node",
"autoaccept" : "true"
}
]
- Success response
Status Code: 200 OK
{
"code":"0",
"status":"CTGKM2981I Connection to cimkc2b151 is successful"}
- Error response
{"code":"CTGKM6002E",
"message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}