PowerSubsystem

PowerSubsystem 1.1.3⁠


Version	v1.1
Release	2021.2

Description⁠

This PowerSubsystem schema contains the definition for the power subsystem of a chassis.

URIs⁠

/redfish/v1/Chassis/{ChassisId}/PowerSubsystem

Properties⁠

Property	Type	Attributes	Notes
Actions {}	object		The available actions for this resource.
Allocation {	object		Power allocation for this subsystem when it represents a subset of the power infrastructure for the chassis or its upstream chassis, such as a chassis containing multiple server blades.
AllocatedWatts	number (W)	read-only (null)	The total amount of power that has been allocated or budgeted to this subsystem.
RequestedWatts	number (W)	read-only (null)	The potential power, in watt units, that the subsystem requests, which might be higher than the current level being consumed because the requested power includes a budget that the subsystem wants for future use.
}
Batteries (v1.1+) {	object		The link to the collection of batteries within this subsystem.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
CapacityWatts	number (W)	read-only (null)	The total amount of power that can be allocated to this subsystem. This value can be either the power supply capacity or the power budget that an upstream chassis assigns to this subsystem.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PowerSupplies {	object		The link to the collection of power supplies within this subsystem.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
PowerSupplyRedundancy [ { } ]	array (object)		The redundancy information for the set of power supplies in this subsystem. See the v1_7_0.v1_7_0 schema for details on this property.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.

Example response⁠

{
    "@odata.type": "#PowerSubsystem.v1_1_3.PowerSubsystem",
    "Id": "PowerSubsystem",
    "Name": "Power Subsystem for Chassis",
    "CapacityWatts": 2000,
    "Allocation": {
        "RequestedWatts": 1500,
        "AllocatedWatts": 1200
    },
    "PowerSupplyRedundancy": [
        {
            "RedundancyType": "Failover",
            "MaxSupportedInGroup": 2,
            "MinNeededInGroup": 1,
            "RedundancyGroup": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay2"
                }
            ],
            "Status": {
                "State": "UnavailableOffline",
                "Health": "OK"
            }
        }
    ],
    "PowerSupplies": {
        "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies"
    },
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem"
}

PowerSupply 1.6.0⁠


Version	v1.6
Release	2024.1

Description⁠

The PowerSupply schema describes a power supply unit. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if a unit is not present.

URIs⁠

