Revision de40437a doc/rapi.rst

b/doc/rapi.rst
1161 1161
``/2/nodes/[node_name]/evacuate``
1162 1162
+++++++++++++++++++++++++++++++++
1163 1163

  
1164
Evacuates all secondary instances off a node.
1164
Evacuates instances off a node.
1165 1165

  
1166 1166
It supports the following commands: ``POST``.
1167 1167

  
1168 1168
``POST``
1169 1169
~~~~~~~~
1170 1170

  
1171
To evacuate a node, either one of the ``iallocator`` or ``remote_node``
1172
parameters must be passed::
1171
Returns a job ID. The result of the job will contain the IDs of the
1172
individual jobs submitted to evacuate the node.
1173 1173

  
1174
    evacuate?iallocator=[iallocator]
1175
    evacuate?remote_node=[nodeX.example.com]
1176

  
1177
The result value will be a list, each element being a triple of the job
1178
id (for this specific evacuation), the instance which is being evacuated
1179
by this job, and the node to which it is being relocated. In case the
1180
node is already empty, the result will be an empty list (without any
1181
jobs being submitted).
1174
Body parameters:
1182 1175

  
1183
And additional parameter ``early_release`` signifies whether to try to
1184
parallelize the evacuations, at the risk of increasing I/O contention
1185
and increasing the chances of data loss, if the primary node of any of
1186
the instances being evacuated is not fully healthy.
1176
.. opcode_params:: OP_NODE_EVACUATE
1177
   :exclude: nodes
1187 1178

  
1188
If the dry-run parameter was specified, then the evacuation jobs were
1189
not actually submitted, and the job IDs will be null.
1179
Up to and including Ganeti 2.4 query arguments were used. Those are no
1180
longer supported. The new request can be detected by the presence of the
1181
:pyeval:`rlib2._NODE_EVAC_RES1` feature string.
1190 1182

  
1191 1183

  
1192 1184
``/2/nodes/[node_name]/migrate``

Also available in: Unified diff