Skip to main content

GET – Telemetry Service

Request​

GET https://{{ip}}/redfish/v1/TelemetryService
Content-Type: application/json

  1. This resource shall be used to represent a Metrics Service for a Redfish implementation.

  2. It represents the properties for the service itself and has links to collections of metric definitions and metric report definitions.

Response​

  1. The response of the request will be in JSON format. The properties are mentioned in the following table.

  2. The “ServiceEnabled” attribute was introduced to DTMF Redfish Schema version 2019.4.

  3. Hence, in the case of Telemetry Service Root URI alone, to support “ServiceEnabled” attribute, we are migrating to 2019.4 for supporting this attribute alone from DMTF Redfish Schema versioned 2019.2 for supporting this attribute alone from DMTF Redfish Schema versioned 2019.2, which is currently supported by RTP version 1.8.a.

  4. Remaining URIs under Telemetry Service is implemented based on the Redfish Schema versioned 2019.2.

Table 1. Telemetry Service Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support.

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types.

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

Array

True

Description

Array

True

MetricDefinitions

Array

True

  1. A collection of Metric definitions that describes metrics properties.

  2. The entries shall be resources of type MetricDefinitionCollection.

MetricReportDefinitions

Array

True

  1. A collection of MetricReportDefinitions.

  2. The value shall be a link to a resource of type MetricReportDefinitionCollection.

MetricReports

Array

True

A collection of MetricReport resources, that relate to MetricReportDefinition.

Triggers

Array

True

  1. A collection of triggers, which apply to metrics.

  2. The value shall be a link to a resource of type TriggersCollection.

  3. Not allowed to create more than 5 triggers, restricted internally.

Status

Object

True

  1. Refer to Resource Complex Types.

  2. If “ServiceEnabled” attribute has a value true, the value of “State” under “Status” attribute will be enabled.

  3. If “ServiceEnabled” attribute has a value false, the value of “State” under “Status” attribute will be disabled.

Name

String

True

Name of the Collection

MaxReports

Number

True

The maximum number of MetricReports that are supported by this service. If present, the value shall specify the maximum number of metric collectors that can be supported by this service. Limited to 25.

MinCollectionInterval

String

True

The minimum supported time interval between collections. If present, the value shall be an ISO 8601 duration specifying t minimum time interval between collections. Limited to PT5S.

SupportedCollectionFunctions

Array

False

Function to perform over each sample. If present, the metric value shall be computed according to this function. over the collection duration. [Minimum,Summation,Average and Maximum are the supported collection functions]

Actions

Object

True

The Actions object contains the available custom actions on this resource like SubmitTestMetricReportor any Oem Action.

LogService

Object

True

This is a reference to a Log Service used by the Telemetry Service. The value of this property(i.e. MetricReportLog) shall contain a reference to a LogSrveice for the use by this Telemetry Service.

ServiceEnabledBoolean

False

This property shall indicate whether the telemetry service is in enabled state or not. The default value for this attribute will be true.

Response example​

{
    "@odata.context": "/redfish/v1/$metadata#TelemetryService.TelemetryService",
    "@odata.etag": "\"1581328430\"",
    "@odata.id": "/redfish/v1/TelemetryService",
    "@odata.type": "#TelemetryService.v1_2_1.TelemetryService",
    "Actions": {
        "#TelemetryService.SubmitTestMetricReport": {
            "@Redfish.ActionInfo": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo",
            "target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport"
        }
    },
    "Description": "TelemetryService",
    "Id": "TelemetryService",
    "LogService": {
        "@odata.id": "/redfish/v1/TelemetryService/LogServices/MetricReportLog"
    },
    "MaxReports": 5,
    "MetricDefinitions": {
        "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
    },
    "MetricReportDefinitions": {
        "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
    },
    "MetricReports": {
        "@odata.id": "/redfish/v1/TelemetryService/MetricReports"
    },
    "MinCollectionInterval": "PT5S",
    "Name": "TelemetryService",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "ServiceEnabled":true,
    "SupportedCollectionFunctions": [
        "Summation",
        "Minimum",
        "Maximum",
        "Average"
    ],
    "SupportedCollectionFunctions@Redfish.AllowableValues": [
        "Average",
        "Maximum",
        "Summation",
        "Minimum"
    ],
    "Triggers": {
        "@odata.id": "/redfish/v1/TelemetryService/Triggers"
    }
}