Sensors
Sensor 1.11.0
| Version | v1.11 |
| Release | 2025.2 |
Description
The Sensor schema describes a sensor and its properties.
URIs
/redfish/v1/Chassis/{ChassisId}/Sensors/{SensorId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Sensors/{SensorId} (deprecated)
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Sensors/{SensorId} (deprecated)
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Sensors/{SensorId} (deprecated)
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Sensors/{SensorId} (deprecated)
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Sensors/{SensorId} (deprecated)
Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Accuracy (deprecated v1.8) | number (%) | read-only (null) | The estimated percent error of measured versus actual values. Deprecated in v1.8 and later. This property has been deprecated in favor of ReadingAccuracy. |
| Actions { | object | The available actions for this resource. | |
| #Sensor.ResetMetrics {} | object | Resets metrics related to this sensor. For more information, see the Actions section below. | |
| #Sensor.ResetToDefaults (v1.6+) {} | object | The action resets the values of writable properties to factory defaults. For more information, see the Actions section below. | |
| } | |||
| AdjustedMaxAllowableOperatingValue | number | read-only (null) | The adjusted maximum allowable operating value for this equipment based on the environmental conditions. |
| AdjustedMinAllowableOperatingValue | number | read-only (null) | The adjusted minimum allowable operating value for this equipment based on the environmental conditions. |
| ApparentkVAh (v1.5+) | number (kV.A.h) | read-only (null) | Apparent energy (kVAh). |
| ApparentVA | number (V.A) | read-only (null) | The product of voltage and current for an AC circuit, in volt-ampere units. |
| AverageReading (v1.4+) | number | read-only (null) | The average sensor value. |
| AveragingInterval (v1.4+) | string (duration) | read-write (null) | The interval over which the average sensor value is calculated. |
| AveragingIntervalAchieved (v1.4+) | boolean | read-only (null) | Indicates that enough readings were collected to calculate the average sensor reading over the averaging interval time. |
| Calibration (v1.4+) | number | read-write (null) | The calibration offset applied to the Reading. |
| CalibrationTime (v1.4+) | string (date-time) | read-write (null) | The date and time that the sensor was last calibrated. |
| CrestFactor (v1.1+) | number | read-only (null) | The crest factor for this sensor. |
| ElectricalContext | string (enum) | read-only (null) | The combination of current-carrying conductors. For the possible property values, see ElectricalContext in Property details. |
| Enabled (v1.10+) | boolean | read-write (null) | Indicates whether the sensor is enabled and provides a reading. |
| Implementation (v1.1+) | string (enum) | read-only (null) | The implementation of the sensor. For the possible property values, see Implementation in Property details. |
| LifetimeReading (v1.1+) | number | read-only (null) | The total accumulation value for this sensor. |
| LifetimeStartDateTime (v1.9+) | string (date-time) | read-only (null) | The date and time when the sensor started accumulating readings for the LifetimeReading property. |
| Links (v1.3+) { | object | The links to other resources that are related to this resource. | |
| AssociatedControls (v1.4+) [ { | array | An array of links to the controls that can affect this sensor. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| Oem {} | object | The OEM extension property. See the Resource schema for details on this property. | |
| } | |||
| LoadPercent (deprecated v1.1) | number (%) | read-only (null) | The power load utilization for this sensor. Deprecated in v1.1 and later. This property has been deprecated in favor of using a sensor instance with a ReadingType of Percent to show utilization values when needed. |
| Location {} | object | The location information for this sensor. See the v1_23_0.v1_23_0 schema for details on this property. | |
| LowestReading (v1.4+) | number | read-only (null) | The lowest sensor value. |
| LowestReadingTime (v1.4+) | string (date-time) | read-only (null) | The time when the lowest sensor value occurred. |
| Manufacturer (v1.9+) | string | read-only (null) | The manufacturer of this sensor. |
| MaxAllowableOperatingValue | number | read-only (null) | The maximum allowable operating value for this equipment. |
| MinAllowableOperatingValue | number | read-only (null) | The minimum allowable operating value for this equipment. |
| Model (v1.9+) | string | read-only (null) | The model number of the sensor. |
| Oem {} | object | The OEM extension property. See the Resource schema for details on this property. | |
| PartNumber (v1.9+) | string | read-only (null) | The part number of the sensor. |
| PeakReading | number | read-only (null) | The peak sensor value. |
| PeakReadingTime | string (date-time) | read-only (null) | The time when the peak sensor value occurred. |
| PhaseAngleDegrees (v1.5+) | number | read-only (null) | The phase angle (degrees) between the current and voltage waveforms. |
| PhysicalContext | string (enum) | read-write (null) | The area or device to which this sensor measurement applies. For the possible property values, see PhysicalContext in Property details. |
| PhysicalSubContext | string (enum) | read-write (null) | The usage or location within a device to which this sensor measurement applies. For the possible property values, see PhysicalSubContext in Property details. |
| PowerFactor | number | read-only (null) | The power factor for this sensor. |
| Precision | number | read-only (null) | The number of significant digits in the reading. |
| ReactivekVARh (v1.5+) | number (kV.A.h) | read-only (null) | Reactive energy (kVARh). |
| ReactiveVAR | number (V.A) | read-only (null) | The square root of the difference term of squared apparent VA and squared power (Reading) for a circuit, in VAR units. |
| Reading | number | read-only (null) | The sensor value. |
| ReadingAccuracy (v1.8+) | number | read-only (null) | Accuracy (+/-) of the reading. |
| ReadingBasis (v1.7+) | string (enum) | read-only (null) | The basis for the reading of this sensor. For the possible property values, see ReadingBasis in Property details. |
| ReadingRangeMax | number | read-only (null) | The maximum possible value for this sensor. |
| ReadingRangeMin | number | read-only (null) | The minimum possible value for this sensor. |
| ReadingTime (v1.1+) | string (date-time) | read-only (null) | The date and time that the reading was acquired from the sensor. |
| ReadingType | string (enum) | read-only (null) | The type of sensor. For the possible property values, see ReadingType in Property details. |
| ReadingUnits | string | read-only (null) | The units of the reading, thresholds, and other reading-related properties in UCUM c/s format. |
| RelatedItem (v1.2+) [ { | array | An array of links to resources or objects that this sensor services. | |
| @odata.id | string (URI) | read-only | The unique identifier for a resource. |
| } ] | |||
| SensingFrequency (deprecated v1.1) | number | read-only (null) | The time interval between readings of the physical sensor. Deprecated in v1.1 and later. This property has been deprecated in favor of the SensingInterval property, which uses the duration time format for interoperability. |
| SensingInterval (v1.1+) | string (duration) | read-only (null) | The time interval between readings of the sensor. |
| SensorGroup (v1.4+) {} | object | The group of sensors that provide readings for this sensor. See the v1_7_0.v1_7_0 schema for details on this property. | |
| SensorResetTime | string (date-time) | read-only (null) | The date and time when the time-based properties were last reset. |
| SerialNumber (v1.9+) | string | read-only (null) | The serial number of the sensor. |
| SKU (v1.9+) | string | read-only (null) | The SKU of the sensor. |
| SparePartNumber (v1.9+) | string | read-only (null) | The spare part number of the sensor. |
| SpeedRPM (v1.2+) | number ({rev}/min) | read-only (null) | The rotational speed. |
| Status {} | object | The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property. | |
| THDPercent (v1.1+) | number (%) | read-only (null) | The total harmonic distortion percent (% THD). |
| Thresholds { | object | The set of thresholds defined for this sensor. | |
| LowerCaution {} | object | The value at which the reading is below normal range. For more information about this property, see Threshold in Property Details. | |
| LowerCautionUser (v1.2+) {} | object | A user-defined value at which the reading is considered below normal range. For more information about this property, see Threshold in Property Details. | |
| LowerCritical {} | object | The value at which the reading is below normal range but not yet fatal. For more information about this property, see Threshold in Property Details. | |
| LowerCriticalUser (v1.2+) {} | object | A user-defined value at which the reading is considered below normal range but not yet fatal. For more information about this property, see Threshold in Property Details. | |
| LowerFatal {} | object | The value at which the reading is below normal range and fatal. For more information about this property, see Threshold in Property Details. | |
| UpperCaution {} | object | The value at which the reading is above normal range. For more information about this property, see Threshold in Property Details. | |
| UpperCautionUser (v1.2+) {} | object | A user-defined value at which the reading is considered above normal range. For more information about this property, see Threshold in Property Details. | |
| UpperCritical {} | object | The value at which the reading is above normal range but not yet fatal. For more information about this property, see Threshold in Property Details. | |
| UpperCriticalUser (v1.2+) {} | object | A user-defined value at which the reading is considered above normal range but not yet fatal. For more information about this property, see Threshold in Property Details. | |
| UpperFatal {} | object | The value at which the reading is above normal range and fatal. For more information about this property, see Threshold in Property Details. | |
| } | |||
| UserLabel (v1.9+) | string | read-write | A user-assigned label. |
| VoltageType | string (enum) | read-only (null) | The voltage type for this sensor. For the possible property values, see VoltageType in Property details. |
Actions
ResetMetrics
Description
Resets metrics related to this sensor.
Action URI
{Base URI of target resource}/Actions/Sensor.ResetMetrics
Action parameters
This action takes no parameters.
ResetToDefaults (v1.6+)
Description
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/Sensor.ResetToDefaults
Action parameters
This action takes no parameters.
Property details
Activation
The direction of crossing that activates this threshold.
| string | Description |
|---|---|
| Decreasing | Value decreases below the threshold. |
| Disabled (v1.7+) | The threshold is disabled. |
| Either | Value crosses the threshold in either direction. |
| Increasing | Value increases above the threshold. |
ElectricalContext
The combination of current-carrying conductors.
| string | Description |
|---|---|
| Line1 | The circuits that share the L1 current-carrying conductor. |
| Line1ToLine2 | The circuit formed by L1 and L2 current-carrying conductors. |
| Line1ToNeutral | The circuit formed by L1 and neutral current-carrying conductors. |
| Line1ToNeutralAndL1L2 | The circuit formed by L1, L2, and neutral current-carrying conductors. |
| Line2 | The circuits that share the L2 current-carrying conductor. |
| Line2ToLine3 | The circuit formed by L2 and L3 current-carrying conductors. |
| Line2ToNeutral | The circuit formed by L2 and neutral current-carrying conductors. |
| Line2ToNeutralAndL1L2 | The circuit formed by L1, L2, and Neutral current-carrying conductors. |
| Line2ToNeutralAndL2L3 | The circuits formed by L2, L3, and neutral current-carrying conductors. |
| Line3 | The circuits that share the L3 current-carrying conductor. |
| Line3ToLine1 | The circuit formed by L3 and L1 current-carrying conductors. |
| Line3ToNeutral | The circuit formed by L3 and neutral current-carrying conductors. |
| Line3ToNeutralAndL3L1 | The circuit formed by L3, L1, and neutral current-carrying conductors. |
| LineToLine | The circuit formed by two current-carrying conductors. |
| LineToNeutral | The circuit formed by a line and neutral current-carrying conductor. |
| Neutral | The grounded current-carrying return circuit of current-carrying conductors. |
| Total | The circuit formed by all current-carrying conductors. |
Implementation
The implementation of the sensor.
| string | Description |
|---|---|
| PhysicalSensor | The reading is acquired from a physical sensor. |
| Reported | The reading is obtained from software or a device. |
| Synthesized | The reading is obtained by applying a calculation on one or more properties or multiple sensors. The calculation is not provided. |
PhysicalContext
The area or device to which this sensor measurement applies.
| string | Description |
|---|---|
| Accelerator | An accelerator. |
| ACInput | An AC electrical input or input-related circuit. |
| ACMaintenanceBypassInput | An AC electrical maintenance bypass input. |
| ACOutput | An AC electrical output or output-related circuit. |
| ACStaticBypassInput | An AC electrical static bypass input. |
| ACUtilityInput | An AC electrical utility input. |
| ASIC | An ASIC device, such as a networking chip or chipset component. |
| Back | The back of the chassis. |
| Backplane | A backplane within the chassis. |
| Battery | A battery. |
| Board | A circuit board. |
| Chassis | The entire chassis. |
| ComputeBay | A compute bay. |
| CoolingSubsystem | The entire cooling, or air and liquid, subsystem. |
| CPU | A processor (CPU). |
| CPUSubsystem | The entire processor (CPU) subsystem. |
| DCBus | A DC electrical bus. |
| Exhaust | The air exhaust point or points or region of the chassis. |
| ExpansionBay | An expansion bay. |
| ExpansionSubsystem | A group of expansion bays. |
| Fan | A fan. |
| Filter | A filter. |
| FPGA | An FPGA. |
| Front | The front of the chassis. |
| GPU | A graphics processor (GPU). |
| GPUSubsystem | The entire graphics processor (GPU) subsystem. |
| Intake | The air intake point or points or region of the chassis. |
| LiquidInlet | The liquid inlet point of the chassis. |
| LiquidOutlet | The liquid outlet point of the chassis. |
| Lower | The lower portion of the chassis. |
| Manager | A management controller, such as a BMC (baseboard management controller). |
| Memory | A memory device. |
| MemorySubsystem | The entire memory subsystem. |
| Motor | A motor. |
| NetworkBay | A networking bay. |
| NetworkingDevice | A networking device. |
| PowerOutlet | An electrical outlet. |
| PowerSubsystem | The entire power subsystem. |
| PowerSupply | A power supply. |
| PowerSupplyBay | A power supply bay. |
| Pump | A pump. |
| Rectifier | A rectifier device. |
| Reservoir | A reservoir. |
| Room | The room. |
| StorageBay | A storage bay. |
| StorageDevice | A storage device. |
| StorageSubsystem | A storage subsystem. |
| Switch | A switch device. |
| SystemBoard | The system board (PCB). |
| Transceiver | A transceiver. |
| Transformer | A transformer. |
| TrustedModule | A trusted module. |
| Upper | The upper portion of the chassis. |
| VoltageRegulator | A voltage regulator device. |
PhysicalSubContext
The usage or location within a device to which this sensor measurement applies.
| string | Description |
|---|---|
| Input | The input. |
| Output | The output. |
ReadingBasis
The basis for the reading of this sensor.
| string | Description |
|---|---|
| Delta | A reading that reports the difference between two measurements. |
| Headroom | A reading that decreases as it approaches a defined reference point. |
| Zero | A zero-based reading. |
ReadingType
The type of sensor.
| string | Description |
|---|---|
| AbsoluteHumidity (v1.5+) | Absolute humidity (g/m^3). |
| AirFlow (deprecated v1.7) | Air flow (cu ft/min). Deprecated in v1.7 and later. This value has been deprecated in favor of AirFlowCMM for consistent use of SI units. |
| AirFlowCMM (v1.7+) | Air flow (m^3/min). |
| Altitude | Altitude (m). |
| Barometric | Barometric pressure (mm). |
| ChargeAh (v1.4+) | Charge (Ah). |
| Current | Current (A). |
| EnergyJoules | Energy (J). |
| EnergykWh | Energy (kWh). |
| EnergyWh (v1.4+) | Energy (Wh). |
| Frequency | Frequency (Hz). |
| Heat (v1.7+) | Heat (kW). |
| Humidity | Relative humidity (percent). |
| LinearAcceleration (v1.11+) | Linear acceleration (m/s^2). |
| LinearPosition (v1.11+) | Linear position or distance (m). |
| LinearVelocity (v1.11+) | Linear velocity (m/s). |
| LiquidFlow (deprecated v1.7) | Liquid flow (L/s). Deprecated in v1.7 and later. This value has been deprecated in favor of LiquidFlowLPM for consistency of units typically expected or reported by Sensor and Control resources. |
| LiquidFlowLPM (v1.7+) | Liquid flow (L/min). |
| LiquidLevel | Liquid level (cm). |
| Percent (v1.1+) | Percent (%). |
| Power | Power (W). |
| Pressure (deprecated v1.7) | Pressure (Pa). Deprecated in v1.7 and later. This value has been deprecated in favor of PressurePa or PressurekPa for consistency of units between Sensor and Control resources. |
| PressurekPa (v1.5+) | Pressure (kPa). |
| PressurePa (v1.7+) | Pressure (Pa). |
| Rotational | Rotational (RPM). |
| RotationalAcceleration (v1.11+) | Rotational acceleration (rad/s^2). |
| RotationalPosition (v1.11+) | Rotational position (rad). |
| RotationalVelocity (v1.11+) | Rotational velocity (rad/s). |
| Temperature | Temperature (C). |
| Valve (v1.11+) | Valve (% open). |
| Voltage | Voltage (VAC or VDC). |
Threshold
The threshold definition for a sensor.
| Activation | string (enum) | read-write (null) | The direction of crossing that activates this threshold. For the possible property values, see Activation in Property details. |
| DwellTime | string (duration) | read-write (null) | The duration the sensor value must violate the threshold before the threshold is activated. |
| HysteresisDuration (v1.7+) | string (duration) | read-write (null) | The duration the sensor value must not violate the threshold before the threshold is deactivated. |
| HysteresisReading (v1.7+) | number | read-write (null) | The reading offset from the threshold value required to clear the threshold. |
| Reading | number | read-write (null) | The threshold value. |
VoltageType
The voltage type for this sensor.
| string | Description |
|---|---|
| AC | Alternating current. |
| DC | Direct current. |
Example response
{
"@odata.type": "#Sensor.v1_12_0.Sensor",
"Id": "CabinetTemp",
"Name": "Rack Temperature",
"ReadingType": "Temperature",
"ReadingTime": "2019-12-25T04:14:33+06:00",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Reading": 31.6,
"ReadingUnits": "C",
"ReadingRangeMin": 0,
"ReadingRangeMax": 70,
"Accuracy": 0.25,
"Precision": 1,
"SensingInterval": "PT3S",
"PhysicalContext": "Chassis",
"Thresholds": {
"UpperCritical": {
"Reading": 40,
"Activation": "Increasing"
},
"UpperCaution": {
"Reading": 35,
"Activation": "Increasing"
},
"LowerCaution": {
"Reading": 10,
"Activation": "Increasing"
}
},
"@odata.id": "/redfish/v1/Chassis/1/Sensors/CabinetTemp"
}