Scroll to navigation

FREEIPMI_INTERPRET_SENSOR(5) Configuration FREEIPMI_INTERPRET_SENSOR(5)

NAME

freeipmi_interpret_sensor.conf - specify sensor interpretation rules

DESCRIPTION

The /etc/freeipmi//freeipmi_interpret_sensor.conf defines how IPMI sensors should be interpreted. IPMI based sensors specify a number of states/thresholds when they are read. Based on those states/thresholds, libraries and tools such as libfreeipmi(3), libipmimonitoring(3) and ipmi-sensors(8) can report if a sensor reading is "good" or "bad" via a report of a NOMINAL, WARNING, or CRITICAL state.

Each of the states listed below are (hopefully) descriptive enough to describe the state conditions that may be set/unset for each sensor type. For more detailed information on each of the individual states listed below, please see the IPMI Specification "Sensor and Event Code Tables". Ipmi-sensors(8) can be used to determine the sensor types and the states/thresholds that exist on a system by outputting very verbose output and seeing what types of Assertion or Deassertion events are possible.

The possible values for all states/thresholds below are:

Nominal - Signal Nominal reading if state/threshold tripped

Warning - Signal Warning reading if state/treshold tripped

Critical - Signal Critical reading if state/threshold tripped

Not all IPMI sensor types and event types are currently supported. If you would like more to be supported, please e-mail the FreeIPMI mailing list.

The default values selected for individual states/thresholds being tripped are based on best guesses and motherboards being analyzed. If you think they should be changed, please e-mail the FreeIPMI mailing list to discuss what the defaults should be.

Most default interpretations can be determined quite easily and can meet the needs of most users. For example, a reading of "Performance_Met" is normally better than "Performance_Lags". However, some sensors can be ambiguous and depend completely on the manufacturer. For example, "State_Asserted" vs. "State_Deasserted" are completely at the interpretation of the vendor. Users are advised to adjust the interpretations below as needed for their machines.

Every group of state conditions below includes a configuration for "No_Event". This is the condition under which no sensor states/events have occurred or are triggered. Under most conditions, a mapping to "Nominal" is preferred. However, under some circumstances, it may be useful to report something else. For example, if a sensor on a particular motherboard is required to report a state/event, a no sensor state condition could indicate a broken a sensor. This is highly dependent on the motherboard.

FORMAT

