Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

POST method for MetricReportDefinitions

This method creates new metric report definition resources.

Description

Creates a new metric report definition resource. The MetricID properties are not validated while creating metric report definitions. Reports are not created if the properties do not match.

Privilege

APPLIANCE SETUP

HTTP response code

201

Example request body

{
    "Description": "PSUInputVoltage_MRD",
    "Id": "PSUVoltage",
    "MetricReportDefinitionEnabled": true,
    "MetricReportDefinitionType": "Periodic",
    "MetricReportHeartbeatInterval": "PT0H1M0S",
    "Metrics": [
        {
            "MetricId": "PSUInputVoltage"
        }
    ],
    "Name": "PSUInputVoltage",
    "ReportActions": [
        "RedfishEvent",
        "LogToMetricReportsCollection"
    ],
    "ReportTimespan": "PT0H1M0S",
    "ReportUpdates": "Overwrite",
    "Schedule": {
        "RecurrenceInterval": "PT0H1M0S"
    },
    "SuppressRepeatedMetricValue": true
}

Example response body

{
  "Id": "<CustomMRDID>",
  "Name": "ChassisReadingCelsius",
  "Description": "ChassisReadingCelsius",
  "MetricReportDefinitionEnabled": true,
  "MetricReportDefinitionType": "Periodic",
  "MetricReportHeartbeatInterval": "PT0H10M0S",
  "SuppressRepeatedMetricValue": true,
  "ReportTimespan": "PT0H0M0S",
  "ReportUpdates": "Overwrite",
  "ReportActions": [
    "RedfishEvent",
              "LogToMetricReportsCollection"
  ],
  "Schedule": {
    "RecurrenceInterval": "PT0H1M0S"
  },
  "Metrics": [
    {
      "MetricId": "ChassisReadingCelsius"
    }
  ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
RecurrenceInterval	Min– 10 seconds Max– 2 hours Disabled– 0
ReportTimeSpan	Min– 10 seconds Max– 2 hours Disabled– 0
CollectionDuration	Min– 20 seconds Max– 2 hours Disabled– 0
HeartBeatInterval	Min– 10 seconds Max– When the set min value is the RecurrenceInterval value. Disabled– 0

While creating a Metric Report Definition (MRD) with MetricReportDefinitionType as "Periodic" and RecurrenceInterval as "0", the report generated serves like an OnRequest report.

If you want to generate a metric report for SSE or Subscription, update the recurrence interval with accepted values such as 2min that is PT2M. Such values help generate a metric report with at least one metric value.

NOTE:

In the POST method, the values for the attributes, OnChange or OnRequest must meet the following criteria:

RecurrenceInterval and MetricReportHeartbeatInterval are cleared.
SuppressRepeatedMetricValue is set to true.
ReportTimeSpan is 10 seconds or greater.