/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}:unlink: POST

Unlinks an IBM Storage Scale fileset.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}/filesets/{fileset_name}:unlink request unlinks an existing fileset. Removes the junction to an IBM Storage Scale fileset. The operation attribute for this command is LRO. To run this command, you must have the RBAC permission for the unlink action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}:unlink resource..

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}:unlink
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.
body The body of the request that contains the required parameters to be passed on to the IBM Storage Scale system to perform the requested operation. The required parameter is force, which forces the unlink operation to proceed even if there are open files. This parameter forcibly closes any open files, which results in an ESTALE error the next time the file is accessed. 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"
  }
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example unlinks an fileset:

Request data: 
curl -X 'POST' \
  'https://localhost:46443/scalemgmt/v3/filesystems/gpfs0/filesets/tf2:unlink' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "force": true
}'
Response data: 
{
	"name": "MTplZDIzN2EwMS00M2Y0LTQyNDctOTZkNy00MWYyZDg3NmM3ZDQ=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTplZDIzN2EwMS00M2Y0LTQyNDctOTZkNy00MWYyZDg3NmM3ZDQ=",
		"operation_details": {
			"@type": "type.googleapis.com/fileset.v3.UnlinkFilesetRequest",
			"filesystem": "gpfs0",
			"fileset_name": "tf2",
			"force": true
		},
		"status": "DONE",
		"request_time": "2025-04-14T19:43:10.855738830Z",
		"completion_time": "2025-04-14T19:43:10.928520309Z",
		"last_update_time": "2025-04-14T19:43:10.928520309Z",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/fileset.v3.Fileset",
		"name": "tf2",
		"fs_name": "gpfs0",
		"id": 2,
		"status": "FILESETSTATUS_UNLINKED",
		"path": "--",
		"domain_id": 0
	}
}