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

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

``ganeti-rapi`` reads users and passwords from a file (usually
24
``/var/lib/ganeti/rapi/users``) on startup. Changes to the file will be
25
read automatically.
26 27 28 29 30

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

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
56
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2 and
57 58 59 60 61 62 63
   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
The protocol used is JSON_ over HTTP designed after the REST_ principle.
68
HTTP Basic authentication as per :rfc:`2617` is supported.
69 70 71 72

.. _JSON: http://www.json.org/
.. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer

73 74 75 76
HTTP requests with a body (e.g. ``PUT`` or ``POST``) require the request
header ``Content-type`` be set to ``application/json`` (see :rfc:`2616`
(HTTP/1.1), section 7.2.1).

77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
A note on JSON as used by RAPI
++++++++++++++++++++++++++++++

JSON_ as used by Ganeti RAPI does not conform to the specification in
:rfc:`4627`. Section 2 defines a JSON text to be either an object
(``{"key": "value", …}``) or an array (``[1, 2, 3, …]``). In violation
of this RAPI uses plain strings (``"master-candidate"``, ``"1234"``) for
some requests or responses. Changing this now would likely break
existing clients and cause a lot of trouble.

.. highlight:: ruby

Unlike Python's `JSON encoder and decoder
<http://docs.python.org/library/json.html>`_, other programming
languages or libraries may only provide a strict implementation, not
allowing plain values. For those, responses can usually be wrapped in an
array whose first element is then used, e.g. the response ``"1234"``
becomes ``["1234"]``. This works equally well for more complex values.
Example in Ruby::

  require "json"

  # Insert code to get response here
  response = "\"1234\""

  decoded = JSON.parse("[#{response}]").first

Short of modifying the encoder to allow encoding to a less strict
format, requests will have to be formatted by hand. Newer RAPI requests
already use a dictionary as their input data and shouldn't cause any
problems.


111 112 113
PUT or POST?
------------

114 115 116
According to :rfc:`2616` 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.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

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``.

137 138 139
Generic parameters
------------------

140 141
A few parameter mean the same thing across all resources which implement
it.
142 143 144 145

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

Iustin Pop's avatar
Iustin Pop committed
146 147 148 149 150
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.
151 152 153 154

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

155 156 157
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.
158

Iustin Pop's avatar
Iustin Pop committed
159 160 161
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.
162

163 164 165 166 167 168
``force``
+++++++++++

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

169 170 171
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
172 173
You can access the API using your favorite programming language as long
as it supports network connections.
174

175 176 177 178 179
Ganeti RAPI client
++++++++++++++++++

Ganeti includes a standalone RAPI client, ``lib/rapi/client.py``.

180 181 182
Shell
+++++

Iustin Pop's avatar
Iustin Pop committed
183 184
.. highlight:: sh

185 186
Using wget::

Iustin Pop's avatar
Iustin Pop committed
187
   wget -q -O - https://CLUSTERNAME:5080/2/info
188 189 190 191 192 193 194 195 196

or curl::

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


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
197 198 199
.. highlight:: python

::
200 201

  import urllib2
Tim Boring's avatar
Tim Boring committed
202
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
203 204 205 206 207 208
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
214 215
.. highlight:: javascript

216 217
::

Tim Boring's avatar
Tim Boring committed
218
  var url = 'https://CLUSTERNAME:5080/2/info';
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
  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
237
.. highlight:: javascript
238

Iustin Pop's avatar
Iustin Pop committed
239 240
``/``
+++++
241

Iustin Pop's avatar
Iustin Pop committed
242
The root resource.
243

Iustin Pop's avatar
Iustin Pop committed
244
It supports the following commands: ``GET``.
245

Iustin Pop's avatar
Iustin Pop committed
246 247
``GET``
~~~~~~~
248

Iustin Pop's avatar
Iustin Pop committed
249
Shows the list of mapped resources.
250

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

Iustin Pop's avatar
Iustin Pop committed
253 254
``/2``
++++++
255

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

Iustin Pop's avatar
Iustin Pop committed
258
It supports the following commands: ``GET``.
259

