Remotemount/remoteclusters/{remoteCluster}: GET

Gets the details of the cluster that mounts file systems of an owning cluster remotely. This API must be run on a cluster that mounts file systems remotely.

Availability

Available on all IBM Storage Scale editions.

Description

The GET /remotemount/remoteclusters/{remoteCluster} gets the details of the cluster that mounts file systems of an owning cluster 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/remoteclusters/{remoteCluster}

where

remotemount/remoteclusters/{remoteCluster}: Specifies the target of the GET request.

Request headers

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
remoteCluster	Name of the remote cluster.	Required.

Request data

No request data.

Response data

{  
  "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   }
   "remoteClusters": 
    {
      "remoteCluster": "Name of the cluster",
      "ciphers": "Ciphers of the RSA key", 
      "keyDigest": "SHA digest of the public key",
      "owningClusterFilesystems": "Name of the file system of the owning cluster.",
    }
   "OwningFilesystem"
     {
      "filesystem ": "File system on the owning cluster",
      "access ": "Access permissions",  
     }
  }

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

"remoteClusters":

Owning cluster details.

"remoteCluster": "Name of the cluster": The cluster that remotely mounts the file systems of the owning cluster
"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.
"keyDigest": "SHA digest of the public key": The SHA digest of the public key of the remote cluster.
"owningClusterFilesystems": "Name of the owning cluster file systems.": The names of file system of owning cluster and the access permissions to them. Optional.

"OwningFilesystem ":

Owning file system details.

"filesystem ": "File system on the owning cluster": The name of the owning cluster filesystem You can also use the keyword 'all' when addressing all file systems of the owning cluster.
"access": "Access permissions": The access permissions to the owning cluster file system.

"status":

Return status.

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

Examples

The following example shows how to get the details of the cluster Cluster1 that mounts file system remotely.

Request data:

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

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": "..."
  },
  "remoteClusters": [
    {
      "remoteCluster": "Cluster1",
      "ciphers": "[ 'AES128-SHA', 'AES256-SHA' ]",
      "keyDigest": "string",
      "owningClusterFilesystems": "{ {'name':'gpfs0', 'access':'rw'}, {'name':'gpfs1', 'access':'ro'} }"
    }
  ]
}