Dell iDRAC Telemetry Reference Guide

Below is an example to post a custom MRD with specific properties using Redfish interface. Typically, one can GET any existing Predefined report definition (MRD) and update the metrics and properties (at the minimum, different “Id” value should be specified) and POST the updated Json as shown in the example below where a custom report for NIC Tx and Rx bytes metrics for a wanted NIC port (FQDD) - NIC.Slot.1-1-1 is requested.

Command: POST
URI: /redfish/v1/TelemetryService/MetricReportDefinitions
Header: content-type application/json
BODY: <custom MRD definition json>

For example:

curl -s -k -u <user>:<password> -X POST https://<iDRAC_IP>/redfish/v1/TelemetryService/MetricReportDefinitions -H 'Content-Type: application/json' -d '
{
  "Id": "TxRxBytesNicSlot1",
  "Name": "Tx and Rx Bytes from Nic Slot 1 Metric Report",
  "Description": "Tx and Rx Bytes of Nic Slot1 record",
  "MetricReportDefinitionEnabled": true,
  "MetricReportDefinitionType": "Periodic",
  "MetricReportHeartbeatInterval": "PT0H0M0S",
  "SuppressRepeatedMetricValue": false,
  "ReportTimespan": "PT0H0M0S",
  "ReportUpdates": "Overwrite",
  "ReportActions": ["redfishEvent"],
  "Schedule": {
    "RecurrenceInterval": "PT0H2M0S"
  },
  "Metrics": [
    {
      "MetricId": "TxBytes",
      "MetricProperties": [],
      "MetricProperties@odata.count": 0,
      "CollectionFunction": null,
      "CollectionDuration": null,
      "CollectionTimeScope": "Point",
      "Oem": {
        "Dell": {
          "@odata.type": "#DellMetric.v1_1_0.DellMetric",
          "CustomLabel": null,
          "FQDD": "NIC.Slot.1-1-1",
          "Source": null
        }
      }
    },
    {
      "MetricId": "RxBytes",
      "MetricProperties": [],
      "MetricProperties@odata.count": 0,
      "CollectionFunction": null,
      "CollectionDuration": null,
      "CollectionTimeScope": "Point",
      "Oem": {
        "Dell": {
          "@odata.type": "#DellMetric.v1_1_0.DellMetric",
          "CustomLabel": null,
          "FQDD": "NIC.Slot.1-1-1",
          "Source": null
        }
      }
    }
  ],
  "Metrics@odata.count": 2,
  "Links": {
    "Triggers": []
  }
}'

When the above POST command is successful the new custom report is added to the report definition collection. The report collection shall contain both custom metric reports along with Predefined metric reports.

To get report definition collection (URI list only) which include custom report definition:

Command: GET
URI: /redfish/v1/TelemetryService/MetricReportDefinitions
Header: content-type application/json

For example:

curl -s -k -u <user>:<password> -X GET https://<IDRAC_IP>/redfish/v1/TelemetryService/MetricReportDefinitions

To get one report definition detail:

Command: GET
URI: /redfish/v1/TelemetryService/MetricReportDefinitions/<report>
Header: content-type application/json
e.g. <report> = TxRxBytesNicSlot1

For example:

curl -s -k -u <user>:<password> -X GET https://<IDRAC_IP>/redfish/v1/TelemetryService/MetricReports/TxRxBytesNicSlot1.