Iustin Pop's avatar
Iustin Pop committed
260 261
``GET``
~~~~~~~
262

Iustin Pop's avatar
Iustin Pop committed
263
Show the list of mapped resources.
264

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

Iustin Pop's avatar
Iustin Pop committed
267 268
``/2/info``
+++++++++++
269

Iustin Pop's avatar
Iustin Pop committed
270
Cluster information resource.
271

Iustin Pop's avatar
Iustin Pop committed
272
It supports the following commands: ``GET``.
273

Iustin Pop's avatar
Iustin Pop committed
274 275
``GET``
~~~~~~~
276

Iustin Pop's avatar
Iustin Pop committed
277
Returns cluster information.
278

Iustin Pop's avatar
Iustin Pop committed
279
Example::
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

  {
    "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
       }
      }
    }

310 311 312 313 314 315 316 317 318 319 320 321 322 323

``/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.


324 325 326 327 328 329 330 331 332 333 334
``/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.
335 336
``instance-reinstall-reqv1``
  Instance reinstall supports body parameters.
337 338


339 340 341 342 343 344 345 346 347 348 349 350 351 352
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

353
.. opcode_params:: OP_CLUSTER_SET_PARAMS
354 355


356 357 358 359 360
``/2/groups``
+++++++++++++

The groups resource.

361
It supports the following commands: ``GET``, ``POST``.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

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

Returns a list of all existing node groups.

Example::

    [
      {
        "name": "group1",
        "uri": "\/2\/groups\/group1"
      },
      {
        "name": "group2",
        "uri": "\/2\/groups\/group2"
      }
    ]

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

Example::

    [
      {
        "name": "group1",
        "node_cnt": 2,
        "node_list": [
          "node1.example.com",
          "node2.example.com"
        ],
        "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
      },
      {
        "name": "group2",
        "node_cnt": 1,
        "node_list": [
          "node3.example.com"
        ],
        "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
      }
    ]

407 408 409 410 411 412 413 414 415 416 417 418
``POST``
~~~~~~~~

Creates a node group.

If the optional bool *dry-run* argument is provided, the job will not be
actually executed, only the pre-execution checks will be done.

Returns: a job ID that can be used later for polling.

Body parameters:

419 420 421 422
.. opcode_params:: OP_GROUP_ADD

Earlier versions used a parameter named ``name`` which, while still
supported, has been renamed to ``group_name``.
423 424


425
``/2/groups/[group_name]``
426
++++++++++++++++++++++++++
427 428 429

Returns information about a node group.

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
It supports the following commands: ``GET``, ``DELETE``.

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

Returns information about a node group, similar to the bulk output from
the node group list.

``DELETE``
~~~~~~~~~~

Deletes a node group.

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


446 447 448 449 450 451 452 453 454 455 456 457 458 459
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

460 461
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
462 463


464 465 466 467 468 469 470 471 472 473 474 475 476 477
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

478 479
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
480 481


482 483 484 485 486 487 488 489 490 491 492 493 494 495
``/2/groups/[group_name]/assign-nodes``
+++++++++++++++++++++++++++++++++++++++

Assigns nodes to a group.

Supports the following commands: ``PUT``.

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

Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.

Body parameters:

496 497
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
498 499


Iustin Pop's avatar
Iustin Pop committed
500 501
``/2/instances``
++++++++++++++++
502

Iustin Pop's avatar
Iustin Pop committed
503
The instances resource.
504

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

Iustin Pop's avatar
Iustin Pop committed
507 508
``GET``
~~~~~~~
509

Iustin Pop's avatar
Iustin Pop committed
510
Returns a list of all available instances.
511

Iustin Pop's avatar
Iustin Pop committed
512
Example::
513 514 515 516 517 518 519 520 521 522 523 524

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

525 526 527
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.
528

