X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=ha-manager.1-synopsis.adoc;h=0c6ea484bb08c55887209b1179f187bb365c6220;hp=06d3166cb29f19d9393a2ed45bd77a3e22a691de;hb=f13c1238e2f23d82e99c062c8f532d3c985fa7e8;hpb=e0e8bd4748167628cd745596caf55560aa08f7b1 diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index 06d3166..0c6ea48 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -4,35 +4,31 @@ 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` `` :: Description. -`-group` `string` :: +`-group` `` :: The HA group identifier. -`-max_relocate` `integer (0 - N)` (default=`1`):: +`-max_relocate` ` (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` ` (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` `` ('default =' `started`):: -Resource state. +Requested resource state. -`-type` `(ct | vm)` :: +`-type` `` :: Resource type. @@ -42,72 +38,38 @@ Resource type. List HA resources. -`-type` `(ct | vm)` :: +`-type` `` :: Only list resources of specific type -*ha-manager disable* `` - -Disable a 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-manager enable* `` - -Enable a 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-manager groupadd* ` -nodes ` `[OPTIONS]` Create a new HA group. -`` `string` :: +``: `` :: The HA group identifier. -`-comment` `string` :: +`-comment` `` :: Description. `-nodes` `[:]{,[:]}*` :: -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` `` ('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` `` ('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 type. @@ -123,7 +85,7 @@ Get HA groups. Delete ha group configuration. -`` `string` :: +``: `` :: The HA group identifier. @@ -133,41 +95,33 @@ The HA group identifier. Update ha group configuration. -`` `string` :: +``: `` :: The HA group identifier. -`-comment` `string` :: +`-comment` `` :: Description. -`-delete` `string` :: +`-delete` `` :: A list of settings you want to delete. -`-digest` `string` :: +`-digest` `` :: -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` `[:]{,[:]}*` :: -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` `` ('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` `` ('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. -`` `string` :: +``: `` :: Command name -`-verbose` `boolean` :: +`-verbose` `` :: Verbose output format. @@ -191,14 +145,11 @@ Verbose output format. Request resource migration (online) to another node. -`` `:` :: +``: `:` :: -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). -`` `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. -`` `:` :: +``: `:` :: -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). -`` `string` :: +``: `` :: The cluster node name. @@ -226,12 +174,9 @@ The cluster node name. 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). @@ -239,42 +184,37 @@ machines and containers, you can simply use the VM or CT id as a shortcut 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` `` :: Description. -`-delete` `string` :: +`-delete` `` :: A list of settings you want to delete. -`-digest` `string` :: +`-digest` `` :: -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` `` :: The HA group identifier. -`-max_relocate` `integer (0 - N)` (default=`1`):: +`-max_relocate` ` (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` ` (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` `` ('default =' `started`):: -Resource state. +Requested resource state. @@ -283,7 +223,7 @@ Resource state. Display HA manger status. -`-verbose` `boolean` (default=`0`):: +`-verbose` `` ('default =' `0`):: Verbose output. Include complete CRM and LRM status (JSON).