Storage

Drive 1.21.0⁠


Version	v1.21
Release	2024.4

Description⁠

The Drive schema represents a single physical drive for a system, including links to associated volumes. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if a unit is not present.

URIs⁠

/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId} (deprecated)
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId} (deprecated)
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId} (deprecated)
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId} (deprecated)
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId} (deprecated)

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#Drive.Reset (v1.7+) {}	object		This action resets this drive. For more information, see the Actions section below.
#Drive.RevertToOriginalFactoryState (v1.18+) {}	object		This action reverts a self-encrypting drive (SED) to the original factory state. For more information, see the Actions section below.
#Drive.SecureErase {}	object		This action securely erases the contents of the drive. For more information, see the Actions section below.
}
Assembly (v1.3+) {}	object		The link to the assembly associated with this drive.
AssetTag	string	read-write (null)	The user-assigned asset tag for this drive.
BlockSecurityIDEnabled (v1.20+)	boolean	read-write (null)	Indicates if establishment of a TCG-defined security ID (SID) on the drive is blocked.
BlockSizeBytes	integer (By)	read-only (null)	The size, in bytes, of the smallest addressable unit, or block.
CapableSpeedGbs	number (Gbit/s)	read-only (null)	The speed, in gigabits per second (Gbit/s) units, at which this drive can communicate to a storage controller in ideal conditions.
CapacityBytes	integer (By)	read-only (null)	The size, in bytes, of this drive.
Certificates (v1.12+) {}	object		The link to a collection of certificates for device identity and attestation.
ConfigurationLock (v1.19+)	string (enum)	read-write (null)	Indicates whether in-band configuration requests to the drive are locked. Other properties, such as `ConfigurationLockState`, contain additional information regarding the status of the configuration lock. For the possible property values, see ConfigurationLock in Property details.
DriveFormFactor (v1.16+)	string (enum)	read-only (null)	The form factor of the drive inserted in this slot. For the possible property values, see DriveFormFactor in Property details.
EncryptionAbility	string (enum)	read-only (null)	The encryption ability of this drive. For the possible property values, see EncryptionAbility in Property details.
EncryptionStatus	string (enum)	read-only (null)	The status of the encryption of this drive. For the possible property values, see EncryptionStatus in Property details.
EnvironmentMetrics (v1.12+) {}	object		The link to the environment metrics for this drive.
FailurePredicted	boolean	read-only (null)	An indication of whether this drive currently predicts a failure in the near future.
FirmwareVersion (v1.17+)	string	read-only (null)	The firmware version for this drive.
HardwareVersion (v1.21+)	string	read-only (null)	The hardware version of this drive.
HotspareReplacementMode (v1.5+)	string (enum)	read-write (null)	The replacement mode for the hot spare drive. For the possible property values, see HotspareReplacementMode in Property details.
HotspareType	string (enum)	read-write (null)	The type of hot spare that this drive serves as. For the possible property values, see HotspareType in Property details.
Identifiers [ { } ]	array (object)		The durable names for the drive. See the v1_23_0.v1_23_0 schema for details on this property.
IndicatorLED (deprecated v1.11)	string (enum)	read-write (null)	The state of the indicator LED, that identifies the drive. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.11 and later. This property has been deprecated in favor of the `LocationIndicatorActive` property.
Links {	object		The links to other resources that are related to this resource.
ActiveSoftwareImage (v1.16+) {}	object		The link to the software inventory that represents the active drive firmware image.
Chassis (v1.2+) {}	object		The link to the chassis that contains this drive.
Endpoints (v1.1+) [ {	array		An array of links to the endpoints that connect to this drive.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
NetworkDeviceFunctions (v1.14+) [ {	array		An array of links to the network device functions that provide network connectivity for this drive.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PCIeFunctions (v1.6+) [ {	array		An array of links to the PCIe functions that the drive produces.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
SoftwareImages (v1.16+) [ {	array		The images that are associated with this drive.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Storage (v1.13+) {}	object		A link to the storage subsystem to which this drive belongs.
StoragePools (v1.8+) [ {	array		An array of links to the storage pools to which this drive belongs.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Volumes [ {	array		An array of links to the volumes that this drive either wholly or only partially contains.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Location (deprecated v1.4) [ { } ]	array (object)		The location of the drive. See the v1_23_0.v1_23_0 schema for details on this property. Deprecated in v1.4 and later. This property has been deprecated in favor of the singular `PhysicalLocation` property.
LocationIndicatorActive (v1.11+)	boolean	read-write (null)	An indicator allowing an operator to physically locate this resource.
Manufacturer	string	read-only (null)	The manufacturer of this drive.
Measurements (v1.12+, deprecated v1.14) [ { } ]	array (object)		An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.14 and later. This property has been deprecated in favor of the `ComponentIntegrity` resource.
MediaType	string (enum)	read-only (null)	The type of media contained in this drive. For the possible property values, see MediaType in Property details.
Metrics (v1.17+) {}	object	(null)	The link to the metrics associated with this drive.
Model	string	read-only (null)	The model number for the drive.
Multipath (v1.9+)	boolean	read-only (null)	An indication of whether the drive is accessible from multiple paths.
NegotiatedSpeedGbs	number (Gbit/s)	read-only (null)	The speed, in gigabits per second (Gbit/s) units, at which this drive currently communicates to the storage controller.
NVMe (v1.20+) {	object	(null)	NVMe properties for this drive.
ConfigurationLockState (v1.20+) {	object	(null)	The configurable features that are able to be locked from in-band usage on an NVMe subsystem and their current lock state.
FirmwareCommit (v1.20+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Firmware Commit command. For the possible property values, see FirmwareCommit in Property details.
FirmwareImageDownload (v1.20+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Firmware Image Download command. For the possible property values, see FirmwareImageDownload in Property details.
Lockdown (v1.20+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Lockdown command. For the possible property values, see Lockdown in Property details.
SecuritySend (v1.20+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Security Send command. For the possible property values, see SecuritySend in Property details.
VPDWrite (v1.20+)	string (enum)	read-only (null)	The lock state of the NVMe-MI-defined VPD Write command. For the possible property values, see VPDWrite in Property details.
}
}
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Operations (v1.1+) [ {	array		The operations currently running on the drive.
AssociatedTask (v1.1+) {}	object		The link to the task associated with the operation, if any.
Operation (v1.17+)	string (enum)	read-only (null)	The type of the operation. For the possible property values, see Operation in Property details.
OperationName (v1.1+, deprecated v1.17)	string	read-only (null)	The name of the operation. Deprecated in v1.17 and later. This property is deprecated in favor of the `Operation` property using the `OperationType` enumeration defined in the `Volume` schema.
PercentageComplete (v1.1+)	integer (%)	read-only (null)	The percentage of the operation that has been completed.
} ]
PartNumber	string	read-only (null)	The part number for this drive.
PhysicalLocation (v1.4+) {}	object		The location of the drive. This property is equivalent to the `Location` property common to other standard Redfish resources. See the v1_23_0.v1_23_0 schema for details on this property.
PredictedMediaLifeLeftPercent	number (%)	read-only (null)	The percentage of reads and writes that are predicted to be available for the media.
Protocol	string (enum)	read-only (null)	The protocol that this drive currently uses to communicate to the storage controller. For the possible property values, see Protocol in Property details.
ReadyToRemove (v1.10+)	boolean	read-write (null)	An indication of whether the drive is prepared by the system for removal.
Revision	string	read-only (null)	The revision of a SCSI-based drive, as returned from the 'Inquiry' command, which can be the firmware or hardware version. For other types of drives, the `HardwareVersion` and `FirmwareVersion` properties are recommended in favor of this property.
RotationSpeedRPM	number ({rev}/min)	read-only (null)	The rotation speed of this drive, in revolutions per minute (RPM) units.
SerialNumber	string	read-only (null)	The serial number for this drive.
SKU	string	read-only (null)	The SKU for this drive.
SlotCapableProtocols (v1.16+) [ ]	array (string (enum))	read-only (null)	The drive protocols capable in this slot. For the possible property values, see SlotCapableProtocols in Property details.
SlotFormFactor (v1.16+)	string (enum)	read-only (null)	The form factor of the slot. For the possible property values, see SlotFormFactor in Property details.
SparePartNumber (v1.19+)	string	read-only (null)	The spare part number of the drive.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
StatusIndicator	string (enum)	read-write (null)	The state of the status indicator, which communicates status information about this drive. For the possible property values, see StatusIndicator in Property details.
TargetConfigurationLockLevel (v1.20+)	string (enum)	read-write (null)	Indicates the target configuration lock level for the drive based upon the state of the `ConfigurationLock` property. Other properties, such as `ConfigurationLockState`, contain additional information regarding the status of the configuration lock. For the possible property values, see TargetConfigurationLockLevel in Property details.
WriteCacheEnabled (v1.7+)	boolean	read-write (null)	An indication of whether the drive write cache is enabled.

Actions⁠

Reset (v1.7+)⁠

Description

This action resets this drive.

Action URI

{Base URI of target resource}/Actions/Drive.Reset

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	optional	The type of reset. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "On"
}

RevertToOriginalFactoryState (v1.18+)⁠

Description

This action reverts a self-encrypting drive (SED) to the original factory state.

Action URI

{Base URI of target resource}/Actions/Drive.RevertToOriginalFactoryState

Action parameters

Parameter Name	Type	Attributes	Notes
PhysicalSecureID	string	optional	The physical secure ID (PSID). The PSID is generally printed on the drive label and used to revert an encrypted SED.

Request Example

{
    "PhysicalSecureID": "89831871198324172084565217361041"
}

SecureErase⁠

Description

This action securely erases the contents of the drive.

Action URI

{Base URI of target resource}/Actions/Drive.SecureErase

Action parameters

Parameter Name	Type	Attributes	Notes
OverwritePasses (v1.15+)	integer	optional	The number of times to overwrite the drive if performing an overwrite type of sanitization.
SanitizationType (v1.15+)	string (enum)	optional	The type of data sanitization to perform. For the possible property values, see SanitizationType in Property details.

Request Example

{
    "SanitizationType": "CryptographicErase"
}

Property details⁠

ConfigurationLock⁠

Indicates whether in-band configuration requests to the drive are locked. Other properties, such as ConfigurationLockState, contain additional information regarding the status of the configuration lock.

string	Description
Disabled	In-band configuration requests are not locked.
Enabled	In-band configuration requests are locked as specified by `TargetConfigurationLockLevel`.
Partial	Some in-band configuration requests are not locked while others are locked. This value is used for status reporting to indicate that the drive is partially locked and client action is recommended.

DriveFormFactor⁠

The form factor of the drive inserted in this slot.

string	Description
Drive2_5	A 2.5 inch drive.
Drive3_5	A 3.5 inch drive.
EDSFF (v1.18+)	An EDSFF drive.
EDSFF_1U_Long	An EDSFF 1U Long (E1.L) drive.
EDSFF_1U_Short	An EDSFF 1U Short (E1.S) drive.
EDSFF_E3_Long	An EDSFF E3 Long (E3.L) drive.
EDSFF_E3_Short	An EDSFF E3 Short (E3.S) drive.
M2 (v1.18+)	An M.2 drive.
M2_22110	An M.2 22110 drive.
M2_2230	An M.2 2230 drive.
M2_2242	An M.2 2242 drive.
M2_2260	An M.2 2260 drive.
M2_2280	An M.2 2280 drive.
OEM	An OEM-defined form factor.
PCIeHalfLength	A half-length PCIe add-in card.
PCIeSlotFullLength	A full-length PCIe add-in card.
PCIeSlotLowProfile	A low-profile PCIe add-in card.
U2	A U.2 drive.

EncryptionAbility⁠

The encryption ability of this drive.

string	Description
None	The drive is not capable of self-encryption.
Other	The drive is capable of self-encryption through some other means.
SelfEncryptingDrive	The drive is capable of self-encryption per the Trusted Computing Group's Self Encrypting Drive Standard.

EncryptionStatus⁠

The status of the encryption of this drive.

string	Description
Foreign	The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data.
Locked	The drive is currently encrypted and the data is not accessible to the user. However, the system can unlock the drive automatically.
Unecrypted (deprecated v1.1)	The drive is not currently encrypted. Deprecated in v1.1 and later. This value has been deprecated in favor of Unencrypted.
Unencrypted (v1.1+)	The drive is not currently encrypted.
Unlocked	The drive is currently encrypted but the data is accessible to the user in unencrypted form.

FirmwareCommit⁠

The lock state of the NVMe-defined Firmware Commit command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

FirmwareImageDownload⁠

The lock state of the NVMe-defined Firmware Image Download command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

HotspareReplacementMode⁠

The replacement mode for the hot spare drive.

string	Description
NonRevertible	The hot spare drive that is commissioned due to a drive failure remains as a data drive and does not revert to a hot spare if the failed drive is replaced.
Revertible	The hot spare drive that is commissioned due to a drive failure reverts to a hot spare after the failed drive is replaced and rebuilt.

HotspareType⁠

The type of hot spare that this drive serves as.

string	Description
Chassis	The drive is serving as a hot spare for all other drives in this storage domain that are contained in the same chassis.
Dedicated	The drive is serving as a hot spare for a user-defined set of drives or volumes. Clients cannot specify this value when modifying the `HotspareType` property. This value is reported as a result of configuring the spare drives within a volume.
Global	The drive is serving as a hot spare for all other drives in this storage domain.
None	The drive is not a hot spare.

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

IndicatorLED⁠

The state of the indicator LED, that identifies the drive.

string	Description
Blinking	The indicator LED is blinking.
Lit	The indicator LED is lit.
Off	The indicator LED is off.

Lockdown⁠

The lock state of the NVMe-defined Lockdown command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

MediaType⁠

The type of media contained in this drive.

string	Description
HDD	The drive media type is traditional magnetic platters.
SMR	The drive media type is shingled magnetic recording.
SSD	The drive media type is solid state or flash memory.

Operation⁠

The type of the operation.

string	Description
ChangeRAIDType	A ChangeRAIDType operation is being performed.
ChangeStripSize	A ChangeStripSize operation is being performed.
CheckConsistency	A CheckConsistency operation is being performed.
Compress	A Compress operation is being performed.
Decrypt	A Decrypt operation is being performed.
Deduplicate	A Deduplicate operation is being performed.
Delete	A Delete operation is being performed.
Encrypt	An Encrypt operation is being performed.
Format	A Format operation is being performed.
Initialize	An Initialize operation is being performed.
Rebuild	A Rebuild operation is being performed.
Replicate	A Replicate operation is being performed.
Resize	A Resize operation is being performed.
Sanitize	A Sanitize operation is being performed.

Protocol⁠

The protocol that this drive currently uses to communicate to the storage controller.

string	Description
AHCI	Advanced Host Controller Interface (AHCI).
CXL	Compute Express Link.
DisplayPort	DisplayPort.
DVI	DVI.
eMMC	Embedded MultiMediaCard (e.MMC).
Ethernet	Ethernet.
FC	Fibre Channel.
FCoE	Fibre Channel over Ethernet (FCoE).
FCP	Fibre Channel Protocol for SCSI.
FICON	FIbre CONnection (FICON).
FTP	File Transfer Protocol (FTP).
GenZ	GenZ.
HDMI	HDMI.
HTTP	Hypertext Transport Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
I2C	Inter-Integrated Circuit Bus.
InfiniBand	InfiniBand.
iSCSI	Internet SCSI.
iWARP	Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol	Multiple Protocols.
NFSv3	Network File System (NFS) version 3.
NFSv4	Network File System (NFS) version 4.
NVLink	NVLink.
NVMe	Non-Volatile Memory Express (NVMe).
NVMeOverFabrics	NVMe over Fabrics.
OEM	OEM-specific.
PCIe	PCI Express.
QPI	Intel QuickPath Interconnect (QPI).
RoCE	RDMA over Converged Ethernet Protocol.
RoCEv2	RDMA over Converged Ethernet Protocol Version 2.
SAS	Serial Attached SCSI.
SATA	Serial AT Attachment.
SFTP	SSH File Transfer Protocol (SFTP).
SMB	Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP	Transmission Control Protocol (TCP).
TFTP	Trivial File Transfer Protocol (TFTP).
UALink	Ultra Accelerator Link (UALink).
UDP	User Datagram Protocol (UDP).
UET	Ultra Ethernet Transport.
UHCI	Universal Host Controller Interface (UHCI).
UPI	Intel UltraPath Interconnect (UPI).
USB	Universal Serial Bus (USB).
VGA	VGA.

ResetType⁠

The type of reset.

string	Description
ForceOff	Turn off the unit immediately (non-graceful shutdown).
ForceOn	Turn on the unit immediately.
ForceRestart	Shut down immediately and non-gracefully and restart the unit.
FullPowerCycle	Full power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource.
GracefulRestart	Shut down gracefully and restart the unit.
GracefulShutdown	Shut down gracefully and power off.
Nmi	Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On	Turn on the unit.
Pause	Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
PowerCycle	Power cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource.
PushPowerButton	Simulate the pressing of the physical power button on this unit.
Resume	Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
Suspend	Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.

SanitizationType⁠

The type of data sanitization to perform.

string	Description
BlockErase	Delete all logical block addresses, including those that are not currently mapping to active addresses, but leaving the data on the drive.
CryptographicErase	Erase the target data's encryption key leaving only the ciphertext on the drive. For more information, see NIST800-88 and ISO/IEC 27040.
Overwrite	Overwrite data by writing an implementation-specific pattern onto all sectors of the drive.

SecuritySend⁠

The lock state of the NVMe-defined Security Send command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

SlotCapableProtocols⁠

The drive protocols capable in this slot.

string	Description
AHCI	Advanced Host Controller Interface (AHCI).
CXL	Compute Express Link.
DisplayPort	DisplayPort.
DVI	DVI.
eMMC	Embedded MultiMediaCard (e.MMC).
Ethernet	Ethernet.
FC	Fibre Channel.
FCoE	Fibre Channel over Ethernet (FCoE).
FCP	Fibre Channel Protocol for SCSI.
FICON	FIbre CONnection (FICON).
FTP	File Transfer Protocol (FTP).
GenZ	GenZ.
HDMI	HDMI.
HTTP	Hypertext Transport Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
I2C	Inter-Integrated Circuit Bus.
InfiniBand	InfiniBand.
iSCSI	Internet SCSI.
iWARP	Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol	Multiple Protocols.
NFSv3	Network File System (NFS) version 3.
NFSv4	Network File System (NFS) version 4.
NVLink	NVLink.
NVMe	Non-Volatile Memory Express (NVMe).
NVMeOverFabrics	NVMe over Fabrics.
OEM	OEM-specific.
PCIe	PCI Express.
QPI	Intel QuickPath Interconnect (QPI).
RoCE	RDMA over Converged Ethernet Protocol.
RoCEv2	RDMA over Converged Ethernet Protocol Version 2.
SAS	Serial Attached SCSI.
SATA	Serial AT Attachment.
SFTP	SSH File Transfer Protocol (SFTP).
SMB	Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP	Transmission Control Protocol (TCP).
TFTP	Trivial File Transfer Protocol (TFTP).
UALink	Ultra Accelerator Link (UALink).
UDP	User Datagram Protocol (UDP).
UET	Ultra Ethernet Transport.
UHCI	Universal Host Controller Interface (UHCI).
UPI	Intel UltraPath Interconnect (UPI).
USB	Universal Serial Bus (USB).
VGA	VGA.

SlotFormFactor⁠

The form factor of the slot.

string	Description
Drive2_5	A 2.5 inch drive.
Drive3_5	A 3.5 inch drive.
EDSFF (v1.18+)	An EDSFF drive.
EDSFF_1U_Long	An EDSFF 1U Long (E1.L) drive.
EDSFF_1U_Short	An EDSFF 1U Short (E1.S) drive.
EDSFF_E3_Long	An EDSFF E3 Long (E3.L) drive.
EDSFF_E3_Short	An EDSFF E3 Short (E3.S) drive.
M2 (v1.18+)	An M.2 drive.
M2_22110	An M.2 22110 drive.
M2_2230	An M.2 2230 drive.
M2_2242	An M.2 2242 drive.
M2_2260	An M.2 2260 drive.
M2_2280	An M.2 2280 drive.
OEM	An OEM-defined form factor.
PCIeHalfLength	A half-length PCIe add-in card.
PCIeSlotFullLength	A full-length PCIe add-in card.
PCIeSlotLowProfile	A low-profile PCIe add-in card.
U2	A U.2 drive.

StatusIndicator⁠

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

string	Description
Fail	The drive has failed.
Hotspare	The drive has been marked to automatically rebuild and replace a failed drive.
InACriticalArray	The array to which this drive belongs has been degraded.
InAFailedArray	The array to which this drive belongs has failed.
OK	The drive is OK.
PredictiveFailureAnalysis	The drive still works but is predicted to fail soon.
Rebuild	The drive is being rebuilt.

TargetConfigurationLockLevel⁠

Indicates the target configuration lock level for the drive based upon the state of the ConfigurationLock property. Other properties, such as ConfigurationLockState, contain additional information regarding the status of the configuration lock.

string	Description
Baseline	The standard configuration lock level, corresponding to applying firmware, updating security keys, and modifying other hardware settings. It does not include managing the volumes or data on the drive.

VPDWrite⁠

The lock state of the NVMe-MI-defined VPD Write command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

Example response⁠

{
    "@odata.type": "#Drive.v1_22_0.Drive",
    "Id": "3D58ECBC375FD9F2",
    "Name": "Drive Sample",
    "LocationIndicatorActive": true,
    "Model": "C123",
    "Revision": "100A",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "CapacityBytes": 899527000064,
    "FailurePredicted": false,
    "Protocol": "SAS",
    "MediaType": "HDD",
    "Manufacturer": "Contoso",
    "SerialNumber": "1234568",
    "PartNumber": "C123-1111",
    "Identifiers": [
        {
            "DurableNameFormat": "NAA",
            "DurableName": "32ADF365C6C1B7BD"
        }
    ],
    "HotspareType": "None",
    "EncryptionAbility": "SelfEncryptingDrive",
    "EncryptionStatus": "Unlocked",
    "RotationSpeedRPM": 15000,
    "BlockSizeBytes": 512,
    "CapableSpeedGbs": 12,
    "NegotiatedSpeedGbs": 12,
    "Links": {
        "Volumes": [
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/2"
            },
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/3"
            }
        ]
    },
    "Actions": {
        "#Drive.SecureErase": {
            "target": "/redfish/v1/Chassis/1U/Drives/3D58ECBC375FD9F2/Actions/Drive.SecureErase"
        }
    },
    "@odata.id": "/redfish/v1/Chassis/1U/Drives/3D58ECBC375FD9F2"
}

Storage 1.19.0⁠


Version	v1.19
Release	2025.2

Description⁠

The Storage schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of physical or virtual storage controllers and the resources, such as volumes, that can be accessed from that subsystem.

URIs⁠

/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}
/redfish/v1/Storage/{StorageId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#Storage.ImportForeignDrives (v1.19+) {}	object		This action imports encrypted foreign drives to a host-based storage controller by supplying encryption access credentials. For more information, see the Actions section below.
#Storage.RekeyExternalKey (v1.16+) {}	object		This action causes the controllers of the storage subsystem to request new encryption keys managed by an external key service. For more information, see the Actions section below.
#Storage.ResetToDefaults (v1.11+) {}	object		The reset action resets the storage device to factory defaults. This can cause the loss of data. For more information, see the Actions section below.
#Storage.SetControllerPassword (v1.17+) {}	object		This action sets the controller boot password for a host-based storage controller. For more information, see the Actions section below.
#Storage.SetEncryptionKey {}	object		This action sets the local encryption key for the storage subsystem. For more information, see the Actions section below.
}
AutoVolumeCreate (v1.15+)	string (enum)	read-write (null)	Indicates if this storage subsystem automatically creates new volumes for unassigned drives. For the possible property values, see AutoVolumeCreate in Property details.
BlockSecurityIDPolicy (v1.18+)	boolean	read-write (null)	Indicates if the storage controller sends a command to block establishment of a TCG-defined security ID (SID) during each drive boot sequence for drives that support it.
ConfigurationLock (v1.16+)	string (enum)	read-write (null)	Indicates whether in-band configuration requests to the storage subsystem are locked. Other properties, such as `ConfigurationLockState`, contain additional information regarding the status of the configuration lock. For the possible property values, see ConfigurationLock in Property details.
Connections (v1.15+) {}	object		The collection of links to the connections that this storage subsystem contains.
ConsistencyGroups (v1.8+) {}	object		The consistency groups, each of which contains a set of volumes that are treated by an application or set of applications as a single resource, that are managed by this storage subsystem.
Controllers (v1.9+) {}	object		The set of controllers instantiated by this storage subsystem.
Drives [ {	array		The set of drives attached to the storage controllers that this resource represents.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
EncryptionMode (v1.14+)	string (enum)	read-write (null)	The encryption mode of this storage subsystem. For the possible property values, see EncryptionMode in Property details.
EndpointGroups (v1.8+) {}	object		All of the endpoint groups, each of which contains a set of endpoints that are used for a common purpose such as an ACL or logical identification, that belong to this storage subsystem.
FileSystems (v1.8+) {}	object		All file systems that are allocated by this storage subsystem.
HotspareActivationPolicy (v1.14+)	string (enum)	read-write (null)	The policy under which hot spare drives in this storage domain will activate. For the possible property values, see HotspareActivationPolicy in Property details.
Identifiers (v1.9+) [ { } ]	array (object)		The durable names for the storage subsystem. See the v1_23_0.v1_23_0 schema for details on this property.
Links {	object		The links to other resources that are related to this resource.
BlockSecurityIDUnsupportedDrives (v1.18+) [ {	array		The set of drives in this storage subsystem that do not support blocking of TCG-defined security ID (SID).
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
BlockSecurityIDUpdateUnsuccessfulDrives (v1.18+) [ {	array		The set of drives in this storage subsystem for which the most recent attempt to block TCG-defined security ID (SID) failed.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Enclosures [ {	array		An array of links to the chassis to which this storage subsystem is attached.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
HostingStorageSystems (v1.11+) [ {	array		The storage systems that host this storage subsystem.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
NVMeoFDiscoverySubsystems (v1.15+) [ {	array		An array of links to the discovery subsystems that discovered this subsystem in an NVMe-oF environment.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
SimpleStorage (v1.9+) {}	object		The link to the simple storage instance that corresponds to this storage.
StorageServices (v1.9+) [ {	array		An array of links to the storage services that connect to this storage subsystem.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
LocalEncryptionKeyIdentifier (v1.14+)	string	read-only (null)	The local encryption key identifier used by the storage subsystem.
Metrics (v1.18+) {}	object	(null)	The link to the metrics associated with this storage subsystem.
NVMeSubsystemProperties (v1.16+) {	object	(null)	Information specific to NVMe Subsystems.
ConfigurationLockState (v1.17+) {	object	(null)	The configurable features that are able to be locked from in-band usage on an NVMe subsystem and their current lock state.
FirmwareCommit (v1.17+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Firmware Commit command. For the possible property values, see FirmwareCommit in Property details.
FirmwareImageDownload (v1.17+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Firmware Image Download command. For the possible property values, see FirmwareImageDownload in Property details.
Lockdown (v1.17+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Lockdown command. For the possible property values, see Lockdown in Property details.
SecuritySend (v1.17+)	string (enum)	read-only (null)	The lock state of the NVMe-defined Security Send command. For the possible property values, see SecuritySend in Property details.
VPDWrite (v1.17+)	string (enum)	read-only (null)	The lock state of the NVMe-MI-defined VPD Write command. For the possible property values, see VPDWrite in Property details.
}
MaxNamespacesSupported (v1.16+)	number	read-only (null)	The maximum number of namespace attachments supported by this NVMe Subsystem.
SharedNamespaceControllerAttachmentSupported (v1.16+)	boolean	read-only (null)	Indicates whether the subsystem supports shared namespace controller attachment, allowing a shared namespace to be attached concurrently to two or more controllers in an NVMe Subsystem.
}
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Redundancy [ {	array		Redundancy information for the storage subsystem.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
StorageControllers (deprecated v1.13) [ {	array		The set of storage controllers that this resource represents. Deprecated in v1.13 and later. This property has been deprecated in favor of `Controllers` to allow for storage controllers to be represented as their own resources.
@odata.id	string (URI)	read-only required	The unique identifier for a resource.
Actions (v1.2+) {}	object		The available actions for this resource.
Assembly (v1.4+) {}	object		The link to the assembly associated with this storage controller.
AssetTag	string	read-write (null)	The user-assigned asset tag for this storage controller.
CacheSummary (v1.5+) {	object		The cache memory of the storage controller in general detail.
PersistentCacheSizeMiB (v1.5+)	integer (MiBy)	read-only (null)	The portion of the cache memory that is persistent, measured in MiB.
Status (v1.5+) {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
TotalCacheSizeMiB (v1.5+)	integer (MiBy)	read-only required (null)	The total configured cache memory, measured in MiB.
}
Certificates (v1.10+) {}	object		The link to a collection of certificates for device identity and attestation.
ControllerRates (v1.7+) {	object		This property describes the various controller rates used for processes such as volume rebuild or consistency checks.
ConsistencyCheckRatePercent (v1.7+)	integer	read-write (null)	The percentage of controller resources used for performing a data consistency check on volumes.
RebuildRatePercent (v1.7+)	integer	read-write (null)	The percentage of controller resources used for rebuilding/repairing volumes.
TransformationRatePercent (v1.7+)	integer	read-write (null)	The percentage of controller resources used for transforming volumes from one configuration to another.
}
FirmwareVersion	string	read-only (null)	The firmware version of this storage controller.
Identifiers [ { } ]	array (object)		The durable names for the storage controller. See the v1_23_0.v1_23_0 schema for details on this property.
Links (v1.1+) {	object		The links to other resources that are related to this resource.
Endpoints (v1.1+) [ {	array		An array of links to the endpoints that connect to this controller.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PCIeFunctions (v1.7+) [ {	array		An array of links to the PCIe functions that the storage controller produces.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
StorageServices (v1.4+, deprecated v1.9) [ {	array		An array of links to the storage services that connect to this controller. Deprecated in v1.9 and later. This property has been deprecated in favor of `StorageServices` within the `Links` property at the root level.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Location (v1.4+) {}	object		The location of the storage controller. See the v1_23_0.v1_23_0 schema for details on this property.
Manufacturer	string	read-only (null)	The manufacturer of this storage controller.
Measurements (v1.10+, deprecated v1.12) [ { } ]	array (object)		An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.12 and later. This property has been deprecated in favor of the `ComponentIntegrity` resource.
MemberId	string	read-only required	The unique identifier for the member within an array.
Model	string	read-only (null)	The model number for the storage controller.
Name (v1.3+)	string	read-only (null)	The name of the storage controller.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PartNumber	string	read-only (null)	The part number for this storage controller.
PCIeInterface (v1.5+) {}	object		The PCIe interface details for this controller. See the PCIeDevice.v1_21_0 schema for details on this property.
Ports (v1.7+) {}	object		The link to the collection of ports that exist on the storage controller.
SerialNumber	string	read-only (null)	The serial number for this storage controller.
SKU	string	read-only (null)	The SKU for this storage controller.
SpeedGbps	number (Gbit/s)	read-only (null)	The maximum speed of the storage controller's device interface.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
SupportedControllerProtocols [ ]	array (string (enum))	read-only	The supported set of protocols for communicating with this storage controller. For the possible property values, see SupportedControllerProtocols in Property details.
SupportedDeviceProtocols [ ]	array (string (enum))	read-only	The protocols that the storage controller can use to communicate with attached devices. For the possible property values, see SupportedDeviceProtocols in Property details.
SupportedRAIDTypes (v1.6+) [ ]	array (string (enum))	read-only (null)	The set of RAID types supported by the storage controller. For the possible property values, see SupportedRAIDTypes in Property details.
} ]
StorageGroups (v1.8+, deprecated v1.15) {}	object		All of the storage groups, each of which contains a set of volumes and endpoints that are managed as a group for mapping and masking, that belong to this storage subsystem. Deprecated in v1.15 and later. This property was deprecated in favor of the `Connections` property.
StoragePools (v1.8+) {}	object		The set of all storage pools that are allocated by this storage subsystem. A storage pool is the set of storage capacity that can be used to produce volumes or other storage pools.
TargetConfigurationLockLevel (v1.17+)	string (enum)	read-write (null)	Indicates the target configuration lock level for the drive based upon the state of the `ConfigurationLock` property. Other properties, such as `ConfigurationLockState`, contain additional information regarding the status of the configuration lock. For the possible property values, see TargetConfigurationLockLevel in Property details.
Volumes {}	object		The set of volumes that the storage controllers produce.

Actions⁠

ImportForeignDrives (v1.19+)⁠

Description

This action imports encrypted foreign drives to a host-based storage controller by supplying encryption access credentials.

Action URI

{Base URI of target resource}/Actions/Storage.ImportForeignDrives

Action parameters

Parameter Name	Type	Attributes	Notes
ControllerPassword	string	optional	The current controller password. This parameter is not required if the controller does not currently have a password.
DriveEncryptionKey	string	required	The encryption key to unlock the drives.
DriveEncryptionKeyIdentifier	string	optional	An encryption key identifier to filter the drives that are imported. If not provided, the controller attempts to import all foreign drives.

Request Example

{
    "ControllerPassword": "P@ssw0rd",
    "DriveEncryptionKey": "566b523d3f955a7fba38a28ec708ca10"
}

RekeyExternalKey (v1.16+)⁠

Description

This action causes the controllers of the storage subsystem to request new encryption keys managed by an external key service.

Action URI

{Base URI of target resource}/Actions/Storage.RekeyExternalKey

Action parameters

This action takes no parameters.

ResetToDefaults (v1.11+)⁠

Description

The reset action resets the storage device to factory defaults. This can cause the loss of data.

Action URI

{Base URI of target resource}/Actions/Storage.ResetToDefaults

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	required	The type of reset to defaults. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "ResetAll"
}

SetControllerPassword (v1.17+)⁠

Description

This action sets the controller boot password for a host-based storage controller.

Action URI

{Base URI of target resource}/Actions/Storage.SetControllerPassword

Action parameters

Parameter Name	Type	Attributes	Notes
CurrentPassword	string	optional	The current controller password. This parameter is not needed if the controller does not currently have a password.
NewPassword	string	required	The new password to set for the controller.
SecurityKey	string	optional	The security key for the controller. This parameter is not needed if the controller does not have a security key.

Request Example

{
    "CurrentPassword": "MyC0nt0s0C0ntr0ller",
    "NewPassword": "MyNewC0nt0s0C0ntr0ller",
    "SecurityKey": "566b523d3f955a7fba38a28ec708ca10"
}

SetEncryptionKey⁠

Description

This action sets the local encryption key for the storage subsystem.

Action URI

{Base URI of target resource}/Actions/Storage.SetEncryptionKey

Action parameters

Parameter Name	Type	Attributes	Notes
CurrentEncryptionKey (v1.14+)	string	optional	The current local encryption key on the storage subsystem. This parameter is not needed if the controller does not currently have an encryption key.
EncryptionKey	string	required	The local encryption key to set on the storage subsystem.
EncryptionKeyIdentifier (v1.14+)	string	optional	The local encryption key identifier used by the storage subsystem.

Request Example

{
    "EncryptionKey": "566b523d3f955a7fba38a28ec708ca10"
}

Property details⁠

AutoVolumeCreate⁠

Indicates if this storage subsystem automatically creates new volumes for unassigned drives.

string	Description
Disabled	Do not automatically create volumes.
NonRAID	Automatically create non-RAID volumes.
RAID0	Automatically create RAID0 volumes.
RAID1	Automatically create RAID1 volumes.

ConfigurationLock⁠

Indicates whether in-band configuration requests to the storage subsystem are locked. Other properties, such as ConfigurationLockState, contain additional information regarding the status of the configuration lock.

string	Description
Disabled	In-band configuration requests are not locked.
Enabled	In-band configuration requests are locked as specified by `TargetConfigurationLockLevel`.
Partial	Some in-band configuration requests are not locked while others are locked. This value is used for status reporting to indicate that the storage subsystem is partially locked and client action is recommended.

EncryptionMode⁠

The encryption mode of this storage subsystem.

string	Description
Disabled	Encryption is disabled on the storage subsystem.
PasswordOnly (v1.17+)	The storage subsystem uses a password, but no keys for encryption.
PasswordWithExternalKey (v1.17+)	The storage subsystem uses a password and one or more external keys for encryption.
PasswordWithLocalKey (v1.17+)	The storage subsystem uses a password and a local key for encryption.
UseExternalKey	The storage subsystem uses one or more external keys for encryption.
UseLocalKey	The storage subsystem uses a local key for encryption.

FirmwareCommit⁠

The lock state of the NVMe-defined Firmware Commit command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

FirmwareImageDownload⁠

The lock state of the NVMe-defined Firmware Image Download command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

HotspareActivationPolicy⁠

The policy under which hot spare drives in this storage domain will activate.

string	Description
OEM	The hot spare drive will take over for the original drive in an algorithm custom to the OEM.
OnDriveFailure	The hot spare drive will take over for the original drive when the original drive has been marked as failed by the storage domain.
OnDrivePredictedFailure	The hot spare drive will take over for the original drive when the original drive has been predicted to fail in the future by the storage domain.

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

Lockdown⁠

The lock state of the NVMe-defined Lockdown command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

ResetType⁠

The type of reset to defaults.

string	Description
PreserveVolumes	Reset all settings to factory defaults but preserve the configured volumes on the controllers.
ResetAll	Reset all settings to factory defaults and remove all volumes.

SecuritySend⁠

The lock state of the NVMe-defined Security Send command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

SupportedControllerProtocols⁠

The supported set of protocols for communicating with this storage controller.

string	Description
AHCI	Advanced Host Controller Interface (AHCI).
CXL	Compute Express Link.
DisplayPort	DisplayPort.
DVI	DVI.
eMMC	Embedded MultiMediaCard (e.MMC).
Ethernet	Ethernet.
FC	Fibre Channel.
FCoE	Fibre Channel over Ethernet (FCoE).
FCP	Fibre Channel Protocol for SCSI.
FICON	FIbre CONnection (FICON).
FTP	File Transfer Protocol (FTP).
GenZ	GenZ.
HDMI	HDMI.
HTTP	Hypertext Transport Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
I2C	Inter-Integrated Circuit Bus.
InfiniBand	InfiniBand.
iSCSI	Internet SCSI.
iWARP	Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol	Multiple Protocols.
NFSv3	Network File System (NFS) version 3.
NFSv4	Network File System (NFS) version 4.
NVLink	NVLink.
NVMe	Non-Volatile Memory Express (NVMe).
NVMeOverFabrics	NVMe over Fabrics.
OEM	OEM-specific.
PCIe	PCI Express.
QPI	Intel QuickPath Interconnect (QPI).
RoCE	RDMA over Converged Ethernet Protocol.
RoCEv2	RDMA over Converged Ethernet Protocol Version 2.
SAS	Serial Attached SCSI.
SATA	Serial AT Attachment.
SFTP	SSH File Transfer Protocol (SFTP).
SMB	Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP	Transmission Control Protocol (TCP).
TFTP	Trivial File Transfer Protocol (TFTP).
UALink	Ultra Accelerator Link (UALink).
UDP	User Datagram Protocol (UDP).
UET	Ultra Ethernet Transport.
UHCI	Universal Host Controller Interface (UHCI).
UPI	Intel UltraPath Interconnect (UPI).
USB	Universal Serial Bus (USB).
VGA	VGA.

SupportedDeviceProtocols⁠

The protocols that the storage controller can use to communicate with attached devices.

string	Description
AHCI	Advanced Host Controller Interface (AHCI).
CXL	Compute Express Link.
DisplayPort	DisplayPort.
DVI	DVI.
eMMC	Embedded MultiMediaCard (e.MMC).
Ethernet	Ethernet.
FC	Fibre Channel.
FCoE	Fibre Channel over Ethernet (FCoE).
FCP	Fibre Channel Protocol for SCSI.
FICON	FIbre CONnection (FICON).
FTP	File Transfer Protocol (FTP).
GenZ	GenZ.
HDMI	HDMI.
HTTP	Hypertext Transport Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
I2C	Inter-Integrated Circuit Bus.
InfiniBand	InfiniBand.
iSCSI	Internet SCSI.
iWARP	Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol	Multiple Protocols.
NFSv3	Network File System (NFS) version 3.
NFSv4	Network File System (NFS) version 4.
NVLink	NVLink.
NVMe	Non-Volatile Memory Express (NVMe).
NVMeOverFabrics	NVMe over Fabrics.
OEM	OEM-specific.
PCIe	PCI Express.
QPI	Intel QuickPath Interconnect (QPI).
RoCE	RDMA over Converged Ethernet Protocol.
RoCEv2	RDMA over Converged Ethernet Protocol Version 2.
SAS	Serial Attached SCSI.
SATA	Serial AT Attachment.
SFTP	SSH File Transfer Protocol (SFTP).
SMB	Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP	Transmission Control Protocol (TCP).
TFTP	Trivial File Transfer Protocol (TFTP).
UALink	Ultra Accelerator Link (UALink).
UDP	User Datagram Protocol (UDP).
UET	Ultra Ethernet Transport.
UHCI	Universal Host Controller Interface (UHCI).
UPI	Intel UltraPath Interconnect (UPI).
USB	Universal Serial Bus (USB).
VGA	VGA.

SupportedRAIDTypes⁠

The set of RAID types supported by the storage controller.

string	Description
None	A placement policy with no redundancy at the device level.
RAID0	A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy.
RAID00	A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.
RAID01	A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0).
RAID1	A placement policy where each logical block of data is stored on more than one independent storage device.
RAID10	A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1).
RAID10E	A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.
RAID10Triple	A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple).
RAID1E	A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices.
RAID1Triple	A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices.
RAID3	A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.
RAID4	A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.
RAID5	A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and one logical block of parity across a set of 'n+1' independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID50	A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices.
RAID6	A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and two logical blocks of independent parity across a set of 'n+2' independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID60	A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices.
RAID6TP	A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of data and three logical blocks of independent parity across a set of 'n+3' independent storage devices where the parity and data blocks are interleaved across the storage devices.

TargetConfigurationLockLevel⁠

string	Description
Baseline	The standard configuration lock level, corresponding to applying firmware, updating security keys, and modifying other hardware settings. It does not include managing the volumes or data within the storage subsystem.

VPDWrite⁠

The lock state of the NVMe-MI-defined VPD Write command.

string	Description
CommandUnsupported	The command is not supported, therefore lockdown does not apply.
LockdownUnsupported	The command is supported but is not able to be locked.
Locked	The command is supported and is currently locked.
Unlocked	The command is supported, able to be locked, and is currently unlocked.

Example response⁠

{
    "@odata.type": "#Storage.v1_21_0.Storage",
    "Id": "1",
    "Name": "Local Storage Controller",
    "Description": "Integrated RAID Controller",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "StorageControllers": [
        {
            "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1#/StorageControllers/0",
            "MemberId": "0",
            "Name": "Contoso Integrated RAID",
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "Identifiers": [
                {
                    "DurableNameFormat": "NAA",
                    "DurableName": "345C59DBD970859C"
                }
            ],
            "Manufacturer": "Contoso",
            "Model": "12Gbs Integrated RAID",
            "SerialNumber": "2M220100SL",
            "PartNumber": "CT18754",
            "SpeedGbps": 12,
            "FirmwareVersion": "1.0.0.7",
            "SupportedControllerProtocols": [
                "PCIe"
            ],
            "SupportedDeviceProtocols": [
                "SAS",
                "SATA"
            ]
        }
    ],
    "Drives": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Drives/35D38F11ACEF7BD3"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Drives/3F5A8C54207B7233"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Drives/32ADF365C6C1B7BD"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Drives/3D58ECBC375FD9F2"
        }
    ],
    "Volumes": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes"
    },
    "Actions": {
        "#Storage.SetEncryptionKey": {
            "target": "/redfish/v1/Systems/437XR1138R2/Storage/1/Actions/Storage.SetEncryptionKey"
        }
    },
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1"
}

Drive 1.21.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

Reset (v1.7+)⁠​

RevertToOriginalFactoryState (v1.18+)⁠​

SecureErase⁠​

Property details⁠​

ConfigurationLock⁠​

DriveFormFactor⁠​

EncryptionAbility⁠​

EncryptionStatus⁠​

FirmwareCommit⁠​

FirmwareImageDownload⁠​

HotspareReplacementMode⁠​

HotspareType⁠​

idRef⁠​

IndicatorLED⁠​

Lockdown⁠​

MediaType⁠​

Operation⁠​

Protocol⁠​

ResetType⁠​

SanitizationType⁠​

SecuritySend⁠​

SlotCapableProtocols⁠​

SlotFormFactor⁠​

StatusIndicator⁠​

TargetConfigurationLockLevel⁠​

VPDWrite⁠​

Example response⁠​

Storage 1.19.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

ImportForeignDrives (v1.19+)⁠​

RekeyExternalKey (v1.16+)⁠​

ResetToDefaults (v1.11+)⁠​

SetControllerPassword (v1.17+)⁠​

SetEncryptionKey⁠​

Property details⁠​

AutoVolumeCreate⁠​

ConfigurationLock⁠​

EncryptionMode⁠​

FirmwareCommit⁠​

FirmwareImageDownload⁠​

HotspareActivationPolicy⁠​

idRef⁠​

Lockdown⁠​

ResetType⁠​

SecuritySend⁠​

SupportedControllerProtocols⁠​

SupportedDeviceProtocols⁠​

SupportedRAIDTypes⁠​

TargetConfigurationLockLevel⁠​

VPDWrite⁠​

Example response⁠​

Drive 1.21.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

Reset (v1.7+)⁠

RevertToOriginalFactoryState (v1.18+)⁠

SecureErase⁠

Property details⁠

ConfigurationLock⁠

DriveFormFactor⁠

EncryptionAbility⁠

EncryptionStatus⁠

FirmwareCommit⁠

FirmwareImageDownload⁠

HotspareReplacementMode⁠

HotspareType⁠

idRef⁠

IndicatorLED⁠

Lockdown⁠

MediaType⁠

Operation⁠

Protocol⁠

ResetType⁠

SanitizationType⁠

SecuritySend⁠

SlotCapableProtocols⁠

SlotFormFactor⁠

StatusIndicator⁠

TargetConfigurationLockLevel⁠

VPDWrite⁠

Example response⁠

Storage 1.19.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

ImportForeignDrives (v1.19+)⁠

RekeyExternalKey (v1.16+)⁠

ResetToDefaults (v1.11+)⁠

SetControllerPassword (v1.17+)⁠

SetEncryptionKey⁠

Property details⁠

AutoVolumeCreate⁠

ConfigurationLock⁠

EncryptionMode⁠

FirmwareCommit⁠

FirmwareImageDownload⁠

HotspareActivationPolicy⁠

idRef⁠

Lockdown⁠

ResetType⁠

SecuritySend⁠

SupportedControllerProtocols⁠

SupportedDeviceProtocols⁠

SupportedRAIDTypes⁠

TargetConfigurationLockLevel⁠

VPDWrite⁠

Example response⁠