Iustin Pop's avatar
Iustin Pop committed
529
Example::
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

    [
      {
         "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
559 560
``POST``
~~~~~~~~
561

Iustin Pop's avatar
Iustin Pop committed
562
Creates an instance.
563

564 565 566 567
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.
568

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

571 572 573 574
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
575 576
  instance creation requests, version ``0``, but that format is no
  longer supported)
577 578 579 580 581 582

.. opcode_params:: OP_INSTANCE_CREATE

Earlier versions used parameters named ``name`` and ``os``. These have
been replaced by ``instance_name`` and ``os_type`` to match the
underlying opcode. The old names can still be used.
583 584


Iustin Pop's avatar
Iustin Pop committed
585 586
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
587

Iustin Pop's avatar
Iustin Pop committed
588
Instance-specific resource.
589

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

Iustin Pop's avatar
Iustin Pop committed
592 593
``GET``
~~~~~~~
594

Iustin Pop's avatar
Iustin Pop committed
595 596
Returns information about an instance, similar to the bulk output from
the instance list.
597

Iustin Pop's avatar
Iustin Pop committed
598 599
``DELETE``
~~~~~~~~~~
600

Iustin Pop's avatar
Iustin Pop committed
601
Deletes an instance.
602

603 604
It supports the ``dry-run`` argument.

605

606 607 608 609 610 611 612 613 614 615
``/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
616 617
configuration without querying the instance's nodes. The result will be
a job id.
618 619


Iustin Pop's avatar
Iustin Pop committed
620 621
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
622

Iustin Pop's avatar
Iustin Pop committed
623
Reboots URI for an instance.
624

Iustin Pop's avatar
Iustin Pop committed
625
It supports the following commands: ``POST``.
626

Iustin Pop's avatar
Iustin Pop committed
627 628
``POST``
~~~~~~~~
629

Iustin Pop's avatar
Iustin Pop committed
630
Reboots the instance.
631

632 633 634 635 636 637 638 639 640 641 642 643
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.
644

645 646 647
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
648 649
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
650

Iustin Pop's avatar
Iustin Pop committed
651
Instance shutdown URI.
652

Iustin Pop's avatar
Iustin Pop committed
653
It supports the following commands: ``PUT``.
654

Iustin Pop's avatar
Iustin Pop committed
655 656
``PUT``
~~~~~~~
657

Iustin Pop's avatar
Iustin Pop committed
658
Shutdowns an instance.
659

660 661
It supports the ``dry-run`` argument.

662 663 664
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

665

Iustin Pop's avatar
Iustin Pop committed
666 667
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
668

Iustin Pop's avatar
Iustin Pop committed
669
Instance startup URI.
670

Iustin Pop's avatar
Iustin Pop committed
671
It supports the following commands: ``PUT``.
672

Iustin Pop's avatar
Iustin Pop committed
673 674
``PUT``
~~~~~~~
675

Iustin Pop's avatar
Iustin Pop committed
676
Startup an instance.
677

678 679
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
680

681 682
It supports the ``dry-run`` argument.

683 684 685 686 687 688 689 690 691 692
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

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

693 694 695 696 697 698 699 700 701 702 703 704 705 706
Returns a job ID.

Body parameters:

``os`` (string, required)
  Instance operating system.
``start`` (bool, defaults to true)
  Whether to start instance after reinstallation.
``osparams`` (dict)
  Dictionary with (temporary) OS parameters.

For backwards compatbility, this resource also takes the query
parameters ``os`` (OS template name) and ``nostartup`` (bool). New
clients should use the body parameters.
707

708

709 710 711 712 713 714 715 716 717 718 719
``/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``,
720 721 722
``replace_on_secondary``, ``replace_new_secondary`` or
``replace_auto``), ``disks`` (comma separated list of disk indexes),
``remote_node`` and ``iallocator``.
723

724 725 726 727 728 729
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.

730

731 732 733 734 735 736 737 738 739 740
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

741
Takes the bool parameter ``ignore_size``. When set ignore the recorded
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
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.


758 759 760 761 762 763 764 765 766 767 768 769 770 771
``/2/instances/[instance_name]/disk/[disk_index]/grow``
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

Grows one disk of an instance.

Supports the following commands: ``POST``.

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

Returns a job ID.

Body parameters:

