update generated docs

[pve-docs.git] / ha-manager.1-synopsis.adoc

diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc
index 0c6ea484bb08c55887209b1179f187bb365c6220..3071693e775a6b8b5bc59464675285ecd8de4e30 100644 (file)
--- a/ha-manager.1-synopsis.adoc
+++ b/ha-manager.1-synopsis.adoc
@@ -8,44 +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).
 
 
 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.
 
 
 Description.
 

-`-group` `<string>` ::
+`--group` `<string>` ::

 
 The HA group identifier.
 
 
 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.
 
 
 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.
 
 
 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.
 
 
 Requested resource state.
 

-`-type` `<ct | vm>` ::
+`--type` `<ct | vm>` ::

 
 Resource type.
 
 
 Resource type.
 

-
-

 *ha-manager config* `[OPTIONS]`
 
 List HA resources.
 
 *ha-manager config* `[OPTIONS]`
 
 List HA resources.
 

-`-type` `<ct | vm>` ::
+`--type` `<ct | vm>` ::

 
 Only list resources of specific type
 
 
 Only list resources of specific type
 

-
-
-
-*ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
+*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`

 
 Create a new HA group.
 
 
 Create a new HA group.
 


@@ -53,34 +48,30 @@ Create a new HA group.
 
 The HA group identifier.
 
 
 The HA group identifier.
 

-`-comment` `<string>` ::
+`--comment` `<string>` ::

 
 Description.
 
 
 Description.
 

-`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
+`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::

 
 List of cluster node names with optional priority.
 
 
 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.
 
 
 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.
 
 
 Group type.
 

-
-

 *ha-manager groupconfig*
 
 Get HA groups.
 
 *ha-manager groupconfig*
 
 Get HA groups.
 

-
-

 *ha-manager groupremove* `<group>`
 
 Delete ha group configuration.
 *ha-manager groupremove* `<group>`
 
 Delete ha group configuration.


@@ -89,8 +80,6 @@ Delete ha group configuration.
 
 The HA group identifier.
 
 
 The HA group identifier.
 

-
-

 *ha-manager groupset* `<group>` `[OPTIONS]`
 
 Update ha group configuration.
 *ha-manager groupset* `<group>` `[OPTIONS]`
 
 Update ha group configuration.


@@ -99,48 +88,42 @@ Update ha group configuration.
 
 The HA group identifier.
 
 
 The HA group identifier.
 

-`-comment` `<string>` ::
+`--comment` `<string>` ::

 
 Description.
 
 
 Description.
 

-`-delete` `<string>` ::
+`--delete` `<string>` ::

 
 A list of settings you want to delete.
 
 
 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 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.
 
 
 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.
 
 
 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.
 
 
 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.
 
 
 Verbose output format.
 

-
-
-

 *ha-manager migrate* `<sid> <node>`
 
 Request resource migration (online) to another node.
 *ha-manager migrate* `<sid> <node>`
 
 Request resource migration (online) to another node.


@@ -153,8 +136,6 @@ HA resource ID. This consists of a resource type followed by a resource specific
 
 The cluster node name.
 
 
 The cluster node name.
 

-
-

 *ha-manager relocate* `<sid> <node>`
 
 Request resource relocatzion to another node. This stops the service on the
 *ha-manager relocate* `<sid> <node>`
 
 Request resource relocatzion to another node. This stops the service on the


@@ -168,8 +149,6 @@ HA resource ID. This consists of a resource type followed by a resource specific
 
 The cluster node name.
 
 
 The cluster node name.
 

-
-

 *ha-manager remove* `<sid>`
 
 Delete resource configuration.
 *ha-manager remove* `<sid>`
 
 Delete resource configuration.


@@ -178,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 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-manager set* `<sid>` `[OPTIONS]`
 
 Update resource configuration.


@@ -188,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).
 
 
 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.
 
 
 Description.
 

-`-delete` `<string>` ::
+`--delete` `<string>` ::

 
 A list of settings you want to delete.
 
 
 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 different SHA1 digest. This can be used to prevent concurrent modifications.
 

-`-group` `<string>` ::
+`--group` `<string>` ::

 
 The HA group identifier.
 
 
 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.
 
 
 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.
 
 
 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.
 
 
 Requested resource state.
 

-
-
-

 *ha-manager status* `[OPTIONS]`
 
 Display HA manger status.
 
 *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).
 
 
 
 Verbose output. Include complete CRM and LRM status (JSON).
 
 

-
-