/scalemgmt/v3/nsds/{nsd_name}: GET

Lists information about the specified NSD.

Availability

Available on all IBM Storage Scale editions.

Description

The GET nsds/{nsd_name} request lists information about an existing NSD. The operation attribute for this command is view. To run this command, 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/{nsd_name}

where

{nsd_name}: Specifies the NSD name.

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
nsd_name	The name of the NSD.	Required.
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.
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.

{
  "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 the nsd_2 NSD:

Request data:

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

Response data:

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