rapi.rst 20.8 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.


283 284 285 286 287 288 289 290 291 292 293 294 295
``/2/features``
+++++++++++++++

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

Returns a list of features supported by the RAPI server. Available
features:

``instance-create-reqv1``
  Instance creation request data version 1 supported.


Iustin Pop's avatar
Iustin Pop committed
296 297
``/2/instances``
++++++++++++++++
298

Iustin Pop's avatar
Iustin Pop committed
299
The instances resource.
300

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

Iustin Pop's avatar
Iustin Pop committed
303 304
``GET``
~~~~~~~
305

Iustin Pop's avatar
Iustin Pop committed
306
Returns a list of all available instances.
307

Iustin Pop's avatar
Iustin Pop committed
308
Example::
309 310 311 312 313 314 315 316 317 318 319 320

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

321 322 323
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.
324

Iustin Pop's avatar
Iustin Pop committed
325
Example::
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

    [
      {
         "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
355 356
``POST``
~~~~~~~~
357

Iustin Pop's avatar
Iustin Pop committed
358
Creates an instance.
359

360 361 362 363
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.
364

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

Iustin Pop's avatar
Iustin Pop committed
367 368
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
369

Iustin Pop's avatar
Iustin Pop committed
370
Instance-specific resource.
371

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

Iustin Pop's avatar
Iustin Pop committed
374 375
``GET``
~~~~~~~
376

Iustin Pop's avatar
Iustin Pop committed
377 378
Returns information about an instance, similar to the bulk output from
the instance list.
379

Iustin Pop's avatar
Iustin Pop committed
380 381
``DELETE``
~~~~~~~~~~
382

Iustin Pop's avatar
Iustin Pop committed
383
Deletes an instance.
384

385 386
It supports the ``dry-run`` argument.

387

388 389 390 391 392 393 394 395 396 397
``/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
398 399
configuration without querying the instance's nodes. The result will be
a job id.
400 401


Iustin Pop's avatar
Iustin Pop committed
402 403
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
404

Iustin Pop's avatar
Iustin Pop committed
405
Reboots URI for an instance.
406

Iustin Pop's avatar
Iustin Pop committed
407
It supports the following commands: ``POST``.
408

Iustin Pop's avatar
Iustin Pop committed
409 410
``POST``
~~~~~~~~
411

Iustin Pop's avatar
Iustin Pop committed
412
Reboots the instance.
413

414 415 416 417 418 419 420 421 422 423 424 425
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.
426

427 428 429
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
430 431
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
432

Iustin Pop's avatar
Iustin Pop committed
433
Instance shutdown URI.
434

Iustin Pop's avatar
Iustin Pop committed
435
It supports the following commands: ``PUT``.
436

Iustin Pop's avatar
Iustin Pop committed
437 438
``PUT``
~~~~~~~
439

Iustin Pop's avatar
Iustin Pop committed
440
Shutdowns an instance.
441

442 443
It supports the ``dry-run`` argument.

444

Iustin Pop's avatar
Iustin Pop committed
445 446
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
447

Iustin Pop's avatar
Iustin Pop committed
448
Instance startup URI.
449

Iustin Pop's avatar
Iustin Pop committed
450
It supports the following commands: ``PUT``.
451

Iustin Pop's avatar
Iustin Pop committed
452 453
``PUT``
~~~~~~~
454

Iustin Pop's avatar
Iustin Pop committed
455
Startup an instance.
456

457 458
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
459

460 461
It supports the ``dry-run`` argument.

462 463 464 465 466 467 468 469 470 471 472 473
``/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).

474

475 476 477 478 479 480 481 482 483 484 485
``/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``,
486 487 488
``replace_on_secondary``, ``replace_new_secondary`` or
``replace_auto``), ``disks`` (comma separated list of disk indexes),
``remote_node`` and ``iallocator``.
489

490 491 492 493 494 495
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.

496

497 498 499 500 501 502 503 504 505 506
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

507
Takes the bool parameter ``ignore_size``. When set ignore the recorded
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
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
524 525
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
526

Iustin Pop's avatar
Iustin Pop committed
527
Manages per-instance tags.
528

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

