Remotemount/authenticationkey: POST

Generates a new private or public RSA authentication key pair on 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.

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 POST /remotemount/authenticationkey request generates a new RSA authentication key pair (private and public) on a cluster that is used for remote mounting. Use GET /scalemgmt/v2/remotemount/authenticationkey to check whether a new authentication key is already generated. The new key is in addition to the currently active committed key. Both keys are accepted until the administrator runs the mmauth genkey commit command or PUT /scalemgmt/v2/remotemount/authenticationkey endpoint.

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 POST request.

Request headers

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

Request parameters

None.

Request data

None.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"String",
             "progress":"String,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"String",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "status":"Job status",
         }   
        ],
   }
For more information about the fields in the following data structures, see the links at the end of this topic.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"paging"
The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"result"
"commands":"String'
Array of commands that are run in this job.
"progress":"String'
Progress information for the request.
"exitCode":"Exit code"
Exit code of command. Zero is success, nonzero denotes failure.
"stderr":"Error"
CLI messages from stderr.
"stdout":"String"
CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
HTTP request type.
"url":"URL"
The URL through which the job is submitted.
"data":" "
Optional.
"jobId":"ID",
The unique ID of the job.
"submitted":"Time"
The time at which the job was submitted.
"completed":Time"
The time at which the job was completed.
"status":"RUNNING | COMPLETED | FAILED"
Status of the job.

Examples

The following example shows how to generate a new RSA authentication key pair.

Request URL: 
curl -k -u admin:admin001 -X POST --header 'content-type:application/json' --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/remotemount/authenticationkey'
The request URL with no field or filter parameter returns only the details that uniquely identify the object.
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": "..."
  },
  "job": [
    {
      "result": {
        "commands": "[''mmcrfileset gpfs0 restfs1001'', ...]",
        "progress": "[''(2/3) Linking fileset'']",
        "exitCode": "0",
        "stderr": "[''EFSSG0740C There are not enough resources available to create 
                   a new independent file set.'',  ...]",
        "stdout": "[''EFSSG4172I The file set {0} must be independent.'', ...]"
      },
      "request": {
        "type": "POST",
        "url": "/scalemgmt/v2/remotemount/authenticationkey",
        "data":  "nodesDesc": "[ 'mari-16:manager-quorum', 'mari-17::mari-17_admin' ]"
      },
      "jobId": "12345",
      "submitted": "2016-11-14 10.35.56",
      "completed": "2016-11-14 10.35.56",
      "status": "COMPLETED"
    }
  ]
}