/scalemgmt/v3/filesystems:unmount: POST

Unmounts all IBM Storage Scale file systems.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems:unmount request unmounts all file system on one or more nodes in the cluster. If no nodes are specified, the file system is unmounted only from the node where request was issued. To force unmount a file system from a cluster, use the --cluster-name option. The operation attributes for this request are LRO, target nodes, and, batch operation. To run this request, you must have the RBAC permission for the unmount action on the /scalemgmt/v3/filesystems:unmount resource.

Note: If a file system is unmounted forcefully by using the cluster option, affected nodes might still show the file system as mounted, but data is inaccessible. System administrators must issue a manual unmount request to synchronize the state.

Request URL

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

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
body	The body of the request that contains the following parameters to be passed on to the IBM Storage Scale system to perform the requested operation: `{ "force": false, "target_nodes": { "node_class": { "node_classes": [ "string" ] }, "node_list": { "nodes": [ "string" ] } } }`	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 and additional content was sent.
```
{}
```
202: The request has been accepted for processing, but the processing has not been completed.
```
{}
```

Examples

The following example unmount all file systems:

Request data:

curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/filesystems:unmount' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{"force": true,"target_nodes": {"node_class": {"node_classes": ["all"]}}}' -k -n

Response data:

{
  "name": "MTo0MDczM2VkZC03MjdhLTRlNzgtOTYwNC0yNzZkZGVkMjA0YWQ=",
  "metadata": {
    "@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
    "job_id": "MTo0MDczM2VkZC03MjdhLTRlNzgtOTYwNC0yNzZkZGVkMjA0YWQ=",
    "operation_details": {
      "@type": "type.googleapis.com/filesystem.v3.UnmountAllFilesystemsRequest",
      "force": true,
      "target_nodes": {
        "node_class": {
          "node_classes": ["all"]
        }
      }
    },
    "status": "DONE",
    "request_time": "2025-03-31T21:10:48.606757198Z",
    "completion_time": "2025-03-31T21:10:48.620648261Z",
    "last_update_time": "2025-03-31T21:10:48.620648261Z",
    "domain_ids": [0]
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/filesystem.v3.UnmountAllFilesystemsResponse",
    "succeeded": [
      {
        "node": "lancelot-41.openstacklocal",
        "filesystem": "remotefs1"
      },
      {
        "node": "lancelot-42.openstacklocal",
        "filesystem": "remotefs1"
      },
      {
        "node": "lancelot-41.openstacklocal",
        "filesystem": "fs1"
      },
      {
        "node": "lancelot-42.openstacklocal",
        "filesystem": "fs1"
      }
    ]
  }
}