/scalemgmt/v3/filesystems/remote/{filesystem}: PATCH

Updates the information associated with a remote file system.

Availability

Available on all IBM Storage Scale editions.

Description

The PATCH filesystems/remote/{filesystem} request updates the information that is associated with a remote file system.

Request URL

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

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
name The name of the file system. Required.
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 updates the mount point of a remote file system:

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