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