Diskmgmt/vdiskset/server/list/{nodeClass}: GET

Gets a list of IBM Storage Scale RAID servers and their characteristics.

Availability

Available on all IBM Storage Scale editions.

Description

The GET scalemgmt/v2/gnr/diskmgmt/vdiskset/server/list/{nodeClass} request gets the list of IBM Storage Scale RAID servers and their characteristics. For more information about the fields in the data structures that are returned, see the mmvdisk server command. .

Request URL

https://IP address of API server:<port>/scalemgmt/v2/gnr/diskmgmt/vdiskset/server/list/nodeClass
where
list/{nodeClass}
Specifies the resource of this GET call. Required.

Request headers

Content-Type: application/json
Accept: application/json

Request data

No request data.

Parameters

Table 1. List of parameters
Parameter name Description and applicable keywords Required/Optional
nodeClass The node class or the node name for which details are requested. Required.

Response data


  {
  "status": {
    "code": Status code,
    "message": "Status message"
  },  "stdout": [
     "serverList": [
    {
      "nodeName": "Node name",
      "needsAttention": "string",
      "matchingMetric": "string",
      "diskTopology": "Disk topology",
      "number": Node sequence number
    }
    ],
   ]
}
"status":
Return status.
"message": "ReturnMessage"
The return message.
"code": ReturnCode
The return code.
"stdout":"CLI messages"
The CLI messages from stdout.
"serverList"
An array that comprises details on the jobs that were run.
"nodeName": "Name of node"
The name of the node name for which the details are displayed.
"needsAttention": "yes | no "
Specifies whether running the mmvdisk command faces problems from internal commands like mmgetpdisktopology or tspsummary.
"matchingMetric":"Metrics "
The match between current disk topology and the expected designs.
"disktopology":"Disk topology"
The IBM Storage Scale RAID disk topology on the recovery group servers.
"nodeNumber":"Node sequence number"
The sequence number of the node.

Examples

The following example gets information on the nodeClass nc1.

Request data:
curl -X GET --header 'Accept: application/json' --header 'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 
'https://198.51.100.1:443/scalemgmt/v2/gnr/diskmgmt/vdiskset/server/list/nc1
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. 

{ 
  "stdout": [
  "serverList": [
    {
      "diskTopology": "ECE 3 HDD",
      "matchingMetric": "100/100",
      "needsAttention": "no",
      "nodeName": "hciece01-hs.gpfs.net",
      "nodeNumber": 1
    },
    {
      "diskTopology": "ECE 3 HDD",
      "matchingMetric": "100/100",
      "needsAttention": "no",
      "nodeName": "hciece02-hs.gpfs.net",
      "nodeNumber": 2
    },
    {
      "diskTopology": "ECE 3 HDD",
      "matchingMetric": "100/100",
      "needsAttention": "no",
      "nodeName": "hciece03-hs.gpfs.net",
      "nodeNumber": 3
    },
    {
      "diskTopology": "ECE 3 HDD",
      "matchingMetric": "100/100",
      "needsAttention": "no",
      "nodeName": "hciece04-hs.gpfs.net",
      "nodeNumber": 4
    },
    {
      "diskTopology": "ECE 3 HDD",
      "matchingMetric": "100/100",
      "needsAttention": "no",
      "nodeName": "hciece05-hs.gpfs.net",
      "nodeNumber": 5
    }
  ]
  ],
  "status": {
    "code": 200,
    "message": "The request finished successfully."
  }
}