iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

MetricReportDefinition

This resource specifies a set of metrics that shall be collected into a metric report.

/redfish/v1/TelemetryService/MetricReportDefinitions/<MetricReportDefinition-Id>


HTTP Method	Required Privilege
GET	Login
PATCH	ConfigureManager , Login


Property	Type	Read Only	Description
MetricReport	String	Yes	The location where the resultant metric report is placed.
MetricReportDefinitionEnabled	Boolean	No	An indication of whether the generation of new metric reports is enabled.
MetricReportDefinitionType	String	Yes	Specifies when the metric report is generated.
Schedule	String	No	Specifies the schedule for generating the metric report. If a schedule is present, the metric report is generated at an interval specified by Schedule.RecurrenceInterval property.
NOTE While configuring a subscription for CUPS report, it is recommended to set the recurrence interval to 60 seconds or above.
ReportActions	Array	Yes	Specifies the actions to perform when a metric report is generated.
Metrics	Array	Yes	Specifies a list of metrics to include in the metric report. The metrics may include metric properties or calculations applied to a metric property.
ReportUpdates	String	Yes	When logging metric reports, specifies how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. Namely, whether to overwrite, append, or create new report resource.
MetricReport	String	Yes	Specifies the location where the resultant metric report is placed.

Table 1. Status codes
HTTP status code	Extended Information	Error Code
200	Base.1.5.Success	SYS413
400		SYS425, SYS029, SWC0283, SYS460, RAC004, SYS446
400	Base.1.5.MalformedJSON, Base.1.5.PropertyUnknown	SYS405, SYS429
403		LIC501