Skip to main content

GET – Get Simple Storage Instance

Dependence

  1. It represents the properties of a storage controller and its directly attached devices.

  2. These resources are populated by Host Interface, and Northbound API Support is needed.

Request

GET https://{{ip}}/redfish/v1/Systems/{{system_instance}}/SimpleStorage/{{system_simplestorage_instance}}
Content-Type: application/json

Response

The response of the request will be in JSON format. The properties are mentioned in the following tables.

Table 1. Simple Storage Properties

Name

Type

Read Only

Description

(OData Attributes)  

Refer to OData Support.

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types.

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

UefiDevicePath

String

True

The UEFI device path used to access this storage controller. This path is used to identify and locate the specific storage controller.

Status

Object

True

Refer to Resource Complex Types.

Links

Object

True

The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource

Name

Type

Read Only

Description

Oem

Object

False

Refer to Resource Complex Types.

Chassis(N)

Array

True

The value of this property shall be a reference to a resource of type Chassis that represent the physic container associated with this Simple Storage.

Actions

Object

True

This object will contain the actions for this resource under Oem property if any.

Devices

Array of Objects

True

Name

Type

Read Only

Description

Oem

Object

False

Refer to Resource Complex Types.

Name(M)

String

True

Name of the resource or array element

Status

Object

True

Refer to Resource Complex Types.

Manufacturer

String

True

Name of the manufacturer of this storage device.

CapacityBytes

Number

True

The value of this property shall represent the size (in bytes) of the Storage Device.

Model

String

True

Model number of this device.

Response example

{
"@odata.context": "/redfish/v1/$metadata#SimpleStorage.SimpleStorage",
"@odata.etag": "\"1619171742\"",
"@odata.id": "/redfish/v1/Systems/Self/SimpleStorage/SATA_Controller_2",
"@odata.type": "#SimpleStorage.v1_2_2.SimpleStorage",
"Id": "SATA_Controller_2",
"Links": {
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/Self"
}
},
"Name": "SATA_Controller_2",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"UefiDevicePath": "PciRoot(0x1)/Pci(0x8,0x2)/Pci(0x0,0x0)"
}