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
  10 specific name, separated with colon (example: vm:100 / ct:100). For virtual
  11 machines and containers, you can simply use the VM or CT id as a shortcut
  12 (example: 100).
  13
  14 `-comment` `string` ::
  15
  16 Description.
  17
  18 `-group` `string` ::
  19
  20 The HA group identifier.
  21
  22 `-max_relocate` `integer (0 - N)` (default=`1`)::
  23
  24 Maximal number of service relocate tries when a service failes to start.
  25
  26 `-max_restart` `integer (0 - N)` (default=`1`)::
  27
  28 Maximal number of tries to restart the service on a node after its start
  29 failed.
  30
  31 `-state` `(disabled | enabled)` (default=`enabled`)::
  32
  33 Resource state.
  34
  35 `-type` `(ct | vm)` ::
  36
  37 Resource type.
  38
  39
  40
  41 *ha-manager config* `[OPTIONS]`
  42
  43 List HA resources.
  44
  45 `-type` `(ct | vm)` ::
  46
  47 Only list resources of specific type
  48
  49
  50
  51
  52 *ha-manager disable* `<sid>`
  53
  54 Disable a HA resource.
  55
  56 `<sid>` `<type>:<name>` ::
  57
  58 HA resource ID. This consists of a resource type followed by a resource
  59 specific name, separated with colon (example: vm:100 / ct:100). For virtual
  60 machines and containers, you can simply use the VM or CT id as a shortcut
  61 (example: 100).
  62
  63
  64
  65 *ha-manager enable* `<sid>`
  66
  67 Enable a HA resource.
  68
  69 `<sid>` `<type>:<name>` ::
  70
  71 HA resource ID. This consists of a resource type followed by a resource
  72 specific name, separated with colon (example: vm:100 / ct:100). For virtual
  73 machines and containers, you can simply use the VM or CT id as a shortcut
  74 (example: 100).
  75
  76
  77
  78
  79 *ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
  80
  81 Create a new HA group.
  82
  83 `<group>` `string` ::
  84
  85 The HA group identifier.
  86
  87 `-comment` `string` ::
  88
  89 Description.
  90
  91 `-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
  92
  93 List of cluster node names with optional priority. We use priority '0' as
  94 default. The CRM tries to run services on the node with highest priority
  95 (also see option 'nofailback').
  96
  97 `-nofailback` `boolean` (default=`0`)::
  98
  99 The CRM tries to run services on the node with the highest priority. If a
 100 node with higher priority comes online, the CRM migrates the service to
 101 that node. Enabling nofailback prevents that behavior.
 102
 103 `-restricted` `boolean` (default=`0`)::
 104
 105 Services on unrestricted groups may run on any cluster members if all group
 106 members are offline. But they will migrate back as soon as a group member
 107 comes online. One can implement a 'preferred node' behavior using an
 108 unrestricted group with one member.
 109
 110 `-type` `(group)` ::
 111
 112 Group type.
 113
 114
 115
 116 *ha-manager groupconfig*
 117
 118 Get HA groups.
 119
 120
 121
 122 *ha-manager groupremove* `<group>`
 123
 124 Delete ha group configuration.
 125
 126 `<group>` `string` ::
 127
 128 The HA group identifier.
 129
 130
 131
 132 *ha-manager groupset* `<group>` `[OPTIONS]`
 133
 134 Update ha group configuration.
 135
 136 `<group>` `string` ::
 137
 138 The HA group identifier.
 139
 140 `-comment` `string` ::
 141
 142 Description.
 143
 144 `-delete` `string` ::
 145
 146 A list of settings you want to delete.
 147
 148 `-digest` `string` ::
 149
 150 Prevent changes if current configuration file has different SHA1 digest.
 151 This can be used to prevent concurrent modifications.
 152
 153 `-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
 154
 155 List of cluster node names with optional priority. We use priority '0' as
 156 default. The CRM tries to run services on the node with highest priority
 157 (also see option 'nofailback').
 158
 159 `-nofailback` `boolean` (default=`0`)::
 160
 161 The CRM tries to run services on the node with the highest priority. If a
 162 node with higher priority comes online, the CRM migrates the service to
 163 that node. Enabling nofailback prevents that behavior.
 164
 165 `-restricted` `boolean` (default=`0`)::
 166
 167 Services on unrestricted groups may run on any cluster members if all group
 168 members are offline. But they will migrate back as soon as a group member
 169 comes online. One can implement a 'preferred node' behavior using an
 170 unrestricted group with one member.
 171
 172
 173
 174
 175 *ha-manager help* `[<cmd>]` `[OPTIONS]`
 176
 177 Get help about specified command.
 178
 179 `<cmd>` `string` ::
 180
 181 Command name
 182
 183 `-verbose` `boolean` ::
 184
 185 Verbose output format.
 186
 187
 188
 189
 190 *ha-manager migrate* `<sid> <node>`
 191
 192 Request resource migration (online) to another node.
 193
 194 `<sid>` `<type>:<name>` ::
 195
 196 HA resource ID. This consists of a resource type followed by a resource
 197 specific name, separated with colon (example: vm:100 / ct:100). For virtual
 198 machines and containers, you can simply use the VM or CT id as a shortcut
 199 (example: 100).
 200
 201 `<node>` `string` ::
 202
 203 The cluster node name.
 204
 205
 206
 207 *ha-manager relocate* `<sid> <node>`
 208
 209 Request resource relocatzion to another node. This stops the service on the
 210 old node, and restarts it on the target node.
 211
 212 `<sid>` `<type>:<name>` ::
 213
 214 HA resource ID. This consists of a resource type followed by a resource
 215 specific name, separated with colon (example: vm:100 / ct:100). For virtual
 216 machines and containers, you can simply use the VM or CT id as a shortcut
 217 (example: 100).
 218
 219 `<node>` `string` ::
 220
 221 The cluster node name.
 222
 223
 224
 225 *ha-manager remove* `<sid>`
 226
 227 Delete resource configuration.
 228
 229 `<sid>` `<type>:<name>` ::
 230
 231 HA resource ID. This consists of a resource type followed by a resource
 232 specific name, separated with colon (example: vm:100 / ct:100). For virtual
 233 machines and containers, you can simply use the VM or CT id as a shortcut
 234 (example: 100).
 235
 236
 237
 238 *ha-manager set* `<sid>` `[OPTIONS]`
 239
 240 Update resource configuration.
 241
 242 `<sid>` `<type>:<name>` ::
 243
 244 HA resource ID. This consists of a resource type followed by a resource
 245 specific name, separated with colon (example: vm:100 / ct:100). For virtual
 246 machines and containers, you can simply use the VM or CT id as a shortcut
 247 (example: 100).
 248
 249 `-comment` `string` ::
 250
 251 Description.
 252
 253 `-delete` `string` ::
 254
 255 A list of settings you want to delete.
 256
 257 `-digest` `string` ::
 258
 259 Prevent changes if current configuration file has different SHA1 digest.
 260 This can be used to prevent concurrent modifications.
 261
 262 `-group` `string` ::
 263
 264 The HA group identifier.
 265
 266 `-max_relocate` `integer (0 - N)` (default=`1`)::
 267
 268 Maximal number of service relocate tries when a service failes to start.
 269
 270 `-max_restart` `integer (0 - N)` (default=`1`)::
 271
 272 Maximal number of tries to restart the service on a node after its start
 273 failed.
 274
 275 `-state` `(disabled | enabled)` (default=`enabled`)::
 276
 277 Resource state.
 278
 279
 280
 281
 282 *ha-manager status* `[OPTIONS]`
 283
 284 Display HA manger status.
 285
 286 `-verbose` `boolean` (default=`0`)::
 287
 288 Verbose output. Include complete CRM and LRM status (JSON).
 289
 290
 291
 292