772 773
.. opcode_params:: OP_INSTANCE_GROW_DISK
   :exclude: instance_name, disk
774 775


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
``/2/instances/[instance_name]/prepare-export``
+++++++++++++++++++++++++++++++++++++++++++++++++

Prepares an export of an instance.

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

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

Takes one parameter, ``mode``, for the export mode. Returns a job ID.


``/2/instances/[instance_name]/export``
+++++++++++++++++++++++++++++++++++++++++++++++++

Exports an instance.

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

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

Returns a job ID.

Body parameters:

803 804 805
.. opcode_params:: OP_BACKUP_EXPORT
   :exclude: instance_name
   :alias: target_node=destination
806 807


808 809 810 811 812 813 814 815 816 817 818 819 820 821
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++

Migrates an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

822 823
.. opcode_params:: OP_INSTANCE_MIGRATE
   :exclude: instance_name, live
824 825


826 827 828 829 830 831 832 833 834 835 836 837 838 839
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++

Renames an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

840 841
.. opcode_params:: OP_INSTANCE_RENAME
   :exclude: instance_name
842 843


844 845 846 847 848 849 850 851 852 853 854 855 856 857
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

858 859
.. opcode_params:: OP_INSTANCE_SET_PARAMS
   :exclude: instance_name
860 861


862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
``/2/instances/[instance_name]/console``
++++++++++++++++++++++++++++++++++++++++

Request information for connecting to instance's console.

Supports the following commands: ``GET``.

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

Returns a dictionary containing information about the instance's
console. Contained keys:

``instance``
  Instance name.
``kind``
  Console type, one of ``ssh``, ``vnc`` or ``msg``.
``message``
  Message to display (``msg`` type only).
``host``
  Host to connect to (``ssh`` and ``vnc`` only).
``port``
  TCP port to connect to (``vnc`` only).
``user``
  Username to use (``ssh`` only).
``command``
  Command to execute on machine (``ssh`` only)
``display``
  VNC display number (``vnc`` only).


Iustin Pop's avatar
Iustin Pop committed
893 894
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
895

Iustin Pop's avatar
Iustin Pop committed
896
Manages per-instance tags.
897

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

Iustin Pop's avatar
Iustin Pop committed
900 901
``GET``
~~~~~~~
902

Iustin Pop's avatar
Iustin Pop committed
903
Returns a list of tags.
904

Iustin Pop's avatar
Iustin Pop committed
905
Example::
906

Iustin Pop's avatar
Iustin Pop committed
907
    ["tag1", "tag2", "tag3"]
908

Iustin Pop's avatar
Iustin Pop committed
909 910
``PUT``
~~~~~~~
911

Iustin Pop's avatar
Iustin Pop committed
912
Add a set of tags.
913

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

917 918 919
It supports the ``dry-run`` argument.


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

Iustin Pop's avatar
Iustin Pop committed
923
Delete a tag.
924

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

Iustin Pop's avatar
Iustin Pop committed
928
    /tags?tag=[tag]&tag=[tag]
929

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


Iustin Pop's avatar
Iustin Pop committed
933 934
``/2/jobs``
+++++++++++
935

Iustin Pop's avatar
Iustin Pop committed
936
The ``/2/jobs`` resource.
937

Iustin Pop's avatar
Iustin Pop committed
938
It supports the following commands: ``GET``.
939

Iustin Pop's avatar
Iustin Pop committed
940 941
``GET``
~~~~~~~
942

Iustin Pop's avatar
Iustin Pop committed
943
Returns a dictionary of jobs.
944

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

Iustin Pop's avatar
Iustin Pop committed
947 948
``/2/jobs/[job_id]``
++++++++++++++++++++
949 950


Iustin Pop's avatar
Iustin Pop committed
951
Individual job URI.
952

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

Iustin Pop's avatar
Iustin Pop committed
955 956
``GET``
~~~~~~~
957

Iustin Pop's avatar
Iustin Pop committed
958
Returns a job status.
959

Iustin Pop's avatar
Iustin Pop committed
960
Returns: a dictionary with job parameters.
961

