1#Example fan monitor definitions for phosphor-fan-monitor
2
3#List the fans that need to be monitored, along with some
4#properties that define how much slack is allowed in the actual
5#tach value as compared to the target tach value.
6
7#fans:
8# - inventory:
9#    [The system inventory location for the fan]
10#  allowed_out_of_range_time:
11#    [Time (in secs) actual speed can be outside of deviation of
12#     target speed]
13#  deviation:
14#    [Percentage that actual speed must be within target speed]
15#  num_sensors_nonfunc_for_fan_nonfunc:
16#    [How many sensors on the fan must be faulted before fan
17#     will be considered faulted]
18#  sensors: [array of speed sensors for the fan]
19#    - name [The name of the fan sensor]
20#      has_target [true|false  If this sensor has a Target property for
21#                  setting a fan speed (otherwise just for reads)]
22#
23#sensor_trust_groups:
24# - class: [Group class name
25#           Available classes:
26#           * NonzeroSpeed - Only trust if at least one sensor in the group
27#                            has a nonzero speed.]
28#   sensors:
29#     - name [The name of the fan sensor in this group]
30
31#The code uses these parameters as follows:
32#  After a speed reading of a sensor is outside of the allowed deviation of
33#  the target speed for the allowed out of range time, if at least
34#  num_sensors_nonfunc_for_fan_nonfunc sensors meet this condition,
35#  the fan will be set to nonfunctional in the inventory.
36#
37#  Sensor trust groups are used to specify that the speed values for the
38#  sensors in a group cannot be trusted based on some condition, where
39#  the condition is based on the class used to implement the group.  All
40#  sensors in the group go in and out of trust together.  This section
41#  is optional.
42
43#Example entries for 1 fan system:
44#fans:
45#  - inventory: /system/chassis/motherboard/fan0
46#    allowed_out_of_range_time: 15
47#    deviation: 15
48#    num_sensors_nonfunc_for_fan_nonfunc: 1
49#    sensors:
50#      - name: fan0
51#        has_target: true
52#sensor_trust_groups:
53# - class: NonzeroSpeed
54#    sensors:
55#      - name: fan0_0
56