The configuration options that can be specified in the configuration file are listed below. Each configuration option must be listed on a separate line. Arguments for an option are separated by any amount of whitespace. Multiple arguments are also separated by whitespace. Comments can be marked by using the pound sign ("#") character, and lines can be continued on the next using backslash ("\").

OPTIONS

The following states correspond to threshold sensors. This normally applies to sensors that measure non-discrete values, such as temperatures, voltages, RPM, etc.
The following states correspond to Temperature sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Warning.
The following states correspond to Temperature sensors that report on limits.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Temperature sensors that report on device severity.
The following states correspond to Voltage sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Warning.
The following states correspond to Voltage sensors that report on limits.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Voltage sensors that report on performance.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Voltage sensors that report on device severity.
The following states correspond to Current sensors that report on device severity.
The following states correspond to Fan sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Warning.
The following states correspond to Fan sensors that report on device severity.
The following states correspond to Fan sensors that report on device installation.
The following states correspond to Power Supply sensors that report on device severity.
The following states correspond to Fan sensors that report on device availability.
The following states correspond to Fan sensors that report on redundancy.
The following states correspond to Physical Security sensors w/ Physical Security specific output states.
The following states correspond to Platform Violation Attempt sensors w/ Platform Security Violation Attempt specific output states.
The following states correspond to Processor sensors w/ Processor specific output states.
The following states correspond to Processor sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Power Supply sensors w/ Power Supply specific output states.
The following states correspond to Power_Supply sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Critical.
Defaults to Nominal.
The following states correspond to Power Supply sensors that report on redundancy.
The following states correspond to Power Unit sensors w/ Power Unit specific output states.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Warning.
Defaults to Warning.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
The following states correspond to Power Unit sensors that report on device installation.
The following states correspond to Power Unit sensors that report on redundancy.
The following states correspond to Cooling Device sensors that report on redundancy.
The following states correspond to Memory sensors w/ Memory specific output states.
Defaults to Nominal.
Defaults to Warning.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
Defaults to Warning.
Defaults to Nominal.
Defaults to Critical.
Defaults to Nominal.
Defaults to Warning.
Defaults to Critical.
The following states correspond to Memory sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Memory sensors that report on device severity.
The following states correspond to Cooling Device sensors that report on redundancy.
The following states correspond to Drive Slot sensors w/ Drive Slot specific output states.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
IPMI_Drive_Slot_Predictive_Failure
Defaults to Critical.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
Defaults to Critical.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Drive Slot sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Warning.
Defaults to Nominal.
The following states correspond to Drive_Slot sensors that report a predictive failure assertion or deassertion.
The following states correspond to Drive Slot sensors that report on device installation.
The following states correspond to POST Memory Resize sensors that report an assertion or deassertion.
The following states correspond to System Firmware Progress sensors w/ System Firmware Progress specific output states.
The following states correspond to System Firmware Progress sensors that report on device severity.
The following states correspond to Event Logging Disabled sensors w/
The following states correspond to System Event sensors w/ System Event specific output states.
The following states correspond to System Event sensors that report a transition state.
The following states correspond to System Event sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Warning.
The following states correspond to Critical Interrupt sensors w/ Critical Interrupt specific output states.
Defaults to Nominal.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
Defaults to Warning.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
Defaults to Warning.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical. IPMI_Critical_Interrupt_Bus_Degraded Defaults to Warning.
The following states correspond to Button/Switch sensors w/ Button/Switch specific output states.
The following states correspond to Button/Switch sensors that report an assertion or deassertion.
The following states correspond to Button/Switch sensors that report on device severity.
The following states correspond to Module/Board sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Module/Board sensors that report on device installation.
The following states correspond to Chassis sensors that report on device severity.
The following states correspond to Chip Set sensors that report on device severity.
The following states correspond to Cable/Interconnect sensors w/ Cable/Interconnect specific output states.
The following states correspond to Cable/Interconnect sensors that report on device severity.
The following states correspond to Boot Error sensors w/ Boot Error specific output states.
The following states correspond to Boot Error sensors that report an assertion or deassertion.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
The following states correspond to Boot Error sensors that report on device severity.
The following states correspond to OS Boot sensors w/ OS Boot specific output events.
IPMI_OS_Boot_No_Event Defaults to Nominal. IPMI_OS_Boot_A_Boot_Completed Defaults to Nominal. IPMI_OS_Boot_C_Boot_Completed Defaults to Nominal. IPMI_OS_Boot_PXE_Boot_Completed Defaults to Nominal. IPMI_OS_Boot_Diagnostic_Boot_Completed Defaults to Nominal. IPMI_OS_Boot_CD_ROM_Boot_Completed Defaults to Nominal. IPMI_OS_Boot_ROM_Boot_Completed Defaults to Nominal. IPMI_OS_Boot_Boot_Completed_Boot_Device_Not_Specified Defaults to Warning. IPMI_OS_Boot_Base_OS_Hypervisor_Installation_Started Defaults to Nominal. IPMI_OS_Boot_Base_OS_Hypervisor_Installation_Completed Defaults to Nominal. IPMI_OS_Boot_Base_OS_Hypervisor_Installation_Aborted Defaults to Warning. IPMI_OS_Boot_Base_OS_Hypervisor_Installation_Failed Defaults to Critical.
The following states correspond to OS Critical Stop sensors that report an assertion or deassertion.
The following states correspond to Slot Connector sensors w/ Slot Connector specific output states.
The following states correspond to Slot Connector sensors that report on device severity.
The following states correspond to Watchdog 2 sensors w/ Watchdog 2 specific output states.
Defaults to Nominal.
Defaults to Warning.
Defaults to Critical.
Defaults to Critical.
Defaults to Critical.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Warning.
The following states correspond to Platform Alert sensors that report an assertion or deassertion.
The following states correspond to Entity Presence sensors w/ Entity Presence specific output states.
Defaults to Nominal.
Defaults to Nominal.
Defaults to Critical.
Defaults to Critical.
The following states correspond to Entity Presence sensors that report on device installation.
The following states correspond to Management Subsystem Health sensors w/ Management Subsystem Health specific output states.
The following states correspond to Battery sensors w/ Battery specific output states.
Defaults to Nominal.
Defaults to Warning.
Defaults to Critical.
Defaults to Nominal.
The following states correspond to Session Audit sensors w/ Session_Audit specific output states.
The following states correspond to FRU State sensors w/ FRU State specific output states.
The following configuration options can be used to configure OEM specific interpretations. Users should be aware that both IPMI_OEM_Bitmask and IPMI_OEM_Value can be configured for an identical Manufacturer-ID, Product-ID, Event-Reading-Type-Code, and Sensor-Type combination. All interpretations rules for a specific combination are iterated through and the worst resulting sensor state is returned (i.e. Warning < Nominal, Critical < Warning). If no match is found, no sensor state is returned for the OEM sensor reading. For each of the configuration options below, <Manufacturer-ID> is the numeric IANA manufacturer ID for the manufacturer in question. The <Product-ID> is one or more numeric IDs representing the manufacturer's product. The <Product-ID> can be listed as a single numeric number (e.g. 1234), a range of IDs separated by a dash (e.g. 12-20), or a list of specific product IDs separated by a plus (e.g. 12+19+22). Both the Manufacturer-ID and Product-ID can be found using bmc-info(8). Multiple <Manufacturer-ID> and <Product-ID> pairs can be input separated by commas. The Event-Reading-Type-Code and Sensor-Type need not be OEM types. They may be non-OEM types and used to provide interpretation rules for sensors that may be behaving outside the standard of the IPMI specification.
IPMI_OEM_Bitmask can be used to configure a state interpretation for a specific Manufacturer-ID, Product-ID, Event-Reading-Type-Code, and Sensor-Type combination and a specific bitmask of the Sensor-Event. The state will be accepted as the sensor interpretation if the inputted bitmask ANDed with the actual sensor event bitmask reading is true. As a special case, the state will be accepted if the inputted bitmask and the actual sensor event bitmask are both 0. In other words, if no events happened, an OEM interpretation can be configured for this case by inputing a bitmask of 0x0000.
IPMI_OEM_Value can be used to configure a state interpretation for a specific Manufacturer-ID, Product-ID, Event-Reading-Type-Code, and Sensor-Type combination and a specific value for the Sensor-Event-Bitmask. The state will be accepted as the sensor interpretation if the inputted bitmask value is equal to the actual sensor event bitmask reading.

FILES

/etc/freeipmi//freeipmi_interpret_sensor.conf

REPORTING BUGS

Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.

COPYRIGHT

Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

SEE ALSO

libfreeipmi(3), libipmimonitoring(3), ipmi-sensors(8)

http://www.gnu.org/software/freeipmi/

2024-01-27 FreeIPMI 1.6.14