]> git.proxmox.com Git - pve-docs.git/blame_incremental - ha-manager.1-synopsis.adoc
local-lvm.adoc: minor cleanups
[pve-docs.git] / ha-manager.1-synopsis.adoc
... / ...
CommitLineData
1*ha-manager* `<COMMAND> [ARGS] [OPTIONS]`
2
3*ha-manager add* `<sid>` `[OPTIONS]`
4
5Create a new HA resource.
6
7`<sid>`: `<type>:<name>` ::
8
9HA 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
13Description.
14
15`-group` `<string>` ::
16
17The HA group identifier.
18
19`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
20
21Maximal number of service relocate tries when a service failes to start.
22
23`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
24
25Maximal number of tries to restart the service on a node after its start failed.
26
27`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
28
29Requested resource state.
30
31`-type` `<ct | vm>` ::
32
33Resource type.
34
35
36
37*ha-manager config* `[OPTIONS]`
38
39List HA resources.
40
41`-type` `<ct | vm>` ::
42
43Only list resources of specific type
44
45
46
47
48*ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
49
50Create a new HA group.
51
52`<group>`: `<string>` ::
53
54The HA group identifier.
55
56`-comment` `<string>` ::
57
58Description.
59
60`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
61
62List of cluster node names with optional priority.
63
64`-nofailback` `<boolean>` ('default =' `0`)::
65
66The 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.
67
68`-restricted` `<boolean>` ('default =' `0`)::
69
70Resources bound to restricted groups may only run on nodes defined by the group.
71
72`-type` `<group>` ::
73
74Group type.
75
76
77
78*ha-manager groupconfig*
79
80Get HA groups.
81
82
83
84*ha-manager groupremove* `<group>`
85
86Delete ha group configuration.
87
88`<group>`: `<string>` ::
89
90The HA group identifier.
91
92
93
94*ha-manager groupset* `<group>` `[OPTIONS]`
95
96Update ha group configuration.
97
98`<group>`: `<string>` ::
99
100The HA group identifier.
101
102`-comment` `<string>` ::
103
104Description.
105
106`-delete` `<string>` ::
107
108A list of settings you want to delete.
109
110`-digest` `<string>` ::
111
112Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
113
114`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
115
116List of cluster node names with optional priority.
117
118`-nofailback` `<boolean>` ('default =' `0`)::
119
120The 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.
121
122`-restricted` `<boolean>` ('default =' `0`)::
123
124Resources bound to restricted groups may only run on nodes defined by the group.
125
126
127
128
129*ha-manager help* `[<cmd>]` `[OPTIONS]`
130
131Get help about specified command.
132
133`<cmd>`: `<string>` ::
134
135Command name
136
137`-verbose` `<boolean>` ::
138
139Verbose output format.
140
141
142
143
144*ha-manager migrate* `<sid> <node>`
145
146Request resource migration (online) to another node.
147
148`<sid>`: `<type>:<name>` ::
149
150HA 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).
151
152`<node>`: `<string>` ::
153
154The cluster node name.
155
156
157
158*ha-manager relocate* `<sid> <node>`
159
160Request resource relocatzion to another node. This stops the service on the
161old node, and restarts it on the target node.
162
163`<sid>`: `<type>:<name>` ::
164
165HA 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).
166
167`<node>`: `<string>` ::
168
169The cluster node name.
170
171
172
173*ha-manager remove* `<sid>`
174
175Delete resource configuration.
176
177`<sid>`: `<type>:<name>` ::
178
179HA 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).
180
181
182
183*ha-manager set* `<sid>` `[OPTIONS]`
184
185Update resource configuration.
186
187`<sid>`: `<type>:<name>` ::
188
189HA 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).
190
191`-comment` `<string>` ::
192
193Description.
194
195`-delete` `<string>` ::
196
197A list of settings you want to delete.
198
199`-digest` `<string>` ::
200
201Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
202
203`-group` `<string>` ::
204
205The HA group identifier.
206
207`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
208
209Maximal number of service relocate tries when a service failes to start.
210
211`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
212
213Maximal number of tries to restart the service on a node after its start failed.
214
215`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
216
217Requested resource state.
218
219
220
221
222*ha-manager status* `[OPTIONS]`
223
224Display HA manger status.
225
226`-verbose` `<boolean>` ('default =' `0`)::
227
228Verbose output. Include complete CRM and LRM status (JSON).
229
230
231
232