GET – Thermal management properties

Use the GET method to retrieve properties in Thermal resource for a server.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/Thermal

Request body

None

Response body

The response is a JSON object that contains the following parameters:

Field				Type	Description
Id				String	Uniquely identifies the resource within the thermal resource. Always set to “1”.
Name				String	The name of thermal resource. Always sets to “Thermal”.
Description				String	Provides a description of the thermal resource.
Status				Object	Describes the status and health of a resource and its children.
	State			String	This indicates the known state of the resource, such as if it is enabled.
	HealthRollup			String	This represents the overall health state from the view of this resource.
Temperatures				Array	This is the definition for temperature sensors.
	Temperatures[1]			Object	This is the definition for a specified temperature sensor.
		MemberId		String	This is the identifier for the member within the collection.
		Name		String	The name of this temperature sensor.
		LowerThresholdCritical		Number	Below normal range but not yet fatal.
		LowerThresholdFatal		Number	Below normal range and is fatal.
		LowerThresholdNonCritical		Number	Below normal range.
		UpperThresholdCritical		Number	Above normal range but not yet fatal.
		UpperThresholdFatal		Number	Above normal range and is fatal.
		UpperThresholdNonCritical		Number	Above normal range.
		MinReadingRangeTemp		Number	Minimum value for ReadingCelsius.
		MaxReadingRangeTemp		Number	Maximum value for ReadingCelsius.
		PhysicalContext		String	Describes the area or device to which this temperature measurement applies.
		ReadingCelsius		Number	Temperature.
		RelatedItem		Array	Describes the areas or devices to which this temperature measurement applies.
			RelatedItem[N]	Link	The element of the array provides a link to device applied. One element links to chassis resource. One element links to system resource. If the PhysicalContext is “CPU”, the array will contain an element links to related processor resource.
		SensorNumber		Number	A numerical identifier to represent the temperature sensor.
		Status		Object	Describes the status and health of a resource and its children.
			State	String	This indicates the known state of the resource, such as if it is enabled.
Fans				Array	This is the definition for fans.
	Fan[N]			Object	This is the definition for a specified fan.
		MemberId		String	This is the identifier for the member within the collection.
		Name		String	Name of the fan.
		MaxReadingRange		Number	Maximum value for Reading.
		MinReadingRange		Number	Minimum value for Reading.
		PhysicalContext		String	Describes the area or device associated with this fan.
		Reading		Number	Current fan speed.
		ReadingUnits		String	Units in which the reading and thresholds are measured. Always set to “RPM”.
		RelatedItem		Array	Describes the areas or devices to which this temperature measurement applies.
			RelatedItem[N]	Link	The element of the array provides a link to device applied. One element links to chassis resource. One element links to system resource.
		Status		Object	Describes the status and health of a resource and its children.
			State	String	This indicates the known state of the resource, such as if it is enabled.
			Health	String	This represents the health state of this resource in the absence of its dependent resources.
		UpperThresholdCritical		Number	Above normal range but not yet fatal.
		UpperThresholdFatal		Number	Above normal range and is fatal.
		UpperThresholdNonCritical		Number	Above normal range.
		LowerThresholdCritical		Number	Below normal range but not yet fatal.
		LowerThresholdFatal		Number	Below normal range and is fatal.
		LowerThresholdNonCritical		Number	Below normal range.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "Fans": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",
            "ReadingUnits": "RPM",
            "PhysicalContext": "SystemBoard",
            "LowerThresholdFatal": null,
            "Location": {
                "PartLocation": {
                    "LocationType": "Slot",
                    "ServiceLabel": "Fan 1 Tach",
                    "LocationOrdinalValue": 1
                }
            },
            "UpperThresholdCritical": null,
            "MaxReadingRange": 18360,
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/1"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1"
                }
            ],
            "LowerThresholdCritical": 3,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "FanName": "Fan 1 Tach",
            "Name": "Fan 1 Tach",
            "Reading": 0,
            "UpperThresholdNonCritical": null,
            "Oem": {
                "Lenovo": {
                    "Location": {
                        "InfoFormat@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead.",
                        "InfoFormat": "Slot X",
                        "Info": "Slot 1",
                        "Info@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead."
                    }
                }
            },
            "HotPluggable": true,
            "MinReadingRange": 0,
            "MemberId": "0",
            "LowerThresholdNonCritical": null,
            "SensorNumber": 65,
            "UpperThresholdFatal": null
        }
        …
        …
    ],
    "@odata.id": "/redfish/v1/Chassis/1/Thermal",
    "Status": {
        "State": "Enabled",
        "HealthRollup": "OK"
    },
    "Name": "Thermal",
    "Id": "1",
    "Oem": {
        "Lenovo": {
            "@odata.type": "#LenovoThermal.v1_0_0.Thermal",
            "HistoryTempMetric": {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal/Oem/Lenovo/HistoryTempMetric"
            }
        }
    },
    "@odata.type": "#Thermal.v1_5_3.Thermal",
    "Temperatures": [
        {
            "PhysicalContext": "Intake",
            "LowerThresholdCritical": null,
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/1"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1"
                }
            ],
            "UpperThresholdFatal": 50,
            "Status": {
                "State": "Enabled"
            },
            "SensorNumber": 49,
            "Name": "Ambient Temp",
            "MaxReadingRangeTemp": 100,
            "UpperThresholdNonCritical": 43,
            "UpperThresholdCritical": 47,
            "LowerThresholdNonCritical": null,
            "MemberId": "0",
            "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",
            "MinReadingRangeTemp": 0,
            "LowerThresholdFatal": null,
            "ReadingCelsius": 43
        }
        …
        …
    ],
    "Temperatures@odata.count": 40,
    "@odata.etag": "\"d605f76ecfe4632cb9e370\"",
    "Fans@odata.count": 5,
    "Description": "It represents the properties for Temperature and Cooling."
}

Give documentation feedback

GET – Thermal management properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example