]> git.proxmox.com Git - pve-docs.git/blobdiff - ha-manager.1-synopsis.adoc
html: avoid horizontal overflows, break-word and limit image width
[pve-docs.git] / ha-manager.1-synopsis.adoc
index 1d4602722b5d6319afd31ff05d9a191339880f3b..83adbf8a149173d4fb2f5f853cf905897c838ffd 100644 (file)
@@ -8,44 +8,76 @@ Create a new HA resource.
 
 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 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 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).
 
-*ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
+`<timeout>`: `<integer> (0 - N)` ::
+
+Timeout in seconds. If set to 0 a hard stop will be performed.
+
+*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
 
 Create a new HA group.
 
@@ -53,34 +85,30 @@ Create a new HA group.
 
 The HA group identifier.
 
-`-comment` `<string>` ::
+`--comment` `<string>` ::
 
 Description.
 
-`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
+`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
 
 List of cluster node names with optional priority.
 
-`-nofailback` `<boolean>` ('default =' `0`)::
+`--nofailback` `<boolean>` ('default =' `0`)::
 
 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`)::
+`--restricted` `<boolean>` ('default =' `0`)::
 
 Resources bound to restricted groups may only run on nodes defined by the group.
 
-`-type` `<group>` ::
+`--type` `<group>` ::
 
 Group type.
 
-
-
 *ha-manager groupconfig*
 
 Get HA groups.
 
-
-
 *ha-manager groupremove* `<group>`
 
 Delete ha group configuration.
@@ -89,8 +117,6 @@ Delete ha group configuration.
 
 The HA group identifier.
 
-
-
 *ha-manager groupset* `<group>` `[OPTIONS]`
 
 Update ha group configuration.
@@ -99,76 +125,49 @@ Update ha group configuration.
 
 The HA group identifier.
 
-`-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.
 
-`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
+`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
 
 List of cluster node names with optional priority.
 
-`-nofailback` `<boolean>` ('default =' `0`)::
+`--nofailback` `<boolean>` ('default =' `0`)::
 
 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`)::
+`--restricted` `<boolean>` ('default =' `0`)::
 
 Resources bound to restricted groups may only run on nodes defined by the group.
 
-
-
-
-*ha-manager help* `[<cmd>]` `[OPTIONS]`
+*ha-manager help* `[OPTIONS]`
 
 Get help about specified command.
 
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
 
-Command name
+Shows help for a specific command
 
-`-verbose` `<boolean>` ::
+`--verbose` `<boolean>` ::
 
 Verbose output format.
 
+*ha-manager migrate*
 
+An alias for 'ha-manager crm-command migrate'.
 
+*ha-manager relocate*
 
-*ha-manager 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>` ::
-
-The cluster node name.
-
-
-
-*ha-manager 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>` ::
-
-The cluster node name.
-
-
+An alias for 'ha-manager crm-command relocate'.
 
 *ha-manager remove* `<sid>`
 
@@ -178,8 +177,6 @@ Delete 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).
 
-
-
 *ha-manager set* `<sid>` `[OPTIONS]`
 
 Update resource configuration.
@@ -188,45 +185,40 @@ 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.
 
-`-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).
 
 
-
-