/scalemgmt/v3/clusters/remote: GET
Lists information about remote clusters.
Availability
Available on all IBM Storage Scale editions.
Description
The GET clusters/remote request gets information of remote clusters. For more information about the fields in the data structures that are returned, see scalectl cluster command.
Request URL
https://<IP address or host name of API server>:<port>/scalemgmt/v3/clusters/remoteRequest headers
Accept: application/jsonParameters
The following parameters can be used in the request URL to customize the
request:
| Parameter name | Description and applicable keywords | Required/optional |
|---|---|---|
| page_size | Specifies the number of items to list per API request. | Optional. |
| page_token | Specifies the page token that is received from previous clusters/remote: GET request. You can provide this page token to retrieve the next page. | Optional. |
| view | Specifies the view for remote cluster contents. The possible values are basic, and full. The default value is basic. The full view displays all available fields. The basic view omits filesets that exist on the remote cluster. | Optional. |
| 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.
{ "clusters": [ { "cipher_list": "string", "cluster_type": "CLUSTERTYPE_ACCESSING", "contact_nodes": "string", "fileset_resources": [ { "fileset_access": { "alloc_inodes": "string", "comment": "string", "create_time": "2025-04-13T12:16:54.912Z", "data_in_kb": "string", "disposition": "GRANT", "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" } } ], "filesystem_resources": [ { "filesystem_access": { "access_type": "string", "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": "2025-04-13T12:16:54.912Z", "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" } ], "disposition": "GRANT", "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", "root_squash": "string", "storage_pools": [ { "block_group_factor": 1024, "block_size": 4194304, "filesystem": "string", "id": 0, "layout_map": "CLUSTER_BLOCKALLOCATIONTYPE", "max_disk_size": "string", "name": "string", "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 }, "remote_filesystem": { "additional_mount_options": "string", "automatic_mount_option": "YES_AUTO", "default_mount_point": "string", "mount_priority": 0, "name": "string", "owning_cluster": "string", "remote_name": "string" } } ], "id": "string", "key_expiration": "2025-04-13T12:16:54.912Z", "key_expired": true, "name": "string", "new_key_expiration": "2025-04-13T12:16:54.912Z", "new_key_expired": true, "new_sha_digest": "string", "sha_digest": "string" } ], "next_page_token": "string" } - default: An unexpected error response.
{ "code": 0, "details": [ { "@type": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } ], "message": "string" }
Examples
The following example lists information about remote clusters:
Request data:
curl -X 'GET' 'https://localhost:46443/scalemgmt/v3/clusters/remote?view=FULL' -H 'accept: application/json' -n -k{
"clusters": [
{
"name": "cluster1",
"id": "5716205438072543634",
"sha_digest": "901a5a0c1d9c9dc5eb2751bb32f1e384f2a73678d08511526ee7a7b2539b997c",
"filesystem_resources": [
{
"filesystem_access": {
"name": "fs1",
"access_type": "rw"
}
}
],
"fileset_resources": [
{
"fileset_access": {
"name": "root",
"fs_name": "fs1",
"id": 0,
"status": "FILESETSTATUS_LINKED",
"path": "/gpfs/fs1",
"domain_id": 0
}
},
{
"fileset_access": {
"name": "fileset1",
"fs_name": "fs1",
"id": 1,
"status": "FILESETSTATUS_LINKED",
"path": "/gpfs/fs1/fileset1",
"domain_id": 0
}
},
{
"fileset_access": {
"name": "fileset2",
"fs_name": "fs1",
"id": 4,
"status": "FILESETSTATUS_LINKED",
"path": "/gpfs/fs1/fileset2",
"domain_id": 0
}
}
],
"cluster_type": "CLUSTERTYPE_ACCESSING"
},
{
"name": "cluster2",
"id": "3793952426292428382",
"sha_digest": “1052640a1c8660a577a5c9a8b7df7862b9dd3d958174b5c5dd3dfbeb323c45c3”,
"filesystem_resources": [
{
"filesystem_access": {
"name": "fs2",
"access_type": "rw"
}
}
],
"fileset_resources": [
{
"fileset_access": {
"name": "root",
"fs_name": "fs2",
"id": 0,
"status": "FILESETSTATUS_LINKED",
"path": "/gpfs/fs2",
"domain_id": 0
}
},
{
"fileset_access": {
"name": "fileset1",
"fs_name": "fs2",
"id": 1,
"status": "FILESETSTATUS_LINKED",
"path": "/gpfs/fs2/fileset1",
"domain_id": 0
}
},
{
"fileset_access": {
"name": "fileset2",
"fs_name": "fs2",
"id": 2,
"status": "FILESETSTATUS_LINKED",
"path": "/gpfs/fs2/fileset2",
"domain_id": 0
}
}
],
"cluster_type": "CLUSTERTYPE_ACCESSING"
},
]}