GET – Metric Definition Instance
Request
GET https://{{ip}}/redfish/v1/TelemetryService/MetricDefinitions/{{metric_instance}}
Content-Type: application/json
Redfish represents metrics as resource properties (sensor readings, statistics).
Metric Definitions are the metadata of the metrics and provide details about characteristics of readings and calculation for statistics.
It displays a collection of Metric Definitions.
Response
The response of the request will be in JSON format. The properties are mentioned in the following table.
Name | Type | Read only | Description |
| (OData Attributes) | Refer to OData Support | ||
| Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types | |
Id (M) | String | True | Refer to Resource Type Definitions |
Name | String | True | |
| Description | String | True | |
MetricDataType | String | True | The data type of the related metric values. The property provides information to the client on the nature of the metric reading. The value shall be the data type of the related metric values as defined by JSON data types. Boolean,DateTime,Decimal,Integer,String,Enumeration |
MetricType | String | True | Only "Numeric" is supported. The value of the metric shall be a real number with a float format. |
Implementation | String | True | "Physical" for sensors and "Calculated" for metrics The value of this property shall designate how the sensor is implemented. |
Units | String | True | Units of measure for this metric. |
IsLinear | Boolean | True | The value shall specify that the corresponding metric values shall be linear or non-linear. |
MetricProperties | Array | True | A collection of URI for the properties on which this metric definition is defined. Note Each value under "MetricProperties" attribute depicts either a Temperature/Fan/Voltage Sensor and ea of them is represented as a combination of its Sensor Number and Owner LUN Number. For e.g., If a FanSensor has Sensor Number as 48 and LUN Number as 0, then it will be displayed under the MetricProperties attribute as a combination of its Sensor Number and Owner LUN Number as mentioned below: /redfish/v1/Chassis/Self/Thermal#/Fans/48_0/ReadingRPM |
Precision | Number | True | The value of the property shall specify the number of significant digits in the MetricValue. A value shall not be present if MetricType is Discrete. Default value is 3. |
Accuracy | Number | True | The value of the property shall be the percent error +/- of the measured vs. actual values. A value shall not be present if MetricType is Discrete. Default value is 5. |
Calculable | String | True | The value of the property shall specify the types of calculations which can be applied to the metric reading. This property provides information to the client on the suitability of calculation using the metric reading. NonCalculatable: No calculations should be performed on the metric reading. NonSummable: The sum of the metric reading across multiple instances is not meaningful. Summable: The sum of the metric reading across multiple instances is meaningful. Note North Bound Support only available. |
CalculationAlgorithm | String | True | The value of this property shall specify the calculation performed to obtain the metric. The time interval referred her shall be the value of the Calculation Time Interval property. Average: The metric shall be calculated as the average of a metric reading over a sliding time interval. Minimum: The metric shall be calculated as the minimum of a metric reading over a sliding time interval. Note North Bound Support only available. |
CalculationTimeInterval | String | True | The value of this property shall specify the time interval over the metric calculation is performed. The format of the value shall conform to the Duration format. Note North Bound Support only available. |
PhysicalContext | String | True | The value of this property shall specify the physical context of the metric. Note North Bound Support only available. |
Example
Fan_Reading
GET https://{{ip}}/redfish/v1/TelemetryService/MetricDefinitions/Fan_Reading
Content-Type: application/json
Response
Fan_Reading
{
"@odata.context": "/redfish/v1/$metadata#MetricDefinition.MetricDefinition",
"@odata.etag": "\"1581501930\"",
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/Fan_Reading",
"@odata.type": "#MetricDefinition.v1_0_2.MetricDefinition",
"Accuracy": 5,
"Id": "Fan_Reading",
"Implementation": "PhysicalSensor",
"IsLinear": true,
"MetricDataType": "Integer",
"MetricProperties": [
"/redfish/v1/Chassis/Self/Thermal#/Fans/48_0/ReadingRPM",
"/redfish/v1/Chassis/Self/Thermal#/Fans/58_0/ReadingRPM",
"/redfish/v1/Chassis/Self/Thermal#/Fans/54_0/ReadingRPM",
"/redfish/v1/Chassis/Self/Thermal#/Fans/50_0/ReadingRPM",
"/redfish/v1/Chassis/Self/Thermal#/Fans/56_0/ReadingRPM",
"/redfish/v1/Chassis/Self/Thermal#/Fans/52_0/ReadingRPM"
],
"MetricType": "Numeric",
"Name": "Fan Reading",
"Precision": 3,
}