Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / bdd1c8360a29d18178297e580bbde4af9e2e60a5 / . / static / redfish / v1 / JsonSchemas / MemoryChunks / index.json
blob: 3850a6e9571109fa4e1da4fbfed7e781357fef99 [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame]1{
2 "$ref": "#/definitions/MemoryChunks",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_4_0.json",
4 "copyright": "Copyright 2014-2018 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "Oem": {
25 "$ref": "#/definitions/OemActions"
26 }
27 },
28 "type": "object"
29 },
30 "AddressRangeType": {
31 "enum": [
32 "Volatile",
33 "PMEM",
34 "Block"
35 ],
36 "enumDescriptions": {
37 "Block": "Block accesible memory.",
38 "PMEM": "Byte accessible persistent memory.",
39 "Volatile": "Volatile memory."
40 },
41 "type": "string"
42 },
43 "InterleaveSet": {
44 "additionalProperties": false,
45 "description": "This an interleave set for a memory chunk.",
46 "longDescription": "This type shall describe an interleave set of which the memory chunk is a part.",
47 "patternProperties": {
48 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
49 "description": "This property shall specify a valid odata or Redfish property.",
50 "type": [
51 "array",
52 "boolean",
53 "number",
54 "null",
55 "object",
56 "string"
57 ]
58 }
59 },
60 "properties": {
61 "Memory": {
62 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/idRef",
63 "description": "Describes a memory device of the interleave set.",
64 "longDescription": "The value of this property shall be the memory device to which these settings apply.",
65 "readonly": true
66 },
67 "MemoryLevel": {
68 "description": "Level of the interleave set for multi-level tiered memory.",
69 "longDescription": "The value of this property shall be the level of this interleave set for multi-level tiered memory.",
70 "readonly": true,
71 "type": [
72 "number",
73 "null"
74 ]
75 },
76 "OffsetMiB": {
77 "description": "Offset within the DIMM that corresponds to the start of this memory region, measured in mebibytes (MiB).",
78 "longDescription": "The value of this property shall be the offset within the DIMM that corresponds to the start of this memory region, with units in MiB.",
79 "readonly": true,
80 "type": [
81 "number",
82 "null"
83 ]
84 },
85 "RegionId": {
86 "description": "DIMM region identifier.",
87 "longDescription": "The value of this property shall be the DIMM region identifier.",
88 "readonly": true,
89 "type": [
90 "string",
91 "null"
92 ]
93 },
94 "SizeMiB": {
95 "description": "Size of this memory region measured in mebibytes (MiB).",
96 "longDescription": "The value of this property shall be the size of this memory region, with units in MiB.",
97 "readonly": true,
98 "type": [
99 "number",
100 "null"
101 ]
102 }
103 },
104 "type": "object"
105 },
106 "MemoryChunks": {
107 "additionalProperties": false,
108 "description": "This is the schema definition of a Memory Chunk and its configuration.",
109 "longDescription": "This resource shall be used to represent Memory Chunks and Interleave Sets in a Redfish implementation.",
110 "patternProperties": {
111 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
112 "description": "This property shall specify a valid odata or Redfish property.",
113 "type": [
114 "array",
115 "boolean",
116 "number",
117 "null",
118 "object",
119 "string"
120 ]
121 }
122 },
123 "properties": {
124 "@odata.context": {
125 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/context"
126 },
127 "@odata.etag": {
128 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/etag"
129 },
130 "@odata.id": {
131 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/id"
132 },
133 "@odata.type": {
134 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/type"
135 },
136 "Actions": {
137 "$ref": "#/definitions/Actions",
138 "description": "The available actions for this resource.",
139 "longDescription": "The Actions property shall contain the available actions for this resource."
140 },
141 "AddressRangeType": {
142 "anyOf": [
143 {
144 "$ref": "#/definitions/AddressRangeType"
145 },
146 {
147 "type": "null"
148 }
149 ],
150 "description": "Memory type of this memory chunk.",
151 "longDescription": "The value of this property shall be the type of memory chunk.",
152 "readonly": true
153 },
154 "Description": {
155 "anyOf": [
156 {
157 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
158 },
159 {
160 "type": "null"
161 }
162 ],
163 "readonly": true
164 },
165 "Id": {
166 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
167 "readonly": true
168 },
169 "InterleaveSets": {
170 "description": "This is the interleave sets for the memory chunk.",
171 "items": {
172 "anyOf": [
173 {
174 "$ref": "#/definitions/InterleaveSet"
175 },
176 {
177 "type": "null"
178 }
179 ]
180 },
181 "longDescription": "These properties shall represent the interleave sets for the memory chunk.",
182 "type": "array"
183 },
184 "IsMirrorEnabled": {
185 "description": "Mirror Enabled status.",
186 "longDescription": "The value of this property shall indicate if memory mirroring is enabled for this MemoryChunk.",
187 "readonly": true,
188 "type": [
189 "boolean",
190 "null"
191 ]
192 },
193 "IsSpare": {
194 "description": "Spare enabled status.",
195 "longDescription": "The value of this property shall indicate if sparing is enabled for this MemoryChunk.",
196 "readonly": true,
197 "type": [
198 "boolean",
199 "null"
200 ]
201 },
202 "MemoryChunkSizeMiB": {
203 "description": "Size of the memory chunk measured in mebibytes (MiB).",
204 "longDescription": "The value of this property shall be the size of the memory chunk in MiB.",
205 "readonly": true,
206 "type": [
207 "number",
208 "null"
209 ]
210 },
211 "Name": {
212 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
213 "readonly": true
214 },
215 "Oem": {
216 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
217 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
218 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
219 },
220 "Status": {
221 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
222 }
223 },
224 "required": [
225 "Id",
226 "Name"
227 ],
228 "type": "object"
229 },
230 "OemActions": {
231 "additionalProperties": true,
232 "description": "The available OEM specific actions for this resource.",
233 "longDescription": "This type shall contain any additional OEM actions for this resource.",
234 "patternProperties": {
235 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
236 "description": "This property shall specify a valid odata or Redfish property.",
237 "type": [
238 "array",
239 "boolean",
240 "number",
241 "null",
242 "object",
243 "string"
244 ]
245 }
246 },
247 "properties": {},
248 "type": "object"
249 }
250 },
251 "owningEntity": "DMTF",
252 "title": "#MemoryChunks.v1_2_1.MemoryChunks"
253}