summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/ProcessorMetrics/ProcessorMetrics.json
blob: 1b9a37fded894a879afa6d6542d79bd6eb169e15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
{
    "$id": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.v1_0_2.json",
    "$ref": "#/definitions/ProcessorMetrics",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2019 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": {
                "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"
        },
        "CStateResidency": {
            "additionalProperties": false,
            "description": "The C-state residency of the processor.",
            "longDescription": "This type shall contain properties that describe the C-state residency of the processor or core.",
            "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": {
                "Level": {
                    "description": "The C-state level, such as C0, C1, or C2.",
                    "longDescription": "This property shall contain the C-state level, such as C0, C1, or C2.  When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "ResidencyPercent": {
                    "description": "The percentage of time that the processor or core has spent in this particular level of C-state.",
                    "longDescription": "This property shall contain the percentage of time that the processor or core has spent in this particular level of C-state.  When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "type": "object"
        },
        "CacheMetrics": {
            "additionalProperties": false,
            "description": "The processor core metrics.",
            "longDescription": "This type shall contain properties that describe cache metrics of a processor or core.",
            "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": {
                "CacheMiss": {
                    "description": "The number of cache line misses in millions.",
                    "longDescription": "This property shall contain the number of cache line misses of the processor or core in millions.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "CacheMissesPerInstruction": {
                    "description": "The number of cache misses per instruction.",
                    "longDescription": "This property shall contain the number of cache misses per instruction of the processor or core.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "HitRatio": {
                    "description": "The cache line hit ratio.",
                    "longDescription": "This property shall contain the cache hit ratio of the processor or core.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "Level": {
                    "description": "The cache level.",
                    "longDescription": "This property shall contain the level of the cache in the processor or core.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "OccupancyBytes": {
                    "description": "The total cache level occupancy in bytes.",
                    "longDescription": "This property shall contain the total cache occupancy of the processor or core in bytes.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "OccupancyPercent": {
                    "description": "The total cache occupancy percentage.",
                    "longDescription": "This property shall contain the total cache occupancy percentage of the processor or core.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "type": "object"
        },
        "CoreMetrics": {
            "additionalProperties": false,
            "description": "The processor core metrics.",
            "longDescription": "This type shall contain properties that describe the cores of a processor.",
            "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": {
                "CStateResidency": {
                    "description": "The C-state residency of this core in the processor.",
                    "items": {
                        "$ref": "#/definitions/CStateResidency"
                    },
                    "longDescription": "This property shall contain properties that describe the C-state residency of this core in the processor.",
                    "type": "array"
                },
                "CoreCache": {
                    "description": "The cache metrics of this core in the processor.",
                    "items": {
                        "$ref": "#/definitions/CacheMetrics"
                    },
                    "longDescription": "This property shall contain properties that describe the cache metrics of this core in the processor.",
                    "type": "array"
                },
                "CoreId": {
                    "description": "The processor core identifier.",
                    "longDescription": "This property shall contain the identifier of the core within the processor.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "IOStallCount": {
                    "description": "The number of stalled cycles due to I/O operations.",
                    "longDescription": "This property shall contain the number of stalled cycles due to I/O operations of this core in the processor.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "InstructionsPerCycle": {
                    "description": "The number of instructions per clock cycle of this core.",
                    "longDescription": "This property shall contain the number of instructions per clock cycle of this core in the processor.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "MemoryStallCount": {
                    "description": "The number of stalled cycles due to memory operations.",
                    "longDescription": "This property shall contain the number of stalled cycles due to memory operations of this core in the processor.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "UnhaltedCycles": {
                    "description": "The unhalted cycles count of this core.",
                    "longDescription": "This property shall contain the number of unhalted cycles of this core in the processor.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "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"
        },
        "ProcessorMetrics": {
            "additionalProperties": false,
            "description": "The ProcessorMetrics schema contains usage and health statistics for a processor.",
            "longDescription": "This Resource contains the Processor Metrics for a single Processor 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."
                },
                "AverageFrequencyMHz": {
                    "description": "The average frequency of the processor.",
                    "longDescription": "This property shall contain average frequency in MHz, across all enabled cores in the processor.  When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "MHz"
                },
                "BandwidthPercent": {
                    "description": "The CPU bandwidth as a percentage.",
                    "longDescription": "This property shall contain CPU utilization of the processor as a percentage.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the CPU utilization over all processors as a percentage.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                },
                "Cache": {
                    "description": "The processor cache metrics.",
                    "items": {
                        "$ref": "#/definitions/CacheMetrics"
                    },
                    "longDescription": "This property shall contain properties that describe this processor's cache.  When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.",
                    "type": "array"
                },
                "ConsumedPowerWatt": {
                    "description": "The power, in watts, that the processor has consumed.",
                    "longDescription": "This property shall contain the power, in watts, that the processor has consumed.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the sum of power, in watts, that all processors have consumed.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "W"
                },
                "CoreMetrics": {
                    "description": "The processor core metrics.",
                    "items": {
                        "$ref": "#/definitions/CoreMetrics"
                    },
                    "longDescription": "This property shall contain properties that describe the cores of this processor.  When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.",
                    "type": "array"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "FrequencyRatio": {
                    "description": "The frequency relative to the nominal processor frequency ratio.",
                    "longDescription": "This property shall contain the frequency relative to the nominal processor frequency ratio of this processor.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the average FrequencyRatio over all processors.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "KernelPercent": {
                    "description": "The percentage of time spent in kernel mode.",
                    "longDescription": "This property shall contain total percentage of time the processor has spent in kernel mode.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the average KernelPercent over all processors.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                },
                "LocalMemoryBandwidthBytes": {
                    "description": "The local memory bandwidth usage in bytes.",
                    "longDescription": "This property shall contain the local memory bandwidth usage of this processor in bytes.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the sum of LocalMemoryBandwidthBytes over all processors.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "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."
                },
                "RemoteMemoryBandwidthBytes": {
                    "description": "The remote memory bandwidth usage in bytes.",
                    "longDescription": "This property shall contain the remote memory bandwidth usage of this processor in bytes.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the sum of RemoteMemoryBandwidthBytes over all processors.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "TemperatureCelsius": {
                    "description": "The temperature of the processor.",
                    "longDescription": "This property shall contain the temperature, in Celsius, of the processor.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the average temperature, in Celcius, over all processors.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "Cel"
                },
                "ThrottlingCelsius": {
                    "description": "The CPU margin to throttle (temperature offset in degree Celsius).",
                    "longDescription": "This property shall contain the CPU margin to throttle based on an offset between the maximum temperature in which the processor can operate, and the processor's current temperature.  When this Resource is subordinate to the ProcessorSummary object, this property is not applicable.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "Cel"
                },
                "UserPercent": {
                    "description": "The percentage of time spent in user mode.",
                    "longDescription": "This property shall contain total percentage of time the processor has spent in user mode.  When this Resource is subordinate to the ProcessorSummary object, this property shall be the average UserPercent over all processors.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "release": "2018.3",
    "title": "#ProcessorMetrics.v1_0_2.ProcessorMetrics"
}