GET – Power
Request
GET https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}}/Power
Content-Type: application/json
Response
The response is a JSON object that contains the following parameters:
Name | Type | Read only | Description | |||
(OData Attributes) | Refer to OData Support | |||||
Oem | Object | Specifies the AMI-defined OEM properties. | ||||
Name | Type | Read only | Description | |||
@odata.type | String | True | Refer to OData Support | |||
OwnerLUN | Number | True |
| |||
Id(M) | String | True | Refer to Resource Type Definitions | |||
Name(M) | String | True | ||||
Description | String | True | ||||
PowerControl(N) | Array | True | This is the definition of power control function (power reading/limiting). See Power Control Properties. | |||
PowerControl@odata.count | Number | True | An integer representing the number of items in a collection | |||
Voltages(N) | Array | True | This is the definition of voltage sensors. See Voltages Properties. | |||
Voltages@odata.count | Number | True | An integer representing the number of items in a collection. | |||
PowerSupplies(N) | Array | True | Details of a power supplies associated with this system. See PowerSupply Properties. Note Northbound only properties. Platform-specific porting needed. | |||
PowerSupplies@odata.count | Number | True | An integer representing the number of items in a collection | |||
Redundancy(N)(C) | Array | True | Redundancy information for the power subsystem of this system. | |||
Redundancy@odata.count | Number | True | An integer representing the number of items in a collection | |||
Actions | Object | True | It contains Oem Object under Oem attribute under this Actions. | |||
Name | Type | Read only | Description | ||
Name(C) | String | True | Power Control Function name. | ||
MemberId | String | True | This is the identifier for the member within the collection. | ||
PowerConsumedWatts | Number | True | The actual power being consumed (in Watts) by the chassis. Minimum Value: 0. Note Northbound only properties. Platform-specific porting needed. | ||
PowerRequestedWatts | Number | True | The amount of power (in Watts) that the chassis resource is currently requesting be budgeted to it for future use. Minimum Value: 0. Note Northbound only properties. Platform-specific porting needed. | ||
PowerAvailableWatts | Number | True | The amount of power capacity (in Watts) not already allocated and shall equal PowerCapacityWatts -PowerAllocatedWatts. Minimum Value: 0. Note Northbound only properties. Platform-specific porting needed. | ||
PowerCapacityWatts | Number | True | The total power capacity that is available for allocation to the chassis resources. Minimum Value: 0. Note Northbound only properties. Platform-specific porting needed.Northbound only properties. Platform-specific porting needed. | ||
PowerAllocatedWatts | Number | True | The total power currently allocated to chassis resources. Minimum Value: 0. Note Northbound only properties. Platform-specific porting needed. | ||
PowerMetrics | Object | True | Power readings for this chassis. Note DCMI should be supported in the platform and BMC. | ||
Attribute | Type | Description | |||
IntervalInMin | Number | The time interval (or window) in which the PowerMetrics are measured. Minimum Value: 0 Note The unit of IntervalInMin is Minute. | |||
MinConsumedWatts | Number | The lowest power consumption level over the measurement window (the last IntervalInMin minutes). Minimum Value:0 | |||
MaxConsumedWatts | Number | The highest power consumption level that has occurred over the measurement window (the last IntervalInMin minutes). Minimum Value:0 | |||
AverageConsumedWatts | Number | The average power level over the measurement window (the last IntervalInMin minutes). Minimum Value:0 | |||
PowerLimit | Object | False | Power limit status and configuration information for this chassis. | ||
Attribute | Type | Description | |||
| LimitInWatts | Number | The Power limit in watts. Minimum Value:0. | |||
| LimitException | String | The action that is taken if the power cannot be maintained below the LimitInWatts. Refer to Chassis Power Limit Exception Enum Properties. | |||
| CorrectionInMs | Number | The time required for the limiting process to reduce power consumption to below the limit. | |||
RelatedItem(C) | Array | True | The ID(s) of the resources associated with this Power Limit | ||
PhysicalContext(C) | Object | True | The value of this property shall be a description of the affected device or region within the chassis to which this voltage measurement applies. | ||
Enum | Description |
NoAction | Take no action when the limit is exceeded. |
HardPowerOff | Turn the power off immediately when the limit is exceeded. |
LogEventOnly | Log an event when the limit is exceeded but take no further action. |
Oem | Take an OEM-defined action. |
Name | Type | Read only | Description |
Name(C) | String | True | The name of the Voltage sensor. |
MemberId | String | True | This property shall uniquely identify the member within the collection. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index. Note The"@odata.id" identifier for the Voltage Sensor shall start with 0 and "MemebrId" property shall have the same value as the identifier. |
SensorNumber(C) | Number | True | A numerical identifier for this voltage sensor which is unique within this resource. |
Status | Object | True | Refer to Resource Properties for Resource Oem. |
ReadingVolts | Number | True | The current value of the voltage sensor. |
UpperThresholdNonCritical(C) | Number | True | The current reading is above the normal range but is not critical. Units shall use the same units as the related ReadingVolts property |
UpperThresholdCritical(C) | Number | True | The current reading is above the normal range but is not yet Fatal. Units shall use the same units as the related ReadingVolts property |
UpperThresholdFatal(C) | Number | True | The value of this property shall indicate the CurrentReading is above the normal range and is fatal. Units shall use the same units as the related ReadingVolts property. |
LowerThresholdNonCritical(C) | Number | True | The current reading is below the normal range but is not critical. Units shall use the same units as the related ReadingVolts property |
LowerThresholdCritical(C) | Number | True | The current reading is below the normal range but is not ye fatal. Units shall use the same units as the related ReadingVolts property |
LowerThresholdFatal(C) | Number | True | The value of this property shall indicate the CurrentReadin is below the normal range and is fatal. Units shall use the same units as the related ReadingVolts property. |
MinReadingRange | Number | True | The lowest possible value for CurrentReading. Units shall use the same units as the related ReadingVolts property. |
MaxReadingRange | Number | True | The highest possible value for CurrentReading. Units shall use the same units as the related ReadingVolts property. |
PhysicalContext(C) | Object | True | The affected device or region within the chassis to which this voltage measurement applies. |
RelatedItem(C) | Array | True | The ID(s) of the resources associated with this Power Limit |
OwnerLUN | Number | True | This is an OEM attribute and is a specific implementation o AMI. This attribute is used in combination with SensorNumberattribute to display the Sensors under the MetricPropertiesattribute under Telemetry Service MetricDefinitions URI. This attribute can be used to differentiate sensors with identical Sensor numbers but different LUN numbers. |
Name | Type | Read only | Description | |||
Name(C) | String | True | The name of the PowerSupply. | |||
MemberId | String | True | This is the identifier for the member within the collection. | |||
PowerSupplyType(C) | String | True | The Power Supply type (AC or DC) | |||
Enum | Description | |||||
Unknown | The power supply type cannot be determined. | |||||
AC | Alternating Current (AC) power supply. | |||||
DC | Direct Current (DC) power supply. | |||||
ACorDC | Power Supply supports both DC and AC. | |||||
LineInputVoltageType(C) | String | True | The LineInputVoltage at which the power supply is operating. | |||
Enum | Description | |||||
Unknown | The power supply line input voltage type cannot be determined. | |||||
ACLowLine | 100-127V AC input. Deprecated: Use AC120V. | |||||
ACMidLine | 200-240V AC input. Deprecated: Use AC240V | |||||
ACHighLine | 277V AC input. Deprecated: Use AC277V. | |||||
DCNeg48V | -48V DC input. | |||||
DC380V | High Voltage DC input (380V) | |||||
AC120V | AC 120V nominal input. | |||||
AC240V | AC 240V nominal input. | |||||
AC277V | AC 277V nominal input | |||||
ACandDCWid eRange | Wide range AC or DC input. | |||||
ACWideRange | Wide range AC input. | |||||
DC240V | DC 240V nominal input. | |||||
LineInputVoltage(C) | Number | True | The line input voltage at which the Power Supply is operating. | |||
PowerCapacityWatts | Number | True | The maximum capacity of this Power Supply. Minimum Value:0. | |||
LastPowerOutputWatts | Number | True | The average power output of this Power Supply (in Watts). Minimum Value:0. | |||
Model(C) | String | True | The model number for this Power Supply. | |||
FirmwareVersion | String | True | The firmware version for this Power Supply. | |||
SerialNumber | String | True | The serial number for this Power Supply | |||
PartNumber(C) | String | True | The part number for this Power Supply. | |||
SparePartNumber(C) | String | True | The spare part number for this Power Supply. | |||
Status | Object | True | Refer to Resource Properties. | |||
Location(M) | Array | True | See Chassis Properties for Resource Oem. | |||
PowerInputWatts | Number | True | This property shall contain the value of the measured input power, in Watts, of the associated power supply. | |||
PowerOutputWatts | Number | True | This property shall contain the value of the measured output power, in Watts, of the associated power supply. | |||
EfficiencyPercent | Number | True | This property shall contain the value of the measured power efficiency, as a percentage, of the associated power supply. | |||
HotPluggable | Boolean | True | The value of this property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operations that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable. | |||
RelatedItem(C) | Array | True | The ID(s) of the resources associated with this Power Limit | |||
Redundancy(C) | Array | True | This structure is used to show redundancy for power supplies. The Component ids will reference the members of the redundancy groups. | |||
Oem | Object | True | This is an OEM property of Lenovo extended objects for power supply. Property for Lenovo as showed below. | |||
Name | Type | Read Only | Description | |||
ManufactureDate | String | True | Manufacturer date of Power Supply | |||
ManufacturerName | String | True | Manufacturer Name/Id of Power Supply | |||