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
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.v1_0_3.json",
"$ref": "#/definitions/MetricDefinition",
"$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"
},
"Calculable": {
"description": "The types of calculations that can be applied to the metric reading. Provides information to the client on the suitability of calculation using the metric reading.",
"enum": [
"NonCalculatable",
"Summable",
"NonSummable"
],
"enumDescriptions": {
"NonCalculatable": "No calculations should be performed on the metric reading.",
"NonSummable": "The sum of the metric reading across multiple instances is not meaningful.",
"Summable": "The sum of the metric reading across multiple instances is meaningful."
},
"longDescription": "The type shall describe the types of calculations that can be applied to the metric reading.",
"type": "string"
},
"CalculationAlgorithmEnum": {
"enum": [
"Average",
"Maximum",
"Minimum"
],
"enumDescriptions": {
"Average": "The metric is calculated as the average metric reading over a sliding time interval.",
"Maximum": "The metric is calculated as the maximum metric reading over during a time interval.",
"Minimum": "The metric is calculated as the minimum metric reading over a sliding time interval."
},
"enumLongDescriptions": {
"Average": "The metric shall be calculated as the average metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value.",
"Maximum": "The metric shall be calculated as the maximum metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value.",
"Minimum": "The metric shall be calculated as the minimum metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value."
},
"type": "string"
},
"CalculationParamsType": {
"additionalProperties": false,
"description": "The usage of the parameter in the calculation.",
"longDescription": "The list element shall contain the usage of the parameter in the calculation. This property is present when the MetricType property is `Synthesized`.",
"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": {
"ResultMetric": {
"description": "The link to a metric property that stores the result of the calculation.",
"longDescription": "This property shall contain a link to a metric property that stores the result of the calcuation.",
"readonly": true,
"type": [
"string",
"null"
]
},
"SourceMetric": {
"description": "The metric property used as the input into the calculation.",
"longDescription": "This property shall contain a link to a metric property used in a calcuation.",
"readonly": true,
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"ImplementationType": {
"enum": [
"PhysicalSensor",
"Calculated",
"Synthesized",
"DigitalMeter"
],
"enumDescriptions": {
"Calculated": "The metric is implemented by applying a calculation on another metric property. The calculation is specified in the CalculationAlgorithm property.",
"DigitalMeter": "The metric is implemented as digital meter.",
"PhysicalSensor": "The metric is implemented as a physical sensor.",
"Synthesized": "The metric is implemented by applying a calculation on one or more metric properties. The calculation is not provided."
},
"type": "string"
},
"MetricDataType": {
"description": "The data type of the related metric values. Provides information to the client on the nature of the metric reading.",
"enum": [
"Boolean",
"DateTime",
"Decimal",
"Integer",
"String",
"Enumeration"
],
"enumDescriptions": {
"Boolean": "The JSON boolean definition.",
"DateTime": "The JSON string definition with the 'date-time' format.",
"Decimal": "The JSON decimal definition.",
"Enumeration": "The JSON string definition with a set of defined enumerations.",
"Integer": "The JSON integer definition.",
"String": "The JSON string definition."
},
"longDescription": "This type shall describe the data type of the related metric values as defined by JSON data types.",
"type": "string"
},
"MetricDefinition": {
"additionalProperties": false,
"description": "The MetricDefinition schema describes the metadata information for a metric.",
"longDescription": "This Resource shall contain the metadata information for a metric.",
"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"
},
"Accuracy": {
"description": "The estimated percent error of measured versus actual values.",
"longDescription": "This property shall contain the percent error +/- of the measured versus actual values. The property is not meaningful when the MetricType property is `Discrete`.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this Resource.",
"longDescription": "This property shall contain the available actions for this Resource."
},
"Calculable": {
"anyOf": [
{
"$ref": "#/definitions/Calculable"
},
{
"type": "null"
}
],
"description": "An indication of whether the metric can be used in a calculation.",
"longDescription": "This property shall specify whether the metric can be used in a calculation.",
"readonly": false
},
"CalculationAlgorithm": {
"anyOf": [
{
"$ref": "#/definitions/CalculationAlgorithmEnum"
},
{
"type": "null"
}
],
"description": "The calculation that is performed on a source metric to obtain the metric being defined.",
"longDescription": "This property shall contain the calculation performed to obtain the metric.",
"readonly": true
},
"CalculationParameters": {
"description": "The metric properties that are part of the synthesis calculation. This property is present when the MetricType property is `Synthesized`.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/CalculationParamsType"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall list the metric properties that are part of the synthesis calculation. When MetricType=Synthesis, this property may be present.",
"type": "array"
},
"CalculationTimeInterval": {
"description": "The time interval over which the metric calculation is performed.",
"longDescription": "This property shall specify the time interval over the metric calculation is performed. The format of the value shall conform to the Duration format.",
"pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
"readonly": false,
"type": [
"string",
"null"
]
},
"Calibration": {
"description": "The calibration offset added to the metric reading.",
"longDescription": "This property shall contain the calibration offset added to the metric reading. The value shall have the units specified in the Units property. The property is not meaningful when the MetricType property is `Discrete`.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"DiscreteValues": {
"description": "This array property specifies possible values of a discrete metric.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "The values of the property shall specify the possible values of the discrete metic. This property shall have values when the MetricType property has the value 'Discrete'.",
"readonly": false,
"type": "array"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Implementation": {
"anyOf": [
{
"$ref": "#/definitions/ImplementationType"
},
{
"type": "null"
}
],
"description": "The implementation of the metric.",
"longDescription": "This property shall specify the implementation of the metric.",
"readonly": true
},
"IsLinear": {
"description": "An indication of whether the metric values are linear versus non-linear.",
"longDescription": "This property shall indicate whether the metric values are linear versus non-linear. Linear metrics may use a greater than relation to compared them. An example of linear metrics include performance metrics. Examples of non-linear metrics include error codes.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"MaxReadingRange": {
"description": "Maximum value for metric reading.",
"longDescription": "The value shall indicate the highest possible value for a related MetricValue. The value shall have the units specified in the property Units. The property is not meaningful, when the MetricType property has the value 'Discrete'.",
"readonly": true,
"type": [
"number",
"null"
]
},
"MetricDataType": {
"anyOf": [
{
"$ref": "#/definitions/MetricDataType"
},
{
"type": "null"
}
],
"description": "The data type of the metric.",
"longDescription": "This property shall specify the data-type of the metric.",
"readonly": false
},
"MetricProperties": {
"description": "The list of URIs with wildcards and property identifiers that this metric definition defines. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.",
"format": "uri-reference",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This array property shall list the URIs with wildcards and property identifiers that this metric defines. A set of curly braces shall delimit each wildcard in the URI. The corresponding entry in the Wildcard property shall replace each wildcard. After a URI with wildcards replaces its wildcards, it shall identify a Resource property to which the metric definition applies. The property identifiers portion of the URI shall follow RFC6901-defined JSON fragment notation rules.",
"readonly": false,
"type": "array"
},
"MetricType": {
"anyOf": [
{
"$ref": "#/definitions/MetricType"
},
{
"type": "null"
}
],
"description": "The type of metric.",
"longDescription": "This property shall specify the type of metric.",
"readonly": false
},
"MinReadingRange": {
"description": "Minimum value for metric reading.",
"longDescription": "This property shall contain the lowest possible value for the metric reading. The value shall have the units specified in the property Units. The property is not meaningful, when the MetricType property has the value 'Discrete'.",
"readonly": true,
"type": [
"number",
"null"
]
},
"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."
},
"PhysicalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext"
},
{
"type": "null"
}
],
"description": "The physical context of the metric.",
"longDescription": "This property shall contain the physical context of the metric.",
"readonly": true
},
"Precision": {
"description": "Number of significant digits in the metric reading.",
"longDescription": "This property shall specify the number of significant digits in the metric reading. The property is not meaningful, when the MetricType property has the value 'Discrete'.",
"readonly": true,
"type": [
"integer",
"null"
]
},
"SensingInterval": {
"description": "The time interval between when a metric is updated.",
"longDescription": "This property shall specify the time interval between when a metric is updated. The format of the value shall conform to the Duration format.",
"pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
"readonly": false,
"type": [
"string",
"null"
]
},
"TimestampAccuracy": {
"description": "The accuracy of the timestamp.",
"longDescription": "This property shall specify the expected + or - variability of the timestamp. The format of the value shall conform to the Duration format.",
"pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
"readonly": true,
"type": [
"string",
"null"
]
},
"Units": {
"description": "The units of measure for this metric.",
"longDescription": "This property shall specify the units of the metric. This property shall be consistent with the case-sensitive ('C/s' column) Unified Code for Units of Measure. Note: Not all units of measured are covered by UCUM.",
"readonly": false,
"type": [
"string",
"null"
]
},
"Wildcards": {
"description": "The wildcards and their substitution values for the entries in the MetricProperties array property.",
"items": {
"$ref": "#/definitions/Wildcard"
},
"longDescription": "The property shall contain a list of wildcards and their replacement strings, which are applied to the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property.",
"type": "array"
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"MetricType": {
"description": "The type of metric. Provides information to the client on how the metric can be handled.",
"enum": [
"Numeric",
"Discrete",
"Gauge",
"Counter",
"Countdown"
],
"enumDescriptions": {
"Countdown": "The metric is a countdown metric. The metric reading is a non-negative integer that decreases monotonically. When a counter reaches its minimum, the value resets to preset value and resumes counting down.",
"Counter": "The metric is a counter metric. The metric reading is a non-negative integer that increases monotonically. When a counter reaches its maximum, the value resets to 0 and resumes counting.",
"Discrete": "The metric is a discrete metric. The metric value is discrete. The possible values are listed in the DiscreteValues property.",
"Gauge": "The metric is a gauge metric. The metric value is a real number. When the metric value reaches the gauges extrema, it stays at that value, until the reading falls within the extrema.",
"Numeric": "The metric is a numeric metric. The metric value is any real number."
},
"enumLongDescriptions": {
"Discrete": "The metric values shall indicate discrete states."
},
"longDescription": "This property shall contain the type of metric.",
"type": "string"
},
"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"
},
"Wildcard": {
"additionalProperties": false,
"description": "The wildcard and its substitution values.",
"longDescription": "This property shall contain a wildcard and its substitution values.",
"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": {
"Name": {
"description": "The string used as a wildcard.",
"longDescription": "This property shall contain the string used as a wildcard.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Values": {
"description": "An array of values to substitute for the wildcard.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain the list of values to substitute for the wildcard.",
"readonly": true,
"type": "array"
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2018.2",
"title": "#MetricDefinition.v1_0_3.MetricDefinition"
}
|
