Gnr/diskmgmt/vdiskset: GET

Gets the list of vdisk sets and displays their attributes and sizing information.

Availability

Available on IBM Storage Scale Erasure Code Edition only.

Description

The GET scalemgmt/v2/gnr/diskmgmt/vdiskset request displays the list of vdisk sets along with their attributes and sizing information. For more information about the fields in the data structures that are returned, see the mmvdisk vdiskset command.

Request URL

https://IP address of API server:<port>/scalemgmt/v2/gnr/diskmgmt/vdiskset

where

vdiskset: Specifies the resource of this GET call.

Request headers

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

Parameters

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/Optional
vdisksetName	The name of the vdisk set for which the attributes and sizing information is listed.	Optional

Request data

No request data.

Response data

{
  "status": {
    "code": 200,
    "message": "..."
  },
  "vdiskList": [
    {
      "vdisksetName": "string",
      "created": "string",
      "fsName": "string",
      "recoveryGroups": "string",
      "vdiskCount": 0,
      "vdiskSize": 0,
      "vdiskRawSize": 0,
      "declusteredArray": "string",
      "raidCode": "string",
      "blocksize": 0,
      "usage": "string",
      "storagePool": "string",
      "totalRawSize": 0,
      "freeRawSize": 0,
      "vdiskSets": "string",
      "freePercent": 0,
      "hardwareType": "string",
      "memoryAvailable": 0,
      "memoryRequired": "string",
      "vdiskSetServerMemory": "string",
      "nodeClass": "string"
    }
  ]
}

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

"status":

Return status.

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

"vdiskList"

"vdisksetName": "Name": The vdisk set name.
"blocksize": Size: The block size of a vdisk set definition. The block size is constrained by the RAID code. Valid values for 3WayReplication and 4WayReplication are 256K, 512K, 1M, and 2M. Valid values for 4+2P and 4+3P are 512K, 1M, 2M, 4M, 8M. Valid values for 8+2P and 8+3P are 512K, 1M, 2M, 4M, 8M, 16M.
"created": "yes | no": Specifies whether the vdisk set is created.
"declusteredArray": "name ": The name of the declustered array.
"freePercent": "size in Percentage ": The available aggregate size of the declustered array to which the vdisk set belongs, specified as a percentage.
"freeRawSize": "size in bytes ": The available aggregate size of the declustered array to which the vdisk set belongs, specified as bytes.
"fsName": "name ": The name of the file system that uses this vdisk set.
"hardwareType":"Hardware details": The type of hardware used.
"memoryAvailable": "size": The memory size available per server.
"memoryRequired": "size": The memory size required per server.
"raidCode": "Code": The RAID code of a vdisk set definition.
"storagePool": "Storage pool ": IBM Storage Scale file system storage pool for the vdisk NSDs. If the NSD usage is dataAndMetadata or metadataOnly, then the default storage pool must be "system" and need not be specified. If the NSD usage is dataOnly, the storage pool must be specified and cannot be "system".
"totalRawSize": "size": The total vdisk set size that is used from the declustered array, including the RAID code redundancy.
"usage": "dataAndMetadata | metadataOnly | dataOnly": The NSD pool usage of the vdisk set. The default value is dataAndMetadata.
"vdiskCount": "Count of Vdisk sets": The number of vdisks in the vdisk sets.
"vdiskRawSize": "Usage details": The raw disk space that is used by each vdisk in the vdisk set.
"vdiskSetServerMemory":Server memory size: The server memory size available for the vdisk set.
"vdiskSize": "size": The usable size of each vdisk in the vdisk set of the file system.
""nodeClass"": "name": The recovery group server node class.

Examples

The following example gets the vdisk set information.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:text/html' 'https://198.51.100.1:443/scalemgmt/v2/gnr/diskmgmt/vdiskset'

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": "The request finished successfully."
  },
  "vdiskList": [
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs1",
      "memoryAvailable": 0,
      "recoveryGroups": "rgL",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "vd2_rgL"
    },
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs1",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "vd2_rgR"
    },
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs2",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "gpfs2_system_0"
    },
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs2",
      "memoryAvailable": 0,
      "recoveryGroups": "rgL",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "gpfs2_system_1"
    },
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs0",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "gpfs0_system_2"
    },
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs0",
      "memoryAvailable": 0,
      "recoveryGroups": "rgL",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "gpfs0_system_1"
    },
    {
      "blocksize": 0,
      "created": "no",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "RG002VS001"
    },
    {
      "blocksize": 0,
      "created": "no",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "n005p002"
    },
    {
      "blocksize": 0,
      "created": "no",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "n005p003"
    },
    {
      "blocksize": 0,
      "created": "no",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "",
      "memoryAvailable": 0,
      "recoveryGroups": "rgR",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "n005p004"
    },
    {
      "blocksize": 0,
      "created": "yes",
      "freePercent": 0,
      "freeRawSize": 0,
      "fsName": "gpfs3",
      "memoryAvailable": 0,
      "recoveryGroups": "rgL",
      "totalRawSize": 0,
      "vdiskCount": 0,
      "vdiskRawSize": 0,
      "vdiskSize": 0,
      "vdisksetName": "vd4"
    },
  ]
}