Remotemount/remotefilesystems/{remoteFilesystem}: GET

Lists the details of a remote file system. 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/remotefilesystems/{remoteFilesystem} gets the details of a remote file system. For more information about the fields in the data structures that are returned, see mmremotefs command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/remotemount/remotefilesystems/{remoteFilesystem}

where

remotemount/remotefilesystems/{remoteFilesystem}: 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
remoteFilesystem	Name of the remote file system.	Required.

Request data

No request data.

Response data

{  
  "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   }
   "remoteFilesystems": [
    {
      "remoteFilesystem": "Remote file system name",
      "owningFilesystem": "Owning file system name",
      "owningCluster": "Owning cluster name",
      "remoteMountPath": "Remote mount path of the file system",
      "mountOptions": "Mount options",
      "automount": "Status of the auto mount"
    }
  ]

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

"remoteFilesystems":

Remote file system details.

"remoteFilesystem": "Remote file system name": The name of the remote file system on the remote cluster.
"owningFilesystem": "Owning file system name": The name of the file system on the owning cluster.
"owningCluster": "Owning cluster name": The owning cluster of the remote file system.
"remoteMountPath": "Remote mount path of the file system": The remote mount path of the remote file system.
"mountOptions": "Mount options": The mount options of the remote file system.
"automount": "Status of the auto mount": The automount status of the remote 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 file system RemoteFilesystem1.

Request data:

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

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": "..."
  },
   "remoteFilesystems": [
    {
      "remoteFilesystem": "RemoteFilesystem1",
      "owningFilesystem": "Owningfileystem1",
      "owningCluster": "Cluster1",
      "remoteMountPath": "string",
      "mountOptions": "string",
      "automount": "string"
    }
  ]