ha-manager.1-synopsis.adoc

   1 *ha-manager* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *ha-manager add* `<sid>` `[OPTIONS]`
   4
   5 Create a new HA resource.
   6
   7 `<sid>`: `<type>:<name>` ::
   8
   9 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).
  10
  11 `--comment` `<string>` ::
  12
  13 Description.
  14
  15 `--group` `<string>` ::
  16
  17 The HA group identifier.
  18
  19 `--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
  20
  21 Maximal number of service relocate tries when a service failes to start.
  22
  23 `--max_restart` `<integer> (0 - N)` ('default =' `1`)::
  24
  25 Maximal number of tries to restart the service on a node after its start failed.
  26
  27 `--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
  28
  29 Requested resource state.
  30
  31 `--type` `<ct | vm>` ::
  32
  33 Resource type.
  34
  35 *ha-manager config* `[OPTIONS]`
  36
  37 List HA resources.
  38
  39 `--type` `<ct | vm>` ::
  40
  41 Only list resources of specific type
  42
  43 *ha-manager crm-command migrate* `<sid> <node>`
  44
  45 Request resource migration (online) to another node.
  46
  47 `<sid>`: `<type>:<name>` ::
  48
  49 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).
  50
  51 `<node>`: `<string>` ::
  52
  53 Target node.
  54
  55 *ha-manager crm-command relocate* `<sid> <node>`
  56
  57 Request resource relocatzion to another node. This stops the service on the
  58 old node, and restarts it on the target node.
  59
  60 `<sid>`: `<type>:<name>` ::
  61
  62 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).
  63
  64 `<node>`: `<string>` ::
  65
  66 Target node.
  67
  68 *ha-manager crm-command stop* `<sid> <timeout>`
  69
  70 Request the service to be stopped.
  71
  72 `<sid>`: `<type>:<name>` ::
  73
  74 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).
  75
  76 `<timeout>`: `<integer> (0 - N)` ::
  77
  78 Timeout in seconds. If set to 0 a hard stop will be performed.
  79
  80 *ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
  81
  82 Create a new HA group.
  83
  84 `<group>`: `<string>` ::
  85
  86 The HA group identifier.
  87
  88 `--comment` `<string>` ::
  89
  90 Description.
  91
  92 `--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
  93
  94 List of cluster node names with optional priority.
  95
  96 `--nofailback` `<boolean>` ('default =' `0`)::
  97
  98 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.
  99
 100 `--restricted` `<boolean>` ('default =' `0`)::
 101
 102 Resources bound to restricted groups may only run on nodes defined by the group.
 103
 104 `--type` `<group>` ::
 105
 106 Group type.
 107
 108 *ha-manager groupconfig*
 109
 110 Get HA groups.
 111
 112 *ha-manager groupremove* `<group>`
 113
 114 Delete ha group configuration.
 115
 116 `<group>`: `<string>` ::
 117
 118 The HA group identifier.
 119
 120 *ha-manager groupset* `<group>` `[OPTIONS]`
 121
 122 Update ha group configuration.
 123
 124 `<group>`: `<string>` ::
 125
 126 The HA group identifier.
 127
 128 `--comment` `<string>` ::
 129
 130 Description.
 131
 132 `--delete` `<string>` ::
 133
 134 A list of settings you want to delete.
 135
 136 `--digest` `<string>` ::
 137
 138 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 139
 140 `--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
 141
 142 List of cluster node names with optional priority.
 143
 144 `--nofailback` `<boolean>` ('default =' `0`)::
 145
 146 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.
 147
 148 `--restricted` `<boolean>` ('default =' `0`)::
 149
 150 Resources bound to restricted groups may only run on nodes defined by the group.
 151
 152 *ha-manager help* `[OPTIONS]`
 153
 154 Get help about specified command.
 155
 156 `--extra-args` `<array>` ::
 157
 158 Shows help for a specific command
 159
 160 `--verbose` `<boolean>` ::
 161
 162 Verbose output format.
 163
 164 *ha-manager migrate*
 165
 166 An alias for 'ha-manager crm-command migrate'.
 167
 168 *ha-manager relocate*
 169
 170 An alias for 'ha-manager crm-command relocate'.
 171
 172 *ha-manager remove* `<sid>`
 173
 174 Delete resource configuration.
 175
 176 `<sid>`: `<type>:<name>` ::
 177
 178 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).
 179
 180 *ha-manager set* `<sid>` `[OPTIONS]`
 181
 182 Update resource configuration.
 183
 184 `<sid>`: `<type>:<name>` ::
 185
 186 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).
 187
 188 `--comment` `<string>` ::
 189
 190 Description.
 191
 192 `--delete` `<string>` ::
 193
 194 A list of settings you want to delete.
 195
 196 `--digest` `<string>` ::
 197
 198 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 199
 200 `--group` `<string>` ::
 201
 202 The HA group identifier.
 203
 204 `--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
 205
 206 Maximal number of service relocate tries when a service failes to start.
 207
 208 `--max_restart` `<integer> (0 - N)` ('default =' `1`)::
 209
 210 Maximal number of tries to restart the service on a node after its start failed.
 211
 212 `--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
 213
 214 Requested resource state.
 215
 216 *ha-manager status* `[OPTIONS]`
 217
 218 Display HA manger status.
 219
 220 `--verbose` `<boolean>` ('default =' `0`)::
 221
 222 Verbose output. Include complete CRM and LRM status (JSON).
 223
 224