Remotemount/owningclusters/{owningCluster}: PUT

Update registration of a cluster that owns file systems that can be mounted remotely. This API must be run on a cluster that mounts file systems remotely.

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 PUT remotemount/owningclusters/{owningCluster} request update registration of a cluster that owns file systems that can be mounted remotely. For more information about the fields in the data structures that are returned, see mmremotecluster command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/remotemount/owningclusters/{owningCluster}
where
remotemount/owningclusters/{owningCluster}
Specifies the cluster for which the registration needs to be updated. Required.

Request headers

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

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
owningCluster Name of the target cluster. Required.
body Body of the request that contains the required parameters to be passed on to the IBM Storage Scale system to perform the requested operation. Required.

Request data

"owningClusters": 
{ 
"owningCluster": "Name of the cluster", 
"contactNodes": "Contact nodes of owning cluster", 
"keyDigest": "SHA digest of the public key", 
"filesystemPairs": "File system mapping", } 
"filesystemPair" { "owningClusterFilesystem ": 
"File system on the owning cluster", 
"owningClusterFilesystem ": "File system on the remote cluster"
}
"owningClusters":
Owning cluster details.
"owningCluster": "Name of the cluster"
The owning cluster of the remote file system.
"contactNodes": "Contact nodes of owning cluster"
The contact nodes of the owning cluster used for remote mounting.
"keyDigest": "SHA digest of the public key"
The SHA digest of the public key of the owning cluster.
"filesystemPairs": "File system mapping"
The mapping of file systems of owning cluster and remote cluster.
"filesystemPair":
File system pair details.
"owningClusterFilesystem": "File system on the owning cluster"
The file system on the owning cluster.
"owningClusterFilesystem": "File system on the remote cluster"
The file system on the remote cluster.

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, and 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 update the registration of the cluster Cluster1.

Request URL: 
curl -k -u admin:admin001 -X PUT --header 'content-type:application/json' --header 'accept:application/json' 
-d '{ \ 
   "owningCluster": "Cluster1", \ 
   "contactNodes": "[%27node1%27, %27node2%27]", \ 
   "key": [ \ 
     "string"
'https://198.51.100.1:443/scalemgmt/v2/remotemount/owningclusters/Cluster1'
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": "PUT",
        "url": "/scalemgmt/v2/remotemount/owningclusters/Cluster1",
        "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"
    }
  ]
}