Gnr/recoverygroups/{recoveryGroupName}/pdisks: GET

Gets the details of the physical disks that are available in a particular recovery group.

Availability

Available with the Elastic Storage Server.

Description

The GET gnr/recoverygroup/{recoveryGroupName}/pdisks request gets the details of the pdisks that are available in a recovery group. For more information about the fields in the data structures that are returned, see mmlspdisk command.

Request URL

https://IP address of API server:<port>/scalemgmt/v2/gnr/recoverygroups/recoveryGroupName/pdisks

where

gnr/recoverygroups/recoveryGroupName: Specifies the recovery group to which the pdisks belong. Required.
pdisks: Specifies pdisks as the source of the GET call. Required.

Request headers

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

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.
recoveryGroupName	The name of the recovery group to which the pdisks belong.	Required.

Request data

No request data.

Response data

{  
   "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   },
    "paging": 
    {
    "next": "URL"
    },
   "pdisks": [
      {
          {
            "details":"Pdisk details"
             {
            "replacementPriority":"Replacement priority"
            "fru":"Field replaceable unit",
            "location":"Location",
            "wwn":"World wide name",
            "server":"Server",
            "rgIndex":"Recovery group index"
            "vendor":"Vendor name",
            "product":"Product name",
            "revision":"Revision",
            "serial":"Serial",
            "hardwareType":"Hardware type",
            "speed":"Speed",
      }
          "metrics":"Performance metrics"
             {
            "reads":"Reads"
            "writes":"Writes",
            "bytesRead":"Bytes read",
            "bytesWritten":"Bytes written",
            "ioErrors":"Number of I/O errors",
            "ioTimeOuts":"Number of I/O timeouts"
            "mediaErrors":"Media errors",
            "checksumErrors":"Cehcksum errors",
            "pathErrors":"Path errors",
            "relativePerformance":"Relative performance"
            "dataBadness":"Data badness",
      }
      "paths":"Path details"
             {
            "paths":"List of paths"
            "noOfPathsActive":"Number of active paths",
            "noOfPathsTotal":"Total number of paths",
            "expectedPathsActive":"Expected acive paths",
            "expectedPathsTotal":"Expected total paths",
            "noOfPathsActiveWrong":"Number of active wrong paths"
            "noOfPathsTotalWrong":"Total number of wrong paths",
           }  
            "oid":"ID"
            "name":"Name",
            "declusteredArray":"Declustered array",
            "recoveryGroup":"Recovery group",
            "state":"State",
            "stateInfo":"State information"
            "healthState":"Health state",
            "freeSpace":"Free space",
            "capacity":"Capacity"
            "pathCount":"Path count",
  }
 ]
}

For more information about the fields in the following data structures, see the links at the end of this topic.

"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.

"pdisks":"Physical disk details"

An array of information that lists the details of the pdisk.

"details":"Pdisk details"

Details of pdisk.

"replacementPriority":"Replacement priority": Replacement priority that is defined for the pdisk.
"fru":"Field replaceable unit",: The field replaceable unit (FRU) of the pdisk.
"location":"Location",: Location of the pdisk in an enclosure.
"wwn":"World wide name",: The world wide name of the pdisk.
"server":"Server",: The server name of the ESS.
"rgIndex":"Recovery group index": Recovery group index of the pdisk.
"vendor":"Vendor name",: Vendor name of the pdisk.
"product":"Product name",: Product name of the pdisk.
"revision":"Revision",: Revision of the pdisk.
"serial":"Serial",: The serial of the pdisk.
"hardwareType":"Hardware type",: Hardware type of the pdisk.
"speed":"Speed": Speed of the pdisk.

"metrics":"Performance metrics"

"reads":"Reads": Number of reads from the pdisk.
"writes":"Writes",: Number of writes to the pdisk.
"bytesRead":"Bytes read",: Number of bytes read from the pdisk.
"bytesWritten":"Bytes written",: Number of writes to the pdisk.
"ioErrors":"Number of I/O errors",: Number of I/O errors reported for the pdisk.
"ioTimeOuts":"Number of I/O timeouts": Number of I/O timeouts reported for the pdisk.
"mediaErrors":"Media errors",: Number of media errors reported for the pdisk.
"checksumErrors":"Cehcksum errors",: Number of checksum errors reported for the pdisk.
"pathErrors":"Path errors",: Number of path errors reported for the pdisk.
"relativePerformance":"Relative performance": Relative performance of the pdisk.
"dataBadness":"Data badness": Data badness of the pdisk.

"paths":"Path details"

"paths":"List of paths": List of paths of the pdisk.
"noOfPathsActive":"Number of active paths",: The number of active paths for the pdisk
"noOfPathsTotal":"Total number of paths",: The total number of paths for the pdisk.
"expectedPathsActive":"Expected acive paths",: The number of expected active paths for the pdisk.
"expectedPathsTotal":"Expected total paths",: The total number of expected paths for the pdisk.
"noOfPathsActiveWrong":"Number of active wrong paths": The number of active wrong paths for the pdisk.
"noOfPathsTotalWrong":"Total number of wrong paths": The total number of wrong paths for the pdisk.

"oid":"ID"

The ID used for paging.

"name":"Name",

Name of the pdisk.

"declusteredArray":"Declustered array",

The name of the declustered array of the pdisk.

"recoveryGroup":"Recovery group",

The name of the recovery group of the pdisk.

"state":"State",

The state of the pdisk

"stateInfo":"State information"

The state information about the pdisk.

"healthState":"Health state",

The health state of the pdisk.

"freeSpace":"Free space",

The free space of the pdisk in bytes.

"capacity":"Capacity"

The capacity of the pdisk in bytes.

"pathCount":"Path count"

The number of paths for the pdisk.

Examples

The following example gets information about the pdisks that are available in the recovery group RG1.

Request data:

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

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.


{
  "status": {
    "code": 200,
    "message": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/filesystems/gpfs0/filesets?lastId=1001"
  },
  "pdisks": [
    {
      "details": {
        "replacementPriority": 1000,
        "fru": "QEMU HARDDISK",
        "location": "24",
        "wwn": "naa.5000CCA01C514D48",
        "server": "gss-22.localnet.com",
        "rgIndex": 23,
        "vendor": "QEMU",
        "product": "QEMU HARDDISK",
        "revision": "1.5",
        "serial": "48",
        "hardwareType": "ROTATING",
        "speed": 7200
      },
      "metrics": {
        "reads": 3484,
        "writes": 698,
        "bytesRead": 546534588,
        "bytesWritten": 612032839,
        "ioErrors": 0,
        "ioTimeOuts": 0,
        "mediaErrors": 0,
        "checksumErrors": 0,
        "pathErrors": 0,
        "relativePerformance": 0.968,
        "dataBadness": 0
      },
      "paths": {
        "paths": "//gss-22/dev/sdar",
        "noOfPathsActive": 1,
        "noOfPathsTotal": 2,
        "expectedPathsActive": 1,
        "expectedPathsTotal": 2,
        "noOfPathsActiveWrong": 0,
        "noOfPathsTotalWrong": 0
      },
      "oid": 0,
      "name": "pdisk1",
      "declusteredArray": "DA1",
      "recoveryGroup": "RG1",
      "state": "NORMAL",
      "stateInfo": "ok",
      "healthState": "HEALTHY",
      "freeSpace": 533649686528,
      "capacity": 536602476544,
      "pathCount": 2
    }
  ]
}