Thermal

Schema Definition

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

Properties

PropertyTypeNullableRequiredPermissionDescription
@odata.contextStringread-onlyThe OData description of a payload.
Format: uri
@odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
@odata.typeStringread-onlyThe type of a resource.
Actions {Objectread-writeThe available actions for this resource.
    #Thermal.SetFanSpeed {Objectread-writeSets the speed of a fan in percent.
        targetStringread-writeLink to invoke action
Format: uri
        titleStringread-writeFriendly action name
    }
    Oem { }Objectread-writeThe available OEM specific actions for this resource.
}
DescriptionStringYesread-onlyProvides a description of this resource and is used for commonality in the schema definitions.
Fans [ {Array[Object]read-writeThis is the definition for fans.
    Actions {Objectread-writeThe available actions for this resource.
        Oem { }Objectread-writeThe available OEM specific actions for this resource.
    }
    HotPluggableBooleanYesread-onlyIndicates if this device can be inserted or removed while the equipment is in operation.
    LowerThresholdCriticalInt64Yesread-onlyBelow normal range but not yet fatal.
    LowerThresholdFatalInt64Yesread-onlyBelow normal range and is fatal.
    LowerThresholdNonCriticalInt64Yesread-onlyBelow normal range.
    MaxReadingRangeInt64Yesread-onlyMaximum value for Reading.
    MemberIdStringread-onlyThis is the identifier for the member within the collection.
    MinReadingRangeInt64Yesread-onlyMinimum value for Reading.
    NameStringYesread-onlyName of the fan.
    Oem {Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
        EID_47597 {Objectread-writeRECS|Box Fan extension
            SpeedPercentSByteread-onlyGets the speed of the fan in percent.
Minimum: 0
Maximum: 100
        }
    }
    PhysicalContextStringread-onlyDescribes 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.
    ReadingInt64Yesread-onlyCurrent fan speed.
    ReadingUnitsStringYesread-onlyUnits 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 {Objectread-writeThis type describes the status and health of a resource and its children.
        HealthStringYesread-onlyThis 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.
        HealthRollupStringYesread-onlyThis 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 { }Objectread-writeOem extension object.
        StateStringYesread-onlyThis 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.
    }
    UpperThresholdCriticalInt64Yesread-onlyAbove normal range but not yet fatal.
    UpperThresholdFatalInt64Yesread-onlyAbove normal range and is fatal.
    UpperThresholdNonCriticalInt64Yesread-onlyAbove normal range.
} ]
Fans@odata.countInt32read-onlyThe number of items in a collection.
IdStringGETread-onlyUniquely identifies the resource within the collection of like resources.
NameStringGETread-onlyThe name of the resource or array element.
Oem {Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    EID_47597 {Objectread-writeRECS|Box Thermal extension
        LastSensorUpdateInt64Yesread-onlyThe timestamp of the last sensor update expressed as milliseconds since the time 00:00:00 UTC on January 1, 1970.
    }
}
Status {Objectread-writeThis type describes the status and health of a resource and its children.
    HealthStringYesread-onlyThis 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.
    HealthRollupStringYesread-onlyThis 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 { }Objectread-writeOem extension object.
    StateStringYesread-onlyThis 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-writeThis is the definition for temperature sensors.
    Actions {Objectread-writeThe available actions for this resource.
        Oem { }Objectread-writeThe available OEM specific actions for this resource.
    }
    LowerThresholdCriticalDecimalYesread-onlyBelow normal range but not yet fatal.
Unit: Cel
    LowerThresholdFatalDecimalYesread-onlyBelow normal range and is fatal.
Unit: Cel
    LowerThresholdNonCriticalDecimalYesread-onlyBelow normal range.
Unit: Cel
    MaxReadingRangeTempDecimalYesread-onlyMaximum value for ReadingCelsius.
Unit: Cel
    MemberIdStringread-onlyThis is the identifier for the member within the collection.
    MinReadingRangeTempDecimalYesread-onlyMinimum value for ReadingCelsius.
Unit: Cel
    NameStringYesread-onlyTemperature sensor name.
    Oem { }Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    PhysicalContextStringread-onlyDescribes 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.
    ReadingCelsiusDecimalYesread-onlyTemperature.
Unit: Cel
    SensorNumberInt64Yesread-onlyA numerical identifier to represent the temperature sensor.
    Status {Objectread-writeThis type describes the status and health of a resource and its children.
        HealthStringYesread-onlyThis 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.
        HealthRollupStringYesread-onlyThis 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 { }Objectread-writeOem extension object.
        StateStringYesread-onlyThis 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.
    }
    UpperThresholdCriticalDecimalYesread-onlyAbove normal range but not yet fatal.
Unit: Cel
    UpperThresholdFatalDecimalYesread-onlyAbove normal range and is fatal.
Unit: Cel
    UpperThresholdNonCriticalDecimalYesread-onlyAbove normal range.
Unit: Cel
} ]
Temperatures@odata.countInt32read-onlyThe number of items in a collection.

Actions

#Thermal.SetFanSpeed

Parameters

PropertyTypeNullableRequiredPermissionDescription
NameStringYesPOSTread-writeThe name of the Fan.
PercentSByteYesPOSTread-writeThe 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