Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 683f7276576dbf0bf7770570190f6b5b4e84d4c9 / . / static / redfish / v1 / JsonSchemas / MemoryDomain / index.json
blob: 739d522b742d71532e2c792e3f964e1c03a27432 [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame^]1{
2 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_2_0.json",
3 "title": "#MemoryDomain.v1_2_0.MemoryDomain",
4 "$ref": "#/definitions/MemoryDomain",
5 "definitions": {
6 "MemorySet": {
7 "type": "object",
8 "patternProperties": {
9 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
10 "type": [
11 "array",
12 "boolean",
13 "number",
14 "null",
15 "object",
16 "string"
17 ],
18 "description": "This property shall specify a valid odata or Redfish property."
19 }
20 },
21 "additionalProperties": true,
22 "properties": {
23 "MemorySet@odata.count": {
24 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/count"
25 },
26 "MemorySet@odata.navigationLink": {
27 "type": "string",
28 "format": "uri"
29 },
30 "MemorySet": {
31 "type": "array",
32 "items": {
33 "$ref": "http://redfish.dmtf.org/schemas/v1/Memory.json#/definitions/Memory"
34 },
35 "readonly": true,
36 "description": "This is the collection of memory for a particular interleave set.",
37 "longDescription": "The values in this collection shall be links to objects of type Memory."
38 }
39 },
40 "description": "This is the interleave sets for a memory chunk.",
41 "longDescription": "This type shall represent the interleave sets for a memory chunk."
42 },
43 "MemoryDomain": {
44 "type": "object",
45 "patternProperties": {
46 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
47 "type": [
48 "array",
49 "boolean",
50 "number",
51 "null",
52 "object",
53 "string"
54 ],
55 "description": "This property shall specify a valid odata or Redfish property."
56 }
57 },
58 "additionalProperties": false,
59 "properties": {
60 "@odata.context": {
61 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/context"
62 },
63 "@odata.id": {
64 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/id"
65 },
66 "@odata.type": {
67 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/type"
68 },
69 "Oem": {
70 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
71 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
72 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
73 },
74 "Id": {
75 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
76 "readonly": true
77 },
78 "Description": {
79 "anyOf": [
80 {"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"},
81 {"type": "null"}
82 ],
83 "readonly": true
84 },
85 "Name": {
86 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
87 "readonly": true
88 },
89 "AllowsMemoryChunkCreation": {
90 "type": [
91 "boolean",
92 "null"
93 ],
94 "readonly": true,
95 "description": "Indicates if this Memory Domain supports the creation of Memory Chunks.",
96 "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Memory Chunks."
97 },
98 "AllowsBlockProvisioning": {
99 "type": [
100 "boolean",
101 "null"
102 ],
103 "readonly": true,
104 "description": "Indicates if this Memory Domain supports the provisioning of blocks of memory.",
105 "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Blocks of memory."
106 },
107 "InterleavableMemorySets": {
108 "type": "array",
109 "items": {
110 "anyOf": [
111 {"$ref": "#/definitions/MemorySet"},
112 {"type": "null"}
113 ]
114 },
115 "description": "This is the interleave sets for the memory chunk.",
116 "longDescription": "These properties shall represent the interleave sets for the memory chunk."
117 },
118 "MemoryChunks": {
119 "anyOf": [
120 {"$ref": "http://redfish.dmtf.org/schemas/v1/MemoryChunksCollection.json#/definitions/MemoryChunksCollection"},
121 {"type": "null"}
122 ],
123 "readonly": true,
124 "description": "A reference to the collection of Memory Chunks associated with this Memory Domain.",
125 "longDescription": "The value of this property shall be a link to a collection of type MemoryChunkCollection."
126 },
127 "AllowsMirroring": {
128 "type": [
129 "boolean",
130 "null"
131 ],
132 "readonly": true,
133 "description": "Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled.",
134 "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Memory Chunks with mirroring enabled."
135 },
136 "AllowsSparing": {
137 "type": [
138 "boolean",
139 "null"
140 ],
141 "readonly": true,
142 "description": "Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled.",
143 "longDescription": "The value of this property shall indicate if this Memory Domain supports the creation of Memory Chunks with sparing enabled."
144 },
145 "Actions": {
146 "type": "object",
147 "patternProperties": {
148 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
149 "type": [
150 "array",
151 "boolean",
152 "number",
153 "null",
154 "object",
155 "string"
156 ],
157 "description": "This property shall specify a valid odata or Redfish property."
158 }
159 },
160 "additionalProperties": false,
161 "properties": {
162 "Oem": {
163 "type": "object",
164 "patternProperties": {
165 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
166 "type": [
167 "array",
168 "boolean",
169 "number",
170 "null",
171 "object",
172 "string"
173 ],
174 "description": "This property shall specify a valid odata or Redfish property."
175 }
176 },
177 "additionalProperties": true,
178 "properties": {},
179 "description": "The available OEM specific actions for this resource.",
180 "longDescription": "This type shall contain any additional OEM actions for this resource."
181 }
182 },
183 "description": "The available actions for this resource.",
184 "longDescription": "The Actions property shall contain the available actions for this resource."
185 }
186 },
187 "required": [
188 "Id",
189 "Name"
190 ],
191 "description": "This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.",
192 "longDescription": "This resource shall be used to represent Memory Domains in a Redfish implementation."
193 }
194 },
195 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright"
196}