X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ha-manager.1-synopsis.adoc;h=83adbf8a149173d4fb2f5f853cf905897c838ffd;hb=60ed554faca57ba18f1b199a4f90c5578f88d91c;hp=feb156ccf361f01be8b3152139dbaffd18b240b4;hpb=013dc89ffce47b8c55412c016a508205768b4fd6;p=pve-docs.git diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index feb156c..83adbf8 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -8,65 +8,76 @@ 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` `` :: +`--comment` `` :: Description. -`-group` `` :: +`--group` `` :: The HA group identifier. -`-max_relocate` ` (0 - N)` ('default =' `1`):: +`--max_relocate` ` (0 - N)` ('default =' `1`):: Maximal number of service relocate tries when a service failes to start. -`-max_restart` ` (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` `` ('default =' `enabled`):: +`--state` `` ('default =' `started`):: -Resource state. +Requested resource state. -`-type` `` :: +`--type` `` :: Resource type. - - *ha-manager config* `[OPTIONS]` List HA resources. -`-type` `` :: +`--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. @@ -74,34 +85,30 @@ Create a new HA group. The HA group identifier. -`-comment` `` :: +`--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` `` ('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` `` ('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` `` :: +`--type` `` :: Group type. - - *ha-manager groupconfig* Get HA groups. - - *ha-manager groupremove* `` Delete ha group configuration. @@ -110,8 +117,6 @@ Delete ha group configuration. The HA group identifier. - - *ha-manager groupset* `` `[OPTIONS]` Update ha group configuration. @@ -120,76 +125,49 @@ Update ha group configuration. The HA group identifier. -`-comment` `` :: +`--comment` `` :: Description. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--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` `` ('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` `` ('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. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-verbose` `` :: +`--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). - -``: `` :: - -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). - -``: `` :: - -The cluster node name. - - +An alias for 'ha-manager crm-command relocate'. *ha-manager remove* `` @@ -199,8 +177,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* `` `[OPTIONS]` Update resource configuration. @@ -209,45 +185,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` `` :: +`--comment` `` :: Description. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-group` `` :: +`--group` `` :: The HA group identifier. -`-max_relocate` ` (0 - N)` ('default =' `1`):: +`--max_relocate` ` (0 - N)` ('default =' `1`):: Maximal number of service relocate tries when a service failes to start. -`-max_restart` ` (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` `` ('default =' `enabled`):: - -Resource state. - - +`--state` `` ('default =' `started`):: +Requested resource state. *ha-manager status* `[OPTIONS]` Display HA manger status. -`-verbose` `` ('default =' `0`):: +`--verbose` `` ('default =' `0`):: Verbose output. Include complete CRM and LRM status (JSON). - -