Iustin Pop's avatar
Iustin Pop committed
531 532
``GET``
~~~~~~~
533

Iustin Pop's avatar
Iustin Pop committed
534
Returns a list of tags.
535

Iustin Pop's avatar
Iustin Pop committed
536
Example::
537

Iustin Pop's avatar
Iustin Pop committed
538
    ["tag1", "tag2", "tag3"]
539

Iustin Pop's avatar
Iustin Pop committed
540 541
``PUT``
~~~~~~~
542

Iustin Pop's avatar
Iustin Pop committed
543
Add a set of tags.
544

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

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


Iustin Pop's avatar
Iustin Pop committed
551 552
``DELETE``
~~~~~~~~~~
553

Iustin Pop's avatar
Iustin Pop committed
554
Delete a tag.
555

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

Iustin Pop's avatar
Iustin Pop committed
559
    /tags?tag=[tag]&tag=[tag]
560

561 562 563
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
564 565
``/2/jobs``
+++++++++++
566

Iustin Pop's avatar
Iustin Pop committed
567
The ``/2/jobs`` resource.
568

Iustin Pop's avatar
Iustin Pop committed
569
It supports the following commands: ``GET``.
570

Iustin Pop's avatar
Iustin Pop committed
571 572
``GET``
~~~~~~~
573

Iustin Pop's avatar
Iustin Pop committed
574
Returns a dictionary of jobs.
575

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

Iustin Pop's avatar
Iustin Pop committed
578 579
``/2/jobs/[job_id]``
++++++++++++++++++++
580 581


Iustin Pop's avatar
Iustin Pop committed
582
Individual job URI.
583

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

Iustin Pop's avatar
Iustin Pop committed
586 587
``GET``
~~~~~~~
588

Iustin Pop's avatar
Iustin Pop committed
589
Returns a job status.
590

Iustin Pop's avatar
Iustin Pop committed
591
Returns: a dictionary with job parameters.
592

Iustin Pop's avatar
Iustin Pop committed
593
The result includes:
594

Iustin Pop's avatar
Iustin Pop committed
595 596
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
597 598
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
599
- opstatus: OpCodes status as a list
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 648 649 650 651 652 653 654 655 656 657 658 659 660
- 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.

661

Iustin Pop's avatar
Iustin Pop committed
662 663
``DELETE``
~~~~~~~~~~
664

Iustin Pop's avatar
Iustin Pop committed
665
Cancel a not-yet-started job.
666

667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690

``/2/jobs/[job_id]/wait``
+++++++++++++++++++++++++

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

Waits for changes on a job. Takes the following body parameters in a
dict:

``fields``
  The job fields on which to watch for changes.

``previous_job_info``
  Previously received field values or None if not yet available.

``previous_log_serial``
  Highest log serial number received so far or None if not yet
  available.

Returns None if no changes have been detected and a dict with two keys,
``job_info`` and ``log_entries`` otherwise.


Iustin Pop's avatar
Iustin Pop committed
691 692
``/2/nodes``
++++++++++++
693

Iustin Pop's avatar
Iustin Pop committed
694
Nodes resource.
695

Iustin Pop's avatar
Iustin Pop committed
696
It supports the following commands: ``GET``.
697

Iustin Pop's avatar
Iustin Pop committed
698 699
``GET``
~~~~~~~
700

Iustin Pop's avatar
Iustin Pop committed
701
Returns a list of all nodes.
702

Iustin Pop's avatar
Iustin Pop committed
703
Example::
704 705 706 707

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
708
        "uri": "\/nodes\/node1.example.com"
709 710 711
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
712
        "uri": "\/nodes\/node2.example.com"
713 714 715
      }
    ]

Iustin Pop's avatar
Iustin Pop committed
716 717 718
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.
719

Iustin Pop's avatar
Iustin Pop committed
720
Example::
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737

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

738 739 740 741 742 743 744
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

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

745 746 747 748 749 750 751 752 753 754 755
``/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``
756
parameters must be passed::
757 758 759 760

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

761 762 763 764 765 766 767 768 769 770
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

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

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

771 772
No parameters are required, but the bool parameter ``live`` can be set
to use live migration (if available).
773 774 775

    migrate?live=[0|1]

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
``/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.

