GET – Memory Instance

Dependence

Displays the information about the Memory devices like DIMM supported by the host connected to the BMC.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.

Request

GET https://{{ip}}/redfish/v1/Systems/Self/Memory/{{Memory_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. Memory properties

Name

Type

Read only

Description

(OData Attributes)

Refer to OData Support.

Oem

Object

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

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

MemoryType

String

True

The Type of Memory.

Note

Platform specific porting needed in BIOS. Purley platform supports this SMBIOS data and BIOS provides MemoryType only when "Extended Type 17 Structure" enabled in BIOS.

Enum

Description

DRAM

NVDIMM_N

NVDIMM_N as defined by JEDEC.

NVDIMM_F

NVDIMM_F as defined by JEDEC.

NVDIMM_P

NVDIMM_P as defined by JEDEC.

IntelOptane

The memory module is Intel Optane DC Persistent Memory and composed of a combination of non-volatile and volatile memory.

MemoryDeviceType

String

True

Type details of Memory. Allowable values are :

DDR	LPDDR4_SDRAM	DDR_SDRAM
DDR2	DDR3_SDRAM	ROM
DDR3	LPDDR3_SDRAM	SDRAM
DDR4	DDR2_SDRAM	EDO
DDR5	DDR2_SDRAM_FB_DIMM	FastPageMode
DDR4_SDRAM	DDR2_SDRAM_FB_DIMM_PROBE	PipelinedNibble
DDR4E_SDRAM	DDR_SGRAM	Logical

BaseModuleType

String

True

The base module type of Memory.

Note

Northbound only properties.

Enum

Description

RDIMM

Registered DIMM.

UDIMM

SO_DIMM

LRDIMM

Load Reduced

Mini_RDIMM

Mini_UDIMM

SO_RDIMM_72b

SO_UDIMM_72b

SO_DIMM_16b

SO_DIMM_32b

MemoryMedia

Array

True

Media of this memory.

Note

Northbound only properties.

Enum

Description

DRAM

DRAM media.

NAND

NAND media.

Proprietary

Proprietary media.

CapacityMiB

Number

True

The value of this property shall be thMe emory capacity in MiB

DataWidthBits

Number

True

The value of this property shall be the bus width in bits

BusWidthBits

Number

True

The value of this property shall be the bus width in bits

Manufacturer

String

True

The manufacturer of the Memory.

SerialNumber

String

True

The serial number as provided by the manufacturer of this Memory.

PartNumber

String

True

The part number as provided by the manufacturer of this Memory.

AllowedSpeedsMHz

Array

True

Speed bins supported by this Memory.

Assembly

Object

True

The link to the assembly associated with this DIMM.
Northbound only properties, platform specific porting needed.

FirmwareRevision

String

True

Revision of firmware on the Memory controller.

Note: Northbound only properties. Platform specific porting needed; require specific platform libraries support and ho between the specific libraries and gami module should be added.

FirmwareApiVersion

String

True

Version of API supported by the firmware.

Note: Northbound only properties. Platform specific porting needed; require specific platform libraries support and ho between the specific libraries and gami module should be added.

FunctionClasses

Array of Items of type String

True

Function Classes by the Memory.

Note: Northbound only properties. Platform specific porting needed; require specific platform libraries support and ho between the specific libraries and gami module should be added.

MaxTDPMilliWatts

Array of type number

True

The value of this property shall be the maximum power budge supported by the Memory in milli Watts.

Note: Northbound only properties. Platform specific porting needed; require specific platform libraries support and hook between the specific libraries and gami module should be added.

SecurityCapabilities

Object

True

This object shall contain properties which describe the security capabilities of the Memory.

Name

Type

Read Only

Description

PassphraseCapable

Boolean

True

Memory passphrase set capability

MaxPassphraseCount

Number

True

Maximum number of passphrases supported fo this Memory.

PassphraseLockLimit

Number

True

Maximum number of incorrect passphrase attempts allowed before memory is locked.

ConfigurationLockCapable

Boolean

