GET /api/v1/data/devices/`{id}`/storage

Use this method to return storage information for a specific device.

Authentication

Authentication with username and password is required.

Resource URI

GET https://{orchestrator_server_IP}/api/v1/data/devices/{id}/storage

where {id} is the ID of the device. To obtain the device IDs, use GET /api/v1/data/devices.

Query parameters

None

Request body

None

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
404	Not found	The resource cannot be found. A descriptive error message is returned in the response body.

Response body

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

Attributes		Type	Description
bay		String	Bay or slot number
blockSize		Integer	Block size
capacity		Integer	(M.2 drives only) Storage capacity, in KB
description		String	Description
diskState		String	Disk-drive state
encryptionStatus		String	Indicates whether the disk drive is encrypted. This can be one of the following values. Unencrypted. The drive is not encrypted. Locked. The drive is encrypted, and the host is power off. Unlocked. The drive is encrypted, and the host is power on.
firmware		Array of objects	Information about add-in card firmware
	build	String	Firmware build
	classifications	Array of integers	Firmware type codes
	date	String	Firmware date
	deviceTypeKey	String	Device type key
	name	String	Firmware name
	revision	String	Firmware revision
	role	String	Firmware role. This can be one of the following values. Primary Backup Temporary Permanent
	softwareID		Firmware ID
	status	String	Firmware status. This can be one of the following values. Active Inactive
	type	String	Firmware type, such as UEFI, MP, or DSA
	version	String	Firmware version
FRU		String	FRU
healthState		String	Health state (translated) that corresponds to the highest event severity of all disk drives in the device. This can be one of the following values. Normal Warning Critical Unknown
healthStateKey		String	Health state key that corresponds to the highest event severity of all disk drives in the device. This can be one of the following values. normal warning critical unknown
hotSpareType		String	Type of hot spare drive. This can be one of the following values. Global None
interfaceType		String	Interface type
largestAvailableSize		Integer
m2Location		String	(M.2 drives only) Location of M.2 drive and bay
manufacturer		String	Manufacturer
mediaType		String	Media type
model		String	Model
name		String	Drive name
numberOfBlocks		Integer	Number of blocks
partNumber		String	Part number
remainingLife		Integer	Indicate the amount of life that remains for a solid-state drive (SSD). This can be one of the following values. 0 - 100. The percent of remaining life -1. Unknown (default) -2. Information is not available -3. The drive is not an SSD
serialNumber		String	Serial number
temperature		Integer	Device temperature
uuid		String	Storage device UUID
_links		Object	Device URI (see Links)

The following example is returned if the request is successful.

[
   {
      "bay": 0,
      "blockSize": 512,
      "capacity": 1200243695616,
      "description": "1.20TB 10K 12Gbps SAS 2.5 HDD",
      "diskState": "Online",
      "encryptionStatus": "Unencrypted",
      "firmware": [{
         "build": "0",
         "classifications": [ 10 ],
         "date": "",
         "deviceTypeKey": "firmware",
         "name": "ST1200MM0009",
         "revision": "0",
         "role": "",
         "softwareID": "01GV140",
         "status": "Inactive",
         "type": "Firmware",
         "version": "L1BD"
      }],
      "FRU": "00FC615",
      "healthState": "OK",
      "healthStateKey": "OK",
      "hotSpareType": "None",
      "interfaceType": "SAS",
      "largestAvailableSize": 512,
      "m2Location": "",
      "manufacturer": "Seagate",
      "mediaType": "HDD",
      "model": "ST1200MM0009",
      "name": "Disk.0",
      "numberOfBlocks": 2344225968,
      "partNumber": "00FC615",
      "remainingLife": null,
      "serialNumber": "WFKBX0F4",
      "temperature": 22,
      "uuid": ""
   },
   ...,
   {
      "bay": 7,
      "blockSize": 512,
      "capacity": 300000000000,
      "description": "300GB 10K 12Gbps SAS 2.5 HDD",
      "diskState": "JBOD",
      "encryptionStatus": "Unencrypted",
      "firmware": [{
         "build": "0",
         "classifications": [ 10 ],
         "date": "",
         "deviceTypeKey": "firmware",
         "name": "ST300MM0008",
         "revision": "0",
         "role": "",
         "softwareID": "00KJ441",
         "status": "Inactive",
         "type": "Firmware",
         "version": "L58D"
      }],
      "FRU": "00FC612",
      "healthState": "OK",
      "healthStateKey": "OK",
      "hotSpareType": "None",
      "interfaceType": "SAS",
      "largestAvailableSize": 512,
      "m2Location": "",
      "manufacturer": "Seagate",
      "mediaType": "HDD",
      "model": "ST300MM0008",
      "name": "Disk.7",
      "numberOfBlocks": 585937500,
      "partNumber": "SH20J31903",
      "remainingLife": null,
      "serialNumber": "S4209Y1Y",
      "temperature": 21,
      "uuid": ""
   }
]

Give documentation feedback

GET /api/v1/data/devices/{id}/storage

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response body​