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 node-maintenance disable* `<node>`
  56
  57 Change the node-maintenance request state.
  58
  59 `<node>`: `<string>` ::
  60
  61 The cluster node name.
  62
  63 *ha-manager crm-command node-maintenance enable* `<node>`
  64
  65 Change the node-maintenance request state.
  66
  67 `<node>`: `<string>` ::
  68
  69 The cluster node name.
  70
  71 *ha-manager crm-command relocate* `<sid> <node>`
  72
  73 Request resource relocatzion to another node. This stops the service on the
  74 old node, and restarts it on the target node.
  75
  76 `<sid>`: `<type>:<name>` ::
  77
  78 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).
  79
  80 `<node>`: `<string>` ::
  81
  82 Target node.
  83
  84 *ha-manager crm-command stop* `<sid> <timeout>`
  85
  86 Request the service to be stopped.
  87
  88 `<sid>`: `<type>:<name>` ::
  89
  90 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).
  91
  92 `<timeout>`: `<integer> (0 - N)` ::
  93
  94 Timeout in seconds. If set to 0 a hard stop will be performed.
  95
  96 *ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
  97
  98 Create a new HA group.
  99
 100 `<group>`: `<string>` ::
 101
 102 The HA group identifier.
 103
 104 `--comment` `<string>` ::
 105
 106 Description.
 107
 108 `--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
 109
 110 List of cluster node names with optional priority.
 111
 112 `--nofailback` `<boolean>` ('default =' `0`)::
 113
 114 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.
 115
 116 `--restricted` `<boolean>` ('default =' `0`)::
 117
 118 Resources bound to restricted groups may only run on nodes defined by the group.
 119
 120 `--type` `<group>` ::
 121
 122 Group type.
 123
 124 *ha-manager groupconfig*
 125
 126 Get HA groups.
 127
 128 *ha-manager groupremove* `<group>`
 129
 130 Delete ha group configuration.
 131
 132 `<group>`: `<string>` ::
 133
 134 The HA group identifier.
 135
 136 *ha-manager groupset* `<group>` `[OPTIONS]`
 137
 138 Update ha group configuration.
 139
 140 `<group>`: `<string>` ::
 141
 142 The HA group identifier.
 143
 144 `--comment` `<string>` ::
 145
 146 Description.
 147
 148 `--delete` `<string>` ::
 149
 150 A list of settings you want to delete.
 151
 152 `--digest` `<string>` ::
 153
 154 Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
 155
 156 `--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
 157
 158 List of cluster node names with optional priority.
 159
 160 `--nofailback` `<boolean>` ('default =' `0`)::
 161
 162 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.
 163
 164 `--restricted` `<boolean>` ('default =' `0`)::
 165
 166 Resources bound to restricted groups may only run on nodes defined by the group.
 167
 168 *ha-manager help* `[OPTIONS]`
 169
 170 Get help about specified command.
 171
 172 `--extra-args` `<array>` ::
 173
 174 Shows help for a specific command
 175
 176 `--verbose` `<boolean>` ::
 177
 178 Verbose output format.
 179
 180 *ha-manager migrate*
 181
 182 An alias for 'ha-manager crm-command migrate'.
 183
 184 *ha-manager relocate*
 185
 186 An alias for 'ha-manager crm-command relocate'.
 187
 188 *ha-manager remove* `<sid>`
 189
 190 Delete resource configuration.
 191
 192 `<sid>`: `<type>:<name>` ::
 193
 194 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).
 195
 196 *ha-manager set* `<sid>` `[OPTIONS]`
 197
 198 Update resource configuration.
 199
 200 `<sid>`: `<type>:<name>` ::
 201
 202 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).
 203
 204 `--comment` `<string>` ::
 205
 206 Description.
 207
 208 `--delete` `<string>` ::
 209
 210 A list of settings you want to delete.
 211
 212 `--digest` `<string>` ::
 213
 214 Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
 215
 216 `--group` `<string>` ::
 217
 218 The HA group identifier.
 219
 220 `--max_relocate` `<integer> (0 - N)` ('default =' `1`)::
 221
 222 Maximal number of service relocate tries when a service failes to start.
 223
 224 `--max_restart` `<integer> (0 - N)` ('default =' `1`)::
 225
 226 Maximal number of tries to restart the service on a node after its start failed.
 227
 228 `--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::
 229
 230 Requested resource state.
 231
 232 *ha-manager status* `[OPTIONS]`
 233
 234 Display HA manger status.
 235
 236 `--verbose` `<boolean>` ('default =' `0`)::
 237
 238 Verbose output. Include complete CRM and LRM status (JSON).
 239
 240