Iustin Pop's avatar
Iustin Pop committed
962
The result includes:
963

Iustin Pop's avatar
Iustin Pop committed
964 965
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
966 967
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
968
- opstatus: OpCodes status as a list
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
- 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:

988 989 990 991 992 993 994 995
.. pyassert::

   errors.ECODE_ALL == set([errors.ECODE_RESOLVER, errors.ECODE_NORES,
     errors.ECODE_INVAL, errors.ECODE_STATE, errors.ECODE_NOENT,
     errors.ECODE_EXISTS, errors.ECODE_NOTUNIQUE, errors.ECODE_FAULT,
     errors.ECODE_ENVIRON])

:pyeval:`errors.ECODE_RESOLVER`
996 997 998 999
  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.

1000
:pyeval:`errors.ECODE_NORES`
1001 1002 1003 1004
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

1005
:pyeval:`errors.ECODE_INVAL`
1006 1007 1008
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

1009
:pyeval:`errors.ECODE_STATE`
1010 1011 1012 1013
  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.

1014
:pyeval:`errors.ECODE_NOENT`
1015 1016 1017
  Entity not found. For example, information has been requested for an
  unknown instance.

1018
:pyeval:`errors.ECODE_EXISTS`
1019 1020 1021
  Entity already exists. For example, instance creation has been
  requested for an already-existing instance.

1022
:pyeval:`errors.ECODE_NOTUNIQUE`
1023 1024
  Resource not unique (e.g. MAC or IP duplication).

1025
:pyeval:`errors.ECODE_FAULT`
1026 1027 1028 1029
  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.

1030
:pyeval:`errors.ECODE_ENVIRON`
1031 1032 1033 1034 1035 1036
  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.

1037

Iustin Pop's avatar
Iustin Pop committed
1038 1039
``DELETE``
~~~~~~~~~~
1040

Iustin Pop's avatar
Iustin Pop committed
1041
Cancel a not-yet-started job.
1042

1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

``/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
1067 1068
``/2/nodes``
++++++++++++
1069

Iustin Pop's avatar
Iustin Pop committed
1070
Nodes resource.
1071

Iustin Pop's avatar
Iustin Pop committed
1072
It supports the following commands: ``GET``.
1073

Iustin Pop's avatar
Iustin Pop committed
1074 1075
``GET``
~~~~~~~
1076

Iustin Pop's avatar
Iustin Pop committed
1077
Returns a list of all nodes.
1078

Iustin Pop's avatar
Iustin Pop committed
1079
Example::
1080 1081 1082 1083

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
1084
        "uri": "\/nodes\/node1.example.com"
1085 1086 1087
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
1088
        "uri": "\/nodes\/node2.example.com"
1089 1090 1091
      }
    ]

Iustin Pop's avatar
Iustin Pop committed
1092 1093 1094
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.
1095

Iustin Pop's avatar
Iustin Pop committed
1096
Example::
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113

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

1114 1115 1116 1117 1118 1119 1120
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

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

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
``/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``
1132
parameters must be passed::
1133 1134 1135 1136

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

1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
The result value will be a list, each element being a triple of the job
id (for this specific evacuation), the instance which is being evacuated
by this job, and the node to which it is being relocated. In case the
node is already empty, the result will be an empty list (without any
jobs being submitted).

And additional parameter ``early_release`` signifies whether to try to
parallelize the evacuations, at the risk of increasing I/O contention
and increasing the chances of data loss, if the primary node of any of
the instances being evacuated is not fully healthy.

If the dry-run parameter was specified, then the evacuation jobs were
not actually submitted, and the job IDs will be null.


1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

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

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

1162 1163 1164 1165 1166 1167 1168 1169
If no mode is explicitly specified, each instances' hypervisor default
migration mode will be used. Query parameters:

``live`` (bool)
  If set, use live migration if available.
``mode`` (string)
  Sets migration mode, ``live`` for live migration and ``non-live`` for
  non-live migration. Supported by Ganeti 2.2 and above.
1170 1171


1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
``/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.

