NSDs: GET

Gets information about NSDs that are part of the system.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The GET nsds request gets information about NSDs that are configured in the system. For more information about the fields in the data structures that are returned, see the topics mmcrnsd command , mmlsdisk command, and mmlsnsd command.

Request URL

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

where

nsds: Specifies NSDs as the resource of the GET call. Required.

Request headers

Accept: application/json

Request data

No request data.

Request parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of request parameters
Parameter name	Description and applicable keywords	Required/optional
fields	Comma separated list of fields to be included in response. ':all:' selects all available fields.	Optional.
filter	Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET'	Optional.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
     },
   "paging": 
    {
    "next": "URL"
    },nsds": 
     [
      {
         "name": "Name"
         "fileSystem": FilesystemName
         "failureGroup": "Failure Group",
         "type": "Type",
         "storagePool": "Storage Pool"
         "status": "Status"
         "availability": Availability
         "quorumDisk": "Quorum Disk",
         "size": "Size",
         "availableBlocks": "Available Blocks"
         "availableFragments": "Available Fragments"
         "nsdServers": "NSD Servers"
         "nsdVolumeId": NSD Volume ID
         "oid": "OID",
       }],
 }

The details of these parameters are given in the following list:

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

"paging": The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.

"nsds":

An array of information about NSDs. The array contains elements that describe the NSDs. For more information about the fields in this structure, see the links at the end of this topic.

"name": "Name": The name of the disk.
"fileSystem": FilesystemName: The file system to which the NSD belongs.
"failureGroup": "Failure Group": ID of the failure group to which the NSD belongs.
"type": "Type": The type of data to be stored on the disk.
"storagePool": "Storage Pool": The pool to which the disk belongs.
"status": "Status": Status of the disk.
"quorumDisk": "Quorum Disk": The quorum status of the disk.
"size": "Size": Size of the disk.
"availableBlocks": "Available Blocks": Available blocks in the disk.
"availableFragments": "Available Fragments": Available fragments of the disk.
"nsdServers": "NSD Servers": The server that manages the I/O.
"nsdVolumeId": NSD Volume ID: ID of the NSD volume.
"oid": "OID": Internal identifier that is used for paging.

Examples

The following example gets information about the NSDs that are configured in the system.

Request URL:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/nsds'

The request URL with no field or filter parameter returns only the details that uniquely identify the object.

Response data:

Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error.

{
  "nsds" : [ {
      "fileSystem" : "gpfs0",
      "name" : "disk1"
     }, {
       "fileSystem" : "gpfs0",
      "name" : "disk8"
  }, {
      "fileSystem" : "objfs",
      "name" : "disk2"
  }, {
      "fileSystem" : "gpfs1",
      "name" : "disk3"
  }, {
      "fileSystem" : "gpfs1",
      "name" : "disk4"
  }, {
      "fileSystem" : "gpfs1",
      "name" : "disk5"
  }, {
      "name" : "disk6"
  }, {
      "fileSystem" : "objfs",
      "name" : "disk7"
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully"
  }
}

Using the field parameter ":all:" returns entire details of the NSDs that are available in the cluster. For example:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/nsds?fields=:all:'

{
  "nsds" : [ {
      "availability" : "up",
      "availableBlocks" : "9.15 GB",
      "availableFragments" : "552 kB",
      "failureGroup" : "1",
      "fileSystem" : "gpfs0",
      "name" : "disk1",
      "nsdServers" : "mari-11.localnet.com,mari-15.localnet.com,mari-14.localnet.com,
                      mari-13.localnet.com,mari-12.localnet.com",
      "nsdVolumeId" : "0A00640B58B82A8C",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "system",
      "type" : "nsd"
   }, {
      "availability" : "up",
      "availableBlocks" : "9.45 GB",
      "availableFragments" : "664 kB",
      "failureGroup" : "1",
      "fileSystem" : "gpfs0",
      "name" : "disk8",
      "nsdServers" : "mari-11.localnet.com,mari-12.localnet.com,mari-13.localnet.com,
                      mari-14.localnet.com,mari-15.localnet.com",
      "nsdVolumeId" : "0A00640B58B82AD9",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "data",
      "type" : "nsd"
  }, {
      "availability" : "up",
      "availableBlocks" : "9.30 GB",
      "availableFragments" : "504 kB",
      "failureGroup" : "1",
      "fileSystem" : "objfs",
      "name" : "disk2",
      "nsdServers" : "mari-11.localnet.com,mari-12.localnet.com,mari-13.localnet.com,
                      mari-14.localnet.com,mari-15.localnet.com",
      "nsdVolumeId" : "0A00640B58B82A96",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "system",
      "type" : "nsd"
  }, {
      "availability" : "up",
      "availableBlocks" : "9.42 GB",
      "availableFragments" : "712 kB",
      "failureGroup" : "1",
      "fileSystem" : "gpfs1",
      "name" : "disk3",
      "nsdServers" : "mari-11.localnet.com,mari-15.localnet.com,mari-14.localnet.com,
                      mari-13.localnet.com,mari-12.localnet.com",
      "nsdVolumeId" : "0A00640B58B82AA1",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "system",
      "type" : "nsd"
  }, {
      "availability" : "up",
      "availableBlocks" : "9.94 GB",
      "availableFragments" : "504 kB",
      "failureGroup" : "1",
      "fileSystem" : "gpfs1",
      "name" : "disk4",
      "nsdServers" : "mari-11.localnet.com,mari-12.localnet.com,mari-13.localnet.com,
                     mari-14.localnet.com,mari-15.localnet.com",
      "nsdVolumeId" : "0A00640B58B82AAC",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "data",
      "type" : "nsd"
  }, {
      "availability" : "up",
      "availableBlocks" : "9.94 GB",
      "availableFragments" : "536 kB",
      "failureGroup" : "1",
      "fileSystem" : "gpfs1",
      "name" : "disk5",
      "nsdServers" : "mari-11.localnet.com,mari-12.localnet.com,mari-13.localnet.com,
                      mari-14.localnet.com,mari-15.localnet.com",
      "nsdVolumeId" : "0A00640B58B82AB7",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "data",
      "type" : "nsd"
  }, {
      "availability" : "unknown",
      "availableBlocks" : "Not Available",
      "availableFragments" : "Not Available",
      "failureGroup" : "1",
      "name" : "disk6",
      "nsdServers" : "mari-11.localnet.com,mari-15.localnet.com,mari-12.localnet.com,
                      mari-13.localnet.com,mari-14.localnet.com",
      "nsdVolumeId" : "0A00640B58B82AC2",
      "quorumDisk" : "no",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "data",
      "type" : "nsd"
  }, {
       "availability" : "up",
      "availableBlocks" : "7.22 GB",
      "availableFragments" : "4.62 MB",
      "failureGroup" : "1",
      "fileSystem" : "objfs",
      "name" : "disk7",
      "nsdServers" : "mari-11.localnet.com,mari-12.localnet.com,mari-13.localnet.com,
                      mari-14.localnet.com,mari-15.localnet.com",
      "nsdVolumeId" : "0A00640B58B82ACD",
      "quorumDisk" : "no",
      "remarks" : "desc",
      "size" : " 10.00GiB",
      "status" : "ready",
      "storagePool" : "data",
      "type" : "nsd"
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully"
  }
}