/scalemgmt/v3/filesystems/remote: POST

Adds a remote file system.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/remote request adds a remote file system. Use this command to add file systems that belong to another IBM Storage Scale cluster that are known to the nodes of the accessing cluster.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/remote

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
filesystem The body of the request that contains the parameters that are sent to IBM Storage Scale to perform the requested operation. Required.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.
    {
  "additional_mount_options": "string",
  "automatic_mount_option": "YES_AUTO",
  "default_mount_point": "string",
  "mount_priority": 0,
  "name": "string",
  "owning_cluster": "string",
  "remote_name": "string"
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example adds a remote file system on the accessing cluster:

Request data: 
curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/filesystems/remote' \
  -H 'accept: application/json' -n -k \
  -H 'Content-Type: application/json' \
  -d '{
  "automatic_mount_option": "YES_AUTO",
  "default_mount_point": "/gpfs/remotefs1",
  "name": "remotefs1",
  "owning_cluster": "owningCluster1",
  "remote_name": "fs1"
}'
Response data: 
{
	"name":  "remotefs1",
	"remote_name":  "fs1",
	"owning_cluster":  "owningCluster1",
	"automatic_mount_option":  "YES_AUTO",
	"default_mount_point":  "/gpfs/remotefs1"
}