]> git.proxmox.com Git - pve-docs.git/blobdiff - ha-manager.1-synopsis.adoc
make dinstall: skip mediawiki deb for now
[pve-docs.git] / ha-manager.1-synopsis.adoc
index feb156ccf361f01be8b3152139dbaffd18b240b4..f91530df2f66c0b75e0f0c3ea3f7d5372bcd1b2d 100644 (file)
@@ -8,65 +8,39 @@ 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>` ('default =' `enabled`)::
+`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
 
-Resource state.
+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 disable* `<sid>`
-
-Disable a HA resource.
-
-`<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 enable* `<sid>`
-
-Enable a HA resource.
-
-`<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]`
+*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
 
 Create a new HA group.
 
@@ -74,34 +48,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. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
+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`)::
 
-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.
+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.
@@ -110,8 +80,6 @@ Delete ha group configuration.
 
 The HA group identifier.
 
-
-
 *ha-manager groupset* `<group>` `[OPTIONS]`
 
 Update ha group configuration.
@@ -120,48 +88,42 @@ 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. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
+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`)::
-
-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.
+`--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* `<sid> <node>`
 
 Request resource migration (online) to another node.
@@ -172,9 +134,7 @@ HA resource ID. This consists of a resource type followed by a resource specific
 
 `<node>`: `<string>` ::
 
-The cluster node name.
-
-
+Target node.
 
 *ha-manager relocate* `<sid> <node>`
 
@@ -187,9 +147,7 @@ HA resource ID. This consists of a resource type followed by a resource specific
 
 `<node>`: `<string>` ::
 
-The cluster node name.
-
-
+Target node.
 
 *ha-manager remove* `<sid>`
 
@@ -199,8 +157,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.
@@ -209,45 +165,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>` ('default =' `enabled`)::
-
-Resource state.
-
-
+`--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).
 
 
-
-