1# power_off_config
2
3## Description
4
5A list of power off rules based on the monitoring state of the fans configured.
6These power off rules can perform different system power off types to protect a
7system that is not able to provide enough cooling due to a number of missing or
8nonfunctional fans.
9
10## Attribute Value(s)
11
12- `type` - ["hard", "soft", "epow"]
13  - "hard" - Perform a hard shutdown that immediately powers off the system.
14  - "soft" - Perform an orderly shutdown requesting that the host OS power off
15    the system.
16  - "epow" - Sets the thermal alert D-Bus property that a power off is imminent
17    after a `service_mode_delay` amount of time passes.
18- `cause` - ["missing_fan_frus", "nonfunc_fan_rotors"]
19  - "missing_fan_frus" - Power off due to missing fan enclosures
20  - "nonfunc_fan_rotors" - Power off due to nonfunctional fan
21    rotors([`sensors`](sensors.md))
22- `count` - integer
23  - Number of the configured `cause` instances to begin the power off `type`
24
25### "hard" & "soft" `type` power offs
26
27- `delay` - integer
28  - Time(in seconds) to delay performing the power off after `count` instances
29    of the `cause` criteria is met.
30- `state` - ["at_pgood", "runtime"] (Optional)
31  - `at_pgood` - At system pgood, the power off rule becomes valid. A power off
32    rule of `at_pgood` can halt a system power on if the conditions are met.
33  - `runtime` - At system runtime, the power off rule becomes valid. A power off
34    rule of `runtime` only goes into affect after the system reaches runtime.
35    (Default)
36
37### "epow" `type` power offs
38
39- `service_mode_delay` - integer
40  - Time(in seconds) given before the thermal alert D-Bus property is set to
41    indicate that a power off is imminent if the `count` instances of the
42    `cause` criteria still exists. This timer is canceled when the `count`
43    instances of the `cause` is not longer met.
44- `meltdown_delay` - integer
45  - Time(in seconds) before a hard power off occurs after the
46    `service_mode_delay` timer expires. This timer can not be canceled once
47    started.
48
49## Example
50
51<pre><code>
52{
53  "fault_handling": [
54    {
55      "num_nonfunc_rotors_before_error": 1,
56      <b><i>"power_off_config": [
57        {
58          "type": "hard",
59          "cause": "missing_fan_frus",
60          "count": 1,
61          "delay": 25,
62          "state": "at_pgood"
63        },
64        {
65          "type": "soft",
66          "cause": "nonfunc_fan_rotors",
67          "count": 2,
68          "delay": 30,
69          "state": "runtime"
70        },
71        {
72          "type": "epow",
73          "cause": "nonfunc_fan_rotors",
74          "count": 3,
75          "service_mode_delay": 300,
76          "meltdown_delay": 300
77        }
78      ]</i></b>
79    }
80  ]
81}
82</code></pre>
83