fixup: s/devies/devices/
[pve-docs.git] / ha-resources-opts.adoc
1 `comment`: `<string>` ::
2
3 Description.
4
5 `group`: `<string>` ::
6
7 The HA group identifier.
8
9 `max_relocate`: `<integer> (0 - N)` ('default =' `1`)::
10
11 Maximal number of service relocate tries when a service failes to start.
12
13 `max_restart`: `<integer> (0 - N)` ('default =' `1`)::
14
15 Maximal number of tries to restart the service on a node after its start failed.
16
17 `state`: `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
18
19 Requested resource state. The CRM reads this state and acts accordingly.
20 Please note that `enabled` is just an alias for `started`.
21 +
22 `started`;;
23 +
24 The CRM tries to start the resource. Service state is
25 set to `started` after successful start. On node failures, or when start
26 fails, it tries to recover the resource.  If everything fails, service
27 state it set to `error`.
28 +
29 `stopped`;;
30 +
31 The CRM tries to keep the resource in `stopped` state, but it
32 still tries to relocate the resources on node failures.
33 +
34 `disabled`;;
35 +
36 The CRM tries to put the resource in `stopped` state, but does not try
37 to relocate the resources on node failures. The main purpose of this
38 state is error recovery, because it is the only way to move a resource out
39 of the `error` state.
40 +
41 `ignored`;;
42 +
43 The resource gets removed from the manager status and so the CRM and the LRM do
44 not touch the resource anymore. All {pve} API calls affecting this resource
45 will be executed, directly bypassing the HA stack. CRM commands will be thrown
46 away while there source is in this state. The resource will not get relocated
47 on node failures.
48