Revision b1e47e2d doc/iallocator.rst

b/doc/iallocator.rst
212 212
    off their node(s). These are described in a separate :ref:`design
213 213
    document <multi-reloc-detailed-design>`.
214 214

  
215
    The ``multi-allocate`` request is used to allocate multiple
216
    instances on the cluster. The request is beside of that very
217
    similiar to the ``allocate`` one. For more details look at
218
    :doc:`Ganeti bulk create <design-bulk-create>`.
219

  
215 220
For both allocate and relocate mode, the following extra keys are needed
216 221
in the ``request`` dictionary:
217 222

  
......
311 316
    should be considered for relocating instances to; type
312 317
    *list of strings*
313 318

  
319
``multi-allocate`` needs the following request arguments:
320

  
321
  instances
322
    a list of request dicts
323

  
314 324
Response message
315 325
~~~~~~~~~~~~~~~~
316 326

  
......
338 348
  serialized opcodes; see the :ref:`design document
339 349
  <multi-reloc-result>` for a detailed description
340 350

  
351
  for the ``multi-allocate`` mode this is a tuple of 2 lists, the first
352
  being element of the tuple is a list of succeeded allocation, with the
353
  instance name as first element of each entry and the node placement in
354
  the second. The second element of the tuple is the instance list of
355
  failed allocations.
356

  
341 357
.. note:: Current Ganeti version accepts either ``result`` or ``nodes``
342 358
   as a backwards-compatibility measure (older versions only supported
343 359
   ``nodes``)

Also available in: Unified diff