Skip to main content

GET – Sensor properties

Use the GET method to retrieve properties in sensor resource.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/Sensors/{SesnorType}_{SensorName}

Request body

None

Response body

Field

Type

Description

Id

String

Uniquely identifies the resource within the collection of Sensor.

The format of this value is <SensorNumber>L<OwnerLUN>, e.g. 244L0, 20L1, etc.

There are also some Redfish specified sensors, such as “PSU{N}_InputVol”, “GPU{N}_Power”.

Name

String

Sensor name, the value is obtained from SDR.

Description

String

Provides a description of this sensor resource.

Reading

Number

Sensor value.

ReadingRangeMax

Number

The maximum possible value for this sensor.

ReadingRangeMin

Number

The minimum possible value for this sensor.

ReadingType

String

Sensor type.

ReadingUnits

Number

The units of the reading and thresholds.

Status

Object

Expanded.

 

State

String

Valid values: Present, Enabled, or Absent.

 

Health

String

Valid values: Functional or Critical.

Thresholds

Object

Expanded.

 

LowerCaution

Object

Expanded.

  

Reading

Number

The value at which the Reading property is below normal range.

 

LowerCritical

Object

Expanded.

  

Reading

Number

The value at which the Reading property is below normal range but not yet fatal.

 

LowerFatal

Object

Expanded.

  

Reading

Number

The value at which the Reading property is below normal range and fatal.

 

UpperCaution

Object

Expanded.

  

Reading

Number

The value at which the Reading property is above normal range.

 

UpperCritical

Object

Expanded.

  

Reading

Number

The value at which the Reading property is above normal range but not yet fatal.

 

UpperFatal

Object

Expanded.

  

Reading

Number

The value at which the Reading property is above normal range and fatal.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

{
"@odata.context": "/redfish/v1/$metadata#Sensor.Sensor",
"@odata.etag": "\"3F45F789\"",
"@odata.id": "/redfish/v1/Chassis/1/Sensors/power_PSU1_Input_Power",
"@odata.type": "#Sensor.v1_2_0.Sensor",
"Description": "This resource is used to represent a sensor for a Redfish implementation",
"Id": "power_PSU1_Input_Power",
"Name": "PSU1 Input Power",
"Reading": 465.0,
"ReadingRangeMax": 3000.0,
"ReadingRangeMin": 0.0,
"ReadingType": "Power",
"ReadingUnits": "W",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}