Skip to main content

GET – Get Storage Instance

Dependence​

  1. It displays the collection of storage resource instances available in the system.

  2. 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}}
Content-Type: application/json

Response​

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

Table 1. 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

Status

Object

True

Refer to Resource Complex Types.

Links

Object

True

Contains references to other resources that are related to this resource.

Name

Type

Read Only

Description

Oem

Object

 Refer to Resource Complex Types.

Enclosures@odata.count

Number

True

An integer representing the number of items in a collection.

Enclosures(N)

Array

True

An array of references to the chassis to which this storage subsystem is attached

StorageControllers@odata.count

Number

True

An integer representing the number of items in a collection.

StorageControllers

Array

True

A collection that indicates all the storage controllers that this resource represents.

Refer to Storage Controller Properties.

Drives@odata.count

Number

True

An integer representing the number of items in a collection.

Drives

Array

True

A collection that indicates all the drives attached to the storage controllers that this resource represents.

Volumes

Object

True

A collection that indicates all the volumes produced by the storage controllers that this resource represents.

Redundancy@odata.count

Number

True

An integer representing the number of items in a collection.

Redundancy(N)

Array

True

Redundancy information for the storage subsystem.

Note
Redundancy information can be configured through redis commands.
Table 2. Storage Controller Properties

Name

Type

Read only

Description

MemberId

String

True

This is the identifier for the member within the collection.

Status

Object

True

Refer to Resource Complex Types.

Assembly

Object

True

The link to the assembly associated with this storage controller.

Northbound only properties, platform specific porting needed.

ControllerRates

  

This type describes the various controller rates used for processes such as Volume Rebuild or Consistency Checks.

Name

Type

Read Only

Description

ConsistencyCheckRatePercent

Number

True

The percentage of controller Resources used for performing a data consistency check on volumes.

RebuildRatePercent

Number

True

The percentage of controller Resources used for rebuilding/repairing volumes.

TransformationRatePercent

Number

True

The percentage of controller Resources used for transforming volumes from one configuration to another.

Name

String

True

The name of the Storage Controller.

SpeedGbps

Number

True

The value of this property shall represent the speed of the Storage bus interface (in Gigabits per second).

FirmwareVersion

String

True

The firmware version of this storage Controller.

Manufacturer

String

True

This is the manufacturer of this storage controller.

Model

String

True

This is the model number for the storage controller.

SKU

String

True

This is the SKU for this storage controller.

SerialNumber

String

True

The serial number for this storage controller.

PartNumber

String

True

The part number for this storage controller.

AssetTag

String

False

The user assigned asset tag for this storage controller.

SupportedControllerProtocols

Array

True

Refer to Protocol Properties for allowed Enum in Array.

SupportedDeviceProtocols

Array

True

Refer to Protocol Properties for allowed Enum in Array.

Identifiers

Array

True

This property shall contain a list of all known durable names for the associated storage controller.

See Resource.v1_8_1 schema property.

Location

Object

True

See Resource.v1_8_1 schema property.

CacheSummary

Object

True

This object describes the cache memory of the storage control in general detail.

Name

Type

Read Only

Description

PersistentCacheSizeMiB

Number

True

The portion of the cache memory that is persistent, measured in MiB.

TotalCacheSizeMiB

Number

True

The total configured cache memory, measure in MiB.

Status

Object

True

Refer to Resource Complex Types

PCIeInterface

Object

 

The PCIe interface details for this controller.

Refer to PCIe Interface Properties.

SupportedRAIDTypes

Array

True

This object describes the RAID Types supported by the storage controller.

Enum

Description

RAID00

A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets

RAID01

A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0)

RAID1

A placement policy where each logical block of data is stored on more than one independent storage device

RAID10

A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1)

RAID10E

A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets

RAID10Triple

A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple)

RAID1E

A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data i uniformly distributed across the storage devices

RAID1Triple

A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices

RAID3

A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device

RAID4

A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device

RAID5

A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and one logical block of parity across a set of 'n+1' independent storage devices where the parity and data blocks are interleaved across the storage devices

RAID50

A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices

RAID6

A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and two logical blocks of independent parity across a set of 'n+2' independent storage devices where the parity and data blocks are interleaved across the storage devices

RAID60

A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices

RAID6TP

A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of data and three logical blocks of independent parity across a set of 'n+3' independent storage devices where the parity and data blocks are interleaved across the storage devices. This is commonly referred to as Triple Parity RAID. Data stored using this form of RAID is able to survive any three independent storage device failures without data loss

Links

Object

True

Contains references to other resources that are related to this resource.

Name

Type

Read Only

Description

Endpoints@odata.count

Number

True

An integer representing the number of items in a collection.

Endpoints(N)

Array

True

The value of this property shall be a reference to the resources that this system is associated with and shall reference a resource of type Endpoint.

Note
These will be available only as a part of FPX Product.
Table 3. Protocol Properties

Member Name

Description

PCIe

PCI Express (Vendor Proprietary).

AHCI

Advanced Host Controller Interface.

UHCI

Universal Host Controller Interface.

SAS

Serial Attached SCSI.

SATA

Serial AT Attachment.

USB

Universal Serial Bus.

NVMe

