/scalemgmt/v3/nsds: GET

Lists information about all network-shared disks (NSDs) that are part of the system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET nsds request list all NSDs. The operation attribute for this request are view and pagination. To run this request, you must have the RBAC permission for the get action on the /scalemgmt/v3/nsds resource.

Request URL

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

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
not_assigned	List all disks that do not belong to any file system	Required.
filesystem_device	List all disks that belong to the specified file system device.	Optional.
view	The type of view for NSD content. The possible values are `local-node`, `all-nodes`, `all-nsds`, `long`, and `extended`. The default value is `all-nsds`.	Optional.
page_size	The number of items to list per request to the API.	Optional.
page_token	The page token is received from previous NSD list call to provide this to retrieve the subsequent page.	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.

{
  "next_page_token": "string",
  "nsds": [
    {
      "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"
    }
  ]
}

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 all NSDs:

Request data:

curl  -n -k  -X GET 'https://localhost:46443/scalemgmt/v3/nsds' -H 'accept: application/json'   -H 'Content-Type: application/json'

Response data:

{
  "nsds": [
    {
      "name": "nsd_1",
      "nsd_servers": ["test-21.openstacklocal"],
      "file_system": "(free disk)",
      "partition_type": "generic",
      "domain_id": 0
    },
    {
      "name": "nsd_2",
      "nsd_servers": ["test-21.openstacklocal"],
      "file_system": "(free disk)",
      "partition_type": "generic",
      "domain_id": 0
    },
    {
      "name": "nsd_3",
      "nsd_servers": ["test-21.openstacklocal"],
      "file_system": "(free disk)",
      "partition_type": "generic",
      "domain_id": 0
    }
  ]
}