summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/ManagerDiagnosticData/ManagerDiagnosticData.json
blob: d6132848e0b27a9b9623a423b8786d1d310e1031 (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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
{
    "$id": "http://redfish.dmtf.org/schemas/v1/ManagerDiagnosticData.v1_2_1.json",
    "$ref": "#/definitions/ManagerDiagnosticData",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2023 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": {
                "#ManagerDiagnosticData.ResetMetrics": {
                    "$ref": "#/definitions/ResetMetrics"
                },
                "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"
        },
        "BootTimeStatistics": {
            "additionalProperties": false,
            "description": "The boot time statistics of a manager.",
            "longDescription": "This object shall contain the boot time statistics of a manager.",
            "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": {
                "FirmwareTimeSeconds": {
                    "description": "The number of seconds the manager spent in the firmware stage.",
                    "longDescription": "This property shall contain the number of seconds the manager spent in the firmware stage.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "InitrdTimeSeconds": {
                    "description": "The number of seconds the manager spent in the initrd boot stage.",
                    "longDescription": "This property shall contain the number of seconds the manager spent in the initrd boot stage.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "KernelTimeSeconds": {
                    "description": "The number of seconds the manager spent in the kernel stage.",
                    "longDescription": "This property shall contain the number of seconds the manager spent in the kernel stage.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "LoaderTimeSeconds": {
                    "description": "The number of seconds the manager spent in the loader stage.",
                    "longDescription": "This property shall contain the number of seconds the manager spent in the loader stage.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "UserSpaceTimeSeconds": {
                    "description": "The number of seconds the manager spent in the user space boot stage.",
                    "longDescription": "This property shall contain the number of seconds the manager spent in the user space boot stage.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "I2CBusStatistics": {
            "additionalProperties": false,
            "description": "The statistics of an I2C bus.",
            "longDescription": "This object shall contain statistics of an I2C bus.",
            "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": {
                "BusErrorCount": {
                    "description": "The number of bus errors on this I2C bus.",
                    "longDescription": "This property shall contain the number of bus errors on this I2C bus.  Bus errors include, but are not limited to, an SDA rising or falling edge while SCL is high or a stuck bus signal.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "I2CBusName": {
                    "description": "The name of the I2C bus.",
                    "longDescription": "This property shall contain the name of the I2C bus.",
                    "readonly": true,
                    "type": "string"
                },
                "NACKCount": {
                    "description": "The number of NACKs on this I2C bus.",
                    "longDescription": "This property shall contain the number of NACKs on this I2C bus.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "TotalTransactionCount": {
                    "description": "The total number of transactions on this I2C bus.",
                    "longDescription": "This property shall contain the total number of transactions on this I2C bus.  The count shall include the number of I2C transactions initiated by the manager and the number of I2C transactions where the manager is the target device.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "ManagerDiagnosticData": {
            "additionalProperties": false,
            "description": "The ManagerDiagnosticData schema defines internal diagnostic data for a manager.  It contains information that might be used by vendors to collect debug information about the manager.  Clients should not make decisions for raising alerts, creating service events, or other actions based on information in this resource.",
            "longDescription": "This resource shall represent internal diagnostic data for a manager for a Redfish implementation.  Clients should not make decisions for raising alerts, creating service events, or other actions based on information in 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": {
                "@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": "The actions property shall contain the available actions for this resource."
                },
                "BootTimeStatistics": {
                    "$ref": "#/definitions/BootTimeStatistics",
                    "description": "The boot time statistics of the manager.",
                    "longDescription": "This property shall contain the boot time statistics of the manager."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "FreeStorageSpaceKiB": {
                    "description": "The available storage space on this manager in kibibytes (KiB).",
                    "longDescription": "This property shall contain the available storage space on this manager in kibibytes (KiB).",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "KiBy"
                },
                "I2CBuses": {
                    "description": "The statistics of the I2C buses.",
                    "items": {
                        "$ref": "#/definitions/I2CBusStatistics"
                    },
                    "longDescription": "This property shall contain the statistics of the I2C buses.  Services may subdivide a physical bus into multiple entries in this property based on how the manager tracks bus segments, virtual buses from a controller, and other segmentation capabilities.",
                    "type": "array"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "MemoryECCStatistics": {
                    "$ref": "#/definitions/MemoryECCStatistics",
                    "description": "The memory ECC statistics of the manager.",
                    "longDescription": "This property shall contain the memory ECC statistics of the manager."
                },
                "MemoryStatistics": {
                    "$ref": "#/definitions/MemoryStatistics",
                    "description": "The memory statistics of the manager.",
                    "longDescription": "This property shall contain the memory statistics of the manager."
                },
                "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."
                },
                "ProcessorStatistics": {
                    "$ref": "#/definitions/ProcessorStatistics",
                    "description": "The processor statistics of the manager.",
                    "longDescription": "This property shall contain the processor statistics of the manager."
                },
                "ServiceRootUptimeSeconds": {
                    "description": "The wall-clock time the service root hosted by this manager has been running in seconds.",
                    "longDescription": "This property shall contain the wall-clock time the service root hosted by this manager has been running in seconds.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "versionAdded": "v1_2_0"
                },
                "TopProcesses": {
                    "description": "The statistics of the top processes of this manager.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/ProcessStatistics"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the statistics of the top processes of this manager.",
                    "type": "array"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "MemoryECCStatistics": {
            "additionalProperties": false,
            "description": "The memory ECC statistics of a manager.",
            "longDescription": "This object shall contain the memory ECC statistics of a manager.",
            "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": {
                "CorrectableECCErrorCount": {
                    "description": "The number of the correctable errors since reset.",
                    "longDescription": "This property shall contain the number of correctable errors since reset.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "UncorrectableECCErrorCount": {
                    "description": "The number of the uncorrectable errors since reset.",
                    "longDescription": "This property shall contain the number of uncorrectable errors since reset.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "MemoryStatistics": {
            "additionalProperties": false,
            "description": "The memory statistics of a manager.",
            "longDescription": "This object shall contain the memory statistics of a manager.",
            "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": {
                "AvailableBytes": {
                    "description": "The amount of memory available in bytes for starting new processes without swapping.",
                    "longDescription": "This property shall contain the amount of memory available in bytes for starting new processes without swapping.  This includes free memory and reclaimable cache and buffers.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "BuffersAndCacheBytes": {
                    "description": "The amount of memory used in bytes by kernel buffers, page caches, and slabs.",
                    "longDescription": "This property shall contain the amount of memory used in bytes by kernel buffers, page caches, and slabs.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "FreeBytes": {
                    "description": "The amount of free memory in bytes.",
                    "longDescription": "This property shall contain the amount of free memory in bytes.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "SharedBytes": {
                    "description": "The amount of shared memory in bytes.",
                    "longDescription": "This property shall contain the amount of shared memory in bytes.  This includes things such as memory consumed by temporary file systems.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "TotalBytes": {
                    "description": "The total amount of memory in bytes.",
                    "longDescription": "This property shall contain the total amount of memory in bytes.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "UsedBytes": {
                    "description": "The amount of used memory in bytes.",
                    "longDescription": "This property shall contain the amount of used memory in bytes.  This value is calculated as TotalBytes minus FreeBytes minus BuffersAndCacheBytes.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                }
            },
            "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"
        },
        "ProcessStatistics": {
            "additionalProperties": false,
            "description": "The statistics of a process running on a manager.",
            "longDescription": "This object shall contain the statistics of a process running on a manager.",
            "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": {
                "CommandLine": {
                    "description": "The command line of this process.",
                    "longDescription": "This property shall contain the command line with parameters of this process.",
                    "readonly": true,
                    "type": "string"
                },
                "KernelTimeSeconds": {
                    "description": "The number of seconds this process executed in kernel space.",
                    "longDescription": "This property shall contain the number of seconds this process executed in kernel space.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "ResidentSetSizeBytes": {
                    "description": "The resident set size of this process in bytes.",
                    "longDescription": "This property shall contain the resident set size of this process in bytes, which is the amount of memory allocated to the process and is in RAM.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "RestartAfterFailureCount": {
                    "description": "The number of times this process has restarted unexpectedly.",
                    "longDescription": "This property shall contain the number of times this process has restarted unexpectedly, such as due to unintentional failures, restarts, or shutdowns, with the same command line including arguments.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "RestartCount": {
                    "description": "The number of times this process has restarted.",
                    "longDescription": "This property shall contain the number of times this process has restarted with the same command line including arguments.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "UptimeSeconds": {
                    "description": "The wall-clock time this process has been running in seconds.",
                    "longDescription": "This property shall contain the wall-clock time this process has been running in seconds.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "UserTimeSeconds": {
                    "description": "The number of seconds this process executed in user space.",
                    "longDescription": "This property shall contain the number of seconds this process executed in user space.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "ProcessorStatistics": {
            "additionalProperties": false,
            "description": "The processor statistics of a manager.",
            "longDescription": "This object shall contain the processor statistics of a manager.",
            "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": {
                "KernelPercent": {
                    "description": "The percentage of CPU time spent in kernel mode.",
                    "longDescription": "This property shall contain the percentage of CPU time, `0` to `100`, spent in kernel mode.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                },
                "UserPercent": {
                    "description": "The percentage of CPU time spent in user mode.",
                    "longDescription": "This property shall contain the percentage of CPU time, `0` to `100`, spent in user mode.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "type": "object"
        },
        "ResetMetrics": {
            "additionalProperties": false,
            "description": "Resets time intervals or counted values of the diagnostic data for this manager.",
            "longDescription": "This action shall reset any time intervals or counted values of the diagnostic data for this manager.",
            "parameters": {},
            "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": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "release": "2022.3",
    "title": "#ManagerDiagnosticData.v1_2_1.ManagerDiagnosticData"
}