Non-Volatile Memory Express.

FC

Fibre Channel.

iSCSI

Internet SCSI.

FCoE

Fibre Channel over Ethernet.

NVMeOverFabrics

NVMe over Fabrics.

SMB

Server Message Block (aka CIFS Common Internet File System).

NFSv3

Network File System version 3.

NFSv4

Network File System version 4.

HTTP

Hypertext Transport Protocol.

HTTPS

Secure Hypertext Transport Protocol.

FTP

File Transfer Protocol.

SFTP

Secure File Transfer Protocol.

Response example​

{
    "@odata.context": "/redfish/v1/$metadata#Storage.Storage",
    "@odata.etag": "\"1619171741\"",
    "@odata.id": "/redfish/v1/Systems/Self/Storage/1",
    "@odata.type": "#Storage.v1_7_0.Storage",
    "Drives": [
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device2_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device0_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device5_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device4_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device8_Port0"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device1_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device7_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device6_Port1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Drives/USB_Device3_Port1"
        }
    ],
    "Drives@odata.count": 9,
    "Id": "1",
    "Links": {
        "Enclosures@odata.count": 0
    },
    "Name": "Local Storage Controller",
    "Redundancy@odata.count": 0,
    "StorageControllers": [
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1#/StorageControllers/0",
            "AssetTag": "(USB_Controller_0)",
            "FirmwareVersion": "1.10",
            "MemberId": "0",
            "Name": "USB_Controller0",
            "PCIeInterface": {
                "LanesInUse": 0,
                "MaxPCIeType": "Gen1",
                "PCIeType": "Gen1"
            },
            "SpeedGbps": 3,
            "Status": {
                "Health": "OK",
                "State": "Enabled"
            },
            "SupportedControllerProtocols": [
                "USB",
                "PCIe"
            ],
            "SupportedDeviceProtocols": [
                "USB"
            ]
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1#/StorageControllers/1",
            "AssetTag": "(USB_Controller_1)",
            "FirmwareVersion": "1.10",
            "MemberId": "1",
            "Name": "USB_Controller1",
            "PCIeInterface": {
                "LanesInUse": 0,
                "MaxPCIeType": "Gen1",
                "PCIeType": "Gen1"
            },
            "SpeedGbps": 3,
            "Status": {
                "Health": "OK",
                "State": "Enabled"
            },
            "SupportedControllerProtocols": [
                "USB",
                "PCIe"
            ],
            "SupportedDeviceProtocols": [
                "USB"
            ]
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1#/StorageControllers/2",
            "AssetTag": "(SATA_Controller_2)",
            "FirmwareVersion": "Not Available",
            "MemberId": "2",
            "Model": "Not Available",
            "Name": "SATA_Controller_2",
            "PCIeInterface": {
                "LanesInUse": 0,
                "MaxPCIeType": "Gen1",
                "PCIeType": "Gen1"
            },
            "SerialNumber": "Not Available",
            "SpeedGbps": 6,
            "Status": {
                "Health": "OK",
                "State": "Enabled"
            },
            "SupportedControllerProtocols": [
                "PCIe",
                "AHCI",
                "SATA"
            ],
            "SupportedDeviceProtocols": [
                "AHCI",
                "SATA"
            ]
        },
        {
            "@odata.id": "/redfish/v1/Systems/Self/Storage/1#/StorageControllers/3",
            "AssetTag": "(SATA_Controller_3)",
            "FirmwareVersion": "Not Available",
            "MemberId": "3",
            "Model": "Not Available",
            "Name": "SATA_Controller_3",
            "PCIeInterface": {
                "LanesInUse": 0,
                "MaxPCIeType": "Gen1",
                "PCIeType": "Gen1"
            },
            "SerialNumber": "Not Available",
            "SpeedGbps": 6,
            "Status": {
                "Health": "OK",
                "State": "Enabled"
            },
            "SupportedControllerProtocols": [
                "PCIe",
                "AHCI",
                "SATA"
            ],
            "SupportedDeviceProtocols": [
                "AHCI",
                "SATA"
            ]
        }
    ],
    "StorageControllers@odata.count": 4,
    "SupportedControllerProtocols@Redfish.AllowableValues": [
        "PCIe",
        "AHCI",
        "UHCI",
        "SAS",
        "SATA",
        "USB",
        "NVMe",
        "FC",
        "iSCSI",
        "FCoE",
        "FCP",
        "FICON",
        "NVMeOverFabrics",
        "SMB",
        "NFSv3",
        "NFSv4",
        "HTTP",
        "HTTPS",
        "FTP",
        "SFTP"
    ],
    "SupportedDeviceProtocols@Redfish.AllowableValues": [
        "PCIe",
        "AHCI",
        "UHCI",
        "SAS",
        "SATA",
        "USB",
        "NVMe",
        "FC",
        "iSCSI",
        "FCoE",
        "FCP",
        "FICON",
        "NVMeOverFabrics",
        "SMB",
        "NFSv3",
        "NFSv4",
        "HTTP",
        "HTTPS",
        "FTP",
        "SFTP"
    ],
    "Volumes": {
        "@odata.id": "/redfish/v1/Systems/Self/Storage/1/Volumes"
    }
}