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).
-`-comment` `<string>` ::
+`--comment` `<string>` ::
Description.
-`-group` `<string>` ::
+`--group` `<string>` ::
The HA group identifier.
-`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
+`--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
Maximal number of service relocate tries when a service failes to start.
-`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
+`--max_restart` `<integer> (0 - N)` ('default =' `1`)::
Maximal number of tries to restart the service on a node after its start failed.
-`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
+`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
Requested resource state.
-`-type` `<ct | vm>` ::
+`--type` `<ct | vm>` ::
Resource type.
-
-
*ha-manager config* `[OPTIONS]`
List HA resources.
-`-type` `<ct | vm>` ::
+`--type` `<ct | vm>` ::
Only list resources of specific type
+*ha-manager crm-command migrate* `<sid> <node>`
+Request resource migration (online) to another node.
+`<sid>`: `<type>:<name>` ::
-*ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
-
-Create a new HA group.
-
-`<group>`: `<string>` ::
-
-The HA group identifier.
+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).
-`-comment` `<string>` ::
+`<node>`: `<string>` ::
-Description.
+Target node.
-`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
+*ha-manager crm-command node-maintenance disable* `<node>`
-List of cluster node names with optional priority.
+Change the node-maintenance request state.
-`-nofailback` `<boolean>` ('default =' `0`)::
+`<node>`: `<string>` ::
-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.
+The cluster node name.
-`-restricted` `<boolean>` ('default =' `0`)::
+*ha-manager crm-command node-maintenance enable* `<node>`
-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.
+Change the node-maintenance request state.
-`-type` `<group>` ::
+`<node>`: `<string>` ::
-Group type.
+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.
-*ha-manager groupconfig*
+`<sid>`: `<type>:<name>` ::
-Get HA groups.
+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 groupremove* `<group>`
+*ha-manager crm-command stop* `<sid> <timeout>`
-Delete ha group configuration.
+Request the service to be stopped.
-`<group>`: `<string>` ::
+`<sid>`: `<type>:<name>` ::
-The HA group identifier.
+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.
-*ha-manager groupset* `<group>` `[OPTIONS]`
+*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
-Update ha group configuration.
+Create a new HA group.
`<group>`: `<string>` ::
The HA group identifier.
-`-comment` `<string>` ::
+`--comment` `<string>` ::
Description.
-`-delete` `<string>` ::
+`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
-A list of settings you want to delete.
+List of cluster node names with optional priority.
-`-digest` `<string>` ::
+`--nofailback` `<boolean>` ('default =' `0`)::
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+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.
-`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
+`--restricted` `<boolean>` ('default =' `0`)::
-List of cluster node names with optional priority.
+Resources bound to restricted groups may only run on nodes defined by the group.
-`-nofailback` `<boolean>` ('default =' `0`)::
+`--type` `<group>` ::
-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.
+Group type.
-`-restricted` `<boolean>` ('default =' `0`)::
+*ha-manager groupconfig*
-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.
+Get HA groups.
+*ha-manager groupremove* `<group>`
+Delete ha group configuration.
+`<group>`: `<string>` ::
-*ha-manager help* `[<cmd>]` `[OPTIONS]`
+The HA group identifier.
-Get help about specified command.
+*ha-manager groupset* `<group>` `[OPTIONS]`
-`<cmd>`: `<string>` ::
+Update ha group configuration.
-Command name
+`<group>`: `<string>` ::
-`-verbose` `<boolean>` ::
+The HA group identifier.
-Verbose output format.
+`--comment` `<string>` ::
+Description.
+`--delete` `<string>` ::
+A list of settings you want to delete.
-*ha-manager migrate* `<sid> <node>`
+`--digest` `<string>` ::
-Request resource migration (online) to another node.
+Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-`<sid>`: `<type>:<name>` ::
+`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
-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).
+List of cluster node names with optional priority.
-`<node>`: `<string>` ::
+`--nofailback` `<boolean>` ('default =' `0`)::
-The cluster node name.
+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.
+`--restricted` `<boolean>` ('default =' `0`)::
+Resources bound to restricted groups may only run on nodes defined by the group.
-*ha-manager relocate* `<sid> <node>`
+*ha-manager help* `[OPTIONS]`
-Request resource relocatzion to another node. This stops the service on the
-old node, and restarts it on the target node.
+Get help about specified command.
-`<sid>`: `<type>:<name>` ::
+`--extra-args` `<array>` ::
-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).
+Shows help for a specific command
-`<node>`: `<string>` ::
+`--verbose` `<boolean>` ::
-The cluster node name.
+Verbose output format.
+
+*ha-manager migrate*
+
+An alias for 'ha-manager crm-command migrate'.
+*ha-manager relocate*
+An alias for 'ha-manager crm-command relocate'.
*ha-manager remove* `<sid>`
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).
-
-
*ha-manager set* `<sid>` `[OPTIONS]`
Update resource configuration.
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).
-`-comment` `<string>` ::
+`--comment` `<string>` ::
Description.
-`-delete` `<string>` ::
+`--delete` `<string>` ::
A list of settings you want to delete.
-`-digest` `<string>` ::
+`--digest` `<string>` ::
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-`-group` `<string>` ::
+`--group` `<string>` ::
The HA group identifier.
-`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
+`--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
Maximal number of service relocate tries when a service failes to start.
-`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
+`--max_restart` `<integer> (0 - N)` ('default =' `1`)::
Maximal number of tries to restart the service on a node after its start failed.
-`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
+`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
Requested resource state.
-
-
-
*ha-manager status* `[OPTIONS]`
Display HA manger status.
-`-verbose` `<boolean>` ('default =' `0`)::
+`--verbose` `<boolean>` ('default =' `0`)::
Verbose output. Include complete CRM and LRM status (JSON).
-
-
projects / pve-docs.git / blobdiff