docs:monitor: Fill in num_sensors_nonfunc_for_fan_nonfunc details
The `num_sensors_nonfunc_for_fan_nonfunc` attribute contains the number
of sensors that must be nonfunctional before the fan containing those
sensors are nonfunctional. This defaults to 0, meaning that the fan
enclosure's functional state will not be updated based on the functional
state of its sensors.
Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: I0fc646a2819a40115e9d519cc00ecf2bc8aab3a1
diff --git a/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md b/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
index ea473e2..748827d 100644
--- a/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
+++ b/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
@@ -1,9 +1,40 @@
# num_sensors_nonfunc_for_fan_nonfunc
## Description
-
+The number of `sensors` that must be deemed nonfunctional for the fan enclosure
+object to also be nonfunctional. This attribute is optional and defaults to 0,
+meaning the fan enclosure will not be set to nonfunctional based on the
+functional state of its list of `sensors`.
## Attribute Value(s)
-
+integer (default = 0)
## Example
+<pre><code>
+{
+ "fans": [
+ {
+ "inventory": "/system/chassis/motherboard/fan0",
+ "allowed_out_of_range_time": 30,
+ "functional_delay": 5,
+ "deviation": 15,
+ <b><i>"num_sensors_nonfunc_for_fan_nonfunc": 1</i></b>,
+ "monitor_start_delay": 30,
+ "fan_missing_error_delay": 20,
+ "nonfunc_rotor_error_delay": 0,
+ "sensors": [
+ {
+ "name": "fan0_0",
+ "has_target": true
+ },
+ {
+ "name": "fan0_1",
+ "has_target": false,
+ "factor": 1.45,
+ "offset": -909
+ }
+ ]
+ }
+ ]
+}
+</code></pre>