/scalemgmt/v3/filesystems/{name}: PATCH

Updates the attributes of an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The PATCH filesystems/{name} request updates the attributes of an IBM Storage Scale file system. You must unmount the file system to update the name, default_mount_point, automatic_mount_option, drive_letter, dmapi_enabled, and maintenance_mode attributes. The mmfsd daemon must be active to update most of the attributes but an exception to this requirement is available for some attributes. Use the files update_mask to control the attributes that need to be updated when running the update request. The operation attribute for this request is update mask. To run this request, you must have the RBAC permission for the update action on the /scalemgmt/v3/filesystems/{name} resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{name}
where
{name}
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
name The name of the file system. Required.
filesystem 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:
{
  "acl_semantics": "POSIX_ACLSEMANTICS",
  "additional_mount_options": "string",
  "auto_inode_limit": "YES",
  "automatic_mount_option": "YES_AUTO",
  "block_allocation_type": "CLUSTER_BLOCKALLOCATIONTYPE",
  "block_size": 4194304,
  "default_data_replicas": 1,
  "default_metadata_replicas": 1,
  "default_mount_point": "string",
  "disks": [
    {
      "device_name": "string",
      "disk_usage": "DATA_AND_METADATA",
      "failure_group": "string",
      "name": "string",
      "nsd_servers": [
        "string"
      ],
      "storage_pool": "string",
      "thin_disk": "THIN_DISK_NO"
    }
  ],
  "dmapi_enabled": "YES",
  "drive_letter": "string",
  "enable_quotas": "YES",
  "exact_mtime": "YES",
  "file_locking_semantics": "POSIX_FILELOCKINGSEMANTICS",
  "filesetdf_enabled": "YES",
  "flush_on_close": "YES",
  "inode_limit": 9223372036854776000,
  "inode_segment_manager": "YES",
  "inode_size": 4096,
  "log_replicas": 3,
  "logfile_size": 4194304,
  "max_data_replicas": 2,
  "max_metadata_replicas": 2,
  "mount_priority": 0,
  "name": "string",
  "nfs4_owner_write_acl": "YES",
  "num_nodes": 32,
  "perfileset_quotas": "YES",
  "prealloc_inodes_number": 0,
  "storage_pools": [
    {
      "block_group_factor": 1024,
      "block_size": 4194304,
      "layout_map": "CLUSTER_BLOCKALLOCATIONTYPE",
      "name": "string",
      "performance_pool": "no",
      "pool_usage": "DATA_AND_METADATA",
      "write_affinity": "YES",
      "write_affinity_depth": 0
    }
  ],
  "strict_replication": "NO_STRICT_REPL",
  "suppress_atime": "YES_SUPPRESSATIME",
  "version": "string",
  "write_cache_threshold": 0
}
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.
    {
      "acl_semantics": "POSIX_ACLSEMANTICS",
      "additional_mount_options": "string",
      "auto_inode_limit": "YES",
      "automatic_mount_option": "YES_AUTO",
      "block_allocation_type": "CLUSTER_BLOCKALLOCATIONTYPE",
      "block_size": 4194304,
      "cluster": "string",
      "create_time": "2024-11-05T10:08:29.545Z",
      "default_data_replicas": 1,
      "default_metadata_replicas": 1,
      "default_mount_point": "string",
      "default_quotas_enabled": "string",
      "disks": [
        {
          "dev_type": "SUBTYPE_DASD_DISK",
          "device_name": "string",
          "disk_subtype": "SUBTYPE_PR_DISK",
          "disk_usage": "DATA_AND_METADATA",
          "domain_id": 0,
          "failure_group": "string",
          "file_system": "string",
          "local_disk_name": "string",
          "name": "string",
          "node_name": "string",
          "nsd_servers": [
            "string"
          ],
          "nsd_version": "string",
          "partition_type": "string",
          "remarks": "string",
          "size": "string",
          "storage_pool": "string",
          "thin_disk": "THIN_DISK_NO",
          "volume_id": "string"
        }
      ],
      "dmapi_enabled": "YES",
      "domain_id": 0,
      "drive_letter": "string",
      "enable_quotas": "YES",
      "encryption": "YES",
      "exact_mtime": "YES",
      "fast_ea_enabled": "string",
      "file_audit_log": "YES",
      "file_locking_semantics": "POSIX_FILELOCKINGSEMANTICS",
      "filesetdf_enabled": "YES",
      "flush_on_close": "YES",
      "highest_supported_version": "string",
      "indirect_block_size": 0,
      "inode_limit": 9223372036854776000,
      "inode_segment_manager": "YES",
      "inode_size": 4096,
      "is_4K_aligned": "YES",
      "local_version": "string",
      "log_replicas": 3,
      "logfile_size": 4194304,
      "maintenance_mode": "YES_MAINTENANCEMODE",
      "manager": "string",
      "manager_version": "string",
      "max_data_replicas": 2,
      "max_metadata_replicas": 2,
      "max_snapshot_id": 0,
      "min_fragment_size": 0,
      "mount_priority": 0,
      "name": "string",
      "nfs4_owner_write_acl": "YES",
      "num_nodes": 32,
      "original_version": "string",
      "perfileset_quotas": "YES",
      "prealloc_inodes_number": 0,
      "quotas_accounting_enabled": "string",
      "quotas_enforced": "string",
      "rapid_repair_enabled": "YES",
      "storage_pools": [
        {
          "block_group_factor": 1024,
          "block_size": 4194304,
          "filesystem": "string",
          "id": 0,
          "layout_map": "CLUSTER_BLOCKALLOCATIONTYPE",
          "max_disk_size": "string",
          "name": "string",
          "performance_pool": "no",
          "pool_usage": "DATA_AND_METADATA",
          "write_affinity": "YES",
          "write_affinity_depth": 0
        }
      ],
      "strict_replication": "NO_STRICT_REPL",
      "subblocks_per_full_block": 0,
      "suppress_atime": "YES_SUPPRESSATIME",
      "uid": "string",
      "version": "string",
      "write_cache_threshold": 0
    }
  • 202: The request has been accepted for processing, but the processing has not been completed.
    {}
  • default: An unexpected error response.
    {
      "code": 0,
      "details": [
        {
          "@type": "string",
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      ],
      "message": "string"
    }

Examples

The following example updates a file system:

Request data:
curl -X 'PATCH' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs1' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
 "enable_quotas": "YES"
}' -k -n
Response data:
{
	"name": "fs1",
	"uid": "4664000A:67EAFE7E",
	"version": "37.00 (5.2.3.0)",
	"original_version": "37.00 (5.2.3.0)",
	"min_fragment_size": 8192,
	"inode_size": 4096,
	"indirect_block_size": 32768,
	"default_metadata_replicas": 1,
	"max_metadata_replicas": 2,
	"default_data_replicas": 1,
	"max_data_replicas": 2,
	"block_allocation_type": "CLUSTER_BLOCKALLOCATIONTYPE",
	"file_locking_semantics": "POSIX_FILELOCKINGSEMANTICS",
	"acl_semantics": "ALL_ACLSEMANTICS",
	"num_nodes": 32,
	"block_size": 4194304,
	"quotas_accounting_enabled": "user;group;fileset",
	"quotas_enforced": "none",
	"default_quotas_enabled": "none",
	"perfileset_quotas": "NO",
	"filesetdf_enabled": "NO",
	"create_time": "2025-03-31T20:43:42Z",
	"dmapi_enabled": "NO",
	"logfile_size": "33554432",
	"exact_mtime": "NO",
	"suppress_atime": "RELATIME_SUPPRESSATIME",
	"strict_replication": "WHEN_POSSIBLE_STRICT_REPL",
	"fast_ea_enabled": "yes",
	"encryption": "NO",
	"inode_limit": "66560",
	"max_snapshot_id": 0,
	"log_replicas": 0,
	"is_4K_aligned": "YES",
	"rapid_repair_enabled": "YES",
	"write_cache_threshold": 0,
	"subblocks_per_full_block": 512,
	"storage_pools": [
		{
			"name": "system"
		},
		{
			"name": "data1"
		}
	],
	"file_audit_log": "NO",
	"maintenance_mode": "NO_MAINTENANCEMODE",
	"flush_on_close": "NO",
	"auto_inode_limit": "NO",
	"disks": [
		{
			"name": "disk1"
		},
		{
			"name": "disk2"
		}
	],
	"automatic_mount_option": "YES_AUTO",
	"default_mount_point": "/gpfs/fs1",
	"mount_priority": 0,
	"nfs4_owner_write_acl": "NO",
	"domain_id": 0,
	"manager": "lancelot-41",
	"manager_version": "37.00 (5.2.3.0)",
	"local_version": "37.00 (5.2.3.0)",
	"highest_supported_version": "37.00 (5.2.3.0)",
	"inode_segment_manager": "YES",
	"cluster": "lancelot-41.openstacklocal"
}