Chassis

ActionInfo 1.4.2⁠

 

Version	v1.4
Release	2023.2

Description⁠

The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among resource instances. This data can ensure that action requests from applications contain supported parameters.

Properties⁠

Property	Type	Attributes	Notes
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Parameters [ {	array		The list of parameters included in the specified Redfish action.
AllowableNumbers (v1.3+) [ ]	array (string, null)	read-only	The allowable numeric values or duration values, inclusive ranges of values, and incremental step values for this parameter as applied to this action target.
AllowablePattern (v1.3+)	string	read-only (null)	The allowable pattern for this parameter as applied to this action target.
AllowableValueDescriptions (v1.4+) [ ]	array (string, null)	read-only	Descriptions of allowable values for this parameter.
AllowableValues [ ]	array (string, null)	read-only	The allowable values for this parameter as applied to this action target.
ArraySizeMaximum (v1.2+)	integer	read-only (null)	The maximum number of array elements allowed for this parameter.
ArraySizeMinimum (v1.2+)	integer	read-only (null)	The minimum number of array elements required for this parameter.
DataType	string (enum)	read-only (null)	The JSON property type for this parameter. For the possible property values, see DataType in Property details.
MaximumValue (v1.1+)	number	read-only (null)	The maximum supported value for this parameter.
MinimumValue (v1.1+)	number	read-only (null)	The minimum supported value for this parameter.
Name	string	read-only required	The name of the parameter for this action.
ObjectDataType	string	read-only (null)	The data type of an object-based parameter.
Required	boolean	read-only	An indication of whether the parameter is required to complete this action.
} ]

Property details⁠

DataType⁠

 

The JSON property type for this parameter.

string	Description
Boolean	A boolean.
Number	A number.
NumberArray	An array of numbers.
Object	An embedded JSON object.
ObjectArray	An array of JSON objects.
String	A string.
StringArray	An array of strings.

Example response⁠

