/scalemgmt/v3/filesystems/{filesystem}:mount: POST

Mounts an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}:mount request mounts an IBM Storage Scale file system on one or more nodes in the cluster. If no nodes are specified, the file system is mounted only on the node where the request is issued. The operation attributes for this request are LRO, target nodes, and remote errors. To run this request, you must have the RBAC permission for the mount action on the /scalemgmt/v3/filesystems:mount resource.

Request URL

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

where

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

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.
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: `{ "mount_options": "string", "mount_point": "string", "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.
```
{}
  
```

Examples

The following example mounts the fs1 file system for all node classes:

Request data:

curl -X 'POST' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs1:mount' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "mount_options": "ro",
  "mount_point": "/gpfs/fs1",
  "target_nodes": {
    "node_class": {
      "node_classes": [
        "all"
      ]
    }
  }
}' -k -n

Response data:

{
	"name": "MToxNDc3MGRkMS1hMjRiLTRmNzMtODZkNS1jNmMwMGY2MWI0YTc=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MToxNDc3MGRkMS1hMjRiLTRmNzMtODZkNS1jNmMwMGY2MWI0YTc=",
		"operation_details": {
			"@type": "type.googleapis.com/filesystem.v3.MountFilesystemRequest",
			"filesystem": "fs1",
			"mount_point": "/gpfs/fs1",
			"mount_options": "ro",
			"target_nodes": {
				"node_class": {
					"node_classes": [
						"all"
					]
				}
			}
		},
		"status": "DONE",
		"request_time": "2025-03-31T21:02:33.489648761Z",
		"completion_time": "2025-03-31T21:02:34.417130141Z",
		"last_update_time": "2025-03-31T21:02:34.417130141Z",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/filesystem.v3.MountFilesystemResponse"
	}
}