{ "$id": "http://redfish.dmtf.org/schemas/v1/Memory.v1_2_6.json", "$ref": "#/definitions/Memory", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, "description": "The available actions for this resource.", "longDescription": "This type shall contain the available actions for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "#Memory.DisablePassphrase": { "$ref": "#/definitions/DisablePassphrase" }, "#Memory.SecureEraseUnit": { "$ref": "#/definitions/SecureEraseUnit" }, "#Memory.SetPassphrase": { "$ref": "#/definitions/SetPassphrase" }, "#Memory.UnlockUnit": { "$ref": "#/definitions/UnlockUnit" }, "Oem": { "$ref": "#/definitions/OemActions", "description": "The available OEM-specific actions for this resource.", "longDescription": "This property shall contain the available OEM-specific actions for this resource." } }, "type": "object" }, "BaseModuleType": { "enum": [ "RDIMM", "UDIMM", "SO_DIMM", "LRDIMM", "Mini_RDIMM", "Mini_UDIMM", "SO_RDIMM_72b", "SO_UDIMM_72b", "SO_DIMM_16b", "SO_DIMM_32b" ], "enumDescriptions": { "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." }, "type": "string" }, "DisablePassphrase": { "additionalProperties": false, "description": "Disable passphrase for given regions.", "longDescription": "This action shall disaple the need for passphrases on the supplied region provided the supplied passphrase matches that of the region.", "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { "description": "The memory region ID to which to apply this action.", "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object" }, "ErrorCorrection": { "enum": [ "NoECC", "SingleBitECC", "MultiBitECC", "AddressParity" ], "enumDescriptions": { "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." }, "type": "string" }, "Links": { "additionalProperties": false, "description": "The links to other resources that are related to this resource.", "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", "description": "The link to the chassis that contains this memory.", "longDescription": "This property shall contain a link to a resource of type Chassis that represents the physical container associated with this memory.", "readonly": true, "versionAdded": "v1_2_0" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." } }, "type": "object" }, "Memory": { "additionalProperties": false, "description": "The schema for definition of a memory and its configuration.", "longDescription": "This resource contains the memory in a Redfish implementation.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", "description": "The available actions for this resource.", "longDescription": "This property shall contain the available actions for this resource." }, "AllocationAlignmentMiB": { "description": "The boundary that memory regions are allocated on, measured in mebibytes (MiB).", "longDescription": "This property shall contain the alignment boundary on which memory regions are allocated, measured in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy", "versionAdded": "v1_2_0" }, "AllocationIncrementMiB": { "description": "The size of the smallest unit of allocation for a memory region in mebibytes (MiB).", "longDescription": "This property shall contain the allocation increment for regions, measured in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy", "versionAdded": "v1_2_0" }, "AllowedSpeedsMHz": { "description": "Speeds supported by this memory.", "items": { "type": "integer" }, "longDescription": "This property shall contain the speed supported by this memory.", "readonly": true, "type": "array", "units": "MHz" }, "BaseModuleType": { "anyOf": [ { "$ref": "#/definitions/BaseModuleType" }, { "type": "null" } ], "description": "The base module type of the memory.", "longDescription": "This property shall contain the base module type of the memory.", "readonly": true }, "BusWidthBits": { "description": "The bus width, in bits.", "longDescription": "This property shall contain the bus width, in bits.", "readonly": true, "type": [ "integer", "null" ] }, "CapacityMiB": { "description": "Memory capacity in mebibytes (MiB).", "longDescription": "This property shall contain the memory capacity in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy" }, "DataWidthBits": { "description": "Data width in bits.", "longDescription": "This property shall contain the data width in bits.", "readonly": true, "type": [ "integer", "null" ] }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "DeviceID": { "description": "Device ID.", "longDescription": "This property shall contain the device ID of the memory.", "readonly": true, "type": [ "string", "null" ] }, "DeviceLocator": { "description": "Location of the memory in the platform.", "longDescription": "This property shall contain location of the memory in the platform, typically marked in the silk screen.", "readonly": true, "type": [ "string", "null" ] }, "ErrorCorrection": { "anyOf": [ { "$ref": "#/definitions/ErrorCorrection" }, { "type": "null" } ], "description": "Error correction scheme supported for this memory.", "longDescription": "This property shall contain the error correction scheme supported for this memory.", "readonly": true }, "FirmwareApiVersion": { "description": "Version of API supported by the firmware.", "longDescription": "This property shall contain the version of API supported by the firmware.", "readonly": true, "type": [ "string", "null" ] }, "FirmwareRevision": { "description": "Revision of firmware on the memory controller.", "longDescription": "This property shall contain the revision of firmware on the memory controller.", "readonly": true, "type": [ "string", "null" ] }, "FunctionClasses": { "description": "Function classes by the memory.", "items": { "type": "string" }, "longDescription": "This property shall contain the function classes by the memory.", "readonly": true, "type": "array" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "IsRankSpareEnabled": { "description": "An indication of whether rank spare is enabled for this memory.", "longDescription": "This property shall indicate whether rank spare is enabled for this memory.", "readonly": true, "type": [ "boolean", "null" ] }, "IsSpareDeviceEnabled": { "description": "An indication of whether a spare device is enabled for this memory.", "longDescription": "This property shall indicate whether the spare device is enabled.", "readonly": true, "type": [ "boolean", "null" ] }, "Links": { "$ref": "#/definitions/Links", "description": "The links to other resources that are related to this resource.", "longDescription": "This property shall contain links to resources that are related to but are not contained by or subordinate to this resource.", "versionAdded": "v1_2_0" }, "Manufacturer": { "description": "The memory manufacturer.", "longDescription": "This property shall contain the manufacturer of the memory.", "readonly": true, "type": [ "string", "null" ] }, "MaxTDPMilliWatts": { "description": "Set of maximum power budgets supported by the memory in milliwatts.", "items": { "type": "integer" }, "longDescription": "This property shall contain an array of maximum power budgets supported by the memory in milliwatts.", "readonly": true, "type": "array", "units": "mW" }, "MemoryDeviceType": { "anyOf": [ { "$ref": "#/definitions/MemoryDeviceType" }, { "type": "null" } ], "description": "Type details of the memory.", "longDescription": "This property shall contain the Memory Device Type as defined by SMBIOS.", "readonly": true }, "MemoryLocation": { "$ref": "#/definitions/MemoryLocation", "description": "Memory connection information to sockets and memory controllers.", "longDescription": "This object shall contain properties that describe the memory connection information to sockets and memory controllers." }, "MemoryMedia": { "description": "Media of this memory.", "items": { "$ref": "#/definitions/MemoryMedia" }, "longDescription": "This property shall contain the media types of this memory.", "readonly": true, "type": "array" }, "MemoryType": { "anyOf": [ { "$ref": "#/definitions/MemoryType" }, { "type": "null" } ], "description": "The type of memory.", "longDescription": "This property shall contain the type of memory that this resource represents.", "readonly": true }, "Metrics": { "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.json#/definitions/MemoryMetrics", "description": "The link to the Metrics associated with this memory.", "longDescription": "The link to the metrics associated with this memory.", "readonly": true }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "OperatingMemoryModes": { "description": "Memory modes supported by the memory.", "items": { "$ref": "#/definitions/OperatingMemoryModes" }, "longDescription": "This property shall contain the memory modes supported by the memory.", "readonly": true, "type": "array" }, "OperatingSpeedMhz": { "description": "Operating speed of memory in MHz or MT/s as appropriate.", "longDescription": "This property shall contain the operating speed of memory 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.", "readonly": true, "type": [ "integer", "null" ], "units": "MHz" }, "PartNumber": { "description": "The product part number of this device.", "longDescription": "This property shall indicate the part number as provided by the manufacturer of this memory.", "readonly": true, "type": [ "string", "null" ] }, "PersistentRegionNumberLimit": { "description": "Total number of persistent regions this memory can support.", "longDescription": "This property shall contain the total number of persistent regions this memory can support.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "PersistentRegionSizeLimitMiB": { "description": "Total size of persistent regions in mebibytes (MiB).", "longDescription": "This property shall contain the total size of persistent regions in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy" }, "PersistentRegionSizeMaxMiB": { "description": "Maximum size of a single persistent region in mebibytes (MiB).", "longDescription": "This property shall contain the maximum size of a single persistent regions in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy", "versionAdded": "v1_2_0" }, "PowerManagementPolicy": { "$ref": "#/definitions/PowerManagementPolicy", "description": "Power management policy information.", "longDescription": "This object shall contain properties that describe the power management policy for this resource." }, "RankCount": { "description": "Number of ranks available in the memory.", "longDescription": "This property shall contain the number of ranks available in the memory. The ranks could be used for spare or interleave.", "readonly": true, "type": [ "integer", "null" ] }, "Regions": { "description": "Memory regions information within the memory.", "items": { "$ref": "#/definitions/RegionSet" }, "longDescription": "This property shall contain the memory region information within the memory.", "type": "array" }, "SecurityCapabilities": { "$ref": "#/definitions/SecurityCapabilities", "description": "Security capabilities of the memory.", "longDescription": "This property shall contain properties that describe the security capabilities of the memory." }, "SerialNumber": { "description": "The product serial number of this device.", "longDescription": "This property shall indicate the serial number as provided by the manufacturer of this memory.", "readonly": true, "type": [ "string", "null" ] }, "SpareDeviceCount": { "description": "Number of unused spare devices available in the memory.", "longDescription": "This property shall contain the number of unused spare devices available in the memory. If memory devices fails, the spare device could be used.", "readonly": true, "type": [ "integer", "null" ] }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", "description": "The status and health of the resource and its subordinate or dependent resources.", "longDescription": "This property shall contain any status or health properties of the resource.", "versionAdded": "v1_1_0" }, "SubsystemDeviceID": { "description": "Subsystem device ID.", "longDescription": "This property shall contain the subsystem device ID of the memory.", "readonly": true, "type": [ "string", "null" ] }, "SubsystemVendorID": { "description": "SubSystem vendor ID.", "longDescription": "This property shall contain the subsystem vendor ID of the memory.", "readonly": true, "type": [ "string", "null" ] }, "VendorID": { "description": "Vendor ID.", "longDescription": "This property shall contain the vendor ID of the memory.", "readonly": true, "type": [ "string", "null" ] }, "VolatileRegionNumberLimit": { "description": "Total number of volatile regions this memory can support.", "longDescription": "This property shall contain the total number of volatile regions this memory can support.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "VolatileRegionSizeLimitMiB": { "description": "Total size of volatile regions in mebibytes (MiB).", "longDescription": "This property shall contain the total size of volatile regions in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy" }, "VolatileRegionSizeMaxMiB": { "description": "Maximum size of a single volatile region in mebibytes (MiB).", "longDescription": "This property shall contain the maximum size of a single volatile regions in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy", "versionAdded": "v1_2_0" } }, "required": [ "@odata.id", "@odata.type", "Id", "Name" ], "type": "object" }, "MemoryClassification": { "enum": [ "Volatile", "ByteAccessiblePersistent", "Block" ], "enumDescriptions": { "Block": "Block-accessible memory.", "ByteAccessiblePersistent": "Byte-accessible persistent memory.", "Volatile": "Volatile memory." }, "type": "string" }, "MemoryDeviceType": { "enum": [ "DDR", "DDR2", "DDR3", "DDR4", "DDR4_SDRAM", "DDR4E_SDRAM", "LPDDR4_SDRAM", "DDR3_SDRAM", "LPDDR3_SDRAM", "DDR2_SDRAM", "DDR2_SDRAM_FB_DIMM", "DDR2_SDRAM_FB_DIMM_PROBE", "DDR_SGRAM", "DDR_SDRAM", "ROM", "SDRAM", "EDO", "FastPageMode", "PipelinedNibble" ], "enumDescriptions": { "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.", "DDR4E_SDRAM": "DDR4E SDRAM.", "DDR4_SDRAM": "DDR4 SDRAM.", "DDR_SDRAM": "DDR SDRAM.", "DDR_SGRAM": "DDR SGRAM.", "EDO": "EDO.", "FastPageMode": "Fast Page Mode.", "LPDDR3_SDRAM": "LPDDR3 SDRAM.", "LPDDR4_SDRAM": "LPDDR4 SDRAM.", "PipelinedNibble": "Pipelined Nibble.", "ROM": "ROM.", "SDRAM": "SDRAM." }, "type": "string" }, "MemoryLocation": { "additionalProperties": false, "description": "Memory connection information to sockets and memory controllers.", "longDescription": "This type shall contain properties that describe the memory connection information to sockets and memory controllers.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "Channel": { "description": "The channel number to which the memory is connected.", "longDescription": "This property shall contain the channel number to which the memory is connected.", "readonly": true, "type": [ "integer", "null" ] }, "MemoryController": { "description": "The memory controller number to which the memory is connected.", "longDescription": "This property shall contain the memory controller number to which the memory is connected.", "readonly": true, "type": [ "integer", "null" ] }, "Slot": { "description": "The slot number to which the memory is connected.", "longDescription": "This property shall contain the slot number to which the memory is connected.", "readonly": true, "type": [ "integer", "null" ] }, "Socket": { "description": "The socket number to which the memory is connected.", "longDescription": "This property shall contain the socket number to which the memory is connected.", "readonly": true, "type": [ "integer", "null" ] } }, "type": "object" }, "MemoryMedia": { "enum": [ "DRAM", "NAND", "Proprietary" ], "enumDescriptions": { "DRAM": "DRAM media.", "NAND": "NAND media.", "Proprietary": "Proprietary media." }, "type": "string" }, "MemoryType": { "enum": [ "DRAM", "NVDIMM_N", "NVDIMM_F", "NVDIMM_P" ], "enumDescriptions": { "DRAM": "The memory module is comprised of volatile memory.", "NVDIMM_F": "The memory module is comprised of non-volatile memory.", "NVDIMM_N": "The memory module is comprised of volatile memory backed by non-volatile memory.", "NVDIMM_P": "The memory module is comprised of a combination of non-volatile and volatile memory." }, "enumLongDescriptions": { "DRAM": "This memory type shall represent volatile DRAM.", "NVDIMM_F": "This memory type shall represent NVDIMM_F as defined by JEDEC.", "NVDIMM_N": "This memory type shall represent NVDIMM_N as defined by JEDEC.", "NVDIMM_P": "This memory type shall represent NVDIMM_P as defined by JEDEC." }, "type": "string" }, "OemActions": { "additionalProperties": true, "description": "The available OEM-specific actions for this resource.", "longDescription": "This type shall contain the available OEM-specific actions for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": {}, "type": "object" }, "OperatingMemoryModes": { "enum": [ "Volatile", "PMEM", "Block" ], "enumDescriptions": { "Block": "Block-accessible system memory.", "PMEM": "Persistent memory, byte-accessible through system address space.", "Volatile": "Volatile memory." }, "type": "string" }, "PowerManagementPolicy": { "additionalProperties": false, "description": "Power management policy information.", "longDescription": "This type shall contain properties that describe the power management policy for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AveragePowerBudgetMilliWatts": { "description": "Average power budget, in milliwatts.", "longDescription": "This property shall contain the average power budget, in milliwatts.", "readonly": true, "type": [ "integer", "null" ], "units": "mW" }, "MaxTDPMilliWatts": { "description": "Maximum TDP in milliwatts.", "longDescription": "This property shall contain the maximum TDP in milliwatts.", "readonly": true, "type": [ "integer", "null" ], "units": "mW" }, "PeakPowerBudgetMilliWatts": { "description": "Peak power budget, in milliwatts.", "longDescription": "This property shall contain the peak power budget, in milliwatts.", "readonly": true, "type": [ "integer", "null" ], "units": "mW" }, "PolicyEnabled": { "description": "An indication of whether the power management policy is enabled.", "longDescription": "This property shall indicate whether the power management policy is enabled.", "readonly": true, "type": [ "boolean", "null" ] } }, "type": "object" }, "RegionSet": { "additionalProperties": false, "description": "Memory region information within a memory device.", "longDescription": "This type shall describe the memory region information within a memory device.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "MemoryClassification": { "anyOf": [ { "$ref": "#/definitions/MemoryClassification" }, { "type": "null" } ], "description": "The classification of memory that the memory region occupies.", "longDescription": "This property shall contain the classification of memory that the memory region occupies.", "readonly": true }, "OffsetMiB": { "description": "Offset within the memory that corresponds to the start of this memory region in mebibytes (MiB).", "longDescription": "This property shall contain the offset within the memory that corresponds to the start of this memory region in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy" }, "PassphraseState": { "description": "An indication of whether the state of the passphrase for this region is enabled.", "longDescription": "This property shall indicate whether the state of the passphrase for this region is enabled.", "readonly": true, "type": [ "boolean", "null" ] }, "RegionId": { "description": "Unique region ID representing a specific region within the memory.", "longDescription": "This property shall contain the unique region ID representing a specific region within the memory.", "readonly": true, "type": [ "string", "null" ] }, "SizeMiB": { "description": "Size of this memory region in mebibytes (MiB).", "longDescription": "This property shall contain the size of this memory region in MiB.", "readonly": true, "type": [ "integer", "null" ], "units": "MiBy" } }, "type": "object" }, "SecureEraseUnit": { "additionalProperties": false, "description": "This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptographic Erase.", "longDescription": "This action shall securely erase the supplied region provided the supplied passphrase matches that of the given region using the NIST SP800-88 Purge: Cryptographic Erase. Use the OverwriteUnit method to perform NIST SP800-88 Purge: Overwrite.", "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { "description": "The memory region ID to which to apply this action.", "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object" }, "SecurityCapabilities": { "additionalProperties": false, "description": "This type contains security capabilities of a memory device.", "longDescription": "This type shall contain properties that describe the security capabilities of a memory device.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "MaxPassphraseCount": { "description": "Maximum number of passphrases supported for this memory.", "longDescription": "This property shall contain the maximum number of passphrases supported for this memory.", "readonly": true, "type": [ "integer", "null" ] }, "PassphraseCapable": { "description": "An indication of whether the memory is passphrase capable.", "longDescription": "This property shall indicate whether the memory is passphrase capable.", "readonly": true, "type": [ "boolean", "null" ] }, "SecurityStates": { "description": "Security states supported by the memory.", "items": { "$ref": "#/definitions/SecurityStates" }, "longDescription": "This property shall contain the security states supported by the memory.", "readonly": true, "type": "array" } }, "type": "object" }, "SecurityStates": { "enum": [ "Enabled", "Disabled", "Unlocked", "Locked", "Frozen", "Passphraselimit" ], "enumDescriptions": { "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." }, "type": "string" }, "SetPassphrase": { "additionalProperties": false, "description": "Set passphrase for the given regions.", "longDescription": "This action shall apply the supplied passphrase to the supplied region.", "parameters": { "Passphrase": { "description": "Passphrase for doing the operation.", "longDescription": "This property shall contain the passphrase used in this action.", "requiredParameter": true, "type": "string" }, "RegionId": { "description": "The memory region ID to which to apply this action.", "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object" }, "UnlockUnit": { "additionalProperties": false, "description": "This contains the action for unlocking given regions.", "longDescription": "This action shall apply the supplied passphrase to the supplied region for the purpose of unlocking the given regions.", "parameters": { "Passphrase": { "description": "The passphrase required to complete the operation.", "longDescription": "This property shall contain the passphrase required to complete this actionn.", "requiredParameter": true, "type": "string" }, "RegionId": { "description": "The memory region ID to which to apply this action.", "longDescription": "This property shall contain the memory region ID to which to apply this action.", "requiredParameter": true, "type": "string" } }, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object" } }, "owningEntity": "DMTF", "release": "2017.1", "title": "#Memory.v1_2_6.Memory" }