GET – Drive Instance
Dependence
This is the schema definition for the Drives.
It represents the properties of a Drives attached to a System.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.
Request
GET https://{{ip}}/redfish/v1/Systems/Self/Storage/{{Storage_instance}}/Drives/{{Drives_instance}}
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following tables.
Name | Type | Read only | Description | |||||||
| (OData Attributes) | Refer to OData Support. | |||||||||
| Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types. | ||||||||
Id(M) | String | True | Refer to Resource Type Definitions | |||||||
Name(M) | String | True | ||||||||
Description | String | True | ||||||||
Status | Object | True | Refer to Resource Complex Types. | |||||||
Manufacturer | String | True | This is the manufacturer of this Drive | |||||||
Model | String | True | This is the model number for the Drive | |||||||
SKU | String | True | This is the SKU for this Drive. | |||||||
SerialNumber | String | True | The serial number for this Drive. | |||||||
PartNumber | String | True | The part number for this Drive. | |||||||
AssetTag | String | True | The user assigned asset tag for this Drive Default it will be null value. | |||||||
| Assembly | Object | True |
| |||||||
Revision | String | True | The revision of this Drive. This is typically the firmware/hardware version of the drive. | |||||||
Links | Object | True | The links object contains the links to other resources that are related to this resource. | |||||||
Name | Type | Read Only | Description | |||||||
Endpoints | Array | True | An array of references to the endpoints that connect to this drive. | |||||||
Endpoints@odata.count | Number | True | An integer representing the number of items in a collection. | |||||||
Oem | Object | Refer to Resource Complex Types. | ||||||||
Chassis | Object | True | A reference to the Chassis which contains this Drive. | |||||||
PCIeFunctions | Array | True | An array of references to the PCIe Functions which the drive produces. | |||||||
PCIeFunctions@odata.count | Number | True | An integer representing the number of items in a collection. | |||||||
Volumes | Array | True | An array of references to the volumes contained in this drive. This will reference Volumes that are either wholly or only partly contained by this drive. | |||||||
Volumes@odata.count | Number | True | An integer representing the number of items in a collection. | |||||||
Operations | Object | True | The operations currently running on the Drive. | |||||||
Name | Type | Read Only | Description | |||||||
OperationName | String | True | The name of the operation. | |||||||
PercentageComplete | Number | True | The percentage of the operation that has been completed. | |||||||
AssociatedTask | Object | True | A reference to the task associated with the operation if any. | |||||||
StatusIndicator | String | True | The state of the status indicator, used to communicate status information about this drive. | |||||||
Enum | Description | |||||||||
OK | The drive is OK. | |||||||||
Fail | The drive has failed. | |||||||||
Rebuild | The drive is being rebuilt. | |||||||||
PredictiveFailureAnalysis | The drive is still working but predicted to fail soon. | |||||||||
Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | |||||||||
InACriticalArray | The array that this drive is a part of is degraded. | |||||||||
InAFailedArray | The array that this drive is a part of is failed. | |||||||||
IndicatorLED | String | True | Thestate of the indicator LED, used to identify the drive. | |||||||
Enum | Description | |||||||||
Lit | The Indicator LED is lit | |||||||||
Blinking | The Indicator LED is blinking. | |||||||||
Off | The Indicator LED is off. | |||||||||
CapacityBytes | Number | True | The size in bytes of this Drive. | |||||||
FailurePredicted | Boolean | True | Is this drive currently predicting a failure in the near future. | |||||||
PhysicalLocation | Object | True | ||||||||
Protocol | String | True | The protocol this drive is using to communicate to the storage controller. | |||||||
Enum | Description | |||||||||
PCIe | PCI Express (Vendor Proprietary) | |||||||||
AHCI | Advanced Host Controller Interface | |||||||||
UHCI | Universal Host Controller Interface | |||||||||
SAS | Serial Attached SCSI | |||||||||
SATA | Serial AT Attachment | |||||||||
USB | Universal Serial Bus | |||||||||
NVMe | Non-Volatile Memory Express | |||||||||
FC | Fibre Channel | |||||||||
iSCSI | Internet SCSI | |||||||||
FCoE | Fibre Channel over Ethernet | |||||||||
NVMeOverFabrics | NVMe over Fabrics | |||||||||
SMB | Server Message Block (aka CIFS Common Internet File System) | |||||||||
NFSv3 | Network File System version 3 | |||||||||
NFSv4 | Network File System version 4 | |||||||||
HTTP | Hypertext Transport Protocol | |||||||||
HTTPS | Secure Hypertext Transport Protocol | |||||||||
SFTP | Secure File Transfer Protocol | |||||||||
FTP | File Transfer Protocol | |||||||||
MediaType | String | True | The type of media contained in this drive. | |||||||
Enum | Description | |||||||||
HDD | The drive media type is traditional magnetic platters. | |||||||||
SSD | The drive media type is solid state or flash memory. | |||||||||
SMR | The drive media type is shingled magnetic recording. | |||||||||
Identifiers | Array | True | ||||||||
EncryptionAbility | String | True | The encryption abilities of this drive. | |||||||
Enum | Description | |||||||||
None | The drive is not capable of self encryption. | |||||||||
SelfEncryptingDrive | The drive is capable of self encryption per th Trusted Computing Group's Self Encrypting Drive Standard. | |||||||||
Other | The drive is capable of self encryption through some other means. | |||||||||
HotspareType | String | True | The type of hotspare this drive is currently severing as. | |||||||
Enum | Description | |||||||||
None | The drive is not currently a hotspare. | |||||||||
Global | The drive is currently serving as a hotspare for all other drives in the storage system. | |||||||||
Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | |||||||||
Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | |||||||||
EncryptionStatus | String | True | The status of the encrpytion of this drive. | |||||||
Enum | Description | |||||||||
Unencrypted | The drive is not currently encrypted. Deprecated: Use Unencrypted. | |||||||||
Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | |||||||||
Locked | The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically. | |||||||||
Unencrypted | The drive is not currently encrypted. | |||||||||
Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data | |||||||||
RotationSpeedRPM | Number | True | The rotation speed of this Drive in Revolutions per Minute (RPM). | |||||||
BlockSizeBytes | Number | True | The size of the smallest addressable unit (Block) of this drive in bytes. | |||||||
CapableSpeedGbs | Number | True | The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second. | |||||||
NegotiatedSpeedGbs | Number | True | The speed which this drive is currently communicating to the storage controller in Gigabits per second. | |||||||
PredictedMediaLifeLeftPercent | Number | True | The percentage of reads and writes that are predicted to still be available for the media. | |||||||
HotspareReplacementMode | String | True | The replacement mode for the hotspare drive. | |||||||
Enum | Description | |||||||||
NonRevertible | A hotspare drive that is commissioned due to a drive failure will remain as a data drive and will not revert to a hotspare if the failed drive is replaced. | |||||||||
Revertible | A hotspare drive that is commissioned due to a drive failure will revert to being a hotspare once the failed drive is replaced and rebuilt. | |||||||||
WriteCacheEnabled | Boolean | True | This property shall indicate whether the drive write cache is enabled. | |||||||
Response example
{
"@odata.context": "/redfish/v1/$metadata#Drive.Drive",
"@odata.etag": "\"1619171740\"",
"@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device2_Port1",
"@odata.type": "#Drive.v1_6_0.Drive",
"BlockSizeBytes": 2048,
"CapacityBytes": 2048,
"EncryptionAbility": "None",
"EncryptionStatus": "Unlocked",
"FailurePredicted": false,
"HotspareType": "Chassis",
"Id": "USB_Device2_Port1",
"Links": {
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/Self"
},
"Endpoints@odata.count": 0,
"Volumes@odata.count": 0
},
"Manufacturer": "American Megatrends Inc.",
"MediaType": "HDD",
"Model": "Virtual Cdrom Device",
"Name": "USB_Device2_Port1",
"PredictedMediaLifeLeftPercent": 255,
"Protocol": "USB",
"Revision": "USB2.00",
"SerialNumber": "AAAABBBBCCCC1",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}