update auto-generated docs
[pve-docs.git] / ha-manager.1-synopsis.adoc
1 *ha-manager* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *ha-manager add* `<sid>` `[OPTIONS]`
4
5 Create a new HA resource.
6
7 `<sid>` `<type>:<name>` ::
8
9 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
10
11 `-comment` `string` ::
12
13 Description.
14
15 `-group` `string` ::
16
17 The HA group identifier.
18
19 `-max_relocate` `integer (0 - N)` (default=`1`)::
20
21 Maximal number of service relocate tries when a service failes to start.
22
23 `-max_restart` `integer (0 - N)` (default=`1`)::
24
25 Maximal number of tries to restart the service on a node after its start failed.
26
27 `-state` `(disabled | enabled)` (default=`enabled`)::
28
29 Resource state.
30
31 `-type` `(ct | vm)` ::
32
33 Resource type.
34
35
36
37 *ha-manager config* `[OPTIONS]`
38
39 List HA resources.
40
41 `-type` `(ct | vm)` ::
42
43 Only list resources of specific type
44
45
46
47
48 *ha-manager disable* `<sid>`
49
50 Disable a HA resource.
51
52 `<sid>` `<type>:<name>` ::
53
54 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
55
56
57
58 *ha-manager enable* `<sid>`
59
60 Enable a HA resource.
61
62 `<sid>` `<type>:<name>` ::
63
64 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
65
66
67
68
69 *ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
70
71 Create a new HA group.
72
73 `<group>` `string` ::
74
75 The HA group identifier.
76
77 `-comment` `string` ::
78
79 Description.
80
81 `-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
82
83 List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
84
85 `-nofailback` `boolean` (default=`0`)::
86
87 The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
88
89 `-restricted` `boolean` (default=`0`)::
90
91 Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.
92
93 `-type` `(group)` ::
94
95 Group type.
96
97
98
99 *ha-manager groupconfig*
100
101 Get HA groups.
102
103
104
105 *ha-manager groupremove* `<group>`
106
107 Delete ha group configuration.
108
109 `<group>` `string` ::
110
111 The HA group identifier.
112
113
114
115 *ha-manager groupset* `<group>` `[OPTIONS]`
116
117 Update ha group configuration.
118
119 `<group>` `string` ::
120
121 The HA group identifier.
122
123 `-comment` `string` ::
124
125 Description.
126
127 `-delete` `string` ::
128
129 A list of settings you want to delete.
130
131 `-digest` `string` ::
132
133 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
134
135 `-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
136
137 List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
138
139 `-nofailback` `boolean` (default=`0`)::
140
141 The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
142
143 `-restricted` `boolean` (default=`0`)::
144
145 Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.
146
147
148
149
150 *ha-manager help* `[<cmd>]` `[OPTIONS]`
151
152 Get help about specified command.
153
154 `<cmd>` `string` ::
155
156 Command name
157
158 `-verbose` `boolean` ::
159
160 Verbose output format.
161
162
163
164
165 *ha-manager migrate* `<sid> <node>`
166
167 Request resource migration (online) to another node.
168
169 `<sid>` `<type>:<name>` ::
170
171 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
172
173 `<node>` `string` ::
174
175 The cluster node name.
176
177
178
179 *ha-manager relocate* `<sid> <node>`
180
181 Request resource relocatzion to another node. This stops the service on the
182 old node, and restarts it on the target node.
183
184 `<sid>` `<type>:<name>` ::
185
186 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
187
188 `<node>` `string` ::
189
190 The cluster node name.
191
192
193
194 *ha-manager remove* `<sid>`
195
196 Delete resource configuration.
197
198 `<sid>` `<type>:<name>` ::
199
200 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
201
202
203
204 *ha-manager set* `<sid>` `[OPTIONS]`
205
206 Update resource configuration.
207
208 `<sid>` `<type>:<name>` ::
209
210 HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
211
212 `-comment` `string` ::
213
214 Description.
215
216 `-delete` `string` ::
217
218 A list of settings you want to delete.
219
220 `-digest` `string` ::
221
222 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
223
224 `-group` `string` ::
225
226 The HA group identifier.
227
228 `-max_relocate` `integer (0 - N)` (default=`1`)::
229
230 Maximal number of service relocate tries when a service failes to start.
231
232 `-max_restart` `integer (0 - N)` (default=`1`)::
233
234 Maximal number of tries to restart the service on a node after its start failed.
235
236 `-state` `(disabled | enabled)` (default=`enabled`)::
237
238 Resource state.
239
240
241
242
243 *ha-manager status* `[OPTIONS]`
244
245 Display HA manger status.
246
247 `-verbose` `boolean` (default=`0`)::
248
249 Verbose output. Include complete CRM and LRM status (JSON).
250
251
252
253