True

Support for locking the configuration.

DataLockCapable

Boolean

True

Support for data locking.

SpareDeviceCount

Number

True

The value of this property shall be the number of unused spare devices available in the Memory. If memory devices fails, the spare device could be used.

ConfigurationLocked

Boolean

True

Indicates that the configuration of this memory has been lock

RankCount

Number

True

The value of this property shall be number of ranks available i the Memory. The ranks could be used for spare or interleave.

Note

Northbound only properties. Platform specific porting needed; require specific platform libraries support and ho between the specific libraries and gami module should be added.

DeviceLocator

String

True

Location of the Memory in the platform, typically marked in the silk screen.

MemoryLocation

Object

True

Memory connection information to sockets and memory controllers.

Note

Northbound only properties, platform specific porting needed.

Name

Type

Read Only

Description

Socket

Number

True

Socket number in which Memory is connected.

MemoryController

Number

True

Memory controller number in which Memory is connected.

Channel

Number

True

Channel number in which Memory is connected.

Slot

Number

True

Slot number in which Memory is connected.

ErrorCorrection

String

True

The value of this property shall be the error correction scheme supported for this memory.

Enum

Description

NoECC

No ECC available.

SingleBitECC

Single bit Data error can be corrected by ECC

MultiBitECC

Multi-bit Data errors can be corrected by ECC.

AddressParity

Address Parity errors can be corrected

OperatingSpeedMhz

Number

True

Operating speed of Memory in MHz

VolatileRegionSizeLimitMiB

Number

True

The value of this property shall be the total size of volatile regions in MiB.

Note

Northbound only properties, platform specific porting needed.

PersistentRegionSizeLimitMiB

Number

True

The value of this property shall be the total size of persistent regions in MiB.

Note

Northbound only properties, platform specific porting needed.

Regions

Array

True

The value of this property shall be the memory region information within the Memory.

Name

Type

Read Only

Description

RegionId

String

True

Unique region ID representing a specific region within the Memory

OffsetMiB

Number

True

Offset with in the Memory that corresponds to the starting of this memory region in MiB

PassphraseEnabled

Boolean

True

The value of this property shall be a boolean indicating if the passphrase is enabled for this region.

SizeMiB

Number

True

Size of this memory region in MiB.

MemoryClassification

String

True

Enum

Description

Volatile

Volatile memory

ByteAccessiblePersistent

Byte accessible persistent memory

Block

Block accesible memory

OperatingMemoryModes

Array

True

The value of this property shall be the memory modes supported by the Memory.

Note

Northbound only properties, platform specific porting needed.

Enum

Description

Volatile

Volatile memory.

PMEM

Persistent memory, byte accesible through system address space.

Block

Block accessible system memory.

PowerManagementPolicy

Object

True

This object shall contain properties which describe the power management policy for the current resource.

Name

Type

Read Only

Description

PolicyEnabled

Boolean

True

Power management policy enabled status.

MaxTDPMilliWatts

Number

True

Maximum TDP in milli watts.

PeakPowerBudgetMilliWatts

Number

True

Peak power budget in milli watts. Unit is mW.

AveragePowerBudgetMilliWatts

Number

True

Average power budget in milli watts.

Unit is mW.

IsSpareDeviceEnabled

Boolean

True

Spare device enabled status.

IsRankSpareEnabled

Boolean

True

Rank spare enabled status.

VolatileRegionNumberLimit

Number

True

Total number of volatile regions this Memory can support.

PersistentRegionNumberLimit

Number

True

Total number of persistent regions this Memory can support.

VolatileRegionSizeMaxMiB

Number

True

Maximum size of a single volatile region in MiB

PersistentRegionSizeMaxMiB

Number

True

Maximum size of a single persistent region in MiB

AllocationIncrementMiB

Number

True

The size of the smallest unit of allocation for a memory region, thus it is the multiple in which regions are actually reserved

AllocationAlignmentMiB

Number

True

The boundary which memory regions are allocated on, measured in MiB

Links

Object

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

