Skip to main content

GET – Telemetry service properties

Use the GET method to retrieve properties in Telemetry service resource for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/TelemetryService

Request body

None

Response body

FieldTypeDescription

Id

String

“TelemetryService”.

Name

String

“Telemetry Service”.

Description

String

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

ServiceEnabled

Boolean

If FoD is 2 or higher, the value is true, otherwise is false.

SupportedCollectionFunctions

Array

"Average", "Minimum", "Maximum"

Status

Object

The status of the telemetry service.

 

State

String

The state of the telemetry service.

 

Health

String

The health of the telemetry service.

MetricDefinitions

Link

The link to the collection of metric definitions.

MetricReportDefinitions

Link

The link to the collection of metric report definitions.

MetricReports

Link

The link to the collection of metric reports.

Actions

Object

Expanded

 

#TelemetryService. SubmitTestMetricReport

Object

This action generates a metric report.

  

target

Link

Link to invoke action.

  

title

String

“SubmitTestMetricReport”

  

@Redfish.ActionInfo

Link

Link to the info of this action.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"MetricReports": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports"
},
"@odata.id": "/redfish/v1/TelemetryService",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Name": "Telemetry Service",
"ServiceEnabled": true,
"SupportedCollectionFunctions": [
"Average",
"Minimum",
"Maximum"
],
"Id": "TelemetryService",
"@odata.type": "#TelemetryService.v1_1_1.TelemetryService",
"MetricDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
},
"MetricReportDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
},
"@odata.etag": "\"7913d34db76cc9af9c13306d210b0da7\"",
"Actions": {
"#TelemetryService.SubmitTestMetricReport": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo",
"title": "SubmitTestMetricReport"
}
},
"Description": "This resource shall be used to represent a Metrics Service for a Redfish implementation."
}