805 806
The request is a string which should be PUT to this URI. The result will
be a job id.
807

808
It supports the bool ``force`` argument.
809

810 811 812 813 814 815 816 817 818 819
``/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
820 821
``output_fields``. The result will be a job id, using which the result
can be retrieved.
822

823 824 825 826 827 828 829 830
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++

Modifies storage units on the node.

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

831 832 833 834 835
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.
836

837 838 839 840 841 842 843 844
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++

Repairs a storage unit on the node.

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

845 846 847
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.
848

Iustin Pop's avatar
Iustin Pop committed
849 850
``/2/nodes/[node_name]/tags``
+++++++++++++++++++++++++++++
851

Iustin Pop's avatar
Iustin Pop committed
852
Manages per-node tags.
853

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

Iustin Pop's avatar
Iustin Pop committed
856 857
``GET``
~~~~~~~
858

Iustin Pop's avatar
Iustin Pop committed
859
Returns a list of tags.
860

Iustin Pop's avatar
Iustin Pop committed
861
Example::
862

Iustin Pop's avatar
Iustin Pop committed
863
    ["tag1", "tag2", "tag3"]
864

Iustin Pop's avatar
Iustin Pop committed
865 866
``PUT``
~~~~~~~
867

Iustin Pop's avatar
Iustin Pop committed
868
Add a set of tags.
869

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

873 874
It supports the ``dry-run`` argument.

Iustin Pop's avatar
Iustin Pop committed
875 876
``DELETE``
~~~~~~~~~~
877

Iustin Pop's avatar
Iustin Pop committed
878
Deletes tags.
879

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

Iustin Pop's avatar
Iustin Pop committed
883
    /tags?tag=[tag]&tag=[tag]
884

885 886 887
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
888 889
``/2/os``
+++++++++
890

Iustin Pop's avatar
Iustin Pop committed
891
OS resource.
892

Iustin Pop's avatar
Iustin Pop committed
893
It supports the following commands: ``GET``.
894

Iustin Pop's avatar
Iustin Pop committed
895 896
``GET``
~~~~~~~
897

Iustin Pop's avatar
Iustin Pop committed
898
Return a list of all OSes.
899

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

Iustin Pop's avatar
Iustin Pop committed
903
Example::
904

Iustin Pop's avatar
Iustin Pop committed
905
    ["debian-etch"]
906

Iustin Pop's avatar
Iustin Pop committed
907 908
``/2/tags``
+++++++++++
909

Iustin Pop's avatar
Iustin Pop committed
910
Manages cluster tags.
911

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

Iustin Pop's avatar
Iustin Pop committed
914 915
``GET``
~~~~~~~
916

Iustin Pop's avatar
Iustin Pop committed
917
Returns the cluster tags.
918

Iustin Pop's avatar
Iustin Pop committed
919
Example::
920

Iustin Pop's avatar
Iustin Pop committed
921
    ["tag1", "tag2", "tag3"]
922

Iustin Pop's avatar
Iustin Pop committed
923 924
``PUT``
~~~~~~~
925

Iustin Pop's avatar
Iustin Pop committed
926
Adds a set of tags.
927

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

931 932 933
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
934 935
``DELETE``
~~~~~~~~~~
936

Iustin Pop's avatar
Iustin Pop committed
937
Deletes tags.
938

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

Iustin Pop's avatar
Iustin Pop committed
942
    /tags?tag=[tag]&tag=[tag]
943

944 945 946
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
947 948
``/version``
++++++++++++
949

Iustin Pop's avatar
Iustin Pop committed
950
The version resource.
951

Iustin Pop's avatar
Iustin Pop committed
952 953
This resource should be used to determine the remote API version and to
adapt clients accordingly.
954

Iustin Pop's avatar
Iustin Pop committed
955
It supports the following commands: ``GET``.
956

Iustin Pop's avatar
Iustin Pop committed
957 958
``GET``
~~~~~~~
959

Iustin Pop's avatar
Iustin Pop committed
960 961
Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
returns ``2``.
962 963

.. vim: set textwidth=72 :
Iustin Pop's avatar
Iustin Pop committed
964 965 966 967
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End: