rapi.rst 20.1 KB
Newer Older
1 2 3
Ganeti remote API
=================

Iustin Pop's avatar
Iustin Pop committed
4
Documents Ganeti version |version|
5 6 7 8 9 10 11 12 13 14 15 16 17 18

.. contents::

Introduction
------------

Ganeti supports a remote API for enable external tools to easily
retrieve information about a cluster's state. The remote API daemon,
*ganeti-rapi*, is automatically started on the master node. By default
it runs on TCP port 5080, but this can be changed either in
``.../constants.py`` or via the command line parameter *-p*. SSL mode,
which is used by default, can also be disabled by passing command line
parameters.

19 20 21 22 23 24 25 26 27 28 29 30

Users and passwords
-------------------

``ganeti-rapi`` reads users and passwords from a file (usually
``/var/lib/ganeti/rapi_users``) on startup. After modifying the password
file, ``ganeti-rapi`` must be restarted.

Each line consists of two or three fields separated by whitespace. The
first two fields are for username and password. The third field is
optional and can be used to specify per-user options. Currently,
``write`` is the only option supported and enables the user to execute
31 32
operations modifying the cluster. Lines starting with the hash sign
(``#``) are treated as comments.
33 34 35 36 37

Passwords can either be written in clear text or as a hash. Clear text
passwords may not start with an opening brace (``{``) or they must be
prefixed with ``{cleartext}``. To use the hashed form, get the MD5 hash
of the string ``$username:Ganeti Remote API:$password`` (e.g. ``echo -n
38 39 40
'jack:Ganeti Remote API:abc123' | openssl md5``) [#pwhash]_ and prefix
it with ``{ha1}``. Using the scheme prefix for all passwords is
recommended. Scheme prefixes are not case sensitive.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

Example::

  # Give Jack and Fred read-only access
  jack abc123
  fred {cleartext}foo555

  # Give write access to an imaginary instance creation script
  autocreator xyz789 write

  # Hashed password for Jessica
  jessica {HA1}7046452df2cbb530877058712cf17bd4 write


.. [#pwhash] Using the MD5 hash of username, realm and password is
   described in RFC2617_ ("HTTP Authentication"), sections 3.2.2.2 and
   3.3. The reason for using it over another algorithm is forward
   compatibility. If ``ganeti-rapi`` were to implement HTTP Digest
   authentication in the future, the same hash could be used.
   In the current version ``ganeti-rapi``'s realm, ``Ganeti Remote
   API``, can only be changed by modifying the source code.


64 65 66
Protocol
--------

67 68
The protocol used is JSON_ over HTTP designed after the REST_ principle.
HTTP Basic authentication as per RFC2617_ is supported.
69 70 71

.. _JSON: http://www.json.org/
.. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
72
.. _RFC2617: http://tools.ietf.org/rfc/rfc2617.txt
73

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100

PUT or POST?
------------

According to RFC2616 the main difference between PUT and POST is that
POST can create new resources but PUT can only create the resource the
URI was pointing to on the PUT request.

Unfortunately, due to historic reasons, the Ganeti RAPI library is not
consistent with this usage, so just use the methods as documented below
for each resource.

For more details have a look in the source code at
``lib/rapi/rlib2.py``.


Generic parameter types
-----------------------

A few generic refered parameter types and the values they allow.

``bool``
++++++++

A boolean option will accept ``1`` or ``0`` as numbers but not
i.e. ``True`` or ``False``.

101 102 103
Generic parameters
------------------

104 105
A few parameter mean the same thing across all resources which implement
it.
106 107 108 109

``bulk``
++++++++

Iustin Pop's avatar
Iustin Pop committed
110 111 112 113 114
Bulk-mode means that for the resources which usually return just a list
of child resources (e.g. ``/2/instances`` which returns just instance
names), the output will instead contain detailed data for all these
subresources. This is more efficient than query-ing the sub-resources
themselves.
115 116 117 118

``dry-run``
+++++++++++

119 120 121
The boolean *dry-run* argument, if provided and set, signals to Ganeti
that the job should not be executed, only the pre-execution checks will
be done.
122

Iustin Pop's avatar
Iustin Pop committed
123 124 125
This is useful in trying to determine (without guarantees though, as in
the meantime the cluster state could have changed) if the operation is
likely to succeed or at least start executing.
126

127 128 129 130 131 132
``force``
+++++++++++

Force operation to continue even if it will cause the cluster to become
inconsistent (e.g. because there are not enough master candidates).

133 134 135
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
136 137
You can access the API using your favorite programming language as long
as it supports network connections.
138 139 140 141

Shell
+++++

Iustin Pop's avatar
Iustin Pop committed
142 143
.. highlight:: sh

144 145
Using wget::

Iustin Pop's avatar
Iustin Pop committed
146
   wget -q -O - https://CLUSTERNAME:5080/2/info
147 148 149 150 151 152 153 154 155

or curl::

  curl https://CLUSTERNAME:5080/2/info


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
156 157 158
.. highlight:: python

::
159 160

  import urllib2
Tim Boring's avatar
Tim Boring committed
161
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
162 163 164 165 166 167
  print f.read()


JavaScript
++++++++++

168
.. warning:: While it's possible to use JavaScript, it poses several
Iustin Pop's avatar
Iustin Pop committed
169 170 171
   potential problems, including browser blocking request due to
   non-standard ports or different domain names. Fetching the data on
   the webserver is easier.
172

Iustin Pop's avatar
Iustin Pop committed
173 174
.. highlight:: javascript

175 176
::

Tim Boring's avatar
Tim Boring committed
177
  var url = 'https://CLUSTERNAME:5080/2/info';
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
  var info;
  var xmlreq = new XMLHttpRequest();
  xmlreq.onreadystatechange = function () {
    if (xmlreq.readyState != 4) return;
    if (xmlreq.status == 200) {
      info = eval("(" + xmlreq.responseText + ")");
      alert(info);
    } else {
      alert('Error fetching cluster info');
    }
    xmlreq = null;
  };
  xmlreq.open('GET', url, true);
  xmlreq.send(null);

Resources
---------

Iustin Pop's avatar
Iustin Pop committed
196
.. highlight:: javascript
197

Iustin Pop's avatar
Iustin Pop committed
198 199
``/``
+++++
200

Iustin Pop's avatar
Iustin Pop committed
201
The root resource.
202

Iustin Pop's avatar
Iustin Pop committed
203
It supports the following commands: ``GET``.
204

Iustin Pop's avatar
Iustin Pop committed
205 206
``GET``
~~~~~~~
207

Iustin Pop's avatar
Iustin Pop committed
208
Shows the list of mapped resources.
209

Iustin Pop's avatar
Iustin Pop committed
210
Returns: a dictionary with 'name' and 'uri' keys for each of them.
211

Iustin Pop's avatar
Iustin Pop committed
212 213
``/2``
++++++
214

Iustin Pop's avatar
Iustin Pop committed
215
The ``/2`` resource, the root of the version 2 API.
216

Iustin Pop's avatar
Iustin Pop committed
217
It supports the following commands: ``GET``.
218

Iustin Pop's avatar
Iustin Pop committed
219 220
``GET``
~~~~~~~
221

Iustin Pop's avatar
Iustin Pop committed
222
Show the list of mapped resources.
223

Iustin Pop's avatar
Iustin Pop committed
224
Returns: a dictionary with ``name`` and ``uri`` keys for each of them.
225

Iustin Pop's avatar
Iustin Pop committed
226 227
``/2/info``
+++++++++++
228

Iustin Pop's avatar
Iustin Pop committed
229
Cluster information resource.
230

Iustin Pop's avatar
Iustin Pop committed
231
It supports the following commands: ``GET``.
232

Iustin Pop's avatar
Iustin Pop committed
233 234
``GET``
~~~~~~~
235

Iustin Pop's avatar
Iustin Pop committed
236
Returns cluster information.
237

Iustin Pop's avatar
Iustin Pop committed
238
Example::
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

  {
    "config_version": 2000000,
    "name": "cluster",
    "software_version": "2.0.0~beta2",
    "os_api_version": 10,
    "export_version": 0,
    "candidate_pool_size": 10,
    "enabled_hypervisors": [
      "fake"
    ],
    "hvparams": {
      "fake": {}
     },
    "default_hypervisor": "fake",
    "master": "node1.example.com",
    "architecture": [
      "64bit",
      "x86_64"
    ],
    "protocol_version": 20,
    "beparams": {
      "default": {
        "auto_balance": true,
        "vcpus": 1,
        "memory": 128
       }
      }
    }

269 270 271 272 273 274 275 276 277 278 279 280 281 282

``/2/redistribute-config``
++++++++++++++++++++++++++

Redistribute configuration to all nodes.

It supports the following commands: ``PUT``.

``PUT``
~~~~~~~

Redistribute configuration to all nodes. The result will be a job id.


Iustin Pop's avatar
Iustin Pop committed
283 284
``/2/instances``
++++++++++++++++
285

Iustin Pop's avatar
Iustin Pop committed
286
The instances resource.
287

Iustin Pop's avatar
Iustin Pop committed
288
It supports the following commands: ``GET``, ``POST``.
289

Iustin Pop's avatar
Iustin Pop committed
290 291
``GET``
~~~~~~~
292

Iustin Pop's avatar
Iustin Pop committed
293
Returns a list of all available instances.
294

Iustin Pop's avatar
Iustin Pop committed
295
Example::
296 297 298 299 300 301 302 303 304 305 306 307

    [
      {
        "name": "web.example.com",
        "uri": "\/instances\/web.example.com"
      },
      {
        "name": "mail.example.com",
        "uri": "\/instances\/mail.example.com"
      }
    ]

308 309 310
If the optional bool *bulk* argument is provided and set to a true value
(i.e ``?bulk=1``), the output contains detailed information about
instances as a list.
311

Iustin Pop's avatar
Iustin Pop committed
312
Example::
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341

    [
      {
         "status": "running",
         "disk_usage": 20480,
         "nic.bridges": [
           "xen-br0"
          ],
         "name": "web.example.com",
         "tags": ["tag1", "tag2"],
         "beparams": {
           "vcpus": 2,
           "memory": 512
         },
         "disk.sizes": [
             20480
         ],
         "pnode": "node1.example.com",
         "nic.macs": ["01:23:45:67:89:01"],
         "snodes": ["node2.example.com"],
         "disk_template": "drbd",
         "admin_state": true,
         "os": "debian-etch",
         "oper_state": true
      },
      ...
    ]


Iustin Pop's avatar
Iustin Pop committed
342 343
``POST``
~~~~~~~~
344

Iustin Pop's avatar
Iustin Pop committed
345
Creates an instance.
346

347 348 349 350
If the optional bool *dry-run* argument is provided, the job will not be
actually executed, only the pre-execution checks will be done. Query-ing
the job result will return, in both dry-run and normal case, the list of
nodes selected for the instance.
351

Iustin Pop's avatar
Iustin Pop committed
352
Returns: a job ID that can be used later for polling.
353

Iustin Pop's avatar
Iustin Pop committed
354 355
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
356

Iustin Pop's avatar
Iustin Pop committed
357
Instance-specific resource.
358

Iustin Pop's avatar
Iustin Pop committed
359
It supports the following commands: ``GET``, ``DELETE``.
360

Iustin Pop's avatar
Iustin Pop committed
361 362
``GET``
~~~~~~~
363

Iustin Pop's avatar
Iustin Pop committed
364 365
Returns information about an instance, similar to the bulk output from
the instance list.
366

Iustin Pop's avatar
Iustin Pop committed
367 368
``DELETE``
~~~~~~~~~~
369

Iustin Pop's avatar
Iustin Pop committed
370
Deletes an instance.
371

372 373
It supports the ``dry-run`` argument.

374

375 376 377 378 379 380 381 382 383 384
``/2/instances/[instance_name]/info``
+++++++++++++++++++++++++++++++++++++++

It supports the following commands: ``GET``.

``GET``
~~~~~~~

Requests detailed information about the instance. An optional parameter,
``static`` (bool), can be set to return only static information from the
385 386
configuration without querying the instance's nodes. The result will be
a job id.
387 388


Iustin Pop's avatar
Iustin Pop committed
389 390
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
391

Iustin Pop's avatar
Iustin Pop committed
392
Reboots URI for an instance.
393

Iustin Pop's avatar
Iustin Pop committed
394
It supports the following commands: ``POST``.
395

Iustin Pop's avatar
Iustin Pop committed
396 397
``POST``
~~~~~~~~
398

Iustin Pop's avatar
Iustin Pop committed
399
Reboots the instance.
400

401 402 403 404 405 406 407 408 409 410 411 412
The URI takes optional ``type=soft|hard|full`` and
``ignore_secondaries=0|1`` parameters.

``type`` defines the reboot type. ``soft`` is just a normal reboot,
without terminating the hypervisor. ``hard`` means full shutdown
(including terminating the hypervisor process) and startup again.
``full`` is like ``hard`` but also recreates the configuration from
ground up as if you would have done a ``gnt-instance shutdown`` and
``gnt-instance start`` on it.

``ignore_secondaries`` is a bool argument indicating if we start the
instance even if secondary disks are failing.
413

414 415 416
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
417 418
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
419

Iustin Pop's avatar
Iustin Pop committed
420
Instance shutdown URI.
421

Iustin Pop's avatar
Iustin Pop committed
422
It supports the following commands: ``PUT``.
423

Iustin Pop's avatar
Iustin Pop committed
424 425
``PUT``
~~~~~~~
426

Iustin Pop's avatar
Iustin Pop committed
427
Shutdowns an instance.
428

429 430
It supports the ``dry-run`` argument.

431

Iustin Pop's avatar
Iustin Pop committed
432 433
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
434

Iustin Pop's avatar
Iustin Pop committed
435
Instance startup URI.
436

Iustin Pop's avatar
Iustin Pop committed
437
It supports the following commands: ``PUT``.
438

Iustin Pop's avatar
Iustin Pop committed
439 440
``PUT``
~~~~~~~
441

Iustin Pop's avatar
Iustin Pop committed
442
Startup an instance.
443

444 445
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
446

447 448
It supports the ``dry-run`` argument.

449 450 451 452 453 454 455 456 457 458 459 460
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

``POST``
~~~~~~~~

Takes the parameters ``os`` (OS template name) and ``nostartup`` (bool).

461

462 463 464 465 466 467 468 469 470 471 472
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

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

``POST``
~~~~~~~~

Takes the parameters ``mode`` (one of ``replace_on_primary``,
473 474 475
``replace_on_secondary``, ``replace_new_secondary`` or
``replace_auto``), ``disks`` (comma separated list of disk indexes),
``remote_node`` and ``iallocator``.
476

477 478 479 480 481 482
Either ``remote_node`` or ``iallocator`` needs to be defined when using
``mode=replace_new_secondary``.

``mode`` is a mandatory parameter. ``replace_auto`` tries to determine
the broken disk(s) on its own and replacing it.

483

484 485 486 487 488 489 490 491 492 493
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

It supports the following commands: ``PUT``.

``PUT``
~~~~~~~

494
Takes the bool parameter ``ignore_size``. When set ignore the recorded
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
size (useful for forcing activation when recorded size is wrong).


``/2/instances/[instance_name]/deactivate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

Deactivate disks on an instance.

It supports the following commands: ``PUT``.

``PUT``
~~~~~~~

Takes no parameters.


Iustin Pop's avatar
Iustin Pop committed
511 512
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
513

Iustin Pop's avatar
Iustin Pop committed
514
Manages per-instance tags.
515

Iustin Pop's avatar
Iustin Pop committed
516
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
517

Iustin Pop's avatar
Iustin Pop committed
518 519
``GET``
~~~~~~~
520

Iustin Pop's avatar
Iustin Pop committed
521
Returns a list of tags.
522

Iustin Pop's avatar
Iustin Pop committed
523
Example::
524

Iustin Pop's avatar
Iustin Pop committed
525
    ["tag1", "tag2", "tag3"]
526

Iustin Pop's avatar
Iustin Pop committed
527 528
``PUT``
~~~~~~~
529

Iustin Pop's avatar
Iustin Pop committed
530
Add a set of tags.
531

Iustin Pop's avatar
Iustin Pop committed
532
The request as a list of strings should be ``PUT`` to this URI. The
533
result will be a job id.
534

535 536 537
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
538 539
``DELETE``
~~~~~~~~~~
540

Iustin Pop's avatar
Iustin Pop committed
541
Delete a tag.
542

Iustin Pop's avatar
Iustin Pop committed
543 544
In order to delete a set of tags, the DELETE request should be addressed
to URI like::
545

Iustin Pop's avatar
Iustin Pop committed
546
    /tags?tag=[tag]&tag=[tag]
547

548 549 550
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
551 552
``/2/jobs``
+++++++++++
553

Iustin Pop's avatar
Iustin Pop committed
554
The ``/2/jobs`` resource.
555

Iustin Pop's avatar
Iustin Pop committed
556
It supports the following commands: ``GET``.
557

Iustin Pop's avatar
Iustin Pop committed
558 559
``GET``
~~~~~~~
560

Iustin Pop's avatar
Iustin Pop committed
561
Returns a dictionary of jobs.
562

Iustin Pop's avatar
Iustin Pop committed
563
Returns: a dictionary with jobs id and uri.
564

Iustin Pop's avatar
Iustin Pop committed
565 566
``/2/jobs/[job_id]``
++++++++++++++++++++
567 568


Iustin Pop's avatar
Iustin Pop committed
569
Individual job URI.
570

Iustin Pop's avatar
Iustin Pop committed
571
It supports the following commands: ``GET``, ``DELETE``.
572

Iustin Pop's avatar
Iustin Pop committed
573 574
``GET``
~~~~~~~
575

Iustin Pop's avatar
Iustin Pop committed
576
Returns a job status.
577

Iustin Pop's avatar
Iustin Pop committed
578
Returns: a dictionary with job parameters.
579

Iustin Pop's avatar
Iustin Pop committed
580
The result includes:
581

Iustin Pop's avatar
Iustin Pop committed
582 583
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
584 585
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
586
- opstatus: OpCodes status as a list
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
- opresult: OpCodes results as a list

For a successful opcode, the ``opresult`` field corresponding to it will
contain the raw result from its :term:`LogicalUnit`. In case an opcode
has failed, its element in the opresult list will be a list of two
elements:

- first element the error type (the Ganeti internal error name)
- second element a list of either one or two elements:

  - the first element is the textual error description
  - the second element, if any, will hold an error classification

The error classification is most useful for the ``OpPrereqError``
error type - these errors happen before the OpCode has started
executing, so it's possible to retry the OpCode without side
effects. But whether it make sense to retry depends on the error
classification:

``resolver_error``
  Resolver errors. This usually means that a name doesn't exist in DNS,
  so if it's a case of slow DNS propagation the operation can be retried
  later.

``insufficient_resources``
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

``wrong_input``
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

``wrong_state``
  Wrong entity state. For example, live migration has been requested for
  a down instance, or instance creation on an offline node. The
  operation can be retried once the resource has changed state.

``unknown_entity``
  Entity not found. For example, information has been requested for an
  unknown instance.

``already_exists``
  Entity already exists. For example, instance creation has been
  requested for an already-existing instance.

``resource_not_unique``
  Resource not unique (e.g. MAC or IP duplication).

``internal_error``
  Internal cluster error. For example, a node is unreachable but not set
  offline, or the ganeti node daemons are not working, etc. A
  ``gnt-cluster verify`` should be run.

``environment_error``
  Environment error (e.g. node disk error). A ``gnt-cluster verify``
  should be run.

Note that in the above list, by entity we refer to a node or instance,
while by a resource we refer to an instance's disk, or NIC, etc.

648

Iustin Pop's avatar
Iustin Pop committed
649 650
``DELETE``
~~~~~~~~~~
651

Iustin Pop's avatar
Iustin Pop committed
652
Cancel a not-yet-started job.
653

Iustin Pop's avatar
Iustin Pop committed
654 655
``/2/nodes``
++++++++++++
656

Iustin Pop's avatar
Iustin Pop committed
657
Nodes resource.
658

Iustin Pop's avatar
Iustin Pop committed
659
It supports the following commands: ``GET``.
660

Iustin Pop's avatar
Iustin Pop committed
661 662
``GET``
~~~~~~~
663

Iustin Pop's avatar
Iustin Pop committed
664
Returns a list of all nodes.
665

Iustin Pop's avatar
Iustin Pop committed
666
Example::
667 668 669 670

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
671
        "uri": "\/nodes\/node1.example.com"
672 673 674
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
675
        "uri": "\/nodes\/node2.example.com"
676 677 678
      }
    ]

Iustin Pop's avatar
Iustin Pop committed
679 680 681
If the optional 'bulk' argument is provided and set to 'true' value (i.e
'?bulk=1'), the output contains detailed information about nodes as a
list.
682

Iustin Pop's avatar
Iustin Pop committed
683
Example::
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700

    [
      {
        "pinst_cnt": 1,
        "mfree": 31280,
        "mtotal": 32763,
        "name": "www.example.com",
        "tags": [],
        "mnode": 512,
        "dtotal": 5246208,
        "sinst_cnt": 2,
        "dfree": 5171712,
        "offline": false
      },
      ...
    ]

701 702 703 704 705 706 707
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

It supports the following commands: ``GET``.

708 709 710 711 712 713 714 715 716 717 718
``/2/nodes/[node_name]/evacuate``
+++++++++++++++++++++++++++++++++

Evacuates all secondary instances off a node.

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

``POST``
~~~~~~~~

To evacuate a node, either one of the ``iallocator`` or ``remote_node``
719
parameters must be passed::
720 721 722 723

    evacuate?iallocator=[iallocator]
    evacuate?remote_node=[nodeX.example.com]

724 725 726 727 728 729 730 731 732 733
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

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

``POST``
~~~~~~~~

734 735
No parameters are required, but the bool parameter ``live`` can be set
to use live migration (if available).
736 737 738

    migrate?live=[0|1]

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
``/2/nodes/[node_name]/role``
+++++++++++++++++++++++++++++

Manages node role.

It supports the following commands: ``GET``, ``PUT``.

The role is always one of the following:

  - drained
  - master
  - master-candidate
  - offline
  - regular

``GET``
~~~~~~~

Returns the current node role.

Example::

    "master-candidate"

``PUT``
~~~~~~~

Change the node role.

768 769
The request is a string which should be PUT to this URI. The result will
be a job id.
770

771
It supports the bool ``force`` argument.
772

773 774 775 776 777 778 779 780 781 782
``/2/nodes/[node_name]/storage``
++++++++++++++++++++++++++++++++

Manages storage units on the node.

``GET``
~~~~~~~

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

786 787 788 789 790 791 792 793
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++

Modifies storage units on the node.

``PUT``
~~~~~~~

794 795 796 797 798
Modifies parameters of storage units on the node. Requires the
parameters ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``)
and ``name`` (name of the storage unit).  Parameters can be passed
additionally. Currently only ``allocatable`` (bool) is supported. The
result will be a job id.
799

800 801 802 803 804 805 806 807
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++

Repairs a storage unit on the node.

``PUT``
~~~~~~~

808 809 810
Repairs a storage unit on the node. Requires the parameters
``storage_type`` (currently only ``lvm-vg`` can be repaired) and
``name`` (name of the storage unit). The result will be a job id.
811

Iustin Pop's avatar
Iustin Pop committed
812 813
``/2/nodes/[node_name]/tags``
+++++++++++++++++++++++++++++
814

Iustin Pop's avatar
Iustin Pop committed
815
Manages per-node tags.
816

Iustin Pop's avatar
Iustin Pop committed
817
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
818

Iustin Pop's avatar
Iustin Pop committed
819 820
``GET``
~~~~~~~
821

Iustin Pop's avatar
Iustin Pop committed
822
Returns a list of tags.
823

Iustin Pop's avatar
Iustin Pop committed
824
Example::
825

Iustin Pop's avatar
Iustin Pop committed
826
    ["tag1", "tag2", "tag3"]
827

Iustin Pop's avatar
Iustin Pop committed
828 829
``PUT``
~~~~~~~
830

Iustin Pop's avatar
Iustin Pop committed
831
Add a set of tags.
832

Iustin Pop's avatar
Iustin Pop committed
833 834
The request as a list of strings should be PUT to this URI. The result
will be a job id.
835

836 837
It supports the ``dry-run`` argument.

Iustin Pop's avatar
Iustin Pop committed
838 839
``DELETE``
~~~~~~~~~~
840

Iustin Pop's avatar
Iustin Pop committed
841
Deletes tags.
842

Iustin Pop's avatar
Iustin Pop committed
843 844
In order to delete a set of tags, the DELETE request should be addressed
to URI like::
845

Iustin Pop's avatar
Iustin Pop committed
846
    /tags?tag=[tag]&tag=[tag]
847

848 849 850
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
851 852
``/2/os``
+++++++++
853

Iustin Pop's avatar
Iustin Pop committed
854
OS resource.
855

Iustin Pop's avatar
Iustin Pop committed
856
It supports the following commands: ``GET``.
857

Iustin Pop's avatar
Iustin Pop committed
858 859
``GET``
~~~~~~~
860

Iustin Pop's avatar
Iustin Pop committed
861
Return a list of all OSes.
862

Iustin Pop's avatar
Iustin Pop committed
863
Can return error 500 in case of a problem. Since this is a costly
Iustin Pop's avatar
Iustin Pop committed
864
operation for Ganeti 2.0, it is not recommended to execute it too often.
865

Iustin Pop's avatar
Iustin Pop committed
866
Example::
867

Iustin Pop's avatar
Iustin Pop committed
868
    ["debian-etch"]
869

Iustin Pop's avatar
Iustin Pop committed
870 871
``/2/tags``
+++++++++++
872

Iustin Pop's avatar
Iustin Pop committed
873
Manages cluster tags.
874

Iustin Pop's avatar
Iustin Pop committed
875
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
876

Iustin Pop's avatar
Iustin Pop committed
877 878
``GET``
~~~~~~~
879

Iustin Pop's avatar
Iustin Pop committed
880
Returns the cluster tags.
881

Iustin Pop's avatar
Iustin Pop committed
882
Example::
883

Iustin Pop's avatar
Iustin Pop committed
884
    ["tag1", "tag2", "tag3"]
885

Iustin Pop's avatar
Iustin Pop committed
886 887
``PUT``
~~~~~~~
888

Iustin Pop's avatar
Iustin Pop committed
889
Adds a set of tags.
890

Iustin Pop's avatar
Iustin Pop committed
891 892
The request as a list of strings should be PUT to this URI. The result
will be a job id.
893

894 895 896
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
897 898
``DELETE``
~~~~~~~~~~
899

Iustin Pop's avatar
Iustin Pop committed
900
Deletes tags.
901

Iustin Pop's avatar
Iustin Pop committed
902 903
In order to delete a set of tags, the DELETE request should be addressed
to URI like::
904

Iustin Pop's avatar
Iustin Pop committed
905
    /tags?tag=[tag]&tag=[tag]
906

907 908 909
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
910 911
``/version``
++++++++++++
912

Iustin Pop's avatar
Iustin Pop committed
913
The version resource.
914

Iustin Pop's avatar
Iustin Pop committed
915 916
This resource should be used to determine the remote API version and to
adapt clients accordingly.
917

Iustin Pop's avatar
Iustin Pop committed
918
It supports the following commands: ``GET``.
919

Iustin Pop's avatar
Iustin Pop committed
920 921
``GET``
~~~~~~~
922

Iustin Pop's avatar
Iustin Pop committed
923 924
Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
returns ``2``.
925 926

.. vim: set textwidth=72 :
Iustin Pop's avatar
Iustin Pop committed
927 928 929 930
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End: