Memory
Memory 1.21.0
| Version | v1.21 |
| Release | 2025.2 |
Description
The Memory schema represents a memory device, such as a DIMM, and its configuration. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if a unit is not present.
URIs
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/CacheMemory/{MemoryId}
Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Actions { | object | The available actions for this resource. | |
| #Memory.DisableMasterPassphrase (v1.17+) {} | object | Disables the master passphrase for the given region. For more information, see the Actions section below. | |
| #Memory.DisablePassphrase {} | object | Disable passphrase for the given region. For more information, see the Actions section below. | |
| #Memory.FreezeSecurityState (v1.17+) {} | object | Freezes the security state of the memory device. For more information, see the Actions section below. | |
| #Memory.InjectPersistentPoison (v1.17+) {} | object | Injects poison to a specific persistent memory address in the memory device. For more information, see the Actions section below. | |
| #Memory.OverwriteUnit (v1.6+) {} | object | This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite. For more information, see the Actions section below. | |
| #Memory.Reset (v1.8+) {} | object | This action resets this memory device. For more information, see the Actions section below. | |
| #Memory.ResetToDefaults (v1.16+) {} | object | The action resets the values of writable properties to factory defaults. For more information, see the Actions section below. | |
| #Memory.ScanMedia (v1.17+) {} | object | Scans the media of the memory device. For more information, see the Actions section below. | |
| #Memory.SecureEraseUnit {} | object | This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptographic Erase. For more information, see the Actions section below. | |
| #Memory.SetMasterPassphrase (v1.17+) {} | object | Sets the master passphrase for the given region. For more information, see the Actions section below. | |
| #Memory.SetPassphrase {} | object | Set passphrase for the given regions. For more information, see the Actions section below. | |
| #Memory.UnlockUnit {} | object | This contains the action for unlocking given regions. For more information, see the Actions section below. | |
| } | |||
| AllocationAlignmentMiB (v1.2+) | integer (MiBy) | read-only (null) | The boundary that memory regions are allocated on, measured in mebibytes (MiB). |
| AllocationIncrementMiB (v1.2+) | integer (MiBy) | read-only (null) | The size of the smallest unit of allocation for a memory region in mebibytes (MiB). |
| AllowedSpeedsMHz [ ] | array (MHz) (integer) | read-only | Speeds supported by this memory device. |
| Assembly (v1.4+) {} | object | The link to the assembly resource associated with this memory device. | |
| BaseModuleType | string (enum) | read-only (null) | The base module type of the memory device. For the possible property values, see BaseModuleType in Property details. |
| BusWidthBits | integer | read-only (null) | The bus width, in bits. |
| CacheLevel (v1.20+) | integer | read-only | The level of the cache memory. |
| CacheSizeMiB (v1.4+) | integer (MiBy) | read-only (null) | Total size of the cache portion memory in MiB. |
| CapacityMiB | integer (MiBy) | read-only (null) | Memory capacity in mebibytes (MiB). |
| Certificates (v1.11+) {} | object | The link to a collection of certificates for device identity and attestation. | |
| ConfigurationLocked (v1.7+) | boolean | read-only (null) | An indication of whether the configuration of this memory device is locked and cannot be altered. |
| CXL (v1.17+) { | object | CXL properties for this memory device. | |
| LabelStorageSizeBytes (v1.17+) | integer (By) | read-only | The size of the label storage area in bytes of this memory device. |
| StagedNonVolatileSizeMiB (v1.17+) | integer (MiBy) | read-write | Total device non-volatile memory capacity in MiB staged for next activation. The value is in multiples of 256 MiB. |
| StagedVolatileSizeMiB (v1.17+) | integer (MiBy) | read-write | Total device volatile memory capacity in MiB staged for next activation. This value is in multiples of 256 MiB. |
| } | |||
| DataWidthBits | integer | read-only (null) | Data width in bits. |
| DeviceID (deprecated v1.3) | string | read-only (null) | Device ID. Deprecated in v1.3 and later. This property has been deprecated in favor of ModuleProductID. |
| DeviceLocator (deprecated v1.9) | string | read-only (null) | Location of the memory device in the platform. Deprecated in v1.9 and later. This property has been deprecated in favor of the ServiceLabel property within Location. |
| Enabled (v1.12+) | boolean | read-write | An indication of whether this memory is enabled. |
| EnvironmentMetrics (v1.11+) {} | object | The link to the environment metrics for this memory. | |
| ErrorCorrection | string (enum) | read-only (null) | Error correction scheme supported for this memory device. For the possible property values, see ErrorCorrection in Property details. |
| FirmwareApiVersion | string | read-only (null) | Version of API supported by the firmware. |
| FirmwareRevision | string | read-only (null) | Revision of firmware on the memory controller. |
| FunctionClasses (deprecated v1.3) [ ] | array (string) | read-only | Function classes by the memory device. Deprecated in v1.3 and later. This property has been deprecated in favor of OperatingMemoryModes at the root of the resource, or MemoryClassification found within RegionSet. |
| HealthData (v1.17+) { | object | The health data of this memory device. | |
| PredictedMediaLifeLeftPercent (v1.17+, deprecated v1.19) | number (%) | read-only (null) | The current health of the memory device as a percentage. Deprecated in v1.19 and later. This property has been deprecated in favor of PredictedMediaLifeLeftPercent in the MemoryMetrics resource. |
| } | |||
| IsRankSpareEnabled | boolean | read-only (null) | An indication of whether rank spare is enabled for this memory device. |
| IsSpareDeviceEnabled | boolean | read-only (null) | An indication of whether a spare device is enabled for this memory device. |
| Links (v1.2+) { | object | The links to other resources that are related to this resource. | |
| Batteries (v1.15+) [ { | array | The batteries that provide power to this memory device during a power-loss event. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| Chassis (v1.2+) {} | object | The link to the chassis that contains this memory device. | |
| Endpoints (v1.17+) [ { | array | An array of links to the endpoints associated with this memory. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| MemoryMediaSources (v1.17+) [ { | array | An array of memory chunks providing media for this memory. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| MemoryRegionMediaSources (v1.18+) [ { | array | An array of memory regions providing media for this memory. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| Oem {} | object | The OEM extension property. See the Resource schema for details on this property. | |
| Processors (v1.11+) [ { | array | An array of links to the processors associated with this memory device. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| } | |||
| Location (v1.4+) {} | object | The location of the memory device. See the v1_23_0.v1_23_0 schema for details on this property. | |
| LocationIndicatorActive (v1.10+) | boolean | read-write (null) | An indicator allowing an operator to physically locate this resource. |
| Log (v1.13+) {} | object | The link to the log service associated with this memory. | |
| LogicalSizeMiB (v1.4+) | integer (MiBy) | read-only (null) | Total size of the logical memory in MiB. |
| Manufacturer | string | read-only (null) | The memory device manufacturer. |
| MaxTDPMilliWatts [ ] | array (mW) (integer) | read-only | Set of maximum power budgets supported by the memory device in milliwatt units. |
| Measurements (v1.11+, deprecated v1.14) [ { } ] | array (object) | An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.14 and later. This property has been deprecated in favor of the ComponentIntegrity resource. | |
| MemoryDeviceType | string (enum) | read-only (null) | Type details of the memory device. For the possible property values, see MemoryDeviceType in Property details. |
| MemoryLocation { | object | Memory connection information to sockets and memory controllers. | |
| Channel | integer | read-only (null) | The channel number to which the memory device is connected. |
| MemoryController | integer | read-only (null) | The memory controller number to which the memory device is connected. |
| Slot | integer | read-only (null) | The slot number to which the memory device is connected. |
| Socket | integer | read-only (null) | The socket number to which the memory device is connected. |
| } | |||
| MemoryMedia [ ] | array (string (enum)) | read-only | Media of this memory device. For the possible property values, see MemoryMedia in Property details. |
| MemorySubsystemControllerManufacturerID (v1.3+) | string | read-only (null) | The manufacturer ID of the memory subsystem controller of this memory device. |
| MemorySubsystemControllerProductID (v1.3+) | string | read-only (null) | The product ID of the memory subsystem controller of this memory device. |
| MemoryType | string (enum) | read-only (null) | The type of memory device. For the possible property values, see MemoryType in Property details. |
| Metrics {} | object | The link to the metrics associated with this memory device. | |
| Model (v1.11+) | string | read-only (null) | The product model number of this device. |
| ModuleManufacturerID (v1.3+) | string | read-only (null) | The manufacturer ID of this memory device. |
| ModuleProductID (v1.3+) | string | read-only (null) | The product ID of this memory device. |
| NonVolatileSizeLimitMiB (v1.17+) | integer (MiBy) | read-write | The total non-volatile memory capacity in mebibytes (MiB). |
| NonVolatileSizeMiB (v1.4+) | integer (MiBy) | read-only (null) | Total size of the non-volatile portion memory in MiB. |
| Oem {} | object | The OEM extension property. See the Resource schema for details on this property. | |
| OperatingMemoryModes [ ] | array (string (enum)) | read-only | Memory modes supported by the memory device. For the possible property values, see OperatingMemoryModes in Property details. |
| OperatingSpeedMhz | integer (MHz) | read-only (null) | Operating speed of the memory device in MHz or MT/s as appropriate. |
| OperatingSpeedRangeMHz (v1.13+) {} | object | Range of allowed operating speeds (MHz). See the Control.v1_7_0 schema for details on this property. | |
| PartNumber | string | read-only (null) | The product part number of this device. |
| PersistentRegionNumberLimit (v1.2+) | integer | read-only (null) | Total number of persistent regions this memory device can support. |
| PersistentRegionSizeLimitMiB | integer (MiBy) | read-only (null) | Total size of persistent regions in mebibytes (MiB). |
| PersistentRegionSizeMaxMiB (v1.2+) | integer (MiBy) | read-only (null) | Maximum size of a single persistent region in mebibytes (MiB). |
| PoisonListMaxMediaErrorRecords (v1.17+) | integer | read-write | The maximum number of media error records this device can track in its poison list. |
| PowerManagementICManufacturerID (v1.20+) | string | read-only (null) | The manufacturer ID of the Power Management Integrated Controller on this memory device. |
| PowerManagementICRevisionID (v1.20+) | string | read-only (null) | The revision ID of the Power Management Integrated Controller on this memory device. |
| PowerManagementPolicy { | object | Power management policy information. | |
| AveragePowerBudgetMilliWatts | integer (mW) | read-only (null) | Average power budget, in milliwatt units. |
| MaxTDPMilliWatts | integer (mW) | read-only (null) | Maximum TDP in milliwatt units. |
| PeakPowerBudgetMilliWatts | integer (mW) | read-only (null) | Peak power budget, in milliwatt units. |
| PolicyEnabled | boolean | read-only (null) | An indication of whether the power management policy is enabled. |
| } | |||
| RankCount | integer | read-only (null) | Number of ranks available in the memory device. |
| Regions [ { | array | Memory regions information within the memory device. | |
| MasterPassphraseEnabled (v1.17+) | boolean | read-only (null) | An indication of whether the master passphrase is enabled for this region. |
| MemoryClassification | string (enum) | read-only (null) | The classification of memory that the memory region occupies. For the possible property values, see MemoryClassification in Property details. |
| OffsetMiB | integer (MiBy) | read-only (null) | Offset within the memory that corresponds to the start of this memory region in mebibytes (MiB). |
| PassphraseEnabled (v1.5+) | boolean | read-only (null) | An indication of whether the passphrase is enabled for this region. |
| PassphraseState (deprecated v1.5) | boolean | read-only (null) | An indication of whether the state of the passphrase for this region is enabled. Deprecated in v1.5 and later. This property has been deprecated in favor of PassphraseEnabled found within RegionSet. |
| RegionId | string | read-only (null) | Unique region ID representing a specific region within the memory device. |
| SizeMiB | integer (MiBy) | read-only (null) | Size of this memory region in mebibytes (MiB). |
| } ] | |||
| SecurityCapabilities { | object | Security capabilities of the memory device. | |
| ConfigurationLockCapable (v1.7+) | boolean | read-only (null) | An indication of whether this memory device supports the locking, or freezing, of the configuration. |
| DataLockCapable (v1.7+) | boolean | read-only (null) | An indication of whether this memory device supports data locking. |
| MaxPassphraseCount | integer | read-only (null) | Maximum number of passphrases supported for this memory device. |
| PassphraseCapable | boolean | read-only (null) | An indication of whether the memory device is passphrase capable. |
| PassphraseLockLimit (v1.7+) | integer | read-only (null) | The maximum number of incorrect passphrase attempts allowed before memory device is locked. |
| SecurityStates (deprecated v1.7) [ ] | array (string (enum)) | read-only | Security states supported by the memory device. For the possible property values, see SecurityStates in Property details. Deprecated in v1.7 and later. This property has been deprecated in favor of using the individual PassphraseCapable, DataLockCapable, and ConfigurationLockCapable properties. |
| } | |||
| SecurityState (v1.7+) | string (enum) | read-write (null) | The current security state of this memory device. For the possible property values, see SecurityState in Property details. |
| SecurityStates (v1.17+) { | object | The security states of this memory device. | |
| MasterPassphraseAttemptCountReached (v1.17+) | boolean | read-only (null) | An indication of whether an incorrect master passphrase attempt count has been reached. |
| UserPassphraseAttemptCountReached (v1.17+) | boolean | read-only (null) | An indication of whether an incorrect user passphrase attempt count has been reached. |
| } | |||
| SerialNumber | string | read-only (null) | The product serial number of this device. |
| SpareDeviceCount | integer | read-only (null) | Number of unused spare devices available in the memory device. |
| SparePartNumber (v1.11+) | string | read-only (null) | The spare part number of the memory. |
| Status (v1.1+) {} | object | The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property. | |
| SubsystemDeviceID (deprecated v1.3) | string | read-only (null) | Subsystem device ID. Deprecated in v1.3 and later. This property has been deprecated in favor of MemorySubsystemControllerProductID. |
| SubsystemVendorID (deprecated v1.3) | string | read-only (null) | SubSystem vendor ID. Deprecated in v1.3 and later. This property has been deprecated in favor of MemorySubsystemControllerManufacturerID. |
| VendorID (deprecated v1.3) | string | read-only (null) | Vendor ID. Deprecated in v1.3 and later. This property has been deprecated in favor of ModuleManufacturerID. |
| VolatileRegionNumberLimit (v1.2+) | integer | read-only (null) | Total number of volatile regions this memory device can support. |
| VolatileRegionSizeLimitMiB | integer (MiBy) | read-only (null) | Total size of volatile regions in mebibytes (MiB). |
| VolatileRegionSizeMaxMiB (v1.2+) | integer (MiBy) | read-only (null) | Maximum size of a single volatile region in mebibytes (MiB). |
| VolatileSizeLimitMiB (v1.17+) | integer (MiBy) | read-write | The total volatile memory capacity in mebibytes (MiB). |
| VolatileSizeMiB (v1.4+) | integer (MiBy) | read-only (null) | Total size of the volatile portion memory in MiB. |
Actions
DisableMasterPassphrase (v1.17+)
Description
Disables the master passphrase for the given region.
Action URI
{Base URI of target resource}/Actions/Memory.DisableMasterPassphrase
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | The master passphrase for the specified region. |
| RegionId | string | required | The memory region ID to which to disable the master passphrase. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
DisablePassphrase
Description
Disable passphrase for the given region.
Action URI
{Base URI of target resource}/Actions/Memory.DisablePassphrase
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | Passphrase for doing the operation. |
| RegionId | string | required | The memory region ID to which to apply this action. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
FreezeSecurityState (v1.17+)
Description
Freezes the security state of the memory device.
Action URI
{Base URI of target resource}/Actions/Memory.FreezeSecurityState
Action parameters
This action takes no parameters.
InjectPersistentPoison (v1.17+)
Description
Injects poison to a specific persistent memory address in the memory device.
Action URI
{Base URI of target resource}/Actions/Memory.InjectPersistentPoison
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| PhysicalAddress | string | required | The device persistent physical address in which to perform a poison injection as a hex-encoded string. |
Request Example
{
"PhysicalAddress": "0x8000000"
}
OverwriteUnit (v1.6+)
Description
This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite.
Action URI
{Base URI of target resource}/Actions/Memory.OverwriteUnit
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | Passphrase for doing the operation. |
| RegionId | string | required | The memory region ID to which to apply this action. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
Reset (v1.8+)
Description
This action resets this memory device.
Action URI
{Base URI of target resource}/Actions/Memory.Reset
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| ResetType | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
Request Example
{
"ResetType": "ForceRestart"
}
ResetToDefaults (v1.16+)
Description
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/Memory.ResetToDefaults
Action parameters
This action takes no parameters.
ScanMedia (v1.17+)
Description
Scans the media of the memory device.
Action URI
{Base URI of target resource}/Actions/Memory.ScanMedia
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Length | integer | required | The length of the target region to scan in bytes from the physical address. |
| NoEventLog | boolean | optional | Indicates whether events related to the media scan are not logged. |
| PhysicalAddress | string | required | The starting device physical address to scan as a hex-encoded string. |
Request Example
{
"PhysicalAddress": "0x8000000",
"Length": 2097152
}
SecureEraseUnit
Description
This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptographic Erase.
Action URI
{Base URI of target resource}/Actions/Memory.SecureEraseUnit
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | Passphrase for doing the operation. |
| RegionId | string | required | The memory region ID to which to apply this action. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
SetMasterPassphrase (v1.17+)
Description
Sets the master passphrase for the given region.
Action URI
{Base URI of target resource}/Actions/Memory.SetMasterPassphrase
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | The master passphrase to set for the specified region. |
| RegionId | string | required | The memory region ID to which to apply the master passphrase. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
SetPassphrase
Description
Set passphrase for the given regions.
Action URI
{Base URI of target resource}/Actions/Memory.SetPassphrase
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | Passphrase for doing the operation. |
| RegionId | string | required | The memory region ID to which to apply this action. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
UnlockUnit
Description
This contains the action for unlocking given regions.
Action URI
{Base URI of target resource}/Actions/Memory.UnlockUnit
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Passphrase | string | required | The passphrase required to complete the operation. |
| RegionId | string | required | The memory region ID to which to apply this action. |
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
Property details
BaseModuleType
The base module type of the memory device.
| string | Description |
|---|---|
| CAMM (v1.21+) | Compression Attached Memory Module. |
| Die (v1.7+) | A die within a package. |
| LRDIMM | Load Reduced. |
| Mini_RDIMM | Mini_RDIMM. |
| Mini_UDIMM | Mini_UDIMM. |
| RDIMM | Registered DIMM. |
| SO_DIMM | SO_DIMM. |
| SO_DIMM_16b | SO_DIMM_16b. |
| SO_DIMM_32b | SO_DIMM_32b. |
| SO_RDIMM_72b | SO_RDIMM_72b. |
| SO_UDIMM_72b | SO_UDIMM_72b. |
| UDIMM | UDIMM. |
ErrorCorrection
Error correction scheme supported for this memory device.
| string | Description |
|---|---|
| AddressParity | Address parity errors can be corrected. |
| MultiBitECC | Multibit data errors can be corrected by ECC. |
| NoECC | No ECC available. |
| SingleBitECC | Single bit data errors can be corrected by ECC. |
idRef
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
MemoryClassification
The classification of memory that the memory region occupies.
| string | Description |
|---|---|
| Block | Block-accessible memory. |
| ByteAccessiblePersistent | Byte-accessible persistent memory. |
| Volatile | Volatile memory. |
MemoryDeviceType
Type details of the memory device.
| string | Description |
|---|---|
| DDR | DDR. |
| DDR2 | DDR2. |
| DDR2_SDRAM | DDR2 SDRAM. |
| DDR2_SDRAM_FB_DIMM | DDR2 SDRAM FB_DIMM. |
| DDR2_SDRAM_FB_DIMM_PROBE | DDR2 SDRAM FB_DIMM PROBE. |
| DDR3 | DDR3. |
| DDR3_SDRAM | DDR3 SDRAM. |
| DDR4 | DDR4. |
| DDR4_SDRAM | DDR4 SDRAM. |
| DDR4E_SDRAM | DDR4E SDRAM. |
| DDR5 (v1.11+) | Double data rate type five synchronous dynamic random-access memory. |
| DDR5_MRDIMM (v1.21+) | DDR5 MRDIMM. |
| DDR_SDRAM | DDR SDRAM. |
| DDR_SGRAM | DDR SGRAM. |
| EDO | EDO. |
| FastPageMode | Fast Page Mode. |
| GDDR (v1.11+) | Synchronous graphics random-access memory. |
| GDDR2 (v1.11+) | Double data rate type two synchronous graphics random-access memory. |
| GDDR3 (v1.11+) | Double data rate type three synchronous graphics random-access memory. |
| GDDR4 (v1.11+) | Double data rate type four synchronous graphics random-access memory. |
| GDDR5 (v1.11+) | Double data rate type five synchronous graphics random-access memory. |
| GDDR5X (v1.11+) | Double data rate type five X synchronous graphics random-access memory. |
| GDDR6 (v1.11+) | Double data rate type six synchronous graphics random-access memory. |
| HBM (v1.7+) | High Bandwidth Memory. |
| HBM2 (v1.7+) | The second generation of High Bandwidth Memory. |
| HBM2E (v1.17+) | An updated version of the second generation of High Bandwidth Memory. |
| HBM3 (v1.11+) | The third generation of High Bandwidth Memory. |
| Logical (v1.4+) | Logical device, such as when the memory is fabric-attached. |
| LPDDR3_SDRAM | LPDDR3 SDRAM. |
| LPDDR4_SDRAM | LPDDR4 SDRAM. |
| LPDDR5_SDRAM (v1.19+) | LPDDR5 SDRAM. |
| OEM (v1.11+) | OEM-defined. |
| PipelinedNibble | Pipelined Nibble. |
| ROM | ROM. |
| SDRAM | SDRAM. |
MemoryMedia
Media of this memory device.
| string | Description |
|---|---|
| DRAM | DRAM media. |
| Intel3DXPoint | Intel 3D XPoint media. |
| NAND | NAND media. |
| Proprietary | Proprietary media. |
MemoryType
The type of memory device.
| string | Description |
|---|---|
| Cache (v1.20+) | Cache. |
| DRAM | The memory device is composed of volatile memory. |
| IntelOptane (v1.6+) | The memory device is an Intel Optane Persistent Memory Module. |
| NVDIMM_F | The memory device is composed of non-volatile memory. |
| NVDIMM_N | The memory device is composed of volatile memory backed by non-volatile memory. |
| NVDIMM_P | The memory device is composed of a combination of non-volatile and volatile memory. |
OperatingMemoryModes
Memory modes supported by the memory device.
| string | Description |
|---|---|
| Block | Block-accessible system memory. |
| PMEM | Persistent memory, byte-accessible through system address space. |
| Volatile | Volatile memory. |
ResetType
The type of reset.
| string | Description |
|---|---|
| ForceOff | Turn off the unit immediately (non-graceful shutdown). |
| ForceOn | Turn on the unit immediately. |
| ForceRestart | Shut down immediately and non-gracefully and restart the unit. |
| FullPowerCycle | Full power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource. |
| GracefulRestart | Shut down gracefully and restart the unit. |
| GracefulShutdown | Shut down gracefully and power off. |
| Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
| On | Turn on the unit. |
| Pause | Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors. |
| PowerCycle | Power cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource. |
| PushPowerButton | Simulate the pressing of the physical power button on this unit. |
| Resume | Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors. |
| Suspend | Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on. |
SecurityState
The current security state of this memory device.
| string | Description |
|---|---|
| Disabled | Secure mode is disabled. |
| Enabled | Secure mode is enabled and access to the data is allowed. |
| Frozen (deprecated v1.7) | Secure state is frozen and cannot be modified until reset. Deprecated in v1.7 and later. This value has been deprecated in favor of using the ConfigurationLocked value to indicate that the configuration has been frozen. |
| Locked | Secure mode is enabled and access to the data is locked. |
| Passphraselimit | Number of attempts to unlock the memory exceeded limit. |
| Unlocked (deprecated v1.7) | Secure mode is enabled and access to the data is unlocked. Deprecated in v1.7 and later. This value has been deprecated in favor of Enabled to indicate normal security operation. |
SecurityStates
Security states supported by the memory device.
| string | Description |
|---|---|
| Disabled | Secure mode is disabled. |
| Enabled | Secure mode is enabled and access to the data is allowed. |
| Frozen | Secure state is frozen and cannot be modified until reset. |
| Locked | Secure mode is enabled and access to the data is locked. |
| Passphraselimit | Number of attempts to unlock the memory exceeded limit. |
| Unlocked | Secure mode is enabled and access to the data is unlocked. |
Example response
{
"@odata.type": "#Memory.v1_23_0.Memory",
"Name": "Regular Memory",
"Id": "1",
"RankCount": 1,
"MaxTDPMilliWatts": [
12000
],
"CapacityMiB": 8192,
"DataWidthBits": 64,
"BusWidthBits": 72,
"ErrorCorrection": "MultiBitECC",
"MemoryLocation": {
"Socket": 1,
"MemoryController": 1,
"Channel": 1,
"Slot": 1
},
"MemoryType": "DRAM",
"MemoryDeviceType": "DDR4",
"BaseModuleType": "RDIMM",
"MemoryMedia": [
"DRAM"
],
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Metrics": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1/MemoryMetrics"
},
"EnvironmentMetrics": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1/EnvironmentMetrics"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Socket 1_A",
"LocationType": "Socket",
"LocationOrdinalValue": 0
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1"
}