{
    "@odata.type": "#ActionInfo.v1_5_0.ActionInfo",
    "Id": "ResetActionInfo",
    "Name": "Reset Action Info",
    "Parameters": [
        {
            "Name": "ResetType",
            "Required": true,
            "DataType": "String",
            "AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        }
    ],
    "@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}

Chassis 1.27.0⁠

 

Version	v1.27
Release	2025.2

Description⁠

The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system. 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}

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#Chassis.Reset {}	object		This action resets the chassis. Additionally, it could reset systems or other contained resources depending on the ResetType used to invoke this action. For more information, see the Actions section below.
}
Assembly (v1.6+) {}	object		The link to the assembly associated with this chassis.
AssetTag	string	read-write (null)	The user-assigned asset tag of this chassis.
Certificates (v1.15+) {}	object		The link to a collection of certificates for device identity and attestation.
ChassisType	string (enum)	read-only required	The type of physical form factor of the chassis. For the possible property values, see ChassisType in Property details.
Controls (v1.17+) {}	object		The link to the collection of controls located in this chassis.
DepthMm (v1.4+)	number (mm)	read-only (null)	The depth of the chassis.
Doors (v1.24+) {	object		The doors or access panels of the chassis.
Front (v1.24+) {	object	(null)	The front door of the chassis.
DoorState (v1.24+)	string (enum)	read-only (null)	The state of the door. For the possible property values, see DoorState in Property details.
Locked (v1.24+)	boolean	read-write (null)	Indicates if the door is locked.
UserLabel (v1.24+)	string	read-write	A user-assigned label.
}
Rear (v1.24+) {	object	(null)	The rear door of the chassis.
DoorState (v1.24+)	string (enum)	read-only (null)	The state of the door. For the possible property values, see DoorState in Property details.
Locked (v1.24+)	boolean	read-write (null)	Indicates if the door is locked.
UserLabel (v1.24+)	string	read-write	A user-assigned label.
}
}
Drives (v1.14+) {}	object		The link to the collection of drives within this chassis.
ElectricalSourceManagerURIs (v1.18+) [ ]	array (URI) (string, null)	read-write	The URIs of the management interfaces for the external electrical source connections for this chassis.
ElectricalSourceNames (v1.18+) [ ]	array (string, null)	read-write	The names of the external electrical sources, such as circuits or outlets, connected to this chassis.
EnvironmentalClass (v1.9+)	string (enum)	read-write (null)	The ASHRAE Environmental Class for this chassis. For the possible property values, see EnvironmentalClass in Property details.
EnvironmentMetrics (v1.15+) {}	object		The link to the environment metrics for this chassis.
FabricAdapters (v1.20+) {}	object		The link to the collection of fabric adapters located in this chassis that provide access to fabric-related resource pools.
HeatingCoolingEquipmentNames (v1.25+) [ ]	array (string, null)	read-write	The names of the external heating or cooling equipment, such as coolant distribution units, connected to this chassis.
HeatingCoolingManagerURIs (v1.25+) [ ]	array (URI) (string, null)	read-write	The URIs of the management interfaces for the external heating or cooling equipment for this chassis.
HeightMm (v1.4+)	number (mm)	read-only (null)	The height of the chassis.
HotPluggable (v1.21+)	boolean	read-only (null)	An indication of whether this component can be inserted or removed while the equipment is in operation.
IndicatorLED (deprecated v1.14)	string (enum)	read-write (null)	The state of the indicator LED, which identifies the chassis. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.14 and later. This property has been deprecated in favor of the LocationIndicatorActive property.
LeakDetectors (v1.26+) {}	object		The link to the collection of leak detectors located in this chassis.
Links {	object		The links to other resources that are related to this resource.
AutomationNodes (v1.27+) [ {	array		An array of links to the automation nodes contained in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Cables (v1.17+) [ {	array		An array of links to the cables connected to this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ComputerSystems [ {	array		An array of links to the computer systems that this chassis directly and wholly contains.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ConnectedCoolingLoops (v1.23+) [ {	array		An array of links to cooling loops connected to this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ContainedBy {}	object		The link to the chassis that contains this chassis.
Contains [ {	array		An array of links to any other chassis that this chassis has in it.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
CooledBy (deprecated v1.20) [ {	array		An array of links to resources or objects that cool this chassis. Normally, the link is for either a chassis or a specific set of fans. Deprecated in v1.20 and later. This property has been deprecated in favor of the Fans link property, and details provided in the ThermalSubsystem resource.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
CoolingUnits (v1.23+) [ {	array		An array of links to cooling unit functionality contained in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Drives (v1.2+) [ {	array		An array of links to the drives located in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Facility (v1.11+) {}	object		The link to the facility that contains this chassis.
Fans (v1.20+) [ {	array		An array of links to the fans that cool this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagedBy [ {	array		An array of links to the managers responsible for managing this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagersInChassis (v1.2+) [ {	array		An array of links to the managers located in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PCIeDevices (v1.4+, deprecated v1.10) [ {	array		An array of links to the PCIe devices located in this chassis. Deprecated in v1.10 and later. This property has been deprecated in favor of the PCIeDevices resource collection in the root of this resource.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PowerDistribution (v1.20+) {}	object	(null)	A link to power distribution functionality contained in this chassis.
PoweredBy (deprecated v1.20) [ {	array		An array of links to resources or objects that power this chassis. Normally, the link is for either a chassis or a specific set of power supplies. Deprecated in v1.20 and later. This property has been deprecated in favor of the PowerOutlets and PowerSupplies link properties, and details provided in the PowerSubsystem resource.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PowerOutlets (v1.18+) [ {	array		An array of links to the outlets that provide power to this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
PowerSupplies (v1.20+) [ {	array		An array of links to the power supplies that provide power to this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Processors (v1.9+) [ {	array		An array of links to the processors located in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ResourceBlocks (v1.5+) [ {	array		An array of links to the resource blocks located in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Storage (v1.2+) [ {	array		An array of links to the storage subsystems connected to or inside this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Switches (v1.7+) [ {	array		An array of links to the switches located in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Location (v1.2+) {}	object		The location of the chassis. See the v1_23_0.v1_23_0 schema for details on this property.
LocationIndicatorActive (v1.14+)	boolean	read-write (null)	An indicator allowing an operator to physically locate this resource.
LogServices {}	object		The link to the logs for this chassis.
Manufacturer	string	read-only (null)	The manufacturer of this chassis.
MaxPowerWatts (v1.12+)	number (W)	read-only (null)	The upper bound of the total power consumed by the chassis.
Measurements (v1.15+, deprecated v1.19) [ { } ]	array (object)		An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.19 and later. This property has been deprecated in favor of the ComponentIntegrity resource.
MediaControllers (v1.11+, deprecated v1.20) {}	object		The link to the collection of media controllers located in this chassis. Deprecated in v1.20 and later. This property has been deprecated in favor of FabricAdapters.
Memory (v1.11+) {}	object		The link to the collection of memory located in this chassis that belong to fabric-related resource pools.
MemoryDomains (v1.11+) {}	object		The link to the collection of memory domains located in this chassis that belong to fabric-related resource pools.
MinPowerWatts (v1.12+)	number (W)	read-only (null)	The lower bound of the total power consumed by the chassis.
Model	string	read-only (null)	The model number of the chassis.
NetworkAdapters (v1.4+) {}	object		The link to the collection of network adapters associated with this chassis.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PartNumber	string	read-only (null)	The part number of the chassis.
PCIeDevices (v1.10+) {}	object		The link to the collection of PCIe devices located in this chassis.
PCIeSlots (v1.8+, deprecated v1.24) {}	object		The link to the PCIe slot properties for this chassis. Deprecated in v1.24 and later. This property has been deprecated in favor of the PCIeDevices property. The PCIeSlots schema has been deprecated in favor of the PCIeDevice schema. Empty PCIe slots are represented by PCIeDevice resources using the Absent value of the State property within Status.
PhysicalSecurity (v1.1+) {	object		The physical security state of the chassis.
IntrusionSensor (v1.1+)	string (enum)	read-write (null)	The physical security state of the chassis, such as if hardware intrusion is detected. For the possible property values, see IntrusionSensor in Property details.
IntrusionSensorNumber (v1.1+, deprecated v1.22)	integer	read-only (null)	A numerical identifier to represent the physical security sensor. Deprecated in v1.22 and later. This property has been deprecated in order to allow for multiple physical sensors to construct this object.
IntrusionSensorReArm (v1.1+)	string (enum)	read-write (null)	The policy that describes how the physical security state of the chassis returns to a normal state. For the possible property values, see IntrusionSensorReArm in Property details.
}
Power (deprecated v1.15) {}	object		The link to the power properties, or power supplies, power policies, and sensors, for this chassis. Deprecated in v1.15 and later. This link has been deprecated in favor of the PowerSubsystem link property.
PoweredByParent (v1.20+)	boolean	read-only (null)	Indicates that the chassis receives power from the containing chassis.
PowerState (v1.0.1+)	string (enum)	read-only (null)	The current power state of the chassis. For the possible property values, see PowerState in Property details.
PowerSubsystem (v1.15+) {}	object		The link to the power subsystem properties for this chassis.
Processors (v1.22+) {}	object		The link to the collection of processors located in this chassis that belong to fabric-related resource pools.
Replaceable (v1.21+)	boolean	read-only (null)	An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.
Sensors (v1.9+) {}	object		The link to the collection of sensors located in the equipment and sub-components.
SerialNumber	string	read-only (null)	The serial number of the chassis.
SKU	string	read-only (null)	The SKU of the chassis.
SparePartNumber (v1.16+)	string	read-only (null)	The spare part number of the chassis.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
Thermal (deprecated v1.15) {}	object		The link to the thermal properties, such as fans, cooling, and sensors, for this chassis. Deprecated in v1.15 and later. This link has been deprecated in favor of the ThermalSubsystem link property.
ThermalDirection (v1.20+)	string (enum)	read-only (null)	Indicates the thermal management path through the chassis. For the possible property values, see ThermalDirection in Property details.
ThermalManagedByParent (v1.20+)	boolean	read-only (null)	Indicates that the chassis is thermally managed by the parent chassis.
ThermalSubsystem (v1.15+) {}	object		The link to the thermal subsystem properties for this chassis.
TrustedComponents (v1.21+) {}	object		The link to the trusted components in this chassis.
UUID (v1.7+)	string (uuid)	read-only (null)	The UUID for this chassis.
Version (v1.21+)	string	read-only (null)	The hardware version of this chassis.
WeightKg (v1.4+)	number (kg)	read-only (null)	The weight of the chassis.
WidthMm (v1.4+)	number (mm)	read-only (null)	The width of the chassis.

Actions⁠

Reset⁠

Description

This action resets the chassis. Additionally, it could reset systems or other contained resources depending on the ResetType used to invoke this action.

Action URI

{Base URI of target resource}/Actions/Chassis.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⁠

ChassisType⁠

 

The type of physical form factor of the chassis.

string	Description
Blade	An enclosed or semi-enclosed, typically vertically-oriented, system chassis that must be plugged into a multi-system chassis to function normally.
Card	A loose device or circuit board intended to be installed in a system or other enclosure.
Cartridge	A small self-contained system intended to be plugged into a multi-system chassis.
Component	A small chassis, card, or device that contains devices for a particular subsystem or function.
Drawer	An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that can be slid into a multi-system chassis.
Enclosure	A generic term for a chassis that does not fit any other description.
Expansion	A chassis that expands the capabilities or capacity of another chassis.
HeatExchanger (v1.23+)	A heat exchanger.
ImmersionTank (v1.23+)	An immersion cooling tank.
IPBasedDrive (v1.3+)	A chassis in a drive form factor with IP-based network connections.
Module	A small, typically removable, chassis or card that contains devices for a particular subsystem or function.
Other	A chassis that does not fit any of these definitions.
Pod	A collection of equipment racks in a large, likely transportable, container.
PowerStrip (v1.25+)	A power strip, typically placed in the zero-U space of a rack.
Rack	An equipment rack, typically a 19-inch wide freestanding unit.
RackGroup (v1.4+)	A group of racks that form a single entity or share infrastructure.
RackMount	A single-system chassis designed specifically for mounting in an equipment rack.
Row	A collection of equipment racks.
Shelf	An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that must be plugged into a multi-system chassis to function normally.
Sidecar	A chassis that mates mechanically with another chassis to expand its capabilities or capacity.
Sled	An enclosed or semi-enclosed, system chassis that must be plugged into a multi-system chassis to function normally similar to a blade type chassis.
StandAlone	A single, free-standing system, commonly called a tower or desktop chassis.
StorageEnclosure (v1.6+)	A chassis that encloses storage.
Zone	A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated.

DoorState⁠

 

The state of the door.

string	Description
Closed	Door is closed.
Locked	Door is closed and locked.
LockedAndOpen	Door is open and locked.
Open	Door is open.

EnvironmentalClass⁠

 

The ASHRAE Environmental Class for this chassis.

string	Description
A1	ASHRAE Environmental Class 'A1'.
A2	ASHRAE Environmental Class 'A2'.
A3	ASHRAE Environmental Class 'A3'.
A4	ASHRAE Environmental Class 'A4'.

idRef⁠

 

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

IndicatorLED⁠

 

The state of the indicator LED, which identifies the chassis.

string	Description
Blinking	The indicator LED is blinking.
Lit	The indicator LED is lit.
Off	The indicator LED is off.
Unknown (deprecated v1.2)	The state of the indicator LED cannot be determined. Deprecated in v1.2 and later. This value has been deprecated in favor of returning null if the state is unknown.

IntrusionSensor⁠

 

The physical security state of the chassis, such as if hardware intrusion is detected.

string	Description
HardwareIntrusion	A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected to be in an insecure state.
Normal	No physical security condition is detected at this time.
TamperingDetected	Physical tampering of the monitored entity is detected.

IntrusionSensorReArm⁠

 

The policy that describes how the physical security state of the chassis returns to a normal state.

string	Description
Automatic	The sensor is automatically restored to the normal state when no security condition is detected.
Manual	A user is required to clear the sensor to restore it to the normal state.

PowerState⁠

 

The current power state of the chassis.

string	Description
Off	The resource is powered off. The components within the resource might continue to have AUX power.
On	The resource is powered on.
Paused	The resource is paused.
PoweringOff	A temporary state between on and off. The components within the resource can take time to process the power off action.
PoweringOn	A temporary state between off and on. The components within the resource can take time to process the power on action.

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.

ThermalDirection⁠

 

Indicates the thermal management path through the chassis.

string	Description
BackToFront	A chassis with the air intake in the back and exhaust out the front.
FrontToBack	A chassis with the air intake in the front and exhaust out the back.
Sealed	A sealed chassis with no air pathway.
TopExhaust	A chassis with air exhaust on the top.

Example response⁠

{
    "@odata.type": "#Chassis.v1_28_0.Chassis",
    "Id": "1U",
    "Name": "Computer System Chassis",
    "ChassisType": "RackMount",
    "AssetTag": "Chicago-45Z-2381",
    "Manufacturer": "Contoso",
    "Model": "3500RX",
    "SKU": "8675309",
    "SerialNumber": "437XR1138R2",
    "PartNumber": "224071-J23",
    "PowerState": "On",
    "LocationIndicatorActive": true,
    "Location": {
        "Placement": {
            "Row": "North",
            "Rack": "WEB43",
            "RackOffsetUnits": "EIA_310",
            "RackOffset": 12
        }
    },
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "HeightMm": 44.45,
    "WidthMm": 431.8,
    "DepthMm": 711,
    "WeightKg": 15.31,
    "EnvironmentalClass": "A3",
    "Sensors": {
        "@odata.id": "/redfish/v1/Chassis/1U/Sensors"
    },
    "PowerSubsystem": {
        "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem"
    },
    "ThermalSubsystem": {
        "@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem"
    },
    "EnvironmentMetrics": {
        "@odata.id": "/redfish/v1/Chassis/1U/EnvironmentMetrics"
    },
    "Links": {
        "ComputerSystems": [
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC"
            }
        ],
        "ManagersInChassis": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC"
            }
        ]
    },
    "@odata.id": "/redfish/v1/Chassis/1U"
}

Fan 1.5.2⁠

 

Version	v1.5
Release	2023.2

Description⁠

The Fan schema describes a cooling fan unit for a computer system or similar devices contained within a chassis. 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}/​ThermalSubsystem/​Fans/​{FanId}

Properties⁠

Property	Type	Attributes	Notes
Actions {}	object		The available actions for this resource.
Assembly {	object		The link to the assembly associated with this fan.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
FanDiameterMm (v1.4+)	integer (mm)	read-only (null)	The diameter of the fan assembly in millimeter units.
HotPluggable	boolean	read-only (null)	An indication of whether this device can be inserted or removed while the equipment is in operation.
Links (v1.2+) {	object		The links to other resources that are related to this resource.
CoolingChassis (v1.2+) [ {	array		An array of links to the chassis that are directly cooled by this fan.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
}
Location {}	object		The location of the fan. 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 fan.
Model	string	read-only (null)	The model number for this fan.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PartNumber	string	read-only (null)	The part number for this fan.
PhysicalContext	string (enum)	read-only	The area or device associated with this fan. For the possible property values, see PhysicalContext in Property details.
PowerWatts (v1.1+) {}	object		Power consumption (W). See the Sensor.v1_12_0 schema for details on this property.
Replaceable (v1.3+)	boolean	read-only (null)	An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.
SecondarySpeedPercent (v1.5+) {}	object		The fan speed (percent) of the second rotor in a multi-rotor fan. See the Sensor.v1_12_0 schema for details on this property.
SerialNumber	string	read-only (null)	The serial number for this fan.
SparePartNumber	string	read-only (null)	The spare part number for this fan.
SpeedPercent {}	object		The fan speed (percent). See the Sensor.v1_12_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.

Property details⁠

PhysicalContext⁠

 

The area or device associated with this fan.

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.

Example response⁠

{
    "@odata.type": "#Fan.v1_6_0.Fan",
    "Id": "Bay1",
    "Name": "Fan Bay 1",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "PhysicalContext": "Chassis",
    "Model": "RKS-440DC",
    "Manufacturer": "Contoso Fans",
    "PartNumber": "23456-133",
    "SparePartNumber": "93284-133",
    "LocationIndicatorActive": true,
    "HotPluggable": true,
    "SpeedPercent": {
        "Reading": 45,
        "SpeedRPM": 2200,
        "DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/FanBay1"
    },
    "Location": {
        "PartLocation": {
            "ServiceLabel": "Chassis Fan Bay 1",
            "LocationType": "Bay",
            "LocationOrdinalValue": 0
        }
    },
    "@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay1"
}

Power 1.7.3 (deprecated)⁠

 

Version	v1.7 Deprecated
Release	2020.4

This schema has been deprecated and use in new implementations is discouraged except to retain compatibility with existing products. This schema has been deprecated in favor of the PowerSubsystem schema.

Description⁠

The Power schema describes power metrics and represents the properties for power consumption and power limiting.

URIs⁠

/​redfish/​v1/​Chassis/​{ChassisId}/​Power (deprecated)

Properties⁠

Property	Type	Attributes	Notes
Actions (v1.3+) {	object		The available actions for this resource.
#Power.PowerSupplyReset (v1.6+) {}	object		This action resets the targeted power supply. For more information, see the Actions section below.
}
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PowerControl [ {	array		The set of power control functions, including power reading and limiting.
@odata.id	string (URI)	read-only required	The unique identifier for a resource.
Actions (v1.3+) {}	object		The available actions for this resource.
MemberId	string	read-only required	The unique identifier for the member within an array.
Name	string	read-only (null)	The power control function name.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PhysicalContext (v1.4+)	string (enum)	read-only	The area, device, or set of devices to which this power control applies. For the possible property values, see PhysicalContext in Property details.
PowerAllocatedWatts	number (W)	read-only (null)	The total amount of power that has been allocated or budgeted to chassis.
PowerAvailableWatts	number (W)	read-only (null)	The amount of reserve power capacity, in watt units, that remains. This value is the PowerCapacityWatts value minus the PowerAllocatedWatts value.
PowerCapacityWatts	number (W)	read-only (null)	The total amount of power that can be allocated to the chassis. This value can be either the power supply capacity or the power budget that an upstream chassis assigns to this chassis.
PowerConsumedWatts	number (W)	read-only (null)	The actual power that the chassis consumes, in watt units.
PowerLimit {	object		The power limit status and configuration information for this chassis.
CorrectionInMs	integer (ms)	read-write (null)	The time required for the limiting process to reduce power consumption to below the limit.
LimitException	string (enum)	read-write (null)	The action that is taken if the power cannot be maintained below the LimitInWatts. For the possible property values, see LimitException in Property details.
LimitInWatts	number (W)	read-write (null)	The power limit, in watt units. If null, power capping is disabled.
}
PowerMetrics {	object		The power readings for this chassis.
AverageConsumedWatts	number (W)	read-only (null)	The average power level over the measurement window over the last IntervalInMin minutes.
IntervalInMin	integer (min)	read-only (null)	The time interval, or window, over which the power metrics are measured.
MaxConsumedWatts	number (W)	read-only (null)	The highest power consumption level, in watt units, that has occurred over the measurement window within the last IntervalInMin minutes.
MinConsumedWatts	number (W)	read-only (null)	The lowest power consumption level, in watt units, over the measurement window that occurred within the last IntervalInMin minutes.
}
PowerRequestedWatts	number (W)	read-only (null)	The potential power, in watt units, that the chassis requests, which might be higher than the current level being consumed because the requested power includes a budget that the chassis wants for future use.
RelatedItem [ {	array		An array of links to resources or objects associated with this power limit.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
} ]
PowerSupplies [ {	array		The set of power supplies associated with this system or device.
@odata.id	string (URI)	read-only required	The unique identifier for a resource.
Actions (v1.3+) {}	object		The available actions for this resource.
Assembly (v1.5+) {	object		The link to the assembly resource associated with this power supply.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
EfficiencyPercent (v1.5+)	number (%)	read-only (null)	The measured efficiency of this power supply as a percentage.
FirmwareVersion	string	read-only (null)	The firmware version for this power supply.
HotPluggable (v1.5+)	boolean	read-only (null)	An indication of whether this device can be inserted or removed while the equipment is in operation.
IndicatorLED (v1.2+)	string (enum)	read-write (null)	The state of the indicator LED, which identifies the power supply. For the possible property values, see IndicatorLED in Property details.
InputRanges (v1.1+) [ {	array		The input ranges that the power supply can use.
InputType (v1.1+)	string (enum)	read-only (null)	The Input type (AC or DC). For the possible property values, see InputType in Property details.
MaximumFrequencyHz (v1.1+)	number (Hz)	read-only (null)	The maximum line input frequency at which this power supply input range is effective.
MaximumVoltage (v1.1+)	number (V)	read-only (null)	The maximum line input voltage at which this power supply input range is effective.
MinimumFrequencyHz (v1.1+)	number (Hz)	read-only (null)	The minimum line input frequency at which this power supply input range is effective.
MinimumVoltage (v1.1+)	number (V)	read-only (null)	The minimum line input voltage at which this power supply input range is effective.
Oem (v1.1+) {}	object		The OEM extension property. See the Resource schema for details on this property.
OutputWattage (v1.1+)	number (W)	read-only (null)	The maximum capacity of this power supply when operating in this input range.
} ]
LastPowerOutputWatts	number (W)	read-only (null)	The average power output of this power supply.
LineInputVoltage	number (V)	read-only (null)	The line input voltage at which the power supply is operating.
LineInputVoltageType	string (enum)	read-only (null)	The line voltage type supported as an input to this power supply. For the possible property values, see LineInputVoltageType in Property details.
Location (v1.5+) {}	object		The location of the power supply. See the v1_23_0.v1_23_0 schema for details on this property.
Manufacturer (v1.1+)	string	read-only (null)	The manufacturer of this power supply.
MemberId	string	read-only required	The unique identifier for the member within an array.
Model	string	read-only (null)	The model number for this power supply.
Name	string	read-only (null)	The name of the power supply.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PartNumber	string	read-only (null)	The part number for this power supply.
PowerCapacityWatts	number (W)	read-only (null)	The maximum capacity of this power supply.
PowerInputWatts (v1.5+)	number (W)	read-only (null)	The measured input power of this power supply.
PowerOutputWatts (v1.5+)	number (W)	read-only (null)	The measured output power 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.
Redundancy [ {	array		The set of redundancy groups for this power supply.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
RelatedItem [ {	array		An array of links to resources or objects associated with this power supply.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
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.
} ]
Redundancy [ {	array		The redundancy information for the set of power supplies in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Voltages [ {	array		The set of voltage sensors for this chassis.
@odata.id	string (URI)	read-only required	The unique identifier for a resource.
Actions (v1.3+) {}	object		The available actions for this resource.
LowerThresholdCritical	number (V)	read-only (null)	The value at which the reading is below normal range but not yet fatal.
LowerThresholdFatal	number (V)	read-only (null)	The value at which the reading is below normal range and fatal.
LowerThresholdNonCritical	number (V)	read-only (null)	The value at which the reading is below normal range.
MaxReadingRange	number (V)	read-only (null)	Maximum value for this sensor.
MemberId	string	read-only required	The unique identifier for the member within an array.
MinReadingRange	number (V)	read-only (null)	Minimum value for this sensor.
Name	string	read-only (null)	Voltage sensor name.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PhysicalContext	string (enum)	read-only	The area or device to which this voltage measurement applies. For the possible property values, see PhysicalContext in Property details.
ReadingVolts	number (V)	read-only (null)	The reading of the voltage sensor.
RelatedItem [ {	array		An array of links to resources or objects to which this voltage measurement applies.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
SensorNumber	integer	read-only (null)	A numerical identifier to represent the voltage sensor.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
UpperThresholdCritical	number (V)	read-only (null)	The value at which the reading is above normal range but not yet fatal.
UpperThresholdFatal	number (V)	read-only (null)	The value at which the reading is above normal range and fatal.
UpperThresholdNonCritical	number (V)	read-only (null)	The value at which the reading is above normal range.
} ]

Actions⁠

PowerSupplyReset (v1.6+)⁠

Description

This action resets the targeted power supply.

Action URI

{Base URI of target resource}/Actions/Power.PowerSupplyReset

Action parameters

Parameter Name	Type	Attributes	Notes
MemberId	string	required	The MemberId of the power supply within the PowerSupplies array on which to perform the reset.
ResetType	string (enum)	optional	The type of reset. For the possible property values, see ResetType in Property details.

Request Example

{
    "MemberId": "0",
    "ResetType": "ForceRestart"
}

Property details⁠

IndicatorLED⁠

 

The state of the indicator LED, which identifies the power supply.

string	Description
Blinking	The indicator LED is blinking.
Lit	The indicator LED is lit.
Off	The indicator LED is off.

InputType⁠

 

The Input type (AC or DC).

string	Description
AC	Alternating Current (AC) input range.
DC	Direct Current (DC) input range.

LimitException⁠

 

The action that is taken if the power cannot be maintained below the LimitInWatts.

string	Description
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.
NoAction	Take no action when the limit is exceeded.
Oem	Take an OEM-defined action.

LineInputVoltageType⁠

 

The line voltage type supported as an input to this power supply.

string	Description
AC120V (v1.1+)	AC 120V nominal input.
AC240V (v1.1+)	AC 240V nominal input.
AC277V (v1.1+)	AC 277V nominal input.
ACandDCWideRange (v1.1+)	Wide range AC or DC input.
ACHighLine (deprecated v1.1)	277V AC input. Deprecated in v1.1 and later. This value has been deprecated in favor of AC277V.
ACLowLine (deprecated v1.1)	100-127V AC input. Deprecated in v1.1 and later. This value has been deprecated in favor of AC120V.
ACMidLine (deprecated v1.1)	200-240V AC input. Deprecated in v1.1 and later. This value has been deprecated in favor of AC240V.
ACWideRange (v1.1+)	Wide range AC input.
DC240V (v1.1+)	DC 240V nominal input.
DC380V	High-voltage DC input (380V).
DCNeg48V	-48V DC input.
Unknown	The power supply line input voltage type cannot be determined.

PhysicalContext⁠

 

The area, device, or set of devices to which this power control 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.

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.
Unknown	The power supply type cannot be determined.

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": "#Power.v1_7_3.Power",
    "Id": "Power",
    "Name": "Power",
    "PowerControl": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/PowerControl/0",
            "MemberId": "0",
            "Name": "Server Power Control",
            "PowerConsumedWatts": 344,
            "PowerRequestedWatts": 800,
            "PowerAvailableWatts": 0,
            "PowerCapacityWatts": 800,
            "PowerAllocatedWatts": 800,
            "PowerMetrics": {
                "IntervalInMin": 30,
                "MinConsumedWatts": 271,
                "MaxConsumedWatts": 489,
                "AverageConsumedWatts": 319
            },
            "PowerLimit": {
                "LimitInWatts": 500,
                "LimitException": "LogEventOnly",
                "CorrectionInMs": 50
            },
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ],
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            }
        }
    ],
    "Voltages": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/Voltages/0",
            "MemberId": "0",
            "Name": "VRM1 Voltage",
            "SensorNumber": 11,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "ReadingVolts": 12,
            "UpperThresholdNonCritical": 12.5,
            "UpperThresholdCritical": 13,
            "UpperThresholdFatal": 15,
            "LowerThresholdNonCritical": 11.5,
            "LowerThresholdCritical": 11,
            "LowerThresholdFatal": 10,
            "MinReadingRange": 0,
            "MaxReadingRange": 20,
            "PhysicalContext": "VoltageRegulator",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/Voltages/1",
            "MemberId": "1",
            "Name": "VRM2 Voltage",
            "SensorNumber": 12,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "ReadingVolts": 5,
            "UpperThresholdNonCritical": 5.5,
            "UpperThresholdCritical": 7,
            "LowerThresholdNonCritical": 4.75,
            "LowerThresholdCritical": 4.5,
            "MinReadingRange": 0,
            "MaxReadingRange": 20,
            "PhysicalContext": "VoltageRegulator",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        }
    ],
    "PowerSupplies": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/PowerSupplies/0",
            "MemberId": "0",
            "Name": "Power Supply Bay",
            "Status": {
                "State": "Enabled",
                "Health": "Warning"
            },
            "PowerSupplyType": "AC",
            "LineInputVoltageType": "ACWideRange",
            "LineInputVoltage": 120,
            "PowerCapacityWatts": 800,
            "LastPowerOutputWatts": 325,
            "Model": "499253-B21",
            "Manufacturer": "ManufacturerName",
            "FirmwareVersion": "1.00",
            "SerialNumber": "1Z0000001",
            "PartNumber": "0000001A3A",
            "SparePartNumber": "0000001A3A",
            "InputRanges": [
                {
                    "InputType": "AC",
                    "MinimumVoltage": 100,
                    "MaximumVoltage": 120,
                    "OutputWattage": 800
                },
                {
                    "InputType": "AC",
                    "MinimumVoltage": 200,
                    "MaximumVoltage": 240,
                    "OutputWattage": 1300
                }
            ],
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        }
    ],
    "Actions": {
        "#Power.PowerSupplyReset": {
            "target": "/redfish/v1/Chassis/1U/Power/Actions/Power.PowerSupplyReset"
        }
    },
    "@odata.id": "/redfish/v1/Chassis/1U/Power"
}

Thermal 1.7.3 (deprecated)⁠

 

Version	v1.7 Deprecated
Release	2020.4

This schema has been deprecated and use in new implementations is discouraged except to retain compatibility with existing products. This schema has been deprecated in favor of the ThermalSubsystem schema.

Description⁠

The Thermal schema describes temperature monitoring and thermal management subsystems, such as cooling fans, for a computer system or similar devices contained within a chassis.

URIs⁠

/​redfish/​v1/​Chassis/​{ChassisId}/​Thermal (deprecated)

Properties⁠

Property	Type	Attributes	Notes
Actions (v1.3+) {}	object		The available actions for this resource.
Fans [ {	array		The set of fans for this chassis.
@odata.id	string (URI)	read-only required	The unique identifier for a resource.
Actions (v1.3+) {}	object		The available actions for this resource.
Assembly (v1.4+) {	object		The link to the assembly associated with this fan.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
FanName (deprecated v1.1)	string	read-only (null)	The name of the fan. Deprecated in v1.1 and later. This property has been deprecated in favor of the Name property.
HotPluggable (v1.4+)	boolean	read-only (null)	An indication of whether this device can be inserted or removed while the equipment is in operation.
IndicatorLED (v1.2+)	string (enum)	read-write (null)	The state of the indicator LED, which identifies this fan. For the possible property values, see IndicatorLED in Property details.
Location (v1.4+) {}	object		The location of the fan. See the v1_23_0.v1_23_0 schema for details on this property.
LowerThresholdCritical	integer	read-only (null)	The value at which the reading is below normal range but not yet fatal.
LowerThresholdFatal	integer	read-only (null)	The value at which the reading is below normal range and fatal.
LowerThresholdNonCritical	integer	read-only (null)	The value at which the reading is below normal range.
Manufacturer (v1.2+)	string	read-only (null)	The manufacturer of this fan.
MaxReadingRange	integer	read-only (null)	Maximum value for this sensor.
MemberId	string	read-only required	The unique identifier for the member within an array.
MinReadingRange	integer	read-only (null)	Minimum value for this sensor.
Model (v1.2+)	string	read-only (null)	The model number for this fan.
Name (v1.1+)	string	read-only (null)	Name of the fan.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PartNumber (v1.2+)	string	read-only (null)	The part number for this fan.
PhysicalContext	string (enum)	read-only	The area or device associated with this fan. For the possible property values, see PhysicalContext in Property details.
Reading	integer	read-only (null)	The fan speed.
ReadingUnits (v1.0.1+)	string (enum)	read-only (null)	The units in which the fan reading and thresholds are measured. For the possible property values, see ReadingUnits in Property details.
Redundancy [ {	array		The set of redundancy groups for this fan.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
RelatedItem [ {	array		An array of links to resources or objects that this fan services.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
SensorNumber (v1.5+)	integer	read-only (null)	The numerical identifier for this fan speed sensor.
SerialNumber (v1.2+)	string	read-only (null)	The serial number for this fan.
SparePartNumber (v1.2+)	string	read-only (null)	The spare part number for this fan.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
UpperThresholdCritical	integer	read-only (null)	The value at which the reading is above normal range but not yet fatal.
UpperThresholdFatal	integer	read-only (null)	The value at which the reading is above normal range and fatal.
UpperThresholdNonCritical	integer	read-only (null)	The value at which the reading is above normal range.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Redundancy [ {	array		The redundancy information for the set of fans in this chassis.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
Temperatures [ {	array		The set of temperature sensors for this chassis.
@odata.id	string (URI)	read-only required	The unique identifier for a resource.
Actions (v1.3+) {}	object		The available actions for this resource.
AdjustedMaxAllowableOperatingValue (v1.4+)	integer (Cel)	read-only (null)	Adjusted maximum allowable operating temperature for this equipment based on the current environmental conditions present.
AdjustedMinAllowableOperatingValue (v1.4+)	integer (Cel)	read-only (null)	Adjusted minimum allowable operating temperature for this equipment based on the current environmental conditions present.
DeltaPhysicalContext (v1.4+)	string (enum)	read-only	The area or device to which the DeltaReadingCelsius temperature measurement applies, relative to PhysicalContext. For the possible property values, see DeltaPhysicalContext in Property details.
DeltaReadingCelsius (v1.4+)	number (Cel)	read-only (null)	The delta temperature reading.
LowerThresholdCritical	number (Cel)	read-only (null)	The value at which the reading is below normal range but not yet fatal.
LowerThresholdFatal	number (Cel)	read-only (null)	The value at which the reading is below normal range and fatal.
LowerThresholdNonCritical	number (Cel)	read-only (null)	The value at which the reading is below normal range.
LowerThresholdUser (v1.6+)	integer (Cel)	read-write (null)	The value at which the reading is below the user-defined range.
MaxAllowableOperatingValue (v1.4+)	integer (Cel)	read-only (null)	Maximum allowable operating temperature for this equipment.
MaxReadingRangeTemp	number (Cel)	read-only (null)	Maximum value for this sensor.
MemberId	string	read-only required	The unique identifier for the member within an array.
MinAllowableOperatingValue (v1.4+)	integer (Cel)	read-only (null)	Minimum allowable operating temperature for this equipment.
MinReadingRangeTemp	number (Cel)	read-only (null)	Minimum value for this sensor.
Name	string	read-only (null)	The temperature sensor name.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PhysicalContext	string (enum)	read-only	The area or device to which this temperature measurement applies. For the possible property values, see PhysicalContext in Property details.
ReadingCelsius	number (Cel)	read-only (null)	The temperature (C).
RelatedItem [ {	array		An array of links to resources or objects that represent areas or devices to which this temperature applies.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
SensorNumber	integer	read-only (null)	The numerical identifier of the temperature sensor.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
UpperThresholdCritical	number (Cel)	read-only (null)	The value at which the reading is above normal range but not yet fatal.
UpperThresholdFatal	number (Cel)	read-only (null)	The value at which the reading is above normal range and fatal.
UpperThresholdNonCritical	number (Cel)	read-only (null)	The value at which the reading is above normal range.
UpperThresholdUser (v1.6+)	integer (Cel)	read-write (null)	The value at which the reading is above the user-defined range.
} ]

Property details⁠

DeltaPhysicalContext⁠

 

The area or device to which the DeltaReadingCelsius temperature measurement applies, relative to PhysicalContext.

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.

IndicatorLED⁠

 

The state of the indicator LED, which identifies this fan.

string	Description
Blinking	The indicator LED is blinking.
Lit	The indicator LED is lit.
Off	The indicator LED is off.

PhysicalContext⁠

 

The area or device associated with this fan.

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.

ReadingUnits⁠

 

The units in which the fan reading and thresholds are measured.

string	Description
Percent	The fan reading and thresholds are measured as a percentage.
RPM	The fan reading and thresholds are measured in revolutions per minute.

Example response⁠

{
    "@odata.type": "#Thermal.v1_7_3.Thermal",
    "Id": "Thermal",
    "Name": "Thermal",
    "Temperatures": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Temperatures/0",
            "MemberId": "0",
            "Name": "CPU1 Temp",
            "SensorNumber": 5,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "ReadingCelsius": 41,
            "UpperThresholdNonCritical": 42,
            "UpperThresholdCritical": 45,
            "UpperThresholdFatal": 48,
            "MinReadingRangeTemp": 0,
            "MaxReadingRangeTemp": 60,
            "PhysicalContext": "CPU",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
                }
            ]
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Temperatures/1",
            "MemberId": "1",
            "Name": "CPU2 Temp",
            "SensorNumber": 6,
            "Status": {
                "State": "Disabled"
            },
            "UpperThresholdNonCritical": 42,
            "UpperThresholdCritical": 45,
            "UpperThresholdFatal": 48,
            "MinReadingRangeTemp": 0,
            "MaxReadingRangeTemp": 60,
            "PhysicalContext": "CPU",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU2"
                }
            ]
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Temperatures/2",
            "MemberId": "2",
            "Name": "Chassis Intake Temp",
            "SensorNumber": 9,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "ReadingCelsius": 25,
            "UpperThresholdUser": 28,
            "UpperThresholdNonCritical": 30,
            "UpperThresholdCritical": 40,
            "UpperThresholdFatal": 50,
            "LowerThresholdUser": 20,
            "LowerThresholdNonCritical": 10,
            "LowerThresholdCritical": 5,
            "LowerThresholdFatal": 0,
            "MinReadingRangeTemp": 0,
            "MaxReadingRangeTemp": 60,
            "PhysicalContext": "Intake",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                },
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                }
            ]
        }
    ],
    "Fans": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/0",
            "MemberId": "0",
            "Name": "BaseBoard System Fan",
            "PhysicalContext": "Backplane",
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "Reading": 2100,
            "ReadingUnits": "RPM",
            "LowerThresholdFatal": 0,
            "MinReadingRange": 0,
            "MaxReadingRange": 5000,
            "Redundancy": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Redundancy/0"
                }
            ],
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/1",
            "MemberId": "1",
            "Name": "BaseBoard System Fan Backup",
            "PhysicalContext": "Backplane",
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "Reading": 2050,
            "ReadingUnits": "RPM",
            "LowerThresholdFatal": 0,
            "MinReadingRange": 0,
            "MaxReadingRange": 5000,
            "Redundancy": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Redundancy/0"
                }
            ],
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        }
    ],
    "Redundancy": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Redundancy/0",
            "MemberId": "0",
            "Name": "BaseBoard System Fans",
            "RedundancySet": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/0"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/1"
                }
            ],
            "Mode": "N+m",
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "MinNumNeeded": 1,
            "MaxNumSupported": 2
        }
    ],
    "@odata.id": "/redfish/v1/Chassis/1U/Thermal"
}