iDRAC9 Redfish API

Redfish is a next-generation systems management interface standard which enables scalable secure and open server management.

DOCUMENTATION API

Volume Settings instance

Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.

Privilege: Login

Security
Key, Type & Details
basicAuth
http
X-Auth
apiKey
X-Auth-Token
In: header
Requests
Path Parameters
ComputerSystemId
string Required

The value of the Id property of the ComputerSystem resource

StorageId
string Required

The value of the Id property of the Storage resource

VolumeId
string Required

The value of the Id property of the Volume resource

The response contains a representation of the Volume resource

Response Body
Response Body

Error condition

Response Body

The error payload from a Redfish Service.

error
object

The properties that describe an error from a Redfish Service.

@Message.ExtendedInfo
array[object]

An array of messages describing one or more error messages.

code
string Required

A string indicating a specific MessageId from a Message Registry.

message
string Required

A human-readable error message corresponding to the message in a Message Registry.

GETTry it
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}/Settings
Copy
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}/Settings
Response Samples
{
  "@odata.context": "/redfish/v1/$metadata#Volume.Volume",
  "@odata.id": "/redfish/v1/Systems/System.Embedded.1/Storage/CPU.1/Volumes/Disk.Bay.0:Enclosure.Internal.0-1/Settings",
  "@odata.type": "#Volume.v1_10_0.Volume",
  "Actions": {},
  "BlockSizeBytes": 0,
  "CapacityBytes": 3840755982336,
  "Description": "PCIe SSD in Slot 0 in Bay 1",
  "DisplayName": null,
  "Encrypted": null,
  "EncryptionTypes": [],
  "Id": "Disk.Bay.0:Enclosure.Internal.0-1",
  "Identifiers": [],
  "Links": {
    "Drives": [
      {
        "@odata.id": "/redfish/v1/Systems/System.Embedded.1/Storage/CPU.1/Drives/Disk.Bay.0:Enclosure.Internal.0-1"
      }
    ],
    "Drives@odata.count": 1
  },
  "MediaSpanCount": null,
  "Name": "PCIe SSD in Slot 0 in Bay 1",
  "Operations": [],
  "OptimumIOSizeBytes": null,
  "RAIDType": null,
  "ReadCachePolicy": null,
  "Status": {
    "Health": "OK",
    "HealthRollup": "OK",
    "State": "Enabled"
  },
  "VolumeType": "RawDevice",
  "WriteCachePolicy": null
}
{
  "@Message.ExtendedInfo": [
    null
  ],
  "code": "string",
  "message": "string"
}