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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_4_1.json",
"$ref": "#/definitions/TelemetryService",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2025 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": {
"#TelemetryService.ClearMetricReports": {
"$ref": "#/definitions/ClearMetricReports"
},
"#TelemetryService.ClearTelemetryData": {
"$ref": "#/definitions/ClearTelemetryData"
},
"#TelemetryService.CollectTelemetryData": {
"$ref": "#/definitions/CollectTelemetryData"
},
"#TelemetryService.ResetMetricReportDefinitionsToDefaults": {
"$ref": "#/definitions/ResetMetricReportDefinitionsToDefaults"
},
"#TelemetryService.ResetTriggersToDefaults": {
"$ref": "#/definitions/ResetTriggersToDefaults"
},
"#TelemetryService.SubmitTestMetricReport": {
"$ref": "#/definitions/SubmitTestMetricReport"
},
"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"
},
"ClearMetricReports": {
"additionalProperties": false,
"description": "The action to clear the metric reports for this telemetry service.",
"longDescription": "This action shall delete all entries found in the metric report collection for this telemetry service.",
"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",
"versionAdded": "v1_3_0"
},
"ClearTelemetryData": {
"additionalProperties": false,
"description": "The action to clear the telemetry data for this telemetry service.",
"longDescription": "This action shall delete all entries found in the telemetry data collection for this telemetry service.",
"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",
"versionAdded": "v1_4_0"
},
"CollectTelemetryData": {
"actionResponse": {
"$ref": "#/definitions/CollectTelemetryDataResponse"
},
"additionalProperties": false,
"description": "The action to collect the telemetry data from a device or service. When the telemetry data is collected, a new telemetry data resource will be created.",
"longDescription": "This action shall collect the telemetry data from a device or service. The `Location` header in the response shall contain a URI to a resource of type `TelemetryData` that contains the telemetry data. The `AdditionalDataURI` property in the referenced `TelemetryData` resource shall contain the URI to download the telemetry data.",
"parameters": {
"OEMTelemetryDataType": {
"description": "The OEM-defined type of telemetry data to collect.",
"longDescription": "This parameter shall contain the OEM-defined type of telemetry data to collect. This parameter shall be required if `TelemetryDataType` is `OEM`.",
"type": "string"
},
"TargetDevices": {
"description": "An array of devices from which to collect telemetry data.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
},
"longDescription": "This parameter shall contain an array of devices from which to collect telemetry data.",
"type": "array"
},
"TelemetryDataType": {
"$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryData.json#/definitions/TelemetryDataTypes",
"description": "The type of telemetry data to collect.",
"longDescription": "This parameter shall contain the type of telemetry data to collect.",
"requiredParameter": true
}
},
"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",
"versionAdded": "v1_4_0"
},
"CollectTelemetryDataResponse": {
"additionalProperties": false,
"description": "The response body for the `CollectTelemetryData` action.",
"longDescription": "This type shall contain the properties found in the response body for the `CollectTelemetryData` 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": {
"TelemetryData": {
"description": "An array of links to the collected telemetry data.",
"items": {
"type": "string"
},
"longDescription": "This property shall contain an array of links to resources of type `TelemetryData` that represent the collected telemetry data.",
"readonly": true,
"type": "array",
"versionAdded": "v1_4_0"
}
},
"required": [
"TelemetryData"
],
"type": "object"
},
"CollectionFunction": {
"description": "An operation to perform over the sample.",
"enum": [
"Average",
"Maximum",
"Minimum",
"Summation"
],
"enumDescriptions": {
"Average": "An averaging function.",
"Maximum": "A maximum function.",
"Minimum": "A minimum function.",
"Summation": "A summation function."
},
"longDescription": "If present, the metric value shall be computed according to this function.",
"type": "string"
},
"MetricValue": {
"additionalProperties": false,
"description": "Properties that capture a metric value and other associated information.",
"longDescription": "This type shall contain properties that capture a metric value and other associated information.",
"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": {
"MetricDefinition": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition",
"description": "The link to the metric definition for this metric.",
"longDescription": "This property shall contain a link to a resource of type `MetricDefinition` that describes what this metric value captures.",
"readonly": true,
"versionAdded": "v1_1_0"
},
"MetricId": {
"description": "The metric definitions identifier for this metric.",
"longDescription": "This property shall contain the same value as the `Id` property of the source metric within the associated metric definition.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
},
"MetricProperty": {
"description": "The URI for the property from which this metric is derived.",
"format": "uri-reference",
"longDescription": "The value shall be the URI to the property following the JSON fragment notation, as defined by RFC6901, to identify an individual property in a Redfish resource.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
},
"MetricValue": {
"description": "The metric value, as a string.",
"longDescription": "This property shall contain the metric value, as a string.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
},
"Timestamp": {
"description": "The date and time when the metric is obtained. A management application can establish a time series of metric data by retrieving the instances of metric value and sorting them according to their timestamp.",
"format": "date-time",
"longDescription": "The value shall time when the metric value was obtained. Note that this value may be different from the time when this instance is created.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
}
},
"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"
},
"ResetMetricReportDefinitionsToDefaults": {
"additionalProperties": false,
"description": "The action to reset the metric report definitions to factory defaults.",
"longDescription": "This action shall reset all entries found in the metric report definition collection to factory defaults. This action may delete members of the metric report definition collection.",
"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",
"versionAdded": "v1_3_0"
},
"ResetTriggersToDefaults": {
"additionalProperties": false,
"description": "The action to reset the triggers to factory defaults.",
"longDescription": "This action shall reset all entries found in the triggers collection to factory defaults. This action may delete members of the triggers collection.",
"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",
"versionAdded": "v1_3_0"
},
"SubmitTestMetricReport": {
"additionalProperties": false,
"description": "This action generates a metric report.",
"longDescription": "This action shall cause the event service to immediately generate the metric report as an alert event. Then, this message should be sent to any appropriate event destinations.",
"parameters": {
"GeneratedMetricReportValues": {
"description": "The contents of the `MetricReportValues` in the generated metric report.",
"items": {
"$ref": "#/definitions/MetricValue"
},
"longDescription": "This parameter shall contain the contents of the `MetricReportValues` array property in the generated metric report.",
"requiredParameter": true,
"type": "array",
"versionAdded": "v1_1_0"
},
"MetricReportName": {
"description": "The name of the metric report in generated metric report.",
"longDescription": "This parameter shall contain the name of the generated metric report.",
"requiredParameter": true,
"type": "string"
},
"MetricReportValues": {
"deprecated": "This property has been deprecated in favor of using the property `GeneratedMetricReportValues`.",
"description": "The contents of the `MetricReportValues` array in the generated metric report.",
"longDescription": "This parameter shall contain the contents of the `MetricReportValues` array property in the generated metric report.",
"type": "string",
"versionDeprecated": "v1_1_0"
}
},
"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"
},
"TelemetryService": {
"additionalProperties": false,
"description": "The `TelemetryService` schema describes a telemetry service. The telemetry service is used for collecting and reporting metric data within the Redfish service.",
"longDescription": "This resource contains a telemetry service for 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."
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"LogService": {
"$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService",
"description": "The link to a log service that the telemetry service uses. This service can be a dedicated log service or a pointer to a log service under another resource, such as a manager.",
"longDescription": "This property shall contain a link to a resource of type `LogService` that this telemetry service uses.",
"readonly": true
},
"MaxReports": {
"description": "The maximum number of metric reports that this service supports.",
"longDescription": "This property shall contain the maximum number of metric reports that this service supports.",
"readonly": true,
"type": [
"integer",
"null"
]
},
"MetricDefinitions": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinitionCollection.json#/definitions/MetricDefinitionCollection",
"description": "The link to the collection of metric definitions.",
"longDescription": "This property shall contain a link to a resource collection of type `MetricDefinitionCollection`.",
"readonly": true
},
"MetricReportDefinitions": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinitionCollection.json#/definitions/MetricReportDefinitionCollection",
"description": "The link to the collection of metric report definitions.",
"longDescription": "This property shall contain a link to a resource collection of type `MetricReportDefinitionCollection`.",
"readonly": true
},
"MetricReports": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportCollection.json#/definitions/MetricReportCollection",
"description": "The link to the collection of metric reports.",
"longDescription": "This property shall contain a link to a resource collection of type `MetricReportCollection`.",
"readonly": true
},
"MinCollectionInterval": {
"description": "The minimum time interval between gathering metric data that this service allows.",
"longDescription": "This property shall contain the minimum time interval between gathering metric data that this service allows.",
"pattern": "^P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?$",
"readonly": true,
"type": [
"string",
"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."
},
"ServiceEnabled": {
"description": "An indication of whether this service is enabled.",
"longDescription": "This property shall indicate whether this service is enabled.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_2_0"
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the resource and its subordinate or dependent resources.",
"longDescription": "This property shall contain any status or health properties of the resource."
},
"SupportedCollectionFunctions": {
"description": "The functions that can be performed over each metric.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/CollectionFunction"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall contain the function to apply over the collection duration.",
"readonly": true,
"type": "array"
},
"SupportedOEMTelemetryDataTypes": {
"description": "A list of supported OEM-defined telemetry data types.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain a list of supported OEM-defined telemetry data types.",
"readonly": true,
"type": "array",
"versionAdded": "v1_4_0"
},
"SupportedTelemetryDataTypes": {
"description": "A list of supported telemetry data types.",
"items": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryData.json#/definitions/TelemetryDataTypes"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall contain a list of supported telemetry data types.",
"readonly": true,
"type": "array",
"versionAdded": "v1_4_0"
},
"TelemetryData": {
"$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryDataCollection.json#/definitions/TelemetryDataCollection",
"description": "The link to the collection of data telemetry.",
"longDescription": "This property shall contain a link to a resource collection of type `TelemetryDataCollection`.",
"readonly": true,
"versionAdded": "v1_4_0"
},
"Triggers": {
"$ref": "http://redfish.dmtf.org/schemas/v1/TriggersCollection.json#/definitions/TriggersCollection",
"description": "The link to the collection of triggers that apply to metrics.",
"longDescription": "This property shall contain a link to a resource collection of type `TriggersCollection`.",
"readonly": true
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
}
},
"language": "en",
"owningEntity": "DMTF",
"release": "2025.2",
"title": "#TelemetryService.v1_4_1.TelemetryService"
}
|
