summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json
blob: b0fcfbda344c9c32305c9acc49779bf932e76bce (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
{
    "$id": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.v1_2_0.json",
    "$ref": "#/definitions/MemoryMetrics",
    "$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": {
                "#MemoryMetrics.ClearCurrentPeriod": {
                    "$ref": "#/definitions/ClearCurrentPeriod"
                },
                "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"
        },
        "AlarmTrips": {
            "additionalProperties": false,
            "description": "The alarm trip information about the memory.  These alarms are reset when the system resets.  Note that if they are re-discovered they can be reasserted.",
            "longDescription": "This type shall contain properties that describe the types of alarms that have been raised by the memory.  These alarms shall be reset when the system resets.  Note that if they are re-discovered they can be reasserted.",
            "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": {
                "AddressParityError": {
                    "description": "An indication of whether an address parity error was detected that a retry could not correct.",
                    "longDescription": "This property shall indicate whether an address parity error was detected that a retry could not correct.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "CorrectableECCError": {
                    "description": "An indication of whether the correctable error threshold crossing alarm trip was detected.",
                    "longDescription": "This property shall indicate whether the correctable error threshold crossing alarm trip was detected.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SpareBlock": {
                    "description": "An indication of whether the spare block capacity crossing alarm trip was detected.",
                    "longDescription": "This property shall indicate whether the spare block capacity crossing alarm trip was detected.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "Temperature": {
                    "description": "An indication of whether a temperature threshold alarm trip was detected.",
                    "longDescription": "This property shall indicates whether a temperature threshold alarm trip was detected.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "UncorrectableECCError": {
                    "description": "An indication of whether the uncorrectable error threshold alarm trip was detected.",
                    "longDescription": "This property shall indicate whether the uncorrectable error threshold alarm trip was detected.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "ClearCurrentPeriod": {
            "additionalProperties": false,
            "description": "This action sets the CurrentPeriod property's values to 0.",
            "longDescription": "This action shall set the CurrentPeriod property's values to 0.",
            "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"
        },
        "CurrentPeriod": {
            "additionalProperties": false,
            "description": "The memory metrics since the last system reset or ClearCurrentPeriod action.",
            "longDescription": "This type shall describe the memory metrics since last system reset or ClearCurrentPeriod action.",
            "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": {
                "BlocksRead": {
                    "description": "The number of blocks read since reset.",
                    "longDescription": "This property shall contain the number of blocks read since reset.  When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "BlocksWritten": {
                    "description": "The number of blocks written since reset.",
                    "longDescription": "This property shall contain the number of blocks written since reset.  When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "HealthData": {
            "additionalProperties": false,
            "description": "The health information of the memory.",
            "longDescription": "This type shall contain properties that describe the HealthData metrics 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": {
                "AlarmTrips": {
                    "$ref": "#/definitions/AlarmTrips",
                    "description": "Alarm trip information about the memory.",
                    "longDescription": "This object shall contain properties describe the types of alarms that have been raised by the memory.  When this Resource is subordinate to the MemorySummary object, this property shall indicate whether an alarm of a given type have been raised by any area of memory."
                },
                "DataLossDetected": {
                    "description": "An indication of whether data loss was detected.",
                    "longDescription": "This property shall indicate whether data loss was detected.  When this Resource is subordinate to the MemorySummary object, this property shall indicate whether any data loss was detected in any area of memory.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "LastShutdownSuccess": {
                    "description": "An indication of whether the last shutdown succeeded.",
                    "longDescription": "This property shall indicate whether the last shutdown succeeded.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "PerformanceDegraded": {
                    "description": "An indication of whether performance has degraded.",
                    "longDescription": "This property shall indicate whether performance has degraded.  When this Resource is subordinate to the MemorySummary object, this property shall indicate whether degraded performance mode status is detected in any area of memory.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "PredictedMediaLifeLeftPercent": {
                    "description": "The percentage of reads and writes that are predicted to still be available for the media.",
                    "longDescription": "This property shall contain an indicator of the percentage of life remaining in the media.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%",
                    "versionAdded": "v1_1_0"
                },
                "RemainingSpareBlockPercentage": {
                    "description": "The remaining spare blocks, as a percentage.",
                    "longDescription": "This property shall contain the remaining spare blocks as a percentage.  When this Resource is subordinate to the MemorySummary object, this property shall be the RemainingSpareBlockPercentage over all memory.",
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "type": "object"
        },
        "LifeTime": {
            "additionalProperties": false,
            "description": "The memory metrics for the lifetime of the memory.",
            "longDescription": "This type shall describe the memory metrics since manufacturing.",
            "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": {
                "BlocksRead": {
                    "description": "The number of blocks read for the lifetime of the memory.",
                    "longDescription": "This property shall contain the number of blocks read for the lifetime of the Memory.  When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "BlocksWritten": {
                    "description": "The number of blocks written for the lifetime of the memory.",
                    "longDescription": "This property shall contain the number of blocks written for the lifetime of the Memory.  When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "MemoryMetrics": {
            "additionalProperties": false,
            "description": "The usage and health statistics for a memory device or system memory summary.",
            "longDescription": "The MemoryMetrics Schema shall contain the memory metrics for a memory device or system memory summary 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."
                },
                "BandwidthPercent": {
                    "description": "The memory bandwidth utilization as a percentage.",
                    "longDescription": "This property shall contain memory bandwidth utilization as a percentage.  When this Resource is subordinate to the MemorySummary object, this property shall be the memory bandwidth utilization over all memory as a percentage.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%",
                    "versionAdded": "v1_2_0"
                },
                "BlockSizeBytes": {
                    "description": "The block size, in bytes.",
                    "longDescription": "This property shall contain the block size, in bytes, of all stucture elements.  When this Resource is subordinate to the MemorySummary object, this property is not applicable.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "CurrentPeriod": {
                    "$ref": "#/definitions/CurrentPeriod",
                    "description": "The memory metrics since the last reset or ClearCurrentPeriod action.",
                    "longDescription": "This property shall contain properties that describe the memory metrics for the current period."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "HealthData": {
                    "$ref": "#/definitions/HealthData",
                    "description": "The health information of the memory.",
                    "longDescription": "This property shall contain properties that describe the health data memory metrics for the memory.  When this Resource is subordinate to the MemorySummary object, this property is not applicable."
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "LifeTime": {
                    "$ref": "#/definitions/LifeTime",
                    "description": "The memory metrics for the lifetime of the memory.",
                    "longDescription": "This property shall contain properties that describe the memory metrics for the lifetime of the memory."
                },
                "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."
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "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"
        }
    },
    "owningEntity": "DMTF",
    "release": "2019.2",
    "title": "#MemoryMetrics.v1_2_0.MemoryMetrics"
}