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