iLO 4 REST API Data Model (PowerMetrics Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki
See Resource Map for more details.
"PowerMetrics" defines the following properties:
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)Sets the length of time, in minutes, that power consumption must remain above the warning threshold before an SNMP alert is triggered. The maximum duration is 240 minutes, and the duration must be a multiple of 5.
JSON type:
Integer
from 0 to 240.
| GET | Rendered if supported by the implementation or omitted if not. |
| PATCH | This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. |
HTTP PATCH to resource with request JSON:
{"Oem": {"Hp": {"SNMPPowerThresholdAlert": {"DurationInMin": <integer-value>}}}}
The property "Oem/Hp/SNMPPowerThresholdAlert/DurationInMin" on resource type PowerMetrics may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
Sets the power consumption threshold (watts). If power consumption exceeds this value for the specified time duration, an SNMP alert is triggered.
JSON type:
Integer
| GET | Rendered if supported by the implementation or omitted if not. |
| PATCH | This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. |
HTTP PATCH to resource with request JSON:
{"Oem": {"Hp": {"SNMPPowerThresholdAlert": {"ThresholdWatts": <integer-value>}}}}
The property "Oem/Hp/SNMPPowerThresholdAlert/ThresholdWatts" on resource type PowerMetrics may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
Trigger determines whether alerts are based on peak power consumption, average power consumption, or if they are disabled. Trigger property can only be enabled if the ThresholdWatts and DurationInMin values are specified/configured.
JSON type:
String containing one of the following supported values:
"Disabled"
"AveragePowerConsumption"
"PeakPowerConsumption"
| GET | Rendered if supported by the implementation or omitted if not. |
| PATCH | This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. |
HTTP PATCH to resource with request JSON:
{"Oem": {"Hp": {"SNMPPowerThresholdAlert": {"Trigger": "AveragePowerConsumption"}}}}
The property "Oem/Hp/SNMPPowerThresholdAlert/Trigger" on resource type PowerMetrics may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
The total power (Watts) allocated to the chassis.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Amount of power (Watts) not already budgeted and therefore available for additional allocation. (PowerCapacity - PowerAllocated). This indicates how much reserve power capacity is left.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The total power (Watts) available to the chassis from all power supplies (adjusting for redundancy settings).
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The latest observed power (Watts) being drawn by this chassis. The update interval may vary depending upon implementation but is usually measured in seconds.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Time in milliseconds that it takes for the limiting process to react and correct the power consumption below the limit.
JSON type:
Integer
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The value of this property shall represent a reference to the resource that is being limited.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Action that is taken if the power cannot be maintained below the LimitInWatts.
JSON type:
String containing one of the following supported values:
"NoAction"
"HardPowerOff"
"LogEventOnly"
"Oem"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
| PATCH | This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. |
HTTP PATCH to resource with request JSON:
{"PowerLimit": {"LimitException": "LogEventOnly"}}
The property "PowerLimit/LimitException" on resource type PowerMetrics may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
The Power (Watts) limit (also known as 'Power Cap'). Set to null to disable the power cap.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
| PATCH | This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. |
HTTP PATCH to resource with request JSON:
{"PowerLimit": {"LimitInWatts": <integer-value>}}
The property "PowerLimit/LimitInWatts" on resource type PowerMetrics may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
The average power consumed during the interval specified by 'IntervalInMin'.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The interval between power metric evaluation in minutes.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The maximum power consumed during the interval specified by 'IntervalInMin'.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The minimum power consumed during the interval specified by 'IntervalInMin'.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Potential power (Watts) that the chassis is requesting that might be higher than the current level being consumed. This is because the requested power includes budget that the chassis has reserved for future use.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This property is a member of PowerMetrics
CorrelatableID for this power supply.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The power supply firmware version.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The average power (Watts) consumed.
JSON type:
Integer
greater than or equal to 0.
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Line input voltage at which the power supply is operating at this moment (in Volts).
JSON type:
Integer
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This property is a member of PowerMetrics
Line voltage type: ACLowLine, ACMidLine, ACHighLine, DCNeg48V, DC420V, or Unknown.
JSON type:
String containing one of the following supported values:
|
"Unknown"
"ACLowLine"
"ACMidLine"
"ACHighLine"
"DCNeg48V"
"HighVoltageDC"
The power supply model name.
JSON type:
String
The latest observed average power being drawn by the power supply (Watts). This is usually updated every 10 seconds but the period can vary in some circumstances.
JSON type:
Integer
greater than or equal to 0.
The power supply bay number.
JSON type:
Integer
greater than or equal to 0.
If true, this power supply (and power supply bay) is capable of being hot-plugged.
JSON type:
Boolean ('true' or 'false')
The latest observed maximum output power being drawn by the power supply (Watts). This is usually updated every 10 seconds but the period can vary in some circumstances.
JSON type:
Integer
greater than or equal to 0.
If true, this power supply is mismatched with others in the system.
JSON type:
Boolean ('true' or 'false')
Indicates the known state of the resource.
JSON type:
String containing one of the following supported values:
"Unknown"
"Ok"
"Degraded"
"Failed"
"OverVoltage"
"OverCurrent"
"OverTemperature"
"ACPowerLost"
"FanFailure"
"WarningHighInputVoltage"
"WarningLowInputVoltage"
"WarningHighOutputVoltage"
"WarningLowOutputVoltage"
"WarningInletTemperature"
"WarningInternalTemperature"
"WarningHighAuxiliaryVoltage"
"WarningLowAuxiliaryVoltage"
"PowerSupplyMismatch"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
The IP address of the iPDU connected to this power supply.
JSON type:
String
The Ethernet MAC address of the iPDU connected to this power supply.
JSON type:
String
The model number of the iPDU connected to this power supply.
JSON type:
String
The serial number of the iPDU connected to this power supply.
JSON type:
String
Indicates the known state of the resource.
JSON type:
String containing one of the following supported values:
"Unknown"
"Ok"
"Degraded"
"Failed"
"OverVoltage"
"OverCurrent"
"OverTemperature"
"ACPowerLost"
"FanFailure"
"WarningHighInputVoltage"
"WarningLowInputVoltage"
"WarningHighOutputVoltage"
"WarningLowOutputVoltage"
"WarningInletTemperature"
"WarningInternalTemperature"
"WarningHighAuxiliaryVoltage"
"WarningLowAuxiliaryVoltage"
"PowerSupplyMismatch"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
If true, this power supply is capable of being connected to an iPDUs.
JSON type:
Boolean ('true' or 'false')
The power supply part number.
JSON type:
String
The power capacity of the power supply, in Watts.
JSON type:
Integer
greater than or equal to 0.
The power supply type: AC, DC, or Unknown.
JSON type:
String containing one of the following supported values:
"Unknown"
"AC"
"DC"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
The power supply serial number.
JSON type:
String
The power supply spare part number.
JSON type:
String
Indicates the health state of this resource without considering its dependent resources.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
Indicates the overall health state of this resource and its dependent resources.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
Indicates the known state of this resource (for example, if the resource is enabled). Enabled indicates that the resource is available. Disabled indicates that the resource has been made unavailable intentionally, but it can be enabled. Offline indicates that the resource is unavailable intentionally and requires action to be made available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates that the resource is physically unavailable.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
Indicates the health state of this resource without considering its dependent resources.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
Indicates the overall health state of this resource and its dependent resources.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [PowerMetrics](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(PowerMetrics-Resource-Type)#hp-restful-api-data-model-reference-for-ilo-4redfish-10-conformance-cont)
Indicates the known state of this resource (for example, if the resource is enabled). Enabled indicates that the resource is available. Disabled indicates that the resource has been made unavailable intentionally, but it can be enabled. Offline indicates that the resource is unavailable intentionally and requires action to be made available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates that the resource is physically unavailable.
|