GET – Volume Instance
Dependence
Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any 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}}/Volumes/{{Volume_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. | ||||||
CapacityBytes | Number | True | This property shall contain the size in bytes of the associated volume. | ||||||
VolumeType | String | True | This property shall contain the type of the associated Volume. | ||||||
Enum | Description | ||||||||
RawDevice | The volume is a raw physical device without any RAID or other virtualization applied. | ||||||||
NonRedundant | The volume is a non-redundant storage device. | ||||||||
Mirrored | The volume is a mirrored device. | ||||||||
StripedWithParity | The volume is a device which uses parity to retain redundant information. | ||||||||
SpannedMirrors | The volume is a spanned set of mirrored devices. | ||||||||
SpannedStripesWithParity | The volume is a spanned set of devices which uses parity to retain redundant information. | ||||||||
Encrypted | Boolean (False) | True | This property shall contain a boolean indicator if the Volume is currently utilizing encryption or not. Default it will be null | ||||||
EncryptionTypes | Array | True | This property shall contain the types of encryption used by this Volume. | ||||||
Enum | Description | ||||||||
NativeDriveEncryption | The volume is utilizing the native drive encryption capabilities of the drive hardware. | ||||||||
ControllerAssisted | The volume is being encrypted by the storage controller entity. | ||||||||
SoftwareAssisted | The volume is being encrypted by software running on the system or the operating system. | ||||||||
Identifiers | Array | True | This property shall contain a list of all known durable names for the associated volume. | ||||||
BlockSizeBytes | Number | True | The size of the smallest addressable unit (Block) of this volume in bytes. | ||||||
Operations | Array | The operations currently running on the Volume. | |||||||
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. | ||||||
OptimumIOSizeBytes | Number | True | This property shall contain the optimum IO size to use when performing IO on this volume. For logical disks, this is the stripe size. For physical disks, this describes the physical sector size. | ||||||
Links | An array of references to the drives which contain this volume. This will reference Drives that either wholly or only partly contain this volume. | ||||||||
Name | Type | Read only | Description | ||||||
Oem | Object | Refer to Resource Complex Types. | |||||||
Drives@odata.count | Number | True | An integer representing the number of items in a collection. | ||||||
Drives(N) | Array | True | An array of references to the chassis to which this storage subsystem is attached | ||||||
Actions | Object | True | Volume.Initialize is the available actions for this resource | ||||||
Response example
{
"@odata.context": "/redfish/v1/$metadata#Volume.Volume",
"@odata.etag": "\"1619171741\"",
"@odata.id": "/redfish/v1/Systems/Self/Storage/1/Volumes/VOL0",
"@odata.type": "#Volume.v1_0_3.Volume",
"BlockSizeBytes": 16384,
"CapacityBytes": 31439454208,
"Id": "VOL0",
"Links": {
"Drives": [
{
"@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device8_Port0"
}
],
"Drives@odata.count": 1
},
"Name": "VOL0",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}