Skip to main content
Contact Us

OpenManage Enterprise 3.10 RESTful API Guide

PDF

POST method for Metrics

Description
This method returns all the device or group metrics.
Privilege
VIEW
HTTP response codes
201
Example device metric request body 
{
   "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625",
   "EntityType": 0,
   "EntityId": 10397,
   "MetricTypes": [
			1,
			2,
			3
   ],
   "Duration": 0,
   "SortOrder":0
}
Example device metric response body 
{
"EntityId": 10397,
"Value":[
        {
            "Type": "1",
            "Value": "230.0",
            "Timestamp": "2019-07-02 13:45:05.147666"
        },
        {
            "Type": "2",
            "Value": "177.0",
            "Timestamp": "2019-07-02 13:45:05.147666"
        },
        {
            "Type": "3",
            "Value": "197.0",
            "Timestamp": "2019-07-02 13:45:05.147666"
        }
    ]

}
Example Virtual Machine metric request body 
{
   "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625",
   "MetricTypes": [
            23,
            24
          ], 
   "SubEntityType": 0,   
       "SubEntityId": 1,
   "Duration": 0,
   "SortOrder":0 
}
Example Virtual Machine metric response body 
{
"EntityId": 10397,
"Value":[
        {
            "Type": "23",
            "Value": "230.0",
            "Timestamp": "2019-07-02 13:45:05.147666"
        },
        {
            "Type": "24",
            "Value": "177.0",
            "Timestamp": "2019-07-02 13:45:05.147666"
        }
    ]
}
Table 1. AttributesThis table lists the attributes that this method supports.
Attribute Description
PluginId ID of a plug-in.
EntityType Type of entity—device or group.
EntityId ID of an entity—device or group.
MetricTypes Types of metrics supported.
Duration Duration of metric data collection.
SortOrder Order of metric data collected.
Type Metric type
Value Metric value
Timestamp Collected date and time
SubEntityType Type of subentity— Virtual Machine
SubEntityID ID of subentity— Virtual Machine
Entity Type
0 Device
1 Group
Metric Supported
1 MAX_POWER—Maximum system power consumption
2 MIN_POWER—Minimum system power consumption
3 AVG_POWER—Average system power consumption
4 INSTANT_POWER—Instant system power
5 MAX_INLET_TEMP—Maximum Inlet Temperature
6 MIN_INLET_TEMP—Minimum Inlet Temperature
7 AVG_INLET_TEMP—Average Inlet Temperature
8 INSTANT_TEMP—Instant Inlet Temperature
9 MAX_UTIL_CPU—Maximum CPU utilization
10 MIN_UTIL_CPU—Minimum CPU utilization
11 AVG_UTIL_CPU—Average CPU utilization
12 MAX_UTIL_MEM—Maximum memory utilization
13 MIN_UTIL_MEM—Minimum memory utilization
14 AVG_UTIL_MEM—Average memory utilization
15 MAX_UTIL_IO—Maximum IO utilization
16 MIN_UTIL_IO—Minimum IO utilization
17 AVG_UTIL_IO—Average IO utilization
18 SYS_AIRFLOW—System Air Flow
19 System Energy
20 Virtual Machine CPU Count
21 Virtual Machine CPU Utilization
22 Virtual Machine CPU Average Utilization
23 Virtual Machine Mapped Power Consumption
24 Virtual Machine Mapped Energy Consumption
25 PDU Instant Power Consumption
26 PDU Energy Consumption
31 Average Overall CPU power consumption
32 Minimum Overall CPU power consumption
33 Maximum Overall CPU power consumption
34 Average Overall memory power consumption
35 Minimum Overall memory power consumption
36 Maximum Overall memory power consumption
37 Average System Usage Percent
38 Minimum System Usage Percent
39 Maximum System Usage Percent
43 Minimum fan power consumption
44 Average fan power consumption
45 Maximum fan power consumption
49 Minimum Storage power consumption
50 Average Storage power consumption
51 Maximum Storage power consumption
52 Minimum FPGA power consumption
53 Average FPGA power consumption
54 Maximum FPGA power consumption
Duration
0 Recent
1 One hour
2 Six hours
3 Twelve hours
4 One day
5 Seven Days
6 One Month
7 Three Months
8 Six Months
9 One Year
Sort Order
0 Descending
1 Ascending

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: <>()\