Skip to main content

GET – Volumes managed by storage controller

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/Storage/Id/Volumes/{VolumeId}

Response body​

Field

Type

Description

Description

String

This resource is used to represent volume in Redfish implementation.

BlockSizeBytes

Number

Size of the smallest addressable unit of the associated volume.
Note
If the storage is 7MM or M.2, this object will be hidden.

AccessCapabilities

Array

Supported IO access capabilities.
Note
If the storage is M.2, this object will be hidden.

CapacityBytes

Number

Size in bytes of this volume.

Id

String

Volume Id

Links

Object

Expanded.

 

Drives

Array

An array of references to the drives that are used to create the volume.

  

Drives[N]

Link

Link

RAIDType

String

The RAID type of this volume.

Name

String

volume info name

Status

Object

Expanded.

 

State

String

The state of this volume.

 

Health

String

The health of this volume.

ReadCachePolicy

String

Indicates the read cache policy setting for the Volume.
Note
If the storage is 7MM or M.2, this object will be hidden.

ReadCachePolicy @Redfish.AllowableValues

String

"Off", "ReadAhead".
Note
If the storage is 7MM or M.2, this object will be hidden.

WriteCachePolicy

String

Indicates the write cache policy setting for the Volume.
Note
If the storage is 7MM or M.2, this object will be hidden.

WriteCachePolicy @Redfish.AllowableValues

String

"WriteThrough", "UnprotectedWriteBack" and "ProtectedWriteBack".
Note
If the storage is 7MM or M.2, this object will be hidden.

StripSizeBytes

Number

The number of blocks (bytes) in a strip in a disk array that uses striped data mapping.
Note
If the storage is 7MM or M.2, this object will be hidden.

DisplayName

String

A user-configurable string to name the volume.
Note
If the storage is 7MM or M.2, this object will be hidden.

Actions

Object

Expanded.
Note
If the storage is 7MM or M.2, this object will be hidden.
 

#Volume.Initialize

Object

Expanded

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "Id": "1",
    "Links": {
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/RAID_Slot14/Drives/Disk.0"
            }
        ]
    },
    "WriteCachePolicy@Redfish.AllowableValues": [
        "WriteThrough",
        "UnprotectedWriteBack",
        "ProtectedWriteBack"
    ],
    "BlockSizeBytes": 512,
    "AccessCapabilities": [],
    "DisplayName": "VD_0",
    "ReadCachePolicy": null,
    "ReadCachePolicy@Redfish.AllowableValues": [
        "Off",
        "ReadAhead"
    ],
    "@odata.type": "#Volume.v1_4_1.Volume",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Capacity": {
        "Metadata": {},
        "Snapshot": {},
        "Data": {}
    },
    "Name": "VD_0",
    "Description": "This resource is used to represent a volume for a Redfish implementation.",
    "Actions": {
        "#Volume.Initialize": {
            "target": "/redfish/v1/Systems/1/Storage/RAID_Slot14/Volumes/1/Actions/Volume.Initialize",
            "title": "Initialize",
            "InitializeType@Redfish.AllowableValues": [
                "Fast"
            ]
        }
    },
    "Oem": {
        "Lenovo": {
            "DriveCachePolicy": "",
            "@odata.type": "#LenovoStorageVolume.v1_0_0.LenovoStorageVolume",
            "Bootable": true,
            "AccessPolicy": "",
            "IOPolicy": "",
            "RaidLevel": "RAID 0"
        }
    },
    "CapacityBytes": 238999830528,
    "RAIDType": "RAID0",
    "@odata.id": "/redfish/v1/Systems/1/Storage/RAID_Slot14/Volumes/1",
    "@odata.etag": "\"8a2516f626f924f192e\"",
    "StripSizeBytes": 0,
    "WriteCachePolicy": null
}