5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-22 22:03:47 +03:00
pve-docs/ha-manager.1-synopsis.adoc

241 lines
6.1 KiB
Plaintext
Raw Normal View History

2016-03-05 14:45:04 +01:00
*ha-manager* `<COMMAND> [ARGS] [OPTIONS]`
*ha-manager add* `<sid>` `[OPTIONS]`
Create a new HA resource.
2016-11-05 16:49:43 +01:00
`<sid>`: `<type>:<name>` ::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
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).
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--comment` `<string>` ::
2016-03-05 14:45:04 +01:00
Description.
2017-10-19 09:30:23 +02:00
`--group` `<string>` ::
2016-03-05 14:45:04 +01:00
The HA group identifier.
2017-10-19 09:30:23 +02:00
`--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
2016-03-05 14:45:04 +01:00
Maximal number of service relocate tries when a service failes to start.
2017-10-19 09:30:23 +02:00
`--max_restart` `<integer> (0 - N)` ('default =' `1`)::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
Maximal number of tries to restart the service on a node after its start failed.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
2016-03-05 14:45:04 +01:00
2016-11-20 10:24:34 +01:00
Requested resource state.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--type` `<ct | vm>` ::
2016-03-05 14:45:04 +01:00
Resource type.
*ha-manager config* `[OPTIONS]`
List HA resources.
2017-10-19 09:30:23 +02:00
`--type` `<ct | vm>` ::
2016-03-05 14:45:04 +01:00
Only list resources of specific type
*ha-manager crm-command migrate* `<sid> <node>`
Request resource migration (online) to another node.
`<sid>`: `<type>:<name>` ::
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).
`<node>`: `<string>` ::
Target node.
*ha-manager crm-command node-maintenance disable* `<node>`
Change the node-maintenance request state.
`<node>`: `<string>` ::
The cluster node name.
*ha-manager crm-command node-maintenance enable* `<node>`
Change the node-maintenance request state.
`<node>`: `<string>` ::
The cluster node name.
*ha-manager crm-command relocate* `<sid> <node>`
Request resource relocatzion to another node. This stops the service on the
old node, and restarts it on the target node.
`<sid>`: `<type>:<name>` ::
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).
`<node>`: `<string>` ::
Target node.
*ha-manager crm-command stop* `<sid> <timeout>`
Request the service to be stopped.
`<sid>`: `<type>:<name>` ::
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).
`<timeout>`: `<integer> (0 - N)` ::
Timeout in seconds. If set to 0 a hard stop will be performed.
2017-10-19 09:30:23 +02:00
*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
2016-03-05 14:45:04 +01:00
Create a new HA group.
2016-11-05 16:49:43 +01:00
`<group>`: `<string>` ::
2016-03-05 14:45:04 +01:00
The HA group identifier.
2017-10-19 09:30:23 +02:00
`--comment` `<string>` ::
2016-03-05 14:45:04 +01:00
Description.
2017-10-19 09:30:23 +02:00
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
2016-03-05 14:45:04 +01:00
2016-11-20 10:24:34 +01:00
List of cluster node names with optional priority.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--nofailback` `<boolean>` ('default =' `0`)::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
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.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--restricted` `<boolean>` ('default =' `0`)::
2016-03-05 14:45:04 +01:00
2016-11-20 11:02:02 +01:00
Resources bound to restricted groups may only run on nodes defined by the group.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--type` `<group>` ::
2016-03-05 14:45:04 +01:00
Group type.
*ha-manager groupconfig*
Get HA groups.
*ha-manager groupremove* `<group>`
Delete ha group configuration.
2016-11-05 16:49:43 +01:00
`<group>`: `<string>` ::
2016-03-05 14:45:04 +01:00
The HA group identifier.
*ha-manager groupset* `<group>` `[OPTIONS]`
Update ha group configuration.
2016-11-05 16:49:43 +01:00
`<group>`: `<string>` ::
2016-03-05 14:45:04 +01:00
The HA group identifier.
2017-10-19 09:30:23 +02:00
`--comment` `<string>` ::
2016-03-05 14:45:04 +01:00
Description.
2017-10-19 09:30:23 +02:00
`--delete` `<string>` ::
2016-03-05 14:45:04 +01:00
A list of settings you want to delete.
2017-10-19 09:30:23 +02:00
`--digest` `<string>` ::
2016-03-05 14:45:04 +01:00
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
2016-03-05 14:45:04 +01:00
2016-11-20 10:24:34 +01:00
List of cluster node names with optional priority.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--nofailback` `<boolean>` ('default =' `0`)::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
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.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--restricted` `<boolean>` ('default =' `0`)::
2016-03-05 14:45:04 +01:00
2016-11-20 11:02:02 +01:00
Resources bound to restricted groups may only run on nodes defined by the group.
2016-03-05 14:45:04 +01:00
2018-02-12 09:50:48 +01:00
*ha-manager help* `[OPTIONS]`
2016-03-05 14:45:04 +01:00
Get help about specified command.
2018-02-12 09:50:48 +01:00
`--extra-args` `<array>` ::
2016-03-05 14:45:04 +01:00
2018-02-12 09:50:48 +01:00
Shows help for a specific command
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--verbose` `<boolean>` ::
2016-03-05 14:45:04 +01:00
Verbose output format.
*ha-manager migrate*
2016-03-05 14:45:04 +01:00
An alias for 'ha-manager crm-command migrate'.
2016-03-05 14:45:04 +01:00
*ha-manager relocate*
2016-03-05 14:45:04 +01:00
An alias for 'ha-manager crm-command relocate'.
2016-03-05 14:45:04 +01:00
*ha-manager remove* `<sid>`
Delete resource configuration.
2016-11-05 16:49:43 +01:00
`<sid>`: `<type>:<name>` ::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
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).
2016-03-05 14:45:04 +01:00
*ha-manager set* `<sid>` `[OPTIONS]`
Update resource configuration.
2016-11-05 16:49:43 +01:00
`<sid>`: `<type>:<name>` ::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
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).
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--comment` `<string>` ::
2016-03-05 14:45:04 +01:00
Description.
2017-10-19 09:30:23 +02:00
`--delete` `<string>` ::
2016-03-05 14:45:04 +01:00
A list of settings you want to delete.
2017-10-19 09:30:23 +02:00
`--digest` `<string>` ::
2016-03-05 14:45:04 +01:00
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--group` `<string>` ::
2016-03-05 14:45:04 +01:00
The HA group identifier.
2017-10-19 09:30:23 +02:00
`--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
2016-03-05 14:45:04 +01:00
Maximal number of service relocate tries when a service failes to start.
2017-10-19 09:30:23 +02:00
`--max_restart` `<integer> (0 - N)` ('default =' `1`)::
2016-03-05 14:45:04 +01:00
2016-05-19 16:14:05 +02:00
Maximal number of tries to restart the service on a node after its start failed.
2016-03-05 14:45:04 +01:00
2017-10-19 09:30:23 +02:00
`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
2016-03-05 14:45:04 +01:00
2016-11-20 10:24:34 +01:00
Requested resource state.
2016-03-05 14:45:04 +01:00
*ha-manager status* `[OPTIONS]`
Display HA manger status.
2017-10-19 09:30:23 +02:00
`--verbose` `<boolean>` ('default =' `0`)::
2016-03-05 14:45:04 +01:00
Verbose output. Include complete CRM and LRM status (JSON).