X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ha-manager.1-synopsis.adoc;h=83adbf8a149173d4fb2f5f853cf905897c838ffd;hb=10a2a4aa2e07f720da624f9d0611af8d6be13152;hp=12e8961dbc3cdd15127d8f4f5f0ebc459273ced7;hpb=c2993fe56c757a6b53001af4b2af6517ef598f1e;p=pve-docs.git diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index 12e8961..83adbf8 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -4,250 +4,221 @@ 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` `` :: 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. -`-state` `(disabled | enabled)` (default=`enabled`):: +`--state` `` ('default =' `started`):: -Resource state. +Requested resource state. -`-type` `(ct | vm)` :: +`--type` `` :: Resource type. - - *ha-manager config* `[OPTIONS]` List HA resources. -`-type` `(ct | vm)` :: +`--type` `` :: Only list resources of specific type +*ha-manager crm-command migrate* ` ` + +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). +``: `` :: +Target node. -*ha-manager disable* `` +*ha-manager crm-command relocate* ` ` -Disable a HA resource. +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). +``: `` :: +Target node. -*ha-manager enable* `` +*ha-manager crm-command stop* ` ` -Enable a HA resource. +Request the service to be stopped. -`` `:` :: +``: `:` :: 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). +``: ` (0 - N)` :: +Timeout in seconds. If set to 0 a hard stop will be performed. - -*ha-manager groupadd* ` -nodes ` `[OPTIONS]` +*ha-manager groupadd* ` --nodes ` `[OPTIONS]` Create a new HA group. -`` `string` :: +``: `` :: The HA group identifier. -`-comment` `string` :: +`--comment` `` :: Description. -`-nodes` `[:]{,[:]}*` :: +`--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. -`-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. +Resources bound to restricted groups may only run on nodes defined by the group. -`-type` `(group)` :: +`--type` `` :: Group type. - - *ha-manager groupconfig* Get HA groups. - - *ha-manager groupremove* `` Delete ha group configuration. -`` `string` :: +``: `` :: The HA group identifier. - - *ha-manager groupset* `` `[OPTIONS]` 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. -`-nodes` `[:]{,[:]}*` :: +`--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. -`-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` `` ('default =' `0`):: +Resources bound to restricted groups may only run on nodes defined by the group. - -*ha-manager help* `[]` `[OPTIONS]` +*ha-manager help* `[OPTIONS]` Get help about specified command. -`` `string` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-verbose` `boolean` :: +`--verbose` `` :: Verbose output format. +*ha-manager migrate* +An alias for 'ha-manager crm-command migrate'. +*ha-manager relocate* -*ha-manager migrate* ` ` - -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). - -`` `string` :: - -The cluster node name. - - - -*ha-manager relocate* ` ` - -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). - -`` `string` :: - -The cluster node name. - - +An alias for 'ha-manager crm-command relocate'. *ha-manager remove* `` 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* `` `[OPTIONS]` 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` `` :: 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. -`-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. -`-state` `(disabled | enabled)` (default=`enabled`):: - -Resource state. - - +`--state` `` ('default =' `started`):: +Requested resource state. *ha-manager status* `[OPTIONS]` Display HA manger status. -`-verbose` `boolean` (default=`0`):: +`--verbose` `` ('default =' `0`):: Verbose output. Include complete CRM and LRM status (JSON). - -