/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies/{PowerSupplyId} (deprecated)

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#PowerSupply.Reset {}	object		This action resets the power supply. For more information, see the Actions section below.
}
Assembly {}	object		The link to the assembly associated with this power supply.
Certificates (v1.6+) {}	object		The link to a collection of certificates for device identity and attestation.
EfficiencyRatings [ {	array		The efficiency ratings of this power supply.
EfficiencyPercent	number (%)	read-only (null)	The rated efficiency of this power supply at the specified load.
LoadPercent	number (%)	read-only (null)	The electrical load for this rating.
} ]
ElectricalSourceManagerURIs (v1.2+) [ ]	array (URI) (string, null)	read-write	The URIs of the management interfaces for the upstream electrical source connections for this power supply.
ElectricalSourceNames (v1.2+) [ ]	array (string, null)	read-write	The names of the upstream electrical sources, such as circuits or outlets, connected to this power supply.
FirmwareVersion	string	read-only (null)	The firmware version for this power supply.
HotPluggable	boolean	read-only (null)	An indication of whether this device can be inserted or removed while the equipment is in operation.
InputNominalVoltageType	string (enum)	read-only (null)	The nominal voltage type that is detected on the line input to this power supply. For the possible property values, see InputNominalVoltageType in Property details.
InputRanges [ {	array		The input ranges that the power supply can use.
CapacityWatts	number (W)	read-only (null)	The maximum capacity of this power supply when operating in this input range.
NominalVoltageType	string (enum)	read-only (null)	The input voltage range. For the possible property values, see NominalVoltageType in Property details.
} ]
LineInputStatus (v1.3+)	string (enum)	read-only (null)	The status of the line input. For the possible property values, see LineInputStatus in Property details.
Links {	object		The links to other resources that are related to this resource.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Outlet (deprecated v1.4) {}	object		A link to the outlet connected to this power supply. Deprecated in v1.4 and later. This property has been deprecated in favor of the `PowerOutlets` property to allow for consistent modeling of power supplies with multiple outlet support.
PoweringChassis (v1.4+) [ {	array		An array of links to the chassis that are directly powered by this power supply.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PowerOutlets (v1.2+) [ {	array		An array of links to the outlets that provide power to this power supply.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Location {}	object		The location of the power supply. See the v1_23_0.v1_23_0 schema for details on this property.
LocationIndicatorActive	boolean	read-write (null)	An indicator allowing an operator to physically locate this resource.
Manufacturer	string	read-only (null)	The manufacturer of this power supply.
Metrics {}	object		The link to the power supply metrics resource associated with this power supply.
Model	string	read-only (null)	The model number for this power supply.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OutputNominalVoltageType (v1.5+)	string (enum)	read-only (null)	The nominal output voltage type of this power supply. For the possible property values, see OutputNominalVoltageType in Property details.
OutputRails [ {	array		The output power rails provided by this power supply.
NominalVoltage	number	read-only (null)	The nominal voltage of this output power rail.
PhysicalContext	string (enum)	read-only	The area or device to which this power rail applies. For the possible property values, see PhysicalContext in Property details.
} ]
PartNumber	string	read-only (null)	The part number for this power supply.
PhaseWiringType	string (enum)	read-only (null)	The number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires) provided for the power supply input connector. For the possible property values, see PhaseWiringType in Property details.
PlugType	string (enum)	read-only (null)	The type of plug according to NEMA, IEC, or regional standards. For the possible property values, see PlugType in Property details.
PowerCapacityWatts	number (W)	read-only (null)	The maximum capacity of this power supply.
PowerSupplyType	string (enum)	read-only (null)	The power supply type (AC or DC). For the possible property values, see PowerSupplyType in Property details.
ProductionDate (v1.1+)	string (date-time)	read-only (null)	The production or manufacturing date of this power supply.
Replaceable (v1.5+)	boolean	read-only (null)	An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.
SerialNumber	string	read-only (null)	The serial number for this power supply.
SparePartNumber	string	read-only (null)	The spare part number for this power supply.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
Version (v1.1+)	string	read-only (null)	The hardware version of this power supply.

Actions⁠

Reset⁠

Description

This action resets the power supply.

Action URI

{Base URI of target resource}/Actions/PowerSupply.Reset

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	optional	The type of reset. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "ForceRestart"
}

Property details⁠

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

InputNominalVoltageType⁠

The nominal voltage type that is detected on the line input to this power supply.

string	Description
AC100To127V	AC 100-127V nominal.
AC100To240V	AC 100-240V nominal.
AC100To277V	AC 100-277V nominal.
AC120V	AC 120V nominal.
AC200To240V	AC 200-240V nominal.
AC200To277V	AC 200-277V nominal.
AC208V	AC 208V nominal.
AC230V	AC 230V nominal.
AC240AndDC380V	AC 200-240V and DC 380V.
AC240V	AC 240V nominal.
AC277AndDC380V	AC 200-277V and DC 380V.
AC277V	AC 277V nominal.
AC400V	AC 400V or 415V nominal.
AC480V	AC 480V nominal.
DC12V	DC 12V nominal.
DC16V	DC 16V nominal.
DC1_8V	DC 1.8V nominal.
DC240V	DC 240V nominal.
DC380V	DC 380V nominal.
DC3_3V	DC 3.3V nominal.
DC400V	DC 400V nominal.
DC48V	DC 48V nominal.
DC5V	DC 5V nominal.
DC800V	DC 800V nominal.
DC9V	DC 9V nominal.
DCNeg48V	-48V DC.

LineInputStatus⁠

The status of the line input.

string	Description
LossOfInput	No power detected at line input.
Normal	Line input is within normal operating range.
OutOfRange	Line input voltage or current is outside of normal operating range.

NominalVoltageType⁠

The input voltage range.

string	Description
AC100To127V	AC 100-127V nominal.
AC100To240V	AC 100-240V nominal.
AC100To277V	AC 100-277V nominal.
AC120V	AC 120V nominal.
AC200To240V	AC 200-240V nominal.
AC200To277V	AC 200-277V nominal.
AC208V	AC 208V nominal.
AC230V	AC 230V nominal.
AC240AndDC380V	AC 200-240V and DC 380V.
AC240V	AC 240V nominal.
AC277AndDC380V	AC 200-277V and DC 380V.
AC277V	AC 277V nominal.
AC400V	AC 400V or 415V nominal.
AC480V	AC 480V nominal.
DC12V	DC 12V nominal.
DC16V	DC 16V nominal.
DC1_8V	DC 1.8V nominal.
DC240V	DC 240V nominal.
DC380V	DC 380V nominal.
DC3_3V	DC 3.3V nominal.
DC400V	DC 400V nominal.
DC48V	DC 48V nominal.
DC5V	DC 5V nominal.
DC800V	DC 800V nominal.
DC9V	DC 9V nominal.
DCNeg48V	-48V DC.

OutputNominalVoltageType⁠

The nominal output voltage type of this power supply.

string	Description
AC100To127V	AC 100-127V nominal.
AC100To240V	AC 100-240V nominal.
AC100To277V	AC 100-277V nominal.
AC120V	AC 120V nominal.
AC200To240V	AC 200-240V nominal.
AC200To277V	AC 200-277V nominal.
AC208V	AC 208V nominal.
AC230V	AC 230V nominal.
AC240AndDC380V	AC 200-240V and DC 380V.
AC240V	AC 240V nominal.
AC277AndDC380V	AC 200-277V and DC 380V.
AC277V	AC 277V nominal.
AC400V	AC 400V or 415V nominal.
AC480V	AC 480V nominal.
DC12V	DC 12V nominal.
DC16V	DC 16V nominal.
DC1_8V	DC 1.8V nominal.
DC240V	DC 240V nominal.
DC380V	DC 380V nominal.
DC3_3V	DC 3.3V nominal.
DC400V	DC 400V nominal.
DC48V	DC 48V nominal.
DC5V	DC 5V nominal.
DC800V	DC 800V nominal.
DC9V	DC 9V nominal.
DCNeg48V	-48V DC.

PhaseWiringType⁠

The number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires) provided for the power supply input connector.

string	Description
OneOrTwoPhase3Wire	Single or two-phase / 3-wire (Line1, Line2 or Neutral, Protective Earth).
OnePhase3Wire	Single-phase / 3-wire (Line1, Neutral, Protective Earth).
ThreePhase4Wire	Three-phase / 4-wire (Line1, Line2, Line3, Protective Earth).
ThreePhase5Wire	Three-phase / 5-wire (Line1, Line2, Line3, Neutral, Protective Earth).
TwoPhase3Wire	Two-phase / 3-wire (Line1, Line2, Protective Earth).
TwoPhase4Wire	Two-phase / 4-wire (Line1, Line2, Neutral, Protective Earth).

PhysicalContext⁠

The area or device to which this power rail applies.

string	Description
Accelerator	An accelerator.
ACInput	An AC electrical input or input-related circuit.
ACMaintenanceBypassInput	An AC electrical maintenance bypass input.
ACOutput	An AC electrical output or output-related circuit.
ACStaticBypassInput	An AC electrical static bypass input.
ACUtilityInput	An AC electrical utility input.
ASIC	An ASIC device, such as a networking chip or chipset component.
Back	The back of the chassis.
Backplane	A backplane within the chassis.
Battery	A battery.
Board	A circuit board.
Chassis	The entire chassis.
ComputeBay	A compute bay.
CoolingSubsystem	The entire cooling, or air and liquid, subsystem.
CPU	A processor (CPU).
CPUSubsystem	The entire processor (CPU) subsystem.
DCBus	A DC electrical bus.
Exhaust	The air exhaust point or points or region of the chassis.
ExpansionBay	An expansion bay.
ExpansionSubsystem	A group of expansion bays.
Fan	A fan.
Filter	A filter.
FPGA	An FPGA.
Front	The front of the chassis.
GPU	A graphics processor (GPU).
GPUSubsystem	The entire graphics processor (GPU) subsystem.
Intake	The air intake point or points or region of the chassis.
LiquidInlet	The liquid inlet point of the chassis.
LiquidOutlet	The liquid outlet point of the chassis.
Lower	The lower portion of the chassis.
Manager	A management controller, such as a BMC (baseboard management controller).
Memory	A memory device.
MemorySubsystem	The entire memory subsystem.
Motor	A motor.
NetworkBay	A networking bay.
NetworkingDevice	A networking device.
PowerOutlet	An electrical outlet.
PowerSubsystem	The entire power subsystem.
PowerSupply	A power supply.
PowerSupplyBay	A power supply bay.
Pump	A pump.
Rectifier	A rectifier device.
Reservoir	A reservoir.
Room	The room.
StorageBay	A storage bay.
StorageDevice	A storage device.
StorageSubsystem	A storage subsystem.
Switch	A switch device.
SystemBoard	The system board (PCB).
Transceiver	A transceiver.
Transformer	A transformer.
TrustedModule	A trusted module.
Upper	The upper portion of the chassis.
VoltageRegulator	A voltage regulator device.

PlugType⁠

The type of plug according to NEMA, IEC, or regional standards.

string	Description
California_CS8265	California Standard CS8265 (Single-phase 250V; 50A; 2P3W).
California_CS8365	California Standard CS8365 (Three-phase 250V; 50A; 3P4W).
Field_208V_3P4W_60A	Field-wired; Three-phase 200-250V; 60A; 3P4W.
Field_400V_3P5W_32A	Field-wired; Three-phase 200-240/346-415V; 32A; 3P5W.
IEC_60309_316P6	IEC 60309 316P6 (Single-phase 200-250V; 16A; 1P3W; Blue, 6-hour).
IEC_60309_332P6	IEC 60309 332P6 (Single-phase 200-250V; 32A; 1P3W; Blue, 6-hour).
IEC_60309_363P6	IEC 60309 363P6 (Single-phase 200-250V; 63A; 1P3W; Blue, 6-hour).
IEC_60309_460P9	IEC 60309 460P9 (Three-phase 200-250V; 60A; 3P4W; Blue; 9-hour).
IEC_60309_516P6	IEC 60309 516P6 (Three-phase 200-240/346-415V; 16A; 3P5W; Red; 6-hour).
IEC_60309_532P6	IEC 60309 532P6 (Three-phase 200-240/346-415V; 32A; 3P5W; Red; 6-hour).
IEC_60309_560P9	IEC 60309 560P9 (Three-phase 120-144/208-250V; 60A; 3P5W; Blue; 9-hour).
IEC_60309_563P6	IEC 60309 563P6 (Three-phase 200-240/346-415V; 63A; 3P5W; Red; 6-hour).
IEC_60320_C14	IEC C14 (Single-phase 250V; 10A; 1P3W).
IEC_60320_C20	IEC C20 (Single-phase 250V; 16A; 1P3W).
NEMA_5_15P	NEMA 5-15P (Single-phase 125V; 15A; 1P3W).
NEMA_5_20P	NEMA 5-20P (Single-phase 125V; 20A; 1P3W).
NEMA_6_15P	NEMA 6-15P (Single-phase 250V; 15A; 2P3W).
NEMA_6_20P	NEMA 6-20P (Single-phase 250V; 20A; 2P3W).
NEMA_L14_20P	NEMA L14-20P (Split-phase 125/250V; 20A; 2P4W).
NEMA_L14_30P	NEMA L14-30P (Split-phase 125/250V; 30A; 2P4W).
NEMA_L15_20P	NEMA L15-20P (Three-phase 250V; 20A; 3P4W).
NEMA_L15_30P	NEMA L15-30P (Three-phase 250V; 30A; 3P4W).
NEMA_L21_20P	NEMA L21-20P (Three-phase 120/208V; 20A; 3P5W).
NEMA_L21_30P	NEMA L21-30P (Three-phase 120/208V; 30A; 3P5W).
NEMA_L22_20P	NEMA L22-20P (Three-phase 277/480V; 20A; 3P5W).
NEMA_L22_30P	NEMA L22-30P (Three-phase 277/480V; 30A; 3P5W).
NEMA_L5_15P	NEMA L5-15P (Single-phase 125V; 15A; 1P3W).
NEMA_L5_20P	NEMA L5-20P (Single-phase 125V; 20A; 1P3W).
NEMA_L5_30P	NEMA L5-30P (Single-phase 125V; 30A; 1P3W).
NEMA_L6_15P	NEMA L6-15P (Single-phase 250V; 15A; 2P3W).
NEMA_L6_20P	NEMA L6-20P (Single-phase 250V; 20A; 2P3W).
NEMA_L6_30P	NEMA L6-30P (Single-phase 250V; 30A; 2P3W).

PowerSupplyType⁠

The power supply type (AC or DC).

string	Description
AC	Alternating Current (AC) power supply.
ACorDC	The power supply supports both DC and AC.
DC	Direct Current (DC) power supply.
DCRegulator (v1.5+)	Direct Current (DC) voltage regulator.

ResetType⁠

The type of reset.

string	Description
ForceOff	Turn off the unit immediately (non-graceful shutdown).
ForceOn	Turn on the unit immediately.
ForceRestart	Shut down immediately and non-gracefully and restart the unit.
FullPowerCycle	Full power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource.
GracefulRestart	Shut down gracefully and restart the unit.
GracefulShutdown	Shut down gracefully and power off.
Nmi	Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On	Turn on the unit.
Pause	Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
PowerCycle	Power cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource.
PushPowerButton	Simulate the pressing of the physical power button on this unit.
Resume	Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
Suspend	Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.

Example response⁠

{
    "@odata.type": "#PowerSupply.v1_6_0.PowerSupply",
    "Id": "Bay1",
    "Name": "Power Supply Bay 1",
    "Status": {
        "State": "Enabled",
        "Health": "Warning"
    },
    "LineInputStatus": "Normal",
    "Model": "RKS-440DC",
    "Manufacturer": "Contoso Power",
    "FirmwareVersion": "1.00",
    "SerialNumber": "3488247",
    "PartNumber": "23456-133",
    "SparePartNumber": "93284-133",
    "LocationIndicatorActive": false,
    "HotPluggable": false,
    "PowerCapacityWatts": 400,
    "PhaseWiringType": "OnePhase3Wire",
    "PlugType": "IEC_60320_C14",
    "InputRanges": [
        {
            "NominalVoltageType": "AC200To240V",
            "CapacityWatts": 400
        },
        {
            "NominalVoltageType": "AC120V",
            "CapacityWatts": 350
        },
        {
            "NominalVoltageType": "DC380V",
            "CapacityWatts": 400
        }
    ],
    "EfficiencyRatings": [
        {
            "LoadPercent": 25,
            "EfficiencyPercent": 75
        },
        {
            "LoadPercent": 50,
            "EfficiencyPercent": 85
        },
        {
            "LoadPercent": 90,
            "EfficiencyPercent": 80
        }
    ],
    "OutputRails": [
        {
            "NominalVoltage": 3.3,
            "PhysicalContext": "SystemBoard"
        },
        {
            "NominalVoltage": 5,
            "PhysicalContext": "SystemBoard"
        },
        {
            "NominalVoltage": 12,
            "PhysicalContext": "StorageDevice"
        }
    ],
    "Location": {
        "PartLocation": {
            "ServiceLabel": "PSU 1",
            "LocationType": "Bay",
            "LocationOrdinalValue": 0
        }
    },
    "Links": {
        "Outlet": {
            "@odata.id": "https://redfishpdu.contoso.com/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A4"
        }
    },
    "Assembly": {
        "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/Assembly"
    },
    "Metrics": {
        "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/Metrics"
    },
    "Actions": {
        "#PowerSupply.Reset": {
            "target": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/PowerSupply.Reset"
        }
    },
    "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1"
}

PowerSubsystem 1.1.3⁠​

Description⁠​

URIs⁠​

Properties⁠​

Example response⁠​

PowerSupply 1.6.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

Reset⁠​

Property details⁠​

idRef⁠​

InputNominalVoltageType⁠​

LineInputStatus⁠​

NominalVoltageType⁠​

OutputNominalVoltageType⁠​

PhaseWiringType⁠​

PhysicalContext⁠​

PlugType⁠​

PowerSupplyType⁠​

ResetType⁠​

Example response⁠​

PowerSubsystem 1.1.3⁠

Description⁠

URIs⁠

Properties⁠

Example response⁠

PowerSupply 1.6.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

Reset⁠

Property details⁠

idRef⁠

InputNominalVoltageType⁠

LineInputStatus⁠

NominalVoltageType⁠

OutputNominalVoltageType⁠

PhaseWiringType⁠

PhysicalContext⁠

PlugType⁠

PowerSupplyType⁠

ResetType⁠

Example response⁠