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
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_1_2.json",
"$ref": "#/definitions/TelemetryService",
"$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": {
"#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"
},
"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": "A metric value.",
"longDescription": "A metric value in the context of 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": {
"MetricDefinition": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition",
"description": "The link to the metric.",
"longDescription": "The link to the Metric Definition Resource that describes what this metric report captures.",
"readonly": true,
"versionAdded": "v1_1_0"
},
"MetricId": {
"description": "The metric definitions identifier for this metric.",
"longDescription": "This property shall contain the same as the Id property of the source metric within the associated MetricDefinition.",
"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": "This property shall contain the URI to the property, which follows the RFC6901-defined JSON fragment notation, 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 time when the metric value is obtained. A management application may 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": "This property shall contain the time when the metric value was obtained. Note that this 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"
},
"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 content 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 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 to 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 may be a dedicated Log Service or a pointer a Log Service under another entity, such as Manager.",
"longDescription": "This property shall contain a link to a Log Service 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."
},
"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": false,
"type": "array"
},
"Triggers": {
"$ref": "http://redfish.dmtf.org/schemas/v1/TriggersCollection.json#/definitions/TriggersCollection",
"description": "The link to the collection of triggers, which 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"
}
},
"owningEntity": "DMTF",
"release": "2018.3",
"title": "#TelemetryService.v1_1_2.TelemetryService"
}
|
