Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Memory

Description

This resource shall represent a memory device in a Redfish implementation. It may also represent a location, such as a slot, socket, or bay, where a unit may be installed, but the State property within the Status property contains Absent.

Fields

FieldTypeDescription
AllocationAlignmentMiBintegerThis property shall contain the alignment boundary on which memory regions are allocated, measured in MiB.
AllocationIncrementMiBintegerThis property shall contain the allocation increment for regions, measured in MiB.
AllowedSpeedsMHzarrayThis property shall contain the speeds supported by this memory device.
BaseModuleTypeBaseModuleTypeThis property shall contain the base module type of the memory device.
BusWidthBitsintegerThis property shall contain the bus width, in bits.
CapacityMiBintegerThis property shall contain the memory capacity in MiB.
CXLCXLThis property shall contain CXL-specific properties for this memory device.
DataWidthBitsintegerThis property shall contain the data width in bits.
DescriptionDescription
EnabledbooleanThe value of this property shall indicate if this memory is enabled.
EnvironmentMetricsEnvironmentMetricsThis property shall contain a link to a resource of type `EnvironmentMetrics` that specifies the environment metrics for this memory.
ErrorCorrectionErrorCorrectionThis property shall contain the error correction scheme supported for this memory device.
FirmwareApiVersionstringThis property shall contain the version of API supported by the firmware.
FirmwareRevisionstringThis property shall contain the revision of firmware on the memory controller.
FunctionClassesarrayThis property shall contain the function classes by the memory device.
HealthDataHealthDataThis property shall contain the health data of this memory device.
IdId
IsRankSpareEnabledbooleanThis property shall indicate whether rank spare is enabled for this memory device.
IsSpareDeviceEnabledbooleanThis property shall indicate whether the spare device is enabled.
LinksLinksThis property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
LocationLocationThis property shall contain the location information of the associated memory device.
LocationIndicatorActivebooleanThis property shall contain the state of the indicator used to physically identify or locate this resource. A write to this property shall update the value of `IndicatorLED` in this resource, if supported, to reflect the implementation of the locating function.
LogLogServiceThis property shall contain a link to a resource of type `LogService`.
LogicalSizeMiBintegerThis property shall contain the total size of the logical memory in MiB.
ManufacturerstringThis property shall contain the manufacturer of the memory device.
MaxTDPMilliWattsarrayThis property shall contain an array of maximum power budgets supported by the memory device in milliwatt units.
MemoryDeviceTypeMemoryDeviceTypeThis property shall contain the Memory Device Type as defined by SMBIOS.
MemoryLocationMemoryLocationThis object shall contain properties that describe the memory connection information to sockets and memory controllers.
MemoryMediaarrayThis property shall contain the media types of this memory device.
MemorySubsystemControllerManufacturerIDstringThis property shall contain the two byte manufacturer ID of the memory subsystem controller of this memory device as defined by JEDEC in JEP-106.
MemorySubsystemControllerProductIDstringThis property shall contain the two byte product ID of the memory subsystem controller of this memory device as defined by the manufacturer.
MemoryTypeMemoryTypeThis property shall contain the type of memory device that this resource represents.
MetricsMemoryMetricsThe link to the metrics associated with this memory device.
ModelstringThis property shall indicate the model information as provided by the manufacturer of this memory.
ModuleManufacturerIDstringThis property shall contain the two byte manufacturer ID of this memory device as defined by JEDEC in JEP-106.
ModuleProductIDstringThis property shall contain the two byte product ID of this memory device as defined by the manufacturer.
NameName
NonVolatileSizeLimitMiBintegerThis property shall contain the total non-volatile memory capacity in mebibytes (MiB).
NonVolatileSizeMiBintegerThis property shall contain the total size of the non-volatile portion memory in MiB.
OemOemThis property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements.
OperatingMemoryModesarrayThis property shall contain the memory modes supported by the memory device.
OperatingSpeedMhzintegerThis property shall contain the operating speed of the memory device in MHz or MT/s (mega-transfers per second) as reported by the memory device. Memory devices that operate at their bus speed shall report the operating speed in MHz (bus speed), while memory devices that transfer data faster than their bus speed, such as DDR memory, shall report the operating speed in MT/s (mega-transfers/second). The reported value shall match the conventionally reported values for the technology used by the memory device.
OperatingSpeedRangeMHzControlRangeExcerptThis property shall contain the operating speed control, in megahertz units, for this resource. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value of `FrequencyMHz`.
PartNumberstringThis property shall indicate the part number as provided by the manufacturer of this memory device.
PersistentRegionNumberLimitintegerThis property shall contain the total number of persistent regions this memory device can support.
PersistentRegionSizeLimitMiBintegerThis property shall contain the total size of persistent regions in MiB.
PersistentRegionSizeMaxMiBintegerThis property shall contain the maximum size of a single persistent regions in MiB.
PoisonListMaxMediaErrorRecordsintegerThis property shall contain the maximum number of media error records this device can track in its poison list.
PowerManagementICManufacturerIDstringThis property shall contain the two byte manufacturer ID of the Power Management Integrated Controller on this memory device as defined by JEDEC in JESD301.
PowerManagementICRevisionIDstringThis property shall contain the two byte revision ID of the Power Management Integrated Controller on this memory device as defined by JEDEC in JESD301.
PowerManagementPolicyPowerManagementPolicyThis object shall contain properties that describe the power management policy for this resource.
RankCountintegerThis property shall contain the number of ranks available in the memory device. The ranks could be used for spare or interleave.
RegionsarrayThis property shall contain the memory region information within the memory device.
SecurityCapabilitiesSecurityCapabilitiesThis property shall contain properties that describe the security capabilities of the memory device.
SecurityStateSecurityStatesThis property shall contain the current security state of this memory device.
SecurityStatesSecurityStateInfoThis property shall contain the security states of this memory device.
SerialNumberstringThis property shall indicate the serial number as provided by the manufacturer of this memory device.
SpareDeviceCountintegerThis property shall contain the number of unused spare devices available in the memory device. If the memory device fails, the spare devices could be used.
SparePartNumberstringThis property shall contain the spare part number of the memory.
StatusStatusThis property shall contain any status or health properties of the resource.
SubsystemDeviceIDstringThis property shall contain the subsystem device ID of the memory device.
SubsystemVendorIDstringThis property shall contain the subsystem vendor ID of the memory device.
VendorIDstringThis property shall contain the vendor ID of the memory device.
VolatileRegionNumberLimitintegerThis property shall contain the total number of volatile regions this memory device can support.
VolatileRegionSizeLimitMiBintegerThis property shall contain the total size of volatile regions in MiB.
VolatileRegionSizeMaxMiBintegerThis property shall contain the maximum size of a single volatile regions in MiB.
VolatileSizeLimitMiBintegerThis property shall contain the total volatile memory capacity in mebibytes (MiB).
VolatileSizeMiBintegerThis property shall contain the total size of the volatile portion memory in MiB.