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/{sensor Id}

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 chassis resource.

ApparentVA

Number

The product of voltage and current for an AC circuit, in volt-ampere units.

MaxAllowableOperatingValue

Number

The maximum allowable operating value for this equipment.

MinAllowableOperatingValue

Number

The minimum allowable operating value for this equipment.

PhysicalContext

String

The area or device to which this sensor measurement applies.

Precision

Number

The number of significant digits in the reading.

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: “Enabled”, “Disabled”

 

Health

String

Valid values: “OK”, “Warning”, “Critical”, or null

Thresholds

Object

Expanded

 

LowerCaution

Object

Expanded

  

Activation

String

“Decreasing”

  

Reading

Number

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

 

LowerCritical

Object

Expanded

  

Activation

String

“Decreasing”

  

Reading

Number

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

 

LowerFatal

Object

Expanded

  

Activation

String

“Decreasing”

  

Reading

Number

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

 

UpperCaution

Object

Expanded

  

Activation

String

“Increasing”

  

Reading

Number

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

 

UpperCritical

Object

Expanded

  

Activation

String

“Increasing”

  

Reading

Number

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

 

UpperFatal

Object

Expanded

  

Activation

String

“Increasing”

  

Reading

Number

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

VoltageType

String

“DC”

It is hidden when not a voltage sensor.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/1L0",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ReadingUnits": "",
"Reading": 0,
"PhysicalContext": null,
"@odata.type": "#Sensor.v1_1_0.Sensor",
"ReadingType": "Power",
"Id": "1L0",
"@odata.etag": "\"253a27c7e52c2a24abf\"",
"Name": "Host Power",
"Description": "This resource is used to represent a sensor for a Redfish implementation."
}