Revision 7faf5110 doc/rapi.rst

b/doc/rapi.rst
28 28
Generic parameters
29 29
------------------
30 30

  
31
A few parameter mean the same thing across all resources which implement it.
31
A few parameter mean the same thing across all resources which implement
32
it.
32 33

  
33 34
``bulk``
34 35
++++++++
......
307 308

  
308 309
Requests detailed information about the instance. An optional parameter,
309 310
``static`` (bool), can be set to return only static information from the
310
configuration without querying the instance's nodes. The result will be a job
311
id.
311
configuration without querying the instance's nodes. The result will be
312
a job id.
312 313

  
313 314

  
314 315
``/2/instances/[instance_name]/reboot``
......
385 386
~~~~~~~~
386 387

  
387 388
Takes the parameters ``mode`` (one of ``replace_on_primary``,
388
``replace_on_secondary``, ``replace_new_secondary`` or ``replace_auto``),
389
``disks`` (comma separated list of disk indexes), ``remote_node`` and
390
``iallocator``.
389
``replace_on_secondary``, ``replace_new_secondary`` or
390
``replace_auto``), ``disks`` (comma separated list of disk indexes),
391
``remote_node`` and ``iallocator``.
391 392

  
392 393

  
393 394
``/2/instances/[instance_name]/tags``
......
586 587

  
587 588
Change the node role.
588 589

  
589
The request is a string which should be PUT to this URI. The result will be a
590
job id.
590
The request is a string which should be PUT to this URI. The result will
591
be a job id.
591 592

  
592 593
It supports the ``force`` argument.
593 594

  
......
601 602

  
602 603
Requests a list of storage units on a node. Requires the parameters
603 604
``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``) and
604
``output_fields``. The result will be a job id, using which the result can be
605
retrieved.
605
``output_fields``. The result will be a job id, using which the result
606
can be retrieved.
606 607

  
607 608
``/2/nodes/[node_name]/storage/modify``
608 609
+++++++++++++++++++++++++++++++++++++++
......
612 613
``PUT``
613 614
~~~~~~~
614 615

  
615
Modifies parameters of storage units on the node. Requires the parameters
616
``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``) and ``name`` (name
617
of the storage unit).  Parameters can be passed additionally. Currently only
618
``allocatable`` (bool) is supported. The result will be a job id.
616
Modifies parameters of storage units on the node. Requires the
617
parameters ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``)
618
and ``name`` (name of the storage unit).  Parameters can be passed
619
additionally. Currently only ``allocatable`` (bool) is supported. The
620
result will be a job id.
619 621

  
620 622
``/2/nodes/[node_name]/storage/repair``
621 623
+++++++++++++++++++++++++++++++++++++++
......
625 627
``PUT``
626 628
~~~~~~~
627 629

  
628
Repairs a storage unit on the node. Requires the parameters ``storage_type``
629
(currently only ``lvm-vg`` can be repaired) and ``name`` (name of the storage
630
unit). The result will be a job id.
630
Repairs a storage unit on the node. Requires the parameters
631
``storage_type`` (currently only ``lvm-vg`` can be repaired) and
632
``name`` (name of the storage unit). The result will be a job id.
631 633

  
632 634
``/2/nodes/[node_name]/tags``
633 635
+++++++++++++++++++++++++++++

Also available in: Unified diff