xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema-installed/TelemetryService.v1_4_1.json

{
    "$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"
}