Encryption/rkms: GET

Provides details about an RKM stanza.

Availability

Available on all IBM Storage Scale editions.

Description

The GET scalemgmt/v2/encryption/rkms request displays information on a remote key manager (RKM) server stanza. The RKM stanza refers to the block of configuration information that describes a registered key client. It is stored in the RKM.conf file. For more information about the fields in the data structures that are returned, see the mmkeyserv command.

Request URL

https://IP address of API server:<port>/scalemgmt/v2/encryption/rkms
where
rkms
Specifies the resource of this GET call.

Request headers

Content-Type: application/json
Accept: application/json

Request data

No request data.

Response data

{ 
    "jobs": [
        {
            "jobId": Job ID,
            "status": "RUNNING | COMPLETED | FAILED",
            "submitted": "Time and date",
            "completed": "Time and date",
            "runtime": Time,
            "request": {
                "type": "GET | POST | PUT | DELETE",
                "url": "Request URL"
            },
            "result": {
                "progress": [],
                "commands": [
                    "Command name "
                ],
                "stdout": [
                 "type": "Server type"
                 "kmipServerUri": "Server type"
                 "keyStore": "Keystore file"
                 "passphrase": "Password" 
                 "clientCertLabel": "Certification file label"
                 "tenantName": "Tenant name
                ],
                "stderr": [],
                "exitCode": Code            },
            "pids": []
        }
    ],
    "status": {
        "code": Status code,
        "message": "Status message"
    }
}
    }
For more information about the fields in the following data structures, see the links at the end of the topic.
"jobId": "Job ID"
The unique ID of the job.
"status": "RUNNING | COMPLETED | FAILED"
The status of the job.
"submitted": "Time and date"
The time and date when the job was submitted.
"completed": "Time and date"
The time at which the job was completed.
"runtime": "Time and date"
The time that the job took to run.
"request"
"type": "GET | POST | PUT | DELETE"
The request type.
"URL": "Request URL"
The URL through which the job is submitted.
"result"
"progress": Job progress
Progress information for the request.
"commands": "Command name
Array of commands that are run in this job.
"stdout": "message
Request Information.
"type": "Server type
The type of server.
"kmipServerUri": "Server location
The Server URL.
"keyStore": "Keystore file"
The keystore file.
"passphrase"
The Keystore password.
"clientCertLabel": "Certification file label.
Client certification file name.
"tenantName": "Tenant name"
The name of the tenant.
"exitCode":"Exit code"
Exit code of command. Zero indicates success and any other value denotes failure.
"stderr":"Error"
CLI messages from stderr.
"pids": "Process IDs
The process IDs for the job.
"status":
Return status.
"message": "ReturnMessage"
The return message.
"code": ReturnCode
The return code.

Examples

The following example gets information on the RKM server stanza.

Request data:
curl -X GET --header 'Accept: application/json' --header 'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 'https://198.51.100.1:443/scalemgmt/v2/encryption/rkms'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
    "jobs": [
        {
            "jobId": 3000000000011,
            "status": "COMPLETED",
            "submitted": "2021-06-21 05:22:28,005",
            "completed": "2021-06-21 05:22:28,309",
            "runtime": 304,
            "request": {
                "type": "GET",
                "url": "/scalemgmt/v2/encryption/rkms"
            },
            "result": {
                "progress": [],
                "commands": [
                    "mmkeyserv rkm show "
                ],
                "stdout": [
                    "lodestar1_devG1 {",
                    "  type = ISKLM",
                    "  kmipServerUri = tls://9.30.252.171:5696",
                    "  keyStore = /var/mmfs/ssl/keyServ/serverKmip.1_lodestar1.myclient2.1.p12",
                    "  passphrase = Ar1cent@123456Nigam",
                    "  clientCertLabel = myclient2",
                    "  tenantName = devG1",
                    "}",
                    "info: lodestar1_devG1 {\n  type = ISKLM\n  kmipServerUri = tls://9.30.252.171:5696\n  keyStore = /var/mmfs/ssl/keyServ/serverKmip.1_lodestar1.myclient2.1.p12\n  passphrase = Ar1cent@123456Nigam\n  clientCertLabel = myclient2\n  tenantName = devG1\n}\n"
                ],
                "stderr": [],
                "exitCode": 0
            },
            "pids": []
        }
    ],
    "status": {
        "code": 200,
        "message": "The request finished successfully."
    }
}