Skip to main content

OpenManage Enterprise 3.10 RESTful API Guide

PDF

PUT method for metric report definitions by ID

This method updates the resource of a specific metric report definition.

Description
Updates the resource of a specific metric report definition.
Privilege
APPLIANCE_SETUP
HTTP response codes
201
Example request body
{
    "Id": "PSUInputVoltage32",
    "MetricReportDefinitionEnabled": false,
    "MetricReportDefinitionType": "Periodic",
    "MetricReportHeartbeatInterval": "PT0H10M0S",
    "Metrics": [
        {
            "MetricId": "PSUInputVoltage"
        }
    ],
    "ReportActions": [
        "RedfishEvent",
        "LogToMetricReportsCollection"
    ],
    "ReportTimespan": "PT0H1M0S",
    "ReportUpdates": "Overwrite",
    "Schedule": {
        "RecurrenceInterval": "PT0H10M0S"
    },
    "SuppressRepeatedMetricValue": true
}

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.


Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\