]> git.proxmox.com Git - pve-docs.git/blobdiff - ha-manager.1-synopsis.adoc
update autogenerated docs
[pve-docs.git] / ha-manager.1-synopsis.adoc
index 06d3166cb29f19d9393a2ed45bd77a3e22a691de..0c6ea484bb08c55887209b1179f187bb365c6220 100644 (file)
@@ -4,35 +4,31 @@
 
 Create a new HA resource.
 
-`<sid>` `<type>:<name>` ::
+`<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 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.
+Maximal number of tries to restart the service on a node after its start failed.
 
-`-state` `(disabled | enabled)` (default=`enabled`)::
+`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
 
-Resource state.
+Requested resource state.
 
-`-type` `(ct | vm)` ::
+`-type` `<ct | vm>` ::
 
 Resource type.
 
@@ -42,72 +38,38 @@ Resource type.
 
 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]`
 
 Create a new HA group.
 
-`<group>` `string` ::
+`<group>`: `<string>` ::
 
 The HA group identifier.
 
-`-comment` `string` ::
+`-comment` `<string>` ::
 
 Description.
 
 `-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.
+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.
+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.
 
-`-type` `(group)` ::
+`-type` `<group>` ::
 
 Group type.
 
@@ -123,7 +85,7 @@ Get HA groups.
 
 Delete ha group configuration.
 
-`<group>` `string` ::
+`<group>`: `<string>` ::
 
 The HA group identifier.
 
@@ -133,41 +95,33 @@ The HA group identifier.
 
 Update ha group configuration.
 
-`<group>` `string` ::
+`<group>`: `<string>` ::
 
 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.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
 `-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.
+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.
+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.
 
 
 
@@ -176,11 +130,11 @@ unrestricted group with one member.
 
 Get help about specified command.
 
-`<cmd>` `string` ::
+`<cmd>`: `<string>` ::
 
 Command name
 
-`-verbose` `boolean` ::
+`-verbose` `<boolean>` ::
 
 Verbose output format.
 
@@ -191,14 +145,11 @@ Verbose output format.
 
 Request resource migration (online) to another node.
 
-`<sid>` `<type>:<name>` ::
+`<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 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` ::
+`<node>`: `<string>` ::
 
 The cluster node name.
 
@@ -209,14 +160,11 @@ The cluster node name.
 Request resource relocatzion to another node. This stops the service on the
 old node, and restarts it on the target node.
 
-`<sid>` `<type>:<name>` ::
+`<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 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` ::
+`<node>`: `<string>` ::
 
 The cluster node name.
 
@@ -226,12 +174,9 @@ The cluster node name.
 
 Delete resource configuration.
 
-`<sid>` `<type>:<name>` ::
+`<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 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).
 
 
 
@@ -239,42 +184,37 @@ machines and containers, you can simply use the VM or CT id as a shortcut
 
 Update resource configuration.
 
-`<sid>` `<type>:<name>` ::
+`<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 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 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.
+Maximal number of tries to restart the service on a node after its start failed.
 
-`-state` `(disabled | enabled)` (default=`enabled`)::
+`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
 
-Resource state.
+Requested resource state.
 
 
 
@@ -283,7 +223,7 @@ Resource state.
 
 Display HA manger status.
 
-`-verbose` `boolean` (default=`0`)::
+`-verbose` `<boolean>` ('default =' `0`)::
 
 Verbose output. Include complete CRM and LRM status (JSON).