Thermal

Schema Definition

This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.

Properties

Property	Type	Nullable	Required	Permission	Description
@odata.context	String			read-only	The OData description of a payload. Format: uri
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
@odata.type	String			read-only	The type of a resource.
Actions {	Object			read-write	The available actions for this resource.
#Thermal.SetFanSpeed {	Object			read-write	Sets the speed of a fan in percent.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
Fans [ {	Array[Object]			read-write	This is the definition for fans.
Actions {	Object			read-write	The available actions for this resource.
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
HotPluggable	Boolean	Yes		read-only	Indicates if this device can be inserted or removed while the equipment is in operation.
LowerThresholdCritical	Int64	Yes		read-only	Below normal range but not yet fatal.
LowerThresholdFatal	Int64	Yes		read-only	Below normal range and is fatal.
LowerThresholdNonCritical	Int64	Yes		read-only	Below normal range.
MaxReadingRange	Int64	Yes		read-only	Maximum value for Reading.
MemberId	String			read-only	This is the identifier for the member within the collection.
MinReadingRange	Int64	Yes		read-only	Minimum value for Reading.
Name	String	Yes		read-only	Name of the fan.
Oem {	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
EID_47597 {	Object			read-write	RECS\|Box Fan extension
SpeedPercent	SByte			read-only	Gets the speed of the fan in percent. Minimum: 0 Maximum: 100
}
}
PhysicalContext	String			read-only	Describes the area or device associated with this fan. Possible Values: Room: The room. Intake: The air intake point of the chassis. Exhaust: The air exhaust point of the chassis. LiquidInlet: The liquid inlet point of the chassis. LiquidOutlet: The liquid outlet point of the chassis. Front: The front of the chassis. Back: The back of the chassis. Upper: The upper portion of the chassis. Lower: The lower portion of the chassis. CPU: A Processor (CPU). GPU: A Graphics Processor (GPU). ASIC: An ASIC device, such as an FPGA or a GPGPU. Backplane: A backplane within the chassis. SystemBoard: The system board (PCB). PowerSupply: A power supply. VoltageRegulator: A voltage regulator device. StorageDevice: A storage device. NetworkingDevice: A networking device. ComputeBay: Within a compute bay. StorageBay: Within a storage bay. NetworkBay: Within a networking bay. ExpansionBay: Within an expansion bay. PowerSupplyBay: Within a power supply bay. Memory: A memory device. Chassis: The entire chassis. Fan: A fan.
Reading	Int64	Yes		read-only	Current fan speed.
ReadingUnits	String	Yes		read-only	Units in which the reading and thresholds are measured. Possible Values: RPM: Indicates that the fan reading and thresholds are measured in rotations per minute. Percent: Indicates that the fan reading and thresholds are measured in percentage.
Status {	Object			read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}
UpperThresholdCritical	Int64	Yes		read-only	Above normal range but not yet fatal.
UpperThresholdFatal	Int64	Yes		read-only	Above normal range and is fatal.
UpperThresholdNonCritical	Int64	Yes		read-only	Above normal range.
} ]
Fans@odata.count	Int32			read-only	The number of items in a collection.
Id	String		GET	read-only	Uniquely identifies the resource within the collection of like resources.
Name	String		GET	read-only	The name of the resource or array element.
Oem {	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
EID_47597 {	Object			read-write	RECS\|Box Thermal extension
LastSensorUpdate	Int64	Yes		read-only	The timestamp of the last sensor update expressed as milliseconds since the time 00:00:00 UTC on January 1, 1970.
}
}
Status {	Object			read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}
Temperatures [ {	Array[Object]			read-write	This is the definition for temperature sensors.
Actions {	Object			read-write	The available actions for this resource.
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
LowerThresholdCritical	Decimal	Yes		read-only	Below normal range but not yet fatal. Unit: Cel
LowerThresholdFatal	Decimal	Yes		read-only	Below normal range and is fatal. Unit: Cel
LowerThresholdNonCritical	Decimal	Yes		read-only	Below normal range. Unit: Cel
MaxReadingRangeTemp	Decimal	Yes		read-only	Maximum value for ReadingCelsius. Unit: Cel
MemberId	String			read-only	This is the identifier for the member within the collection.
MinReadingRangeTemp	Decimal	Yes		read-only	Minimum value for ReadingCelsius. Unit: Cel
Name	String	Yes		read-only	Temperature sensor name.
Oem { }	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
PhysicalContext	String			read-only	Describes the area or device to which this temperature measurement applies. Possible Values: Room: The room. Intake: The air intake point of the chassis. Exhaust: The air exhaust point of the chassis. LiquidInlet: The liquid inlet point of the chassis. LiquidOutlet: The liquid outlet point of the chassis. Front: The front of the chassis. Back: The back of the chassis. Upper: The upper portion of the chassis. Lower: The lower portion of the chassis. CPU: A Processor (CPU). GPU: A Graphics Processor (GPU). ASIC: An ASIC device, such as an FPGA or a GPGPU. Backplane: A backplane within the chassis. SystemBoard: The system board (PCB). PowerSupply: A power supply. VoltageRegulator: A voltage regulator device. StorageDevice: A storage device. NetworkingDevice: A networking device. ComputeBay: Within a compute bay. StorageBay: Within a storage bay. NetworkBay: Within a networking bay. ExpansionBay: Within an expansion bay. PowerSupplyBay: Within a power supply bay. Memory: A memory device. Chassis: The entire chassis. Fan: A fan.
ReadingCelsius	Decimal	Yes		read-only	Temperature. Unit: Cel
SensorNumber	Int64	Yes		read-only	A numerical identifier to represent the temperature sensor.
Status {	Object			read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}
UpperThresholdCritical	Decimal	Yes		read-only	Above normal range but not yet fatal. Unit: Cel
UpperThresholdFatal	Decimal	Yes		read-only	Above normal range and is fatal. Unit: Cel
UpperThresholdNonCritical	Decimal	Yes		read-only	Above normal range. Unit: Cel
} ]
Temperatures@odata.count	Int32			read-only	The number of items in a collection.

Actions

#Thermal.SetFanSpeed

Parameters

Property	Type	Nullable	Required	Permission	Description
Name	String	Yes	POST	read-write	The name of the Fan.
Percent	SByte	Yes	POST	read-write	The speed of the fan in percent. Minimum: 0 Maximum: 100

Request

POST /redfish/v1/Chassis/Chassis1/Thermal/Actions/Thermal.SetFanSpeed
Content-Type: application/json
{
"Name": "String",
"Percent": 0
}

Response

HTTP/1.1 204
Location: ThermalMonitored

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Thermal
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Thermal",
    "@odata.type": "String",
    "Actions": {
        "#Thermal.SetFanSpeed": {
            "target": "/redfish/v1/Chassis/Chassis1/Thermal/Actions/Thermal.SetFanSpeed",
            "title": "String"
        }
        "Oem": { }
    }
    "Description": "String",
    "Fans": [{
        "Actions": {
            "Oem": { }
        }
        "HotPluggable": false,
        "LowerThresholdCritical": 0,
        "LowerThresholdFatal": 0,
        "LowerThresholdNonCritical": 0,
        "MaxReadingRange": 0,
        "MemberId": "String",
        "MinReadingRange": 0,
        "Name": "String",
        "Oem": {
            "EID_47597": {
                "SpeedPercent": 0
            }
        }
        "PhysicalContext": "Room",
        "Reading": 0,
        "ReadingUnits": "RPM",
        "Status": {
            "Health": "OK",
            "HealthRollup": "OK",
            "Oem": { },
            "State": "Enabled"
        }
        "UpperThresholdCritical": 0,
        "UpperThresholdFatal": 0,
        "UpperThresholdNonCritical": 0
    }]
    "Fans@odata.count": 1,
    "Id": "String",
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "LastSensorUpdate": 0
        }
    }
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "Oem": { },
        "State": "Enabled"
    }
    "Temperatures": [{
        "Actions": {
            "Oem": { }
        }
        "LowerThresholdCritical": 0,
        "LowerThresholdFatal": 0,
        "LowerThresholdNonCritical": 0,
        "MaxReadingRangeTemp": 0,
        "MemberId": "String",
        "MinReadingRangeTemp": 0,
        "Name": "String",
        "Oem": { },
        "PhysicalContext": "Room",
        "ReadingCelsius": 0,
        "SensorNumber": 0,
        "Status": {
            "Health": "OK",
            "HealthRollup": "OK",
            "Oem": { },
            "State": "Enabled"
        }
        "UpperThresholdCritical": 0,
        "UpperThresholdFatal": 0,
        "UpperThresholdNonCritical": 0
    }]
    "Temperatures@odata.count": 1
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

Schema Navigation

Thermal

Schema Definition

Properties

Actions

#Thermal.SetFanSpeed

Parameters

Request

Response

Operations

GET

Request

Response

POST

PATCH

DELETE