GET – Volumes managed by storage controller

Use the GET method to retrieve the volume resource for a server.

Request URL

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

Response body

Field			Type	Description
AccessCapabilities			Array	Supported IO access capabilities. Note If the storage is M.2, this object will be hidden.
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.
CapacityBytes			Number	Size in bytes of this volume.
Description			String	This resource is used to represent volume in Redfish implementation.
DisplayName			String	A user-configurable string to name the volume. Note If the storage is 7mm or M.2, this object will be hidden.
Encrypted			Boolean	Is this Volume encrypted.
EncryptionTypes			Array	The types of encryption used by this Volume.
Id			String	Volume Id
IsBootCapable			Boolean	Indicates whether or not the Volume contains a boot image and is capable of booting.
Links			Object	Expanded.
	Drives		Array	An array of references to the drives that are used to create the volume.
		Drives[N]	Link	Link
	DedicatedSpareDrives		Array	Links to DedicatedSpareDrives.
MediaSpanCount			Number	The requested number of media elements used per span in the secondary RAID for a hierarchical RAID type.
RAIDType			String	The RAID type of this volume.
Name			String	Volume info name
OptimumIOSizeBytes			Number	The size in bytes of this Volume's optimum IO size.
ReadCachePolicy			String	Indicates the read cache policy setting for the Volume. Note If the storage is 7mm or M.2, this property will be hidden.
ReadCachePolicy @Redfish.AllowableValues			String	“Off”, “ReadAhead”. Note If the storage is 7mm or M.2, this property will be hidden.
WriteCachePolicy			String	Indicates the write cache policy setting for the Volume. Note If the storage is 7mm or M.2, this property will be hidden.
WriteCachePolicy @Redfish.AllowableValues			String	“WriteThrough”, “UnprotectedWriteBack” and “ProtectedWriteBack”. Note If the storage is 7mm or M.2, this property will be hidden. If the storage is VROC, the value of this property is “Off”.
WriteCacheState			String	Indicates the WriteCacheState policy setting for the Volume.
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.
Status			Object	Expanded.
	State		String	Enabled
	Health		String	The health of this volume. Possible values are “OK”, “Warning” and “Critical”.
Actions			Object	Expanded. Note If the storage is 7mm or M.2, this object will be hidden.
	#Volume.Initialize		Object	Expanded.
		target	String	Initialize
		title	String	The link of this action.
		InitializeType@Redfish.AllowableValues	Array	Items: string Item count: 1

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "@Redfish.WriteableProperties": [
        "DisplayName",
        "IOPolicy",
        "DriveCachePolicy",
        "AccessPolicy",
        "WriteCachePolicy",
        "ReadCachePolicy"
    ],
    "@odata.context": "/redfish/v1/$metadata#Volume.Volume",
    "@odata.etag": "\"ADE20C32\"",
    "@odata.id": "/redfish/v1/Systems/1/Storage/controller_slot8/Volumes/238",
    "@odata.type": "#Volume.v1_8_0.Volume",
    "AccessCapabilities": [
        "Read",
        "Write"
    ],
    "Actions": {
        "#Volume.Initialize": {
            "InitializeType@Redfish.AllowableValues": [
                "Fast",
                "Full"
            ],
            "target": "/redfish/v1/Systems/1/Storage/controller_slot8/Volumes/238/Actions/Volume.Initialize",
            "title": "Initialize"
        }
    },
    "BlockSizeBytes": 512,
    "CapacityBytes": 3997997989888,
    "Description": "This resource is used to represent a volume for                     a Redfish implementation.",
    "DisplayName": "VD_2",
    "Encrypted": false,
    "EncryptionTypes": [],
    "Id": "238",
    "IsBootCapable": false,
    "Links": {
        "DedicatedSpareDrives": [],
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/controller_slot8/Drives/drive_bay_4"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/controller_slot8/Drives/drive_bay_5"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/controller_slot8/Drives/drive_bay_6"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/controller_slot8/Drives/drive_bay_7"
            }
        ]
    },
    "MediaSpanCount": 2,
    "Name": "VD_2",
    "Oem": {
        ...
        }
    },
    "OptimumIOSizeBytes": 262144,
    "RAIDType": "RAID10",
    "ReadCachePolicy": "ReadAhead",
    "ReadCachePolicy@Redfish.AllowableValues": [
        "ReadAhead",
        "Off"
    ],
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "StripSizeBytes": 262144,
    "WriteCachePolicy": "WriteThrough",
    "WriteCachePolicy@Redfish.AllowableValues": [
        "WriteThrough"
    ],
    "WriteCacheState": null
}

Give documentation feedback

GET – Volumes managed by storage controller

Request URL​

Response body​

Status code​

Example​

Request URL

Response body

Status code

Example