Name

Type

Read Only

Description

Oem

Object

Refer to Resource Complex Types.

Chassis(N)

Array

True

A reference to the Chassis which contains this Memory.

Status

Object

Name

Type

Read Only

Description

Oem

Object

Refer to Resource Complex Types.

OriginOfCondition

Object

True

This is the URI of the resource that caused the log entry. Refer to ID Ref in odata4.0.0.json.

ModuleManufacturerID

String

True

The value of this property shall be the two byte manufacturer ID of this memory module as defined by JEDEC in JEP-106.

ModuleProductID

String

True

The value of this property shall be the two byte product ID of this memory module as defined by the manufacturer.

MemorySubsystemControllerManufacturerID

String

True

The value of this property shall be the two byte manufacturer ID of the memory subsystem controller of this memory module as defined by JEDEC in JE-P106.

MemorySubsystemControllerProductID

String

True

The value of this property shall be the two byte product ID of the memory subsystem controller of this memory module as defined by the manufacturer.

VolatileSizeMiB

Number

True

The value of this property shall be the total size of the volatile portion memory in MiB.

NonVolatileSizeMiB

Number

True

The value of this property shall be the maximum size of a single volatile regions in MiB.

CacheSizeMiB

Number

True

The value of this property shall be the total size of the cache portion memory in MiB.

LogicalSizeMiB

Number

True

The value of this property shall be the total size of the logical memory in MiB.

Location(M)

Array

True

See Resource.v1_8_1 schema property.

Metrics(N)

Object

True

This property will have reference to the MemoryMetrics Resource which is populated under this MemoryInstance.

Note

For out-of-band request this Metrics reference will be displayed in response only if the MemoryMetrics is populated for the MemoryInstance and for-in band request it will be displayed by default irrespective of MemyMoretrics availability for the MemoryInstance.

Response example

{
    "@odata.context": "/redfish/v1/$metadata#Memory.Memory",
    "@odata.etag": "\"1614903196\"",
    "@odata.id": "/redfish/v1/Systems/Self/Memory/DevType2_DIMM7",
    "@odata.type": "#Memory.v1_7_1.Memory",
    "Actions": {
        "Oem": {
            "#AmiBios.ChangeState": {
                "State@Redfish.AllowableValues": [
                    "Enabled",
                    "Disabled"
                ],
                "target": "/redfish/v1/Systems/Self/Memory/DevType2_DIMM7/Actions/AmiBios.ChangeState"
            }
        }
    },
    "AllowedSpeedsMHz": [
        2933
    ],
    "BaseModuleType": "RDIMM",
    "BusWidthBits": 72,
    "CacheSizeMiB": 0,
    "CapacityMiB": 16384,
    "DataWidthBits": 64,
    "DeviceLocator": "DIMM 1",
    "Id": "DevType2_DIMM7",
    "Links": {
        "Chassis": {
            "@odata.id": "/redfish/v1/Chassis/Self"
        }
    },
    "LogicalSizeMiB": 0,
    "Manufacturer": "Micron Technology",
    "MemoryDeviceType": "DDR4",
    "MemoryLocation": {
        "Channel": 3,
        "MemoryController": 0,
        "Slot": 1,
        "Socket": 0
    },
    "MemoryType": "DRAM",
    "ModuleManufacturerID": "0x2C80",
    "Name": "DevType2_DIMM7",
    "NonVolatileSizeMiB": 0,
    "OperatingMemoryModes": [
        "Volatile"
    ],
    "OperatingSpeedMhz": 2933,
    "PartNumber": "18ASF2G72PDZ-2G9E1  ",
    "RankCount": 2,
    "SecurityCapabilities": {
        "ConfigurationLockCapable": false,
        "DataLockCapable": false,
        "PassphraseCapable": false
    },
    "SerialNumber": "1B5BAB32",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "VolatileSizeMiB": 16384
}

Give documentation feedback

GET – Memory Instance

Dependence​

Request​

Response​

Response example​

Dependence

Request

Response

Response example