1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_3_4.json", 3 "$ref": "#/definitions/TelemetryService", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "description": "The available actions for this resource.", 10 "longDescription": "This type shall contain the available actions for this resource.", 11 "patternProperties": { 12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 13 "description": "This property shall specify a valid odata or Redfish property.", 14 "type": [ 15 "array", 16 "boolean", 17 "integer", 18 "number", 19 "null", 20 "object", 21 "string" 22 ] 23 } 24 }, 25 "properties": { 26 "#TelemetryService.ClearMetricReports": { 27 "$ref": "#/definitions/ClearMetricReports" 28 }, 29 "#TelemetryService.ResetMetricReportDefinitionsToDefaults": { 30 "$ref": "#/definitions/ResetMetricReportDefinitionsToDefaults" 31 }, 32 "#TelemetryService.ResetTriggersToDefaults": { 33 "$ref": "#/definitions/ResetTriggersToDefaults" 34 }, 35 "#TelemetryService.SubmitTestMetricReport": { 36 "$ref": "#/definitions/SubmitTestMetricReport" 37 }, 38 "Oem": { 39 "$ref": "#/definitions/OemActions", 40 "description": "The available OEM-specific actions for this resource.", 41 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 42 } 43 }, 44 "type": "object" 45 }, 46 "ClearMetricReports": { 47 "additionalProperties": false, 48 "description": "The action to clear the metric reports for this telemetry service.", 49 "longDescription": "This action shall delete all entries found in the metric report collection for this telemetry service.", 50 "parameters": {}, 51 "patternProperties": { 52 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 53 "description": "This property shall specify a valid odata or Redfish property.", 54 "type": [ 55 "array", 56 "boolean", 57 "integer", 58 "number", 59 "null", 60 "object", 61 "string" 62 ] 63 } 64 }, 65 "properties": { 66 "target": { 67 "description": "Link to invoke action", 68 "format": "uri-reference", 69 "type": "string" 70 }, 71 "title": { 72 "description": "Friendly action name", 73 "type": "string" 74 } 75 }, 76 "type": "object", 77 "versionAdded": "v1_3_0" 78 }, 79 "CollectionFunction": { 80 "description": "An operation to perform over the sample.", 81 "enum": [ 82 "Average", 83 "Maximum", 84 "Minimum", 85 "Summation" 86 ], 87 "enumDescriptions": { 88 "Average": "An averaging function.", 89 "Maximum": "A maximum function.", 90 "Minimum": "A minimum function.", 91 "Summation": "A summation function." 92 }, 93 "longDescription": "If present, the metric value shall be computed according to this function.", 94 "type": "string" 95 }, 96 "MetricValue": { 97 "additionalProperties": false, 98 "description": "Properties that capture a metric value and other associated information.", 99 "longDescription": "This type shall contain properties that capture a metric value and other associated information.", 100 "patternProperties": { 101 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 102 "description": "This property shall specify a valid odata or Redfish property.", 103 "type": [ 104 "array", 105 "boolean", 106 "integer", 107 "number", 108 "null", 109 "object", 110 "string" 111 ] 112 } 113 }, 114 "properties": { 115 "MetricDefinition": { 116 "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition", 117 "description": "The link to the metric definition for this metric.", 118 "longDescription": "This property shall contain a link to a resource of type `MetricDefinition` that describes what this metric value captures.", 119 "readonly": true, 120 "versionAdded": "v1_1_0" 121 }, 122 "MetricId": { 123 "description": "The metric definitions identifier for this metric.", 124 "longDescription": "This property shall contain the same value as the `Id` property of the source metric within the associated metric definition.", 125 "readonly": true, 126 "type": [ 127 "string", 128 "null" 129 ], 130 "versionAdded": "v1_1_0" 131 }, 132 "MetricProperty": { 133 "description": "The URI for the property from which this metric is derived.", 134 "format": "uri-reference", 135 "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.", 136 "readonly": true, 137 "type": [ 138 "string", 139 "null" 140 ], 141 "versionAdded": "v1_1_0" 142 }, 143 "MetricValue": { 144 "description": "The metric value, as a string.", 145 "longDescription": "This property shall contain the metric value, as a string.", 146 "readonly": true, 147 "type": [ 148 "string", 149 "null" 150 ], 151 "versionAdded": "v1_1_0" 152 }, 153 "Timestamp": { 154 "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.", 155 "format": "date-time", 156 "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.", 157 "readonly": true, 158 "type": [ 159 "string", 160 "null" 161 ], 162 "versionAdded": "v1_1_0" 163 } 164 }, 165 "type": "object" 166 }, 167 "OemActions": { 168 "additionalProperties": true, 169 "description": "The available OEM-specific actions for this resource.", 170 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 171 "patternProperties": { 172 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 173 "description": "This property shall specify a valid odata or Redfish property.", 174 "type": [ 175 "array", 176 "boolean", 177 "integer", 178 "number", 179 "null", 180 "object", 181 "string" 182 ] 183 } 184 }, 185 "properties": {}, 186 "type": "object" 187 }, 188 "ResetMetricReportDefinitionsToDefaults": { 189 "additionalProperties": false, 190 "description": "The action to reset the metric report definitions to factory defaults.", 191 "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.", 192 "parameters": {}, 193 "patternProperties": { 194 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 195 "description": "This property shall specify a valid odata or Redfish property.", 196 "type": [ 197 "array", 198 "boolean", 199 "integer", 200 "number", 201 "null", 202 "object", 203 "string" 204 ] 205 } 206 }, 207 "properties": { 208 "target": { 209 "description": "Link to invoke action", 210 "format": "uri-reference", 211 "type": "string" 212 }, 213 "title": { 214 "description": "Friendly action name", 215 "type": "string" 216 } 217 }, 218 "type": "object", 219 "versionAdded": "v1_3_0" 220 }, 221 "ResetTriggersToDefaults": { 222 "additionalProperties": false, 223 "description": "The action to reset the triggers to factory defaults.", 224 "longDescription": "This action shall reset all entries found in the triggers collection to factory defaults. This action may delete members of the triggers collection.", 225 "parameters": {}, 226 "patternProperties": { 227 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 228 "description": "This property shall specify a valid odata or Redfish property.", 229 "type": [ 230 "array", 231 "boolean", 232 "integer", 233 "number", 234 "null", 235 "object", 236 "string" 237 ] 238 } 239 }, 240 "properties": { 241 "target": { 242 "description": "Link to invoke action", 243 "format": "uri-reference", 244 "type": "string" 245 }, 246 "title": { 247 "description": "Friendly action name", 248 "type": "string" 249 } 250 }, 251 "type": "object", 252 "versionAdded": "v1_3_0" 253 }, 254 "SubmitTestMetricReport": { 255 "additionalProperties": false, 256 "description": "This action generates a metric report.", 257 "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.", 258 "parameters": { 259 "GeneratedMetricReportValues": { 260 "description": "The contents of the `MetricReportValues` in the generated metric report.", 261 "items": { 262 "$ref": "#/definitions/MetricValue" 263 }, 264 "longDescription": "This parameter shall contain the contents of the `MetricReportValues` array property in the generated metric report.", 265 "requiredParameter": true, 266 "type": "array", 267 "versionAdded": "v1_1_0" 268 }, 269 "MetricReportName": { 270 "description": "The name of the metric report in generated metric report.", 271 "longDescription": "This parameter shall contain the name of the generated metric report.", 272 "requiredParameter": true, 273 "type": "string" 274 }, 275 "MetricReportValues": { 276 "deprecated": "This property has been deprecated in favor of using the property `GeneratedMetricReportValues`.", 277 "description": "The contents of the `MetricReportValues` array in the generated metric report.", 278 "longDescription": "This parameter shall contain the contents of the `MetricReportValues` array property in the generated metric report.", 279 "type": "string", 280 "versionDeprecated": "v1_1_0" 281 } 282 }, 283 "patternProperties": { 284 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 285 "description": "This property shall specify a valid odata or Redfish property.", 286 "type": [ 287 "array", 288 "boolean", 289 "integer", 290 "number", 291 "null", 292 "object", 293 "string" 294 ] 295 } 296 }, 297 "properties": { 298 "target": { 299 "description": "Link to invoke action", 300 "format": "uri-reference", 301 "type": "string" 302 }, 303 "title": { 304 "description": "Friendly action name", 305 "type": "string" 306 } 307 }, 308 "type": "object" 309 }, 310 "TelemetryService": { 311 "additionalProperties": false, 312 "description": "The `TelemetryService` schema describes a telemetry service. The telemetry service is used for collecting and reporting metric data within the Redfish service.", 313 "longDescription": "This resource contains a telemetry service for a Redfish implementation.", 314 "patternProperties": { 315 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 316 "description": "This property shall specify a valid odata or Redfish property.", 317 "type": [ 318 "array", 319 "boolean", 320 "integer", 321 "number", 322 "null", 323 "object", 324 "string" 325 ] 326 } 327 }, 328 "properties": { 329 "@odata.context": { 330 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 331 }, 332 "@odata.etag": { 333 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 334 }, 335 "@odata.id": { 336 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 337 }, 338 "@odata.type": { 339 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 340 }, 341 "Actions": { 342 "$ref": "#/definitions/Actions", 343 "description": "The available actions for this resource.", 344 "longDescription": "This property shall contain the available actions for this resource." 345 }, 346 "Description": { 347 "anyOf": [ 348 { 349 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 350 }, 351 { 352 "type": "null" 353 } 354 ], 355 "readonly": true 356 }, 357 "Id": { 358 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 359 "readonly": true 360 }, 361 "LogService": { 362 "$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService", 363 "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.", 364 "longDescription": "This property shall contain a link to a resource of type `LogService` that this telemetry service uses.", 365 "readonly": true 366 }, 367 "MaxReports": { 368 "description": "The maximum number of metric reports that this service supports.", 369 "longDescription": "This property shall contain the maximum number of metric reports that this service supports.", 370 "readonly": true, 371 "type": [ 372 "integer", 373 "null" 374 ] 375 }, 376 "MetricDefinitions": { 377 "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinitionCollection.json#/definitions/MetricDefinitionCollection", 378 "description": "The link to the collection of metric definitions.", 379 "longDescription": "This property shall contain a link to a resource collection of type `MetricDefinitionCollection`.", 380 "readonly": true 381 }, 382 "MetricReportDefinitions": { 383 "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinitionCollection.json#/definitions/MetricReportDefinitionCollection", 384 "description": "The link to the collection of metric report definitions.", 385 "longDescription": "This property shall contain a link to a resource collection of type `MetricReportDefinitionCollection`.", 386 "readonly": true 387 }, 388 "MetricReports": { 389 "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportCollection.json#/definitions/MetricReportCollection", 390 "description": "The link to the collection of metric reports.", 391 "longDescription": "This property shall contain a link to a resource collection of type `MetricReportCollection`.", 392 "readonly": true 393 }, 394 "MinCollectionInterval": { 395 "description": "The minimum time interval between gathering metric data that this service allows.", 396 "longDescription": "This property shall contain the minimum time interval between gathering metric data that this service allows.", 397 "pattern": "^P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?$", 398 "readonly": true, 399 "type": [ 400 "string", 401 "null" 402 ] 403 }, 404 "Name": { 405 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 406 "readonly": true 407 }, 408 "Oem": { 409 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 410 "description": "The OEM extension property.", 411 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 412 }, 413 "ServiceEnabled": { 414 "description": "An indication of whether this service is enabled.", 415 "longDescription": "This property shall indicate whether this service is enabled.", 416 "readonly": false, 417 "type": [ 418 "boolean", 419 "null" 420 ], 421 "versionAdded": "v1_2_0" 422 }, 423 "Status": { 424 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 425 "description": "The status and health of the resource and its subordinate or dependent resources.", 426 "longDescription": "This property shall contain any status or health properties of the resource." 427 }, 428 "SupportedCollectionFunctions": { 429 "description": "The functions that can be performed over each metric.", 430 "items": { 431 "anyOf": [ 432 { 433 "$ref": "#/definitions/CollectionFunction" 434 }, 435 { 436 "type": "null" 437 } 438 ] 439 }, 440 "longDescription": "This property shall contain the function to apply over the collection duration.", 441 "readonly": true, 442 "type": "array" 443 }, 444 "Triggers": { 445 "$ref": "http://redfish.dmtf.org/schemas/v1/TriggersCollection.json#/definitions/TriggersCollection", 446 "description": "The link to the collection of triggers that apply to metrics.", 447 "longDescription": "This property shall contain a link to a resource collection of type `TriggersCollection`.", 448 "readonly": true 449 } 450 }, 451 "required": [ 452 "@odata.id", 453 "@odata.type", 454 "Id", 455 "Name" 456 ], 457 "type": "object" 458 } 459 }, 460 "language": "en", 461 "owningEntity": "DMTF", 462 "release": "2020.4", 463 "title": "#TelemetryService.v1_3_4.TelemetryService" 464}