HP OneView REST API Reference

server-hardware
server-hardware.html[10/17/2013 10:35:23 AM]
Parameter Attributes Description
refresh Optional Specifies that if necessary an additional request will be queued to obtain the most recent utilization data from the
iLO. The response will not include any refreshed data. To track the availability of the newly collected data,
monitor the TaskResource identified by the refreshTaskUri property in the response. If null, no refresh was
queued.
view Optional Specifies the resolution interval length of the samples to be retrieved. This is reflected in the resolution in the
returned response. Utilization data is automatically purged to stay within storage space constraints. Supported
views are listed below.
native
Resolution of the samples returned will be one sample for each 5-minute time period. This is the default
view and matches the resolution of the data returned by the iLO. Samples at this resolution are retained
up to one year.
hour
Resolution of the samples returned will be one sample for each 60-minute time period. Samples are
calculated by averaging the available 5-minute data samples that occurred within the hour, except for
PeakPower which is calculated by reporting the peak observed 5-minute sample value data during the
hour. Samples at this resolution are retained up to three years.
day
Resolution of the samples returned will be one sample for each 24-hour time period. One day is a 24-
hour period that starts at midnight GMT regardless of the time zone in which the appliance or client is
located. Samples are calculated by averaging the available 5-minute data samples that occurred during
the day, except for PeakPower which is calculated by reporting the peak observed 5-minute sample
value data during the day. Samples at this resolution are retained up to three years.
fields Optional Name of the metric(s) to be retrieved in the format METRIC[,METRIC]... Server hardware supports the following
utilization metrics:
AmbientTemperature
Inlet air temperature in degrees Celsius during this sample interval.
AveragePower
Average power consumption in Watts during this sample interval.
PeakPower
Peak power consumption in Watts during this sample interval.
PowerCap
Dynamic power cap setting on the server hardware in Watts during this sample interval.
CpuUtilization
CPU utilization of all CPUs in percent during this sample interval.
CpuAverageFreq
Average CPU frequency in Mhz during this sample interval.
If unspecified, all metrics supported are returned.
filter Experimental Provides an expression of the requested time range of data. One condition (startDate/endDate) is specified
per filter specification as described below. The condition must be specified via the equals (=) operator.
startDate
Start date of requested starting time range in ISO 8601 format. If omitted, the startDate is determined
by the endDate minus 24 hours.
endDate
End date of requested starting time range in ISO 8601 format. When omitted the endDate includes the
latest data sample available.
If an excessive number of samples would otherwise be returned, the results will be segmented. The caller is
responsible for comparing the returned sliceStartTime with the requested startTime in the response. If the
sliceStartTime is greater than the oldestSampleTime and the requested start time, the caller is
responsible for repeating the request with endTime set to sliceStartTime to obtain the next segment. This
process is repeated until the full data set is retrieved.
If the resource has no data, the UtilizationData is still returned, but will contain no samples and
sliceStartTime/sliceEndTime will be equal. oldestSampleTime/newestSampleTime will still be set
appropriately (null if no data is available). If the filter just does not happen to overlap the data that a resource
does have, then the metric history service will return null sample values for any missing samples.
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-
Version:3"
Response Description
UtilizationData Utilization data requested for the specified server hardware
resource.