Dell iDRAC Telemetry Reference Guide

SCP Export

The SCP export is the process of generating an XML or JSON template. This template can be exported locally or to a network share. SCP Export includes an optional parameter called “IncludeCustomTelemetry”. The Optional parameters expand the default template behavior. When the new optional parameter is selected for SCP Export, the Telemetry Custom definitions are applied from the SCP XML/JSON template.

The following is an example of a simplified XML, exported using SCP with the “IncludeCustomTelemetry” option. The CustomComponents node includes the telemetry custom definitions.

<CustomComponents>
  <CustomMetricReportDefinitions>
      <odata.type>#MetricReportDefinition.v1_4_2.MetricReportDefinition</odata.type>
      <odata.context>/Redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition</odata.context>
      <odata.id>/Redfish/v1/TelemetryService/MetricReportDefinitions/AggregationMetrics</odata.id>
      <Id>AggregationMetrics</Id>
      <Name>Aggregation Metrics Metric Report</Name>
      <Description>Aggregation Metrics report  is derived by applying a formula or filter to a set of base metric values for Power, Temperature, CUPS (CPU, Memory, IO, System)</Description>
      <AppendLimit>2400</AppendLimit>
      <MetricReportDefinitionEnabled>true</MetricReportDefinitionEnabled>
      <MetricReportDefinitionType>OnRequest</MetricReportDefinitionType>
      <MetricReportDefinitionType.Redfish.AllowableValues>Periodic</MetricReportDefinitionType.Redfish.AllowableValues>
      <MetricReportDefinitionType.Redfish.AllowableValues>OnChange</MetricReportDefinitionType.Redfish.AllowableValues>
      <MetricReportDefinitionType.Redfish.AllowableValues>OnRequest</MetricReportDefinitionType.Redfish.AllowableValues>
      <MetricReportHeartbeatInterval>PT0H0M0S</MetricReportHeartbeatInterval>
      <SuppressRepeatedMetricValue>false</SuppressRepeatedMetricValue>
      <ReportTimespan>PT0H2M0S</ReportTimespan>
      <ReportUpdates>AppendWrapsWhenFull</ReportUpdates>
      <ReportUpdates.Redfish.AllowableValues>AppendStopsWhenFull</ReportUpdates.Redfish.AllowableValues>
      <ReportUpdates.Redfish.AllowableValues>AppendWrapsWhenFull</ReportUpdates.Redfish.AllowableValues>
      <ReportUpdates.Redfish.AllowableValues>NewReport</ReportUpdates.Redfish.AllowableValues>
      <ReportUpdates.Redfish.AllowableValues>Overwrite</ReportUpdates.Redfish.AllowableValues>

The following is an example of a simplified JSON, exported using SCP where custom Telemetry definitions are included. The "CustomComponents" node includes the Telemetry custom definitions.

  "CustomComponents": {
            "CustomMetricReportDefinitions": [
                {
                    "@odata.type": "#MetricReportDefinition.v1_4_2.MetricReportDefinition",
                    "@odata.context": "/Redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition",
                    "@odata.id": "/Redfish/v1/TelemetryService/MetricReportDefinitions/AggregationMetrics",
                    "Id": "AggregationMetrics",
                    "Name": "Aggregation Metrics Metric Report",
                    "Description": "Aggregation Metrics report is derived by applying a formula or filter to a set of base metric values for Power, Temperature, CUPS (CPU, Memory, IO, System)",
                    "AppendLimit": 2400,
                    "MetricReportDefinitionEnabled": true,
                    "MetricReportDefinitionType": "OnRequest",
                    "MetricReportHeartbeatInterval": "PT0H0M0S",
                    "SuppressRepeatedMetricValue": false,
                    "ReportTimespan": "PT0H2M0S",
                    "ReportUpdates": "AppendWrapsWhenFull",
                    "Wildcards": [],
                    "MetricReportDefinitionType@Redfish.AllowableValues": [
                        "Periodic",
                        "OnChange",
                        "OnRequest"
                    ],
                    "ReportUpdates@Redfish.AllowableValues": [
                        "AppendStopsWhenFull",
                        "AppendWrapsWhenFull",
                        "NewReport",
                        "Overwrite"
                    ],
                    "ReportActions": [
                        "LogToMetricReportsCollection"
                    ],
                    "ReportActions@Redfish.AllowableValues": [
                        "LogToMetricReportsCollection",
                        "RedfishEvent"
                    ],
                    "Status": {
                        "State": "Enabled"
                    },
                    "Schedule": {
                        "RecurrenceInterval": "PT0H0M0S"
                    },
                    "MetricReport": {
                        "@odata.id": "/Redfish/v1/TelemetryService/MetricReports/AggregationMetrics"
                    },
                    "Metrics": [
                        {
                            "MetricId": "SystemAvgInletTempHour",
                            "MetricProperties": [],
                            "CollectionFunction": null,
                            "CollectionDuration": null,
                            "CollectionTimeScope": "Point",
                            "Oem": {
                                "Dell": {
                                    "@odata.type": "#DellMetric.v1_1_0.DellMetric",
                                    "CustomLabel": null,
                                    "FQDD": null,
                                    "Source": null
                                }
                            }
                        },
                        {
                            "MetricId": "SystemMaxInletTempHour",
                            "MetricProperties": [],
                            "CollectionFunction": null,
                            "CollectionDuration": null,
                            "CollectionTimeScope": "Point",
                            "Oem": {
                                "Dell": {
                                    "@odata.type": "#DellMetric.v1_1_0.DellMetric",
                                    "CustomLabel": null,
                                    "FQDD": null,
                                    "Source": null
                                }
                            }
                        },
                        {
                            "MetricId": "SystemMaxPowerConsumption",
                            "MetricProperties": [],
                            "CollectionFunction": null,
                            "CollectionDuration": null,
                            "CollectionTimeScope": "Point",
                            "Oem": {
                                "Dell": {
                                    "@odata.type": "#DellMetric.v1_1_0.DellMetric",
                                    "CustomLabel": null,
                                    "FQDD": null,
                                    "Source": null
                                }
                            }
                        }
                    ],
                    "Links": {
                        "Triggers": []
                    },
                    "Oem": {
                        "Dell": {
                            "@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinition",
                            "Digest": "45ab1831e9f814eaee29bdc44b55fabf197fb266baffc5e14df2a842875335d2",
                            "iDRACFirmwareVersion": "1.20.50.50"
                        }
                    }
                }