1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/MemoryDomain.v1_5_1.json",
3    "$ref": "#/definitions/MemoryDomain",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
30                    "versionAdded": "v1_2_0"
31                }
32            },
33            "type": "object"
34        },
35        "Links": {
36            "additionalProperties": false,
37            "description": "The links to other resources that are related to this resource.",
38            "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.",
39            "patternProperties": {
40                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
41                    "description": "This property shall specify a valid odata or Redfish property.",
42                    "type": [
43                        "array",
44                        "boolean",
45                        "integer",
46                        "number",
47                        "null",
48                        "object",
49                        "string"
50                    ]
51                }
52            },
53            "properties": {
54                "CXLLogicalDevices": {
55                    "description": "An array of links to the CXL logical devices associated with this memory domain.",
56                    "items": {
57                        "$ref": "http://redfish.dmtf.org/schemas/v1/CXLLogicalDevice.json#/definitions/CXLLogicalDevice"
58                    },
59                    "longDescription": "This property shall contain an array of links to resources of type `CXLLogicalDevice` that represent the CXL logical devices that are associated with this memory domain.",
60                    "readonly": true,
61                    "type": "array",
62                    "versionAdded": "v1_5_0"
63                },
64                "CXLLogicalDevices@odata.count": {
65                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
66                },
67                "FabricAdapters": {
68                    "description": "An array of links to the fabric adapters that present this memory domain to a fabric.",
69                    "items": {
70                        "$ref": "http://redfish.dmtf.org/schemas/v1/FabricAdapter.json#/definitions/FabricAdapter"
71                    },
72                    "longDescription": "This property shall contain an array of links to resources of type `FabricAdapter` that represent the fabric adapters that present this memory domain to a fabric.",
73                    "readonly": true,
74                    "type": "array",
75                    "versionAdded": "v1_5_0"
76                },
77                "FabricAdapters@odata.count": {
78                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
79                },
80                "MediaControllers": {
81                    "deprecated": "This property has been deprecated in favor of the `FabricAdapters` property.",
82                    "description": "An array of links to the media controllers for this memory domain.",
83                    "items": {
84                        "$ref": "http://redfish.dmtf.org/schemas/v1/MediaController.json#/definitions/MediaController"
85                    },
86                    "longDescription": "This property shall contain an array of links to resources of type `MediaController` that are associated with this memory domain.",
87                    "readonly": true,
88                    "type": "array",
89                    "versionAdded": "v1_3_0",
90                    "versionDeprecated": "v1_4_0"
91                },
92                "MediaControllers@odata.count": {
93                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
94                },
95                "Oem": {
96                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
97                    "description": "The OEM extension property.",
98                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
99                },
100                "PCIeFunctions": {
101                    "description": "An array of links to the PCIe functions representing this memory domain.",
102                    "items": {
103                        "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
104                    },
105                    "longDescription": "This property shall contain an array of links to resources of type `PCIeFunction` that represent the PCIe functions representing this memory domain.",
106                    "readonly": true,
107                    "type": "array",
108                    "versionAdded": "v1_5_0"
109                },
110                "PCIeFunctions@odata.count": {
111                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
112                }
113            },
114            "type": "object"
115        },
116        "MemoryDomain": {
117            "additionalProperties": false,
118            "description": "The `MemoryDomain` schema describes a memory domain and its configuration.  Memory domains indicate to the client which memory, or DIMMs, can be grouped together in memory chunks to represent addressable memory.",
119            "longDescription": "This resource shall represent memory domains in a Redfish implementation.",
120            "patternProperties": {
121                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
122                    "description": "This property shall specify a valid odata or Redfish property.",
123                    "type": [
124                        "array",
125                        "boolean",
126                        "integer",
127                        "number",
128                        "null",
129                        "object",
130                        "string"
131                    ]
132                }
133            },
134            "properties": {
135                "@odata.context": {
136                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
137                },
138                "@odata.etag": {
139                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
140                },
141                "@odata.id": {
142                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
143                },
144                "@odata.type": {
145                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
146                },
147                "Actions": {
148                    "$ref": "#/definitions/Actions",
149                    "description": "The available actions for this resource.",
150                    "longDescription": "This property shall contain the available actions for this resource.",
151                    "versionAdded": "v1_2_0"
152                },
153                "AllowsBlockProvisioning": {
154                    "description": "An indication of whether this memory domain supports the provisioning of blocks of memory.",
155                    "longDescription": "This property shall indicate whether this memory domain supports the creation of blocks of memory.",
156                    "readonly": true,
157                    "type": [
158                        "boolean",
159                        "null"
160                    ]
161                },
162                "AllowsMemoryChunkCreation": {
163                    "description": "An indication of whether this memory domain supports the creation of memory chunks.",
164                    "longDescription": "This property shall indicate whether this memory domain supports the creation of memory chunks.",
165                    "readonly": true,
166                    "type": [
167                        "boolean",
168                        "null"
169                    ]
170                },
171                "AllowsMirroring": {
172                    "description": "An indication of whether this memory domain supports the creation of memory chunks with mirroring enabled.",
173                    "longDescription": "This property shall indicate whether this memory domain supports the creation of memory chunks with mirroring enabled.",
174                    "readonly": true,
175                    "type": [
176                        "boolean",
177                        "null"
178                    ],
179                    "versionAdded": "v1_1_0"
180                },
181                "AllowsSparing": {
182                    "description": "An indication of whether this memory domain supports the creation of memory chunks with sparing enabled.",
183                    "longDescription": "This property shall indicate whether this memory domain supports the creation of memory chunks with sparing enabled.",
184                    "readonly": true,
185                    "type": [
186                        "boolean",
187                        "null"
188                    ],
189                    "versionAdded": "v1_1_0"
190                },
191                "Description": {
192                    "anyOf": [
193                        {
194                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
195                        },
196                        {
197                            "type": "null"
198                        }
199                    ],
200                    "readonly": true
201                },
202                "Id": {
203                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
204                    "readonly": true
205                },
206                "InterleavableMemorySets": {
207                    "description": "The interleave sets for the memory chunk.",
208                    "items": {
209                        "$ref": "#/definitions/MemorySet"
210                    },
211                    "longDescription": "This property shall represent the interleave sets for the memory chunk.",
212                    "type": "array"
213                },
214                "Links": {
215                    "$ref": "#/definitions/Links",
216                    "description": "The links to other resources that are related to this resource.",
217                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
218                    "versionAdded": "v1_3_0"
219                },
220                "MemoryChunkIncrementMiB": {
221                    "description": "The incremental size, from the minimum size, allowed for a memory chunk within this domain in mebibytes (MiB).",
222                    "longDescription": "This property shall contain the incremental size, from `MemoryChunkIncrementMiB`, allowed for a memory chunk within this domain in mebibytes (MiB).",
223                    "readonly": true,
224                    "type": [
225                        "integer",
226                        "null"
227                    ],
228                    "units": "MiBy",
229                    "versionAdded": "v1_5_0"
230                },
231                "MemoryChunks": {
232                    "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryChunksCollection.json#/definitions/MemoryChunksCollection",
233                    "description": "The link to the collection of memory chunks associated with this memory domain.",
234                    "longDescription": "This property shall contain a link to a resource collection of type `MemoryChunksCollection`.",
235                    "readonly": true
236                },
237                "MemorySizeMiB": {
238                    "description": "The total size of the memory domain in mebibytes (MiB).",
239                    "longDescription": "This property shall contain the total size of the memory domain in mebibytes (MiB).",
240                    "readonly": true,
241                    "type": [
242                        "integer",
243                        "null"
244                    ],
245                    "units": "MiBy",
246                    "versionAdded": "v1_5_0"
247                },
248                "MinMemoryChunkSizeMiB": {
249                    "description": "The minimum size allowed for a memory chunk within this domain in mebibytes (MiB).",
250                    "longDescription": "This property shall contain the minimum size allowed for a memory chunk within this domain in mebibytes (MiB).",
251                    "readonly": true,
252                    "type": [
253                        "integer",
254                        "null"
255                    ],
256                    "units": "MiBy",
257                    "versionAdded": "v1_5_0"
258                },
259                "Name": {
260                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
261                    "readonly": true
262                },
263                "Oem": {
264                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
265                    "description": "The OEM extension property.",
266                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
267                },
268                "Status": {
269                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
270                    "description": "The status and health of the resource and its subordinate or dependent resources.",
271                    "longDescription": "This property shall contain any status or health properties of the resource.",
272                    "versionAdded": "v1_5_0"
273                }
274            },
275            "required": [
276                "@odata.id",
277                "@odata.type",
278                "Id",
279                "Name"
280            ],
281            "type": "object"
282        },
283        "MemorySet": {
284            "additionalProperties": false,
285            "description": "The interleave sets for a memory chunk.",
286            "longDescription": "This type shall represent the interleave sets for a memory chunk.",
287            "patternProperties": {
288                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
289                    "description": "This property shall specify a valid odata or Redfish property.",
290                    "type": [
291                        "array",
292                        "boolean",
293                        "integer",
294                        "number",
295                        "null",
296                        "object",
297                        "string"
298                    ]
299                }
300            },
301            "properties": {
302                "MemorySet": {
303                    "description": "The set of memory for a particular interleave set.",
304                    "items": {
305                        "$ref": "http://redfish.dmtf.org/schemas/v1/Memory.json#/definitions/Memory"
306                    },
307                    "longDescription": "This property shall contain an array of links to resources of type `Memory`.",
308                    "readonly": true,
309                    "type": "array"
310                },
311                "MemorySet@odata.count": {
312                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
313                }
314            },
315            "type": "object"
316        },
317        "OemActions": {
318            "additionalProperties": true,
319            "description": "The available OEM-specific actions for this resource.",
320            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
321            "patternProperties": {
322                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
323                    "description": "This property shall specify a valid odata or Redfish property.",
324                    "type": [
325                        "array",
326                        "boolean",
327                        "integer",
328                        "number",
329                        "null",
330                        "object",
331                        "string"
332                    ]
333                }
334            },
335            "properties": {},
336            "type": "object"
337        }
338    },
339    "language": "en",
340    "owningEntity": "DMTF",
341    "release": "2022.3",
342    "title": "#MemoryDomain.v1_5_1.MemoryDomain"
343}