OpenManage Enterprise 3.10 RESTful API Guide

PDF

PATCH method for telemetry service

This method updates the telemetry service resource.

Description

Updates the telemetry service resource information.

Privilege

APPLIANCE_SETUP

HTTP response codes

200

Example request body

{
    "ServiceEnabled": true
}

Example response body

{
  "@Message.ExtendedInfo": [
    {
      "Message": "Successfully Completed Request",
      "MessageArgs": [],
      "MessageArgs@odata.count": 0,
      "MessageId": "Base.1.5.Success",
      "RelatedProperties": [],
      "RelatedProperties@odata.count": 0,
      "Resolution": "None",
      "Severity": "OK"
    },
    {
      "Message": "The operation successfully completed.",
      "MessageArgs": [],
      "MessageArgs@odata.count": 0,
      "MessageId": "IDRAC.2.1.SYS413",
      "RelatedProperties": [],
      "RelatedProperties@odata.count": 0,
      "Resolution": "No response action is required.",
      "Severity": "Informational"
    }
  ],
  "@odata.context": "/redfish/v1/$metadata#TelemetryService.TelemetryService",
  "@odata.id": "/redfish/v1/TelemetryService",
  "@odata.type": "#TelemetryService.v1_2_0.TelemetryService",
  "Actions": {
    "#TelemetryService.SubmitTestMetricReport": {
      "target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport"
    }
  },
  "Description": "The Manager TelemetryService",
  "Id": "TelemetryService",
  "MaxReports": 48,
  "MetricDefinitions": {
    "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
  },
  "MetricReportDefinitions": {
    "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
  },
  "MetricReports": {
    "@odata.id": "/redfish/v1/TelemetryService/MetricReports"
  },
  "MinCollectionInterval": "PT0H0M5S",
  "Name": "TelemetryService",
  "Oem": {
    "Dell": {
      "@odata.type": "#DellTelemetryService.v1_0_0.DellTelemetryService",
      "FQDDList": [
        "System.Chassis.1",
        "Fan.Slot.2",
        "Fan.Slot.3",
        "Fan.Slot.4",
        "Fan.Slot.5",
        "Fan.Slot.6",
        "Fan.Slot.7",
        "Fan.Slot.8",
        "Fan.Slot.9",
        "PSU.Slot.1",
        "PSU.Slot.2",
        "PSU.Slot.3",
        "PSU.Slot.4",
        "PSU.Slot.5",
        "PSU.Slot.6"
      ],
      "SourceList": [
        ""
      ]
    }
  },
  "ServiceEnabled": true,
  "SupportedCollectionFunctions": [
    "Average",
    "Maximum",
    "Minimum",
    "Summation"
  ],
  "Triggers": {
    "@odata.id": "/redfish/v1/TelemetryService/Triggers"
  }
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
ServiceEnabled	If set to true, the telemetry service is enabled. If set to false, the service is disabled, modifications to any telemetry resources are not allowed and the telemetry metric report is not available.