Use Stop Multi-Master Cluster REST Service to stop the IBM® Security Guardium® Key Lifecycle Manager server. You can run this REST service on any
master server.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/ckms/config/nodes/stopCluster
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. |
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 value that is specified by the message
property. |
message |
Returns the status message that indicates success or failure of the
operation. |
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. |
Example
- Stop the Multi-Master cluster service
-
POST https://localhost:port/SKLM/rest/v1/ckms/config/nodes/stopCluster
-
- Success response
-
{
"code": "CTGKM3435I",
"status": "CTGKM3435I The Multi-Master cluster is stopped."
}
-
- Error response 1
-
{
"code": "CTGKM3440E",
"status": "CTGKM3440E WebSphere Application Server is unreachable on the master servers: klmlee.
Check the network connectivity and ensure that the WebSphere Application Server is running."
}
- Error response 2
-
{
"code": "CTGKM3434E",
"status": "Failed to stop the Multi-Master cluster. Check logs for more information."
}