Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / bdd1c8360a29d18178297e580bbde4af9e2e60a5 / . / static / redfish / v1 / JsonSchemas / Processor / index.json
blob: 64c3bc826da84441e306a29450b93439a1c2a27a [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame]1{
2 "$ref": "#/definitions/Processor",
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 "InstructionSet": {
31 "enum": [
32 "x86",
33 "x86-64",
34 "IA-64",
35 "ARM-A32",
36 "ARM-A64",
37 "MIPS32",
38 "MIPS64",
39 "OEM"
40 ],
41 "enumDescriptions": {
42 "ARM-A32": "ARM 32-bit.",
43 "ARM-A64": "ARM 64-bit.",
44 "IA-64": "Intel IA-64.",
45 "MIPS32": "MIPS 32-bit.",
46 "MIPS64": "MIPS 64-bit.",
47 "OEM": "OEM-defined.",
48 "x86": "x86 32-bit.",
49 "x86-64": "x86 64-bit."
50 },
51 "type": "string"
52 },
53 "Links": {
54 "additionalProperties": false,
55 "description": "Contains references to other resources that are related to this resource.",
56 "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.",
57 "patternProperties": {
58 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
59 "description": "This property shall specify a valid odata or Redfish property.",
60 "type": [
61 "array",
62 "boolean",
63 "number",
64 "null",
65 "object",
66 "string"
67 ]
68 }
69 },
70 "properties": {
71 "Chassis": {
72 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis",
73 "description": "A reference to the Chassis which contains this Processor.",
74 "longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Processor.",
75 "readonly": true
76 },
77 "Oem": {
78 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
79 "description": "Oem extension object.",
80 "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
81 }
82 },
83 "type": "object"
84 },
85 "OemActions": {
86 "additionalProperties": true,
87 "description": "The available OEM specific actions for this resource.",
88 "longDescription": "This type shall contain any additional OEM actions for this resource.",
89 "patternProperties": {
90 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
91 "description": "This property shall specify a valid odata or Redfish property.",
92 "type": [
93 "array",
94 "boolean",
95 "number",
96 "null",
97 "object",
98 "string"
99 ]
100 }
101 },
102 "properties": {},
103 "type": "object"
104 },
105 "Processor": {
106 "additionalProperties": false,
107 "description": "This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.",
108 "patternProperties": {
109 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
110 "description": "This property shall specify a valid odata or Redfish property.",
111 "type": [
112 "array",
113 "boolean",
114 "number",
115 "null",
116 "object",
117 "string"
118 ]
119 }
120 },
121 "properties": {
122 "@odata.context": {
123 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/context"
124 },
125 "@odata.etag": {
126 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/etag"
127 },
128 "@odata.id": {
129 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/id"
130 },
131 "@odata.type": {
132 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_2.json#/definitions/type"
133 },
134 "Actions": {
135 "$ref": "#/definitions/Actions",
136 "description": "The available actions for this resource.",
137 "longDescription": "The Actions property shall contain the available actions for this resource."
138 },
139 "Assembly": {
140 "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
141 "description": "A reference to the Assembly resource associated with this processor.",
142 "longDescription": "The value of this property shall be a link to a resource of type Assembly.",
143 "readonly": true
144 },
145 "Description": {
146 "anyOf": [
147 {
148 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
149 },
150 {
151 "type": "null"
152 }
153 ],
154 "readonly": true
155 },
156 "Id": {
157 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
158 "readonly": true
159 },
160 "InstructionSet": {
161 "anyOf": [
162 {
163 "$ref": "#/definitions/InstructionSet"
164 },
165 {
166 "type": "null"
167 }
168 ],
169 "description": "The instruction set of the processor.",
170 "longDescription": "This property shall contain the string which identifies the instruction set of the processor contained in this socket.",
171 "readonly": true
172 },
173 "Links": {
174 "$ref": "#/definitions/Links",
175 "description": "Contains references to other resources that are related to this resource.",
176 "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."
177 },
178 "Location": {
179 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location"
180 },
181 "Manufacturer": {
182 "description": "The processor manufacturer.",
183 "longDescription": "This property shall contain a string which identifies the manufacturer of the processor.",
184 "readonly": true,
185 "type": [
186 "string",
187 "null"
188 ]
189 },
190 "MaxSpeedMHz": {
191 "description": "The maximum clock speed of the processor.",
192 "longDescription": "This property shall indicate the maximum rated clock speed of the processor in MHz.",
193 "readonly": true,
194 "type": [
195 "number",
196 "null"
197 ]
198 },
199 "Model": {
200 "description": "The product model number of this device.",
201 "longDescription": "This property shall indicate the model information as provided by the manufacturer of this processor.",
202 "readonly": true,
203 "type": [
204 "string",
205 "null"
206 ]
207 },
208 "Name": {
209 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
210 "readonly": true
211 },
212 "Oem": {
213 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
214 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
215 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
216 },
217 "ProcessorArchitecture": {
218 "anyOf": [
219 {
220 "$ref": "#/definitions/ProcessorArchitecture"
221 },
222 {
223 "type": "null"
224 }
225 ],
226 "description": "The architecture of the processor.",
227 "longDescription": "This property shall contain the string which identifies the architecture of the processor contained in this Socket.",
228 "readonly": true
229 },
230 "ProcessorId": {
231 "$ref": "#/definitions/ProcessorId",
232 "description": "Identification information for this processor.",
233 "longDescription": "This object shall contain identification information for this processor."
234 },
235 "ProcessorType": {
236 "anyOf": [
237 {
238 "$ref": "#/definitions/ProcessorType"
239 },
240 {
241 "type": "null"
242 }
243 ],
244 "description": "The type of processor.",
245 "longDescription": "This property shall contain the string which identifies the type of processor contained in this Socket.",
246 "readonly": true
247 },
248 "Socket": {
249 "description": "The socket or location of the processor.",
250 "longDescription": "This property shall contain the string which identifies the physical location or socket of the processor.",
251 "readonly": true,
252 "type": [
253 "string",
254 "null"
255 ]
256 },
257 "Status": {
258 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
259 },
260 "SubProcessors": {
261 "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorCollection.json#/definitions/ProcessorCollection",
262 "description": "A reference to the collection of Sub-Processors associated with this system, such as cores or threads that are part of a processor.",
263 "longDescription": "The value of this property shall be a link to a collection of type ProcessorCollection.",
264 "readonly": true
265 },
266 "TotalCores": {
267 "description": "The total number of cores contained in this processor.",
268 "longDescription": "This property shall indicate the total count of independent processor cores contained within this processor.",
269 "readonly": true,
270 "type": [
271 "number",
272 "null"
273 ]
274 },
275 "TotalThreads": {
276 "description": "The total number of execution threads supported by this processor.",
277 "longDescription": "This property shall indicate the total count of independent execution threads supported by this processor.",
278 "readonly": true,
279 "type": [
280 "number",
281 "null"
282 ]
283 }
284 },
285 "required": [
286 "Id",
287 "Name"
288 ],
289 "type": "object"
290 },
291 "ProcessorArchitecture": {
292 "enum": [
293 "x86",
294 "IA-64",
295 "ARM",
296 "MIPS",
297 "OEM"
298 ],
299 "enumDescriptions": {
300 "ARM": "ARM.",
301 "IA-64": "Intel Itanium.",
302 "MIPS": "MIPS.",
303 "OEM": "OEM-defined.",
304 "x86": "x86 or x86-64."
305 },
306 "type": "string"
307 },
308 "ProcessorId": {
309 "additionalProperties": false,
310 "description": "This type describes the Identification information for a processor.",
311 "longDescription": "This type shall contain identification information for a processor.",
312 "patternProperties": {
313 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
314 "description": "This property shall specify a valid odata or Redfish property.",
315 "type": [
316 "array",
317 "boolean",
318 "number",
319 "null",
320 "object",
321 "string"
322 ]
323 }
324 },
325 "properties": {
326 "EffectiveFamily": {
327 "description": "The effective Family for this processor.",
328 "longDescription": "This property shall indicate the effective Family information as provided by the manufacturer of this processor.",
329 "readonly": true,
330 "type": [
331 "string",
332 "null"
333 ]
334 },
335 "EffectiveModel": {
336 "description": "The effective Model for this processor.",
337 "longDescription": "This property shall indicate the effective Model information as provided by the manufacturer of this processor.",
338 "readonly": true,
339 "type": [
340 "string",
341 "null"
342 ]
343 },
344 "IdentificationRegisters": {
345 "description": "The contents of the Identification Registers (CPUID) for this processor.",
346 "longDescription": "This property shall include the raw CPUID instruction output as provided by the manufacturer of this processor.",
347 "readonly": true,
348 "type": [
349 "string",
350 "null"
351 ]
352 },
353 "MicrocodeInfo": {
354 "description": "The Microcode Information for this processor.",
355 "longDescription": "This property shall indicate the Microcode Information as provided by the manufacturer of this processor.",
356 "readonly": true,
357 "type": [
358 "string",
359 "null"
360 ]
361 },
362 "Step": {
363 "description": "The Step value for this processor.",
364 "longDescription": "This property shall indicate the Step or revision string information as provided by the manufacturer of this processor.",
365 "readonly": true,
366 "type": [
367 "string",
368 "null"
369 ]
370 },
371 "VendorId": {
372 "description": "The Vendor Identification for this processor.",
373 "longDescription": "This property shall indicate the Vendor Identification string information as provided by the manufacturer of this processor.",
374 "readonly": true,
375 "type": [
376 "string",
377 "null"
378 ]
379 }
380 },
381 "type": "object"
382 },
383 "ProcessorType": {
384 "enum": [
385 "CPU",
386 "GPU",
387 "FPGA",
388 "DSP",
389 "Accelerator",
390 "Core",
391 "Thread",
392 "OEM"
393 ],
394 "enumDescriptions": {
395 "Accelerator": "An Accelerator.",
396 "CPU": "A Central Processing Unit.",
397 "Core": "A Core in a Processor.",
398 "DSP": "A Digital Signal Processor.",
399 "FPGA": "A Field Programmable Gate Array.",
400 "GPU": "A Graphics Processing Unit.",
401 "OEM": "An OEM-defined Processing Unit.",
402 "Thread": "A Thread in a Processor."
403 },
404 "type": "string"
405 }
406 },
407 "owningEntity": "DMTF",
408 "title": "#Processor.v1_3_0.Processor"
409}