Skip to main content

GET – Drives managed by storage controller

Use the GET method to retrieve the drive resource for a server.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/Storage/Id/Drives/{DriveId}

Request body

None

Response body

Field

Type

Description

AssetTag

String

The asset tag for this drive.

Description

String

This resource is used to represent a drive for a Redfish implementation.

BlockSizeBytes

Number

Size of the smallest addressable unit of the associated drive.

CapableSpeedGbs

Number

Fastest capable bus speed of the associated drive.

CapacityBytes

Number

Size in bytes of this Drive.

EncryptionAbility

String

“None”

“SelfEncryptingDrive”

EncryptionStatus

String

“Unlocked”

“Locked”

“Unencrypted”

NegotiatedSpeedGbs

Number

The speed, in gigabit per second (Gbit/s), at which this drive currently communicates to the storage controller.

HotspareType

String

“None”

“Global”

Id

String

Drive slot id

FailurePredicted

Boolean

Indicate this drive currently predicting a failure in the near future.

Identifiers

Array

The Durable names for the drive.

 

Identifiers[N]

Object

Expanded.

  

DurableNameFormat

String

“UUID”

  

DurableName

String

Drive’s uuid info

Links

Object

Expanded.

 

Chassis

Link

A URI reference to a resource of chassis.

 

Volumes

Array

An array of references to the volumes contained in this drive.

  

Volumes[N]

Link

Link

 

PCIeFunctions

Array

An array of links to the PCIe functions that the drive produces.

  

PCIeFunctions[N]

Link

link

PhysicalLocation

Object

The location of this drive.

 

PartLocation

Object

The part location within the placement.

  

LocationOrdinalValue

Integer

The number that represents the location of this drive.

  

LocationType

String

“Bay”.

  

ServiceLabel

String

The service label of this drive.

 

Info

String

Slot number of the drive. If the storage is Host Bus Adapter or RAID, this property will be displayed.

 

InfoFormat

String

"Slot Number". If the storage is Host Bus Adapter or RAID, this property will be displayed.

Manufacturer

String

Drive’s manufacture

MediaType

String

Drive’s media type

Model

String

Model of the drive

Name

String

Name of the drive

PredictedMediaLifeLeftPercent

Number

0-100. disk info remaining life

SKU

String

The SKU for this drive.

StatusIndicator

String

The state of the status indicator, which communicates status information about this drive.

Note
If the storage is a NVMe AIC storage, this property will be hidden.

PartNumber

String

Part number of the drive

Protocol

String

The protocol this drive is using to communicate to storage controller.

Revision

String

Drive’s firmware/hardware version.

RotationSpeedRPM

Number

Drive’s rotation speed.

SerialNumber

String

Serial number of the drive

Status

Object

Expanded.

 

State

String

"Enabled"

 

Health

String

Drive’s health info

Note

The resource “Drive” can describe multiple types of drives. For some cases, such as NVMe added on M.2 card, partial info may not be available.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"SerialNumber": "W0K02Y42",
"Id": "Disk.1",
"@odata.id": "/redfish/v1/Systems/1/Storage/RAID_Slot18/Drives/Disk.1",
"Revision": "L5A7",
"AssetTag": "",
"FailurePredicted": false,
"BlockSizeBytes": 512,
"HotspareType": "None",
"CapableSpeedGbs": 12,
"Identifiers": [
{
"DurableName": "",
"DurableNameFormat": "UUID"
}
],
"StatusIndicator": null,
"PartNumber": "SH20L60465",
"EncryptionStatus": "Unencrypted",
"MediaType": "HDD",
"Description": "This resource is used to represent a drive for a Redfish implementation.",
Volumes": [],
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/1"
},
"PCIeFunctions": []
},
"RotationSpeedRPM": 10500,
"NegotiatedSpeedGbs": 12,
"@odata.type": "#Drive.v1_6_0.Drive",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Protocol": "SAS",
"Name": "300GB 10K 12Gbps SAS 2.5 HDD",
"PredictedMediaLifeLeftPercent": null,
"EncryptionAbility": "None",
"Oem": {
"Lenovo": {
"DriveStatus": "Unconfigured good",
"@odata.type": "#LenovoDrive.v1_0_0.LenovoDrive"
}
},
"CapacityBytes": 300000000000,
"PhysicalLocation": {
"PartLocation": {
"LocationType": "Bay",
"ServiceLabel": "Drive 1",
"LocationOrdinalValue": 1
},
"InfoFormat": "Slot Number",
"Info": "Slot 1",
"Info@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead.",
"InfoFormat@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead."
},
"Manufacturer": "LENOVO",
"@odata.etag": "\"9ed0621341dee6bbe98b640ddee6ad61\"",
"Model": "ST300MM0048",
"SKU": "00FC612"
}