Remotemount/authenticationkey: GET

Gets the public RSA authentication key of a cluster that is used for remote mounting. This API can be run on the cluster that owns the file systems and the cluster that remotely mounts file systems. The public authentication key can be used as input for POST and PUT request of the endpoints /remotemount/owningclusters and /remotemount/remoteclusters.

Availability

Available on all IBM Storage Scale editions.

Note: Only the users with user roles Administrator or Container Operator have permission to use this REST API endpoint.

Description

The GET /remotemount/authenticationkey request gets the public RSA authentication key of a cluster that is used for remote mounting. For more information about the fields in the data structures that are returned, see mmauth command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/remotemount/authenticationkey

where

remotemount/authenticationkey: Specifies the target of this GET request.

Request headers

Accept: application/json

Request data

No request data.

Response data

{  
  "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   }
  "key": "Active public RSA key",
  "newKey": "New public RSA key",
  "ciphers": "Ciphers of the RSA key",   
  }

For more information about the fields in the following data structures, see the links at the end of this topic.

"key": "Active public RSA key": The currently active public RSA key.
"newKey": "New public RSA key": A newly generated public RSA key. This key becomes active when it is committed. To commit this new key, use the endpoint PUT /scalemgmt/v2/remotemount/authenticationkey.
"ciphers": Ciphers of the RSA key": The list of ciphers of the RSA key. It sets the security mode for communications between the current cluster and the remote cluster. For more information on the list of ciphers, see mmauth command.

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

Examples

The following example gets the public RSA authentication key that is required for remote mounting.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/scalemgmt/v2/remotemount/authenticationkey'

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.

{
  "status": {
    "code": 200,
    "message": "..."
  },
  "key": [
    "string"
  ],
  "newKey": [
    "string"
  ],
  "ciphers": "[ 'AES128-SHA', 'AES256-SHA' ]"
}