]> 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 7394c5d25303608fe44a94a6cee63e416b599366..83adbf8a149173d4fb2f5f853cf905897c838ffd 100644 (file)
@@ -32,8 +32,6 @@ Requested resource state.
 
 Resource type.
 
-
-
 *ha-manager config* `[OPTIONS]`
 
 List HA resources.
@@ -42,8 +40,42 @@ List HA resources.
 
 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).
+
+`<timeout>`: `<integer> (0 - N)` ::
+
+Timeout in seconds. If set to 0 a hard stop will be performed.
 
 *ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
 
@@ -73,14 +105,10 @@ Resources bound to restricted groups may only run on nodes defined by the 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.
@@ -123,52 +149,25 @@ The CRM tries to run services on the node with the highest priority. If a node w
 
 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 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.
@@ -216,9 +213,6 @@ Maximal number of tries to restart the service on a node after its start failed.
 
 Requested resource state.
 
-
-
-
 *ha-manager status* `[OPTIONS]`
 
 Display HA manger status.
@@ -228,5 +222,3 @@ Display HA manger status.
 Verbose output. Include complete CRM and LRM status (JSON).
 
 
-
-