1201 1202
The request is a string which should be PUT to this URI. The result will
be a job id.
1203

1204
It supports the bool ``force`` argument.
1205

1206 1207 1208 1209 1210 1211 1212 1213
``/2/nodes/[node_name]/storage``
++++++++++++++++++++++++++++++++

Manages storage units on the node.

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

1214 1215 1216 1217 1218 1219
.. pyassert::

   constants.VALID_STORAGE_TYPES == set([constants.ST_FILE,
                                         constants.ST_LVM_PV,
                                         constants.ST_LVM_VG])

1220
Requests a list of storage units on a node. Requires the parameters
1221 1222
``storage_type`` (one of :pyeval:`constants.ST_FILE`,
:pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`) and
1223 1224
``output_fields``. The result will be a job id, using which the result
can be retrieved.
1225

1226 1227 1228 1229 1230 1231 1232 1233
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++

Modifies storage units on the node.

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

1234
Modifies parameters of storage units on the node. Requires the
1235 1236
parameters ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
:pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`)
1237
and ``name`` (name of the storage unit).  Parameters can be passed
1238 1239
additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool)
is supported. The result will be a job id.
1240

1241 1242 1243 1244 1245 1246 1247 1248
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++

Repairs a storage unit on the node.

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

1249 1250 1251 1252 1253 1254
.. pyassert::

   constants.VALID_STORAGE_OPERATIONS == {
    constants.ST_LVM_VG: set([constants.SO_FIX_CONSISTENCY]),
    }

1255
Repairs a storage unit on the node. Requires the parameters
1256 1257 1258
``storage_type`` (currently only :pyeval:`constants.ST_LVM_VG` can be
repaired) and ``name`` (name of the storage unit). The result will be a
job id.
1259

Iustin Pop's avatar
Iustin Pop committed
1260 1261
``/2/nodes/[node_name]/tags``
+++++++++++++++++++++++++++++
1262

Iustin Pop's avatar
Iustin Pop committed
1263
Manages per-node tags.
1264

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

Iustin Pop's avatar
Iustin Pop committed
1267 1268
``GET``
~~~~~~~
1269

Iustin Pop's avatar
Iustin Pop committed
1270
Returns a list of tags.
1271

Iustin Pop's avatar
Iustin Pop committed
1272
Example::
1273

Iustin Pop's avatar
Iustin Pop committed
1274
    ["tag1", "tag2", "tag3"]
1275

Iustin Pop's avatar
Iustin Pop committed
1276 1277
``PUT``
~~~~~~~
1278

Iustin Pop's avatar
Iustin Pop committed
1279
Add a set of tags.
1280

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

1284 1285
It supports the ``dry-run`` argument.

Iustin Pop's avatar
Iustin Pop committed
1286 1287
``DELETE``
~~~~~~~~~~
1288

Iustin Pop's avatar
Iustin Pop committed
1289
Deletes tags.
1290

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

Iustin Pop's avatar
Iustin Pop committed
1294
    /tags?tag=[tag]&tag=[tag]
1295

1296 1297 1298
It supports the ``dry-run`` argument.


1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
``/2/query/[resource]``
+++++++++++++++++++++++

Requests resource information. Available fields can be found in man
pages and using ``/2/query/[resource]/fields``. The resource is one of
:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2
design document <design-query2>` for more details.

Supports the following commands: ``GET``, ``PUT``.

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

Returns list of included fields and actual data. Takes a query parameter
named "fields", containing a comma-separated list of field names. Does
not support filtering.

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

Returns list of included fields and actual data. The list of requested
fields can either be given as the query parameter "fields" or as a body
parameter with the same name. The optional body parameter "filter" can
be given and must be either ``null`` or a list containing filter
operators.


``/2/query/[resource]/fields``
++++++++++++++++++++++++++++++

Request list of available fields for a resource. The resource is one of
:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the
:doc:`query2 design document <design-query2>` for more details.

Supports the following commands: ``GET``.

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

Returns a list of field descriptions for available fields. Takes an
optional query parameter named "fields", containing a comma-separated
list of field names.


Iustin Pop's avatar