iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

Volumes

Description

A Collection of Volume resource instances.

URL

/redfish/v1/Systems/<ComputerSystem-Id>/Storage/<Storage-Id>/Volumes/<Volume-Id>

Supported HTTP Method and Privileges


HTTP Method	Required Privilege
GET	Login
DELETE	ConfigureComponents, Login

Supported Properties


Property	Type	Read Only	Description
AccessCapabilities	Array	No	Supported IO access capabilities.
AllocatedPools	Object	Yes	An array of references to StoragePools allocated from this Volume.
BlockSizeBytes	Integer	Yes	The size of the smallest addressable unit (Block) of this volume in bytes.
Capacity	String	Yes	Information about the utilization of capacity allocated to this storage volume.
CapacityBytes	Integer	No	The size in bytes of this Volume.
CapacitySources	Array	No	An array of space allocations to this volume.
Compressed	Boolean	No	Indicator of whether or not the Volume has compression enabled.
Deduplicated	Boolean	No	Indicator of whether or not the Volume has deduplication enabled.
DisplayName	String	No	A user-configurable string to name the volume.
Encrypted	Boolean	No	This property contains a boolean indicator if the Volume is currently utilizing encryption or not.
EncryptionTypes	Array	No	The types of encryption used by this Volume.
IOStatistics	String	Yes	Statistics for this volume.
Identifiers	Array	Yes	The Durable names for the volume.
LogicalUnitNumber	Integers	Yes	Indicates the host-visible LogicalUnitNumber assigned to this Volume.
LowSpaceWarningThresholdPercents	Integers	No	Low space warning.
Manufacturer	String	Yes	The manufacturer or OEM of this storage volume.
MaxBlockSizeBytes	Interger	Yes	Max Block size in bytes.
MediaSpanCount	Interger	Yes	Indicates the number of media elements used per span in the secondary RAID for a hierarchical RAID type.
Model	String	Yes	The model number for this storage volume.
Operations	Array	Yes	The operations currently running on the Volume.
OptimumIOSizeBytes	Integer	Yes	The size in bytes of this Volume's optimum IO size.
ProvisioningPolicy	String	No	This property specifies the volume's storage allocation, or provisioning policy.
RAIDType	String	Yes	The RAID type of this volume.
ReadCachePolicy	String	No	Indicates the read cache policy setting for the Volume.
RecoverableCapacitySourceCount	Integer	No	Current number of capacity source resources that are available as replacements.
RemainingCapacityPercent	Integer	Yes	The percentage of the capacity remaining in the Volume.
ReplicaInfo	String	Yes	Describes this storage volume in its role as a target replica.
ReplicaTargets	Array	Yes	The resources that are target replicas of this source.
Status	String	Yes	The property contains the status of the Volume.
StorageGroups	Array	Yes	An array of references to Storage Groups that includes this volume.
StripSizeBytes	Integer	No	The number of blocks (bytes) in a strip in a disk array that uses striped data mapping.
VolumeType	String	Yes	The type of this volume.
VolumeUsage	String	Yes	Indicates the Volume usage type setting for the Volume.
WriteCachePolicy	String	No	Indicates the write cache policy setting for the Volume.
WriteCacheState	String	Yes	Indicates the WriteCacheState policy setting for the Volume.
WriteHoleProtectionPolicy	String	No	The policy that the RAID volume is using to address the write hole issue.

Supported Status Codes


HTTP Status Code	Extended Information	Error Message Code
200	Base.1.0.Success

Supported Action — Initialize
Supported Action — CheckConsistency