From e0e8bd4748167628cd745596caf55560aa08f7b1 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Sat, 5 Mar 2016 14:45:04 +0100 Subject: [PATCH] add ha-manager.1-synopsis.adoc --- ha-manager.1-synopsis.adoc | 292 +++++++++++++++++++++++++++++++++++++ 1 file changed, 292 insertions(+) create mode 100644 ha-manager.1-synopsis.adoc diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc new file mode 100644 index 0000000..06d3166 --- /dev/null +++ b/ha-manager.1-synopsis.adoc @@ -0,0 +1,292 @@ +*ha-manager* ` [ARGS] [OPTIONS]` + +*ha-manager add* `` `[OPTIONS]` + +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` :: + +Description. + +`-group` `string` :: + +The HA group identifier. + +`-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`):: + +Maximal number of tries to restart the service on a node after its start +failed. + +`-state` `(disabled | enabled)` (default=`enabled`):: + +Resource state. + +`-type` `(ct | vm)` :: + +Resource type. + + + +*ha-manager config* `[OPTIONS]` + +List HA resources. + +`-type` `(ct | vm)` :: + +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` :: + +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'). + +`-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. + +`-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. + +`-type` `(group)` :: + +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` :: + +Description. + +`-delete` `string` :: + +A list of settings you want to delete. + +`-digest` `string` :: + +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'). + +`-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. + +`-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. + + + + +*ha-manager help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*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. + + + +*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` :: + +Description. + +`-delete` `string` :: + +A list of settings you want to delete. + +`-digest` `string` :: + +Prevent changes if current configuration file has different SHA1 digest. +This can be used to prevent concurrent modifications. + +`-group` `string` :: + +The HA group identifier. + +`-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`):: + +Maximal number of tries to restart the service on a node after its start +failed. + +`-state` `(disabled | enabled)` (default=`enabled`):: + +Resource state. + + + + +*ha-manager status* `[OPTIONS]` + +Display HA manger status. + +`-verbose` `boolean` (default=`0`):: + +Verbose output. Include complete CRM and LRM status (JSON). + + + + -- 2.39.2