ThermalSubsystem
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"
}
SelectelZone 1.1.0
| Version | v1.1 |
| Release | 0.6.1 |
Description
Parameters for SelectelZone.
URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Oem/Selectel/Zones/{ZoneId}
Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| FanPwm { | object | The fan pwm target interface. | |
| Target | number | read-write | Fan PWM target on percent. |
| } | |||
| Fans (v1.1+) [ ] | array (string) | read-only | List of fans in the zone. |
| Mode { | object | The zone mode. | |
| FailSafe | boolean | read-only | If zone pid control is in fail safe mode. |
| Manual | boolean | read-write | Check current fan mode or set it. |
| } | |||
| Oem {} | object | The OEM extension property. See the Resource schema for details on this property. | |
| Pwms (v1.1+) [ ] | array (string) | read-only | List of fan pwms in the zone. |
| Therms (v1.1+) [ ] | array (string) | read-only | List of therms in the zone. |
Example response
{
"@odata.id": "/redfish/v1/Chassis/SSE_CH_1XX_chassis/ThermalSubsystem/Oem/Selectel/Zones/zone0",
"@odata.type": "#SelectelZone.v1_1_0.SelectelZone",
"FanPwm": {
"Target": 0
},
"Fans": [
"FAN_5a",
"FAN_5b",
"FAN_6a",
"FAN_6b",
"FAN_7a",
"FAN_7b",
"FAN_8a",
"FAN_8b"
],
"Id": "zone0",
"Mode": {
"FailSafe": true,
"Manual": false
},
"Name": "Zone CPU 2",
"Pwms": [
"FAN4_PWM",
"FAN5_PWM",
"FAN6_PWM",
"FAN7_PWM"
],
"Therms": [
"DTS_CPU2"
]
}
ThermalSubsystem 1.4.0
| Version | v1.4 |
| Release | 2025.2 |
Description
The ThermalSubsystem schema contains the definition for the thermal subsystem of a chassis.
URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem
Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Actions {} | object | The available actions for this resource. | |
| CoolantConnectorRedundancy (v1.3+) [ { } ] | array (object) | The redundancy information for the coolant connectors in this subsystem. See the v1_7_0.v1_7_0 schema for details on this property. | |
| CoolantConnectors (v1.2+) {} | object | A link to the coolant connectors for this equipment. | |
| FanRedundancy [ { } ] | array (object) | The redundancy information for the groups of fans in this subsystem. See the v1_7_0.v1_7_0 schema for details on this property. | |
| Fans {} | object | The link to the collection of fans within this subsystem. | |
| Filters (v1.4+) {} | object | A link to the filters for this equipment. | |
| Heaters (v1.1+) {} | object | The link to the collection of heaters within this subsystem. | |
| LeakDetection (v1.3+) {} | object | The link to the leak detection system within this chassis. | |
| Oem {} | object | The OEM extension property. See the Resource schema for details on this property. | |
| Pumps (v1.3+) {} | object | A link to the pumps for this equipment. | |
| Status {} | object | The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property. | |
| ThermalMetrics {} | object | The link to the summary of thermal metrics for this subsystem. |
Property details
idRef
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
Example response
{
"@odata.type": "#ThermalSubsystem.v1_5_0.ThermalSubsystem",
"Id": "ThermalSubsystem",
"Name": "Thermal Subsystem for Chassis",
"FanRedundancy": [
{
"RedundancyType": "NPlusM",
"MaxSupportedInGroup": 2,
"MinNeededInGroup": 1,
"RedundancyGroup": [
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay1"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay2"
}
],
"Status": {
"State": "Enabled",
"Health": "OK"
}
},
{
"RedundancyType": "NPlusM",
"MaxSupportedInGroup": 2,
"MinNeededInGroup": 1,
"RedundancyGroup": [
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/CPU1"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/CPU2"
}
],
"Status": {
"State": "Disabled"
}
}
],
"Fans": {
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans"
},
"ThermalMetrics": {
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/ThermalMetrics"
},
"Status": {
"State": "Enabled",
"Health": "OK"
},
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem"
}