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

Links an IBM Storage Scale fileset.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}/filesets/{fileset_name}:link request links an existing IBM Storage Scale fileset. Creates a junction that references the root directory of a fileset.

A junction is a special directory entry, similar to a POSIX hard link that connects a name in a parent fileset directory to the root directory of a child fileset. From a user's perspective, a junction always appears as a directory. However, users cannot remove a junction using the unlink or rmdir commands. To remove a junction, use unlink. If you don’t specify a junction, it is created in the current directory with the name FilesetName. You can use the mv command to move the directory to a new location within the parent fileset. However, you cannot use mv to move the junction to a different fileset.

To run this command, you must have the RBAC permission for the link action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}:link resource.

Request URL

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

where

filesystems/{filesystem}/filesets/{fileset_name}:link: Specifies fileset as the target for the link operation. Required.
{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 `junction_path`.	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.

{
  "alloc_inodes": "string",
  "comment": "string",
  "create_time": "2024-10-29T04:46:20.822Z",
  "data_in_kb": "string",
  "domain_id": 0,
  "fal_status": "FALSTATUS_DEFAULT",
  "free_inodes": "string",
  "fs_name": "string",
  "iam_mode": "IAMMODE_OFF",
  "id": 0,
  "inode_space": 0,
  "inode_space_designation": "string",
  "inode_space_mask": "string",
  "is_inode_space_owner": true,
  "max_inodes": "string",
  "name": "string",
  "parent_id": "string",
  "path": "string",
  "perm_change_flag": "PERMCHANGEFLAG_CHMODANDSETACL",
  "perm_inherit_flag": "PERMINHERITFLAG_INHERIT_ACL_ONLY",
  "prevent_snapshot_restore": true,
  "root_inode": "string",
  "snap_id": 0,
  "status": "FILESETSTATUS_EMPTY",
  "used_inodes": "string"
}

default: An unexpected error response.

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

Examples

The following example links an fileset:

Request data:

curl -X 'POST' \
  'https://localhost:46443/scalemgmt/v3/filesystems/gpfs0/filesets/tf2:link' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "junction_path": "/mnt/gpfs0/junction"
}'

Response data:

{
	"name": "tf2",
	"fs_name": "gpfs0",
	"id": 2,
	"status": "FILESETSTATUS_LINKED",
	"path": "/mnt/gpfs0/junction",
	"domain_id": 0
}