/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}: PATCH

Updates attributes of the fileset for the specified name.

Availability

Available on all IBM Storage Scale editions.

Description

The PATCH filesystems/{filesystem}/filesets/{fileset_name} request updates an existing fileset. The operation attributes for this request are LRO and update mask. To run this request, you must have the RBAC permission for the update action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name} resource.

Request URL

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

where

{filesystem}: Specifies the name of the file system.
{fileset_name}: Specifies the name of the fileset.

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 name of the file system.	Required.
fileset_name	The name of the fileset.	Required.
fileset	The fileset object that specifies the attributes to update.	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.

{
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

202: The request has been accepted for processing, but the processing has not been completed.c
```
{}
```

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example updates attributes of a fileset:

Request data:

curl -X 'PATCH' \
  'https://localhost:46443/scalemgmt/v3/filesystems/gpfs0/filesets/tf1' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "testfset1"
}'

Response data:

{
	"name": "MTo2OTExZjdlNi1mMDQwLTQwYjctOWRjYy04ZmI4OTU4NmNmMmI=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTo2OTExZjdlNi1mMDQwLTQwYjctOWRjYy04ZmI4OTU4NmNmMmI=",
		"operation_details": {
			"@type": "type.googleapis.com/fileset.v3.UpdateFilesetRequest",
			"filesystem": "gpfs0",
			"fileset_name": "tf1",
			"fileset": {
				"name": "testfset1"
			},
			"update_mask": ""
		},
		"status": "DONE",
		"request_time": "2025-04-14T19:13:10.617916930Z",
		"completion_time": "2025-04-14T19:13:10.647830528Z",
		"last_update_time": "2025-04-14T19:13:10.647830528Z",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/fileset.v3.Fileset",
		"name": "testfset1",
		"fs_name": "gpfs0",
		"id": 1,
		"root_inode": "16576",
		"status": "FILESETSTATUS_UNLINKED",
		"path": "--",
		"create_time": "2024-10-24T20:10:58Z",
		"comment": "",
		"inode_space": 0,
		"alloc_inodes": "0",
		"perm_change_flag": "PERMCHANGEFLAG_CHMODANDSETACL",
		"perm_inherit_flag": "PERMINHERITFLAG_INHERIT_ACL_ONLY",
		"iam_mode": "IAMMODE_OFF",
		"afm_associated": false,
		"domain_id": 0
	}
}