rapi.rst 33.4 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 57
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
   and 3.3. The reason for using it over another algorithm is forward
58 59 60 61 62 63
   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

242 243
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
244

Iustin Pop's avatar
Iustin Pop committed
245 246
``/2/info``
+++++++++++
247

Iustin Pop's avatar
Iustin Pop committed
248
Cluster information resource.
249

Iustin Pop's avatar
Iustin Pop committed
250
It supports the following commands: ``GET``.
251

Iustin Pop's avatar
Iustin Pop committed
252 253
``GET``
~~~~~~~
254

Iustin Pop's avatar
Iustin Pop committed
255
Returns cluster information.
256

Iustin Pop's avatar
Iustin Pop committed
257
Example::
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301

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


302 303 304 305 306 307 308 309 310
``/2/features``
+++++++++++++++

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

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

311 312 313 314 315 316 317 318
.. pyassert::

  rlib2.ALL_FEATURES == set([rlib2._INST_CREATE_REQV1,
                             rlib2._INST_REINSTALL_REQV1,
                             rlib2._NODE_MIGRATE_REQV1,
                             rlib2._NODE_EVAC_RES1])

:pyeval:`rlib2._INST_CREATE_REQV1`
319
  Instance creation request data version 1 supported.
320
:pyeval:`rlib2._INST_REINSTALL_REQV1`
321
  Instance reinstall supports body parameters.
322 323 324 325 326 327
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
  request body parameters.
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
328 329


330 331 332 333 334 335 336 337 338 339 340 341 342 343
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

344
.. opcode_params:: OP_CLUSTER_SET_PARAMS
345 346


347 348 349 350 351
``/2/groups``
+++++++++++++

The groups resource.

352
It supports the following commands: ``GET``, ``POST``.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375

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

376 377
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
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"
      }
    ]

400 401 402 403 404 405 406 407 408 409 410 411
``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:

412 413 414 415
.. opcode_params:: OP_GROUP_ADD

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


418
``/2/groups/[group_name]``
419
++++++++++++++++++++++++++
420 421 422

Returns information about a node group.

423 424 425 426 427 428 429 430
It supports the following commands: ``GET``, ``DELETE``.

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

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

431 432
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`

433 434 435 436 437 438 439 440
``DELETE``
~~~~~~~~~~

Deletes a node group.

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


441 442 443 444 445 446 447 448 449 450 451 452 453 454
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

455 456
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
457

458 459 460 461
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

462

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

Renames a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

477 478
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
479

480 481 482 483
Job result:

.. opcode_result:: OP_GROUP_RENAME

484

485 486 487 488 489 490 491 492 493 494 495 496 497 498
``/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:

499 500
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
501 502


503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
``/2/groups/[group_name]/tags``
+++++++++++++++++++++++++++++++

Manages per-nodegroup tags.

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

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

Returns a list of tags.

Example::

    ["tag1", "tag2", "tag3"]

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

Add a set of tags.

The request as a list of strings should be ``PUT`` to this URI. The
result will be a job id.

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


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

Delete a tag.

In order to delete a set of tags, the DELETE request should be addressed
to URI like::

    /tags?tag=[tag]&tag=[tag]

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


Iustin Pop's avatar
Iustin Pop committed
543 544
``/2/instances``
++++++++++++++++
545

Iustin Pop's avatar
Iustin Pop committed
546
The instances resource.
547

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

Iustin Pop's avatar
Iustin Pop committed
550 551
``GET``
~~~~~~~
552

Iustin Pop's avatar
Iustin Pop committed
553
Returns a list of all available instances.
554

Iustin Pop's avatar
Iustin Pop committed
555
Example::
556 557 558 559 560 561 562 563 564 565 566 567

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

568 569 570
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.
571

572 573
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`

Iustin Pop's avatar
Iustin Pop committed
574
Example::
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603

    [
      {
         "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
604 605
``POST``
~~~~~~~~
606

Iustin Pop's avatar
Iustin Pop committed
607
Creates an instance.
608

609 610 611 612
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.
613

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

616 617 618 619
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
620 621
  instance creation requests, version ``0``, but that format is no
  longer supported)
622 623 624 625 626 627

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

629 630 631 632
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

633

Iustin Pop's avatar
Iustin Pop committed
634 635
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
636

Iustin Pop's avatar
Iustin Pop committed
637
Instance-specific resource.
638

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

Iustin Pop's avatar
Iustin Pop committed
641 642
``GET``
~~~~~~~
643

Iustin Pop's avatar
Iustin Pop committed
644 645
Returns information about an instance, similar to the bulk output from
the instance list.
646

647 648
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`

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

Iustin Pop's avatar
Iustin Pop committed
652
Deletes an instance.
653

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

656

657 658 659 660 661 662 663 664 665 666
``/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
667 668
configuration without querying the instance's nodes. The result will be
a job id.
669 670


Iustin Pop's avatar
Iustin Pop committed
671 672
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
673

Iustin Pop's avatar
Iustin Pop committed
674
Reboots URI for an instance.
675

Iustin Pop's avatar
Iustin Pop committed
676
It supports the following commands: ``POST``.
677

Iustin Pop's avatar
Iustin Pop committed
678 679
``POST``
~~~~~~~~
680

Iustin Pop's avatar
Iustin Pop committed
681
Reboots the instance.
682

683 684 685 686 687 688 689 690 691 692 693 694
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.
695

696 697 698
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
699 700
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
701

Iustin Pop's avatar
Iustin Pop committed
702
Instance shutdown URI.
703

Iustin Pop's avatar
Iustin Pop committed
704
It supports the following commands: ``PUT``.
705

Iustin Pop's avatar
Iustin Pop committed
706 707
``PUT``
~~~~~~~
708

Iustin Pop's avatar
Iustin Pop committed
709
Shutdowns an instance.
710

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

713 714 715
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

716

Iustin Pop's avatar
Iustin Pop committed
717 718
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
719

Iustin Pop's avatar
Iustin Pop committed
720
Instance startup URI.
721

Iustin Pop's avatar
Iustin Pop committed
722
It supports the following commands: ``PUT``.
723

Iustin Pop's avatar
Iustin Pop committed
724 725
``PUT``
~~~~~~~
726

Iustin Pop's avatar
Iustin Pop committed
727
Startup an instance.
728

729 730
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
731

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

734 735 736 737 738 739 740 741 742 743
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

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

744 745 746 747 748 749 750 751 752 753 754 755 756 757
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.
758

759

760 761 762 763 764 765 766 767 768 769 770
``/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``,
771 772 773
``replace_on_secondary``, ``replace_new_secondary`` or
``replace_auto``), ``disks`` (comma separated list of disk indexes),
``remote_node`` and ``iallocator``.
774

775 776 777 778 779 780
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.

781

782 783 784 785 786 787 788 789 790 791
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

792
Takes the bool parameter ``ignore_size``. When set ignore the recorded
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
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.


809 810 811 812 813 814 815 816 817 818 819 820 821 822
``/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:

823 824
.. opcode_params:: OP_INSTANCE_GROW_DISK
   :exclude: instance_name, disk
825 826


827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
``/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:

854 855 856
.. opcode_params:: OP_BACKUP_EXPORT
   :exclude: instance_name
   :alias: target_node=destination
857 858


859 860 861 862 863 864 865 866 867 868 869 870 871 872
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++

Migrates an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

873 874
.. opcode_params:: OP_INSTANCE_MIGRATE
   :exclude: instance_name, live
875 876


877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
``/2/instances/[instance_name]/failover``
+++++++++++++++++++++++++++++++++++++++++

Does a failover of an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

.. opcode_params:: OP_INSTANCE_FAILOVER
   :exclude: instance_name


895 896 897 898 899 900 901 902 903 904 905 906 907 908
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++

Renames an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

909 910
.. opcode_params:: OP_INSTANCE_RENAME
   :exclude: instance_name
911

912 913 914 915
Job result:

.. opcode_result:: OP_INSTANCE_RENAME

916

917 918 919 920 921 922 923 924 925 926 927 928 929 930
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

931 932
.. opcode_params:: OP_INSTANCE_SET_PARAMS
   :exclude: instance_name
933

934 935 936 937
Job result:

.. opcode_result:: OP_INSTANCE_SET_PARAMS

938

939 940 941 942 943 944 945 946 947 948 949 950 951
``/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:

952 953 954 955 956 957 958 959
.. pyassert::

   constants.CONS_ALL == frozenset([
     constants.CONS_MESSAGE,
     constants.CONS_SSH,
     constants.CONS_VNC,
     ])

960 961 962
``instance``
  Instance name.
``kind``
963 964
  Console type, one of :pyeval:`constants.CONS_SSH`,
  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_MESSAGE`.
965
``message``
966
  Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
967
``host``
968 969
  Host to connect to (:pyeval:`constants.CONS_SSH` and
  :pyeval:`constants.CONS_VNC` only).
970
``port``
971
  TCP port to connect to (:pyeval:`constants.CONS_VNC` only).
972
``user``
973
  Username to use (:pyeval:`constants.CONS_SSH` only).
974
``command``
975
  Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
976
``display``
977
  VNC display number (:pyeval:`constants.CONS_VNC` only).
978 979


Iustin Pop's avatar
Iustin Pop committed
980 981
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
982

Iustin Pop's avatar
Iustin Pop committed
983
Manages per-instance tags.
984

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

Iustin Pop's avatar
Iustin Pop committed
987 988
``GET``
~~~~~~~
989

Iustin Pop's avatar
Iustin Pop committed
990
Returns a list of tags.
991

Iustin Pop's avatar
Iustin Pop committed
992
Example::
993

Iustin Pop's avatar
Iustin Pop committed
994
    ["tag1", "tag2", "tag3"]
995

Iustin Pop's avatar
Iustin Pop committed
996 997
``PUT``
~~~~~~~
998

Iustin Pop's avatar
Iustin Pop committed
999
Add a set of tags.
1000

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

1004 1005 1006
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1007 1008
``DELETE``
~~~~~~~~~~
1009

Iustin Pop's avatar
Iustin Pop committed
1010
Delete a tag.
1011

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

Iustin Pop's avatar
Iustin Pop committed
1015
    /tags?tag=[tag]&tag=[tag]
1016

1017 1018 1019
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1020 1021
``/2/jobs``
+++++++++++
1022

Iustin Pop's avatar
Iustin Pop committed
1023
The ``/2/jobs`` resource.
1024

Iustin Pop's avatar
Iustin Pop committed
1025
It supports the following commands: ``GET``.
1026

Iustin Pop's avatar
Iustin Pop committed
1027 1028
``GET``
~~~~~~~
1029

Iustin Pop's avatar
Iustin Pop committed
1030
Returns a dictionary of jobs.
1031

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

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

1038 1039 1040 1041
Returned fields for bulk requests (unlike other bulk requests, these
fields are not the same as for per-job requests):
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`

Iustin Pop's avatar
Iustin Pop committed
1042 1043
``/2/jobs/[job_id]``
++++++++++++++++++++
1044 1045


Iustin Pop's avatar
Iustin Pop committed
1046
Individual job URI.
1047

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

Iustin Pop's avatar
Iustin Pop committed
1050 1051
``GET``
~~~~~~~
1052

1053 1054
Returns a dictionary with job parameters, containing the fields
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.
1055

Iustin Pop's avatar
Iustin Pop committed
1056
The result includes:
1057

Iustin Pop's avatar
Iustin Pop committed
1058 1059
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
1060 1061
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
1062
- opstatus: OpCodes status as a list
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
- 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:

1082 1083 1084 1085 1086 1087 1088 1089
.. 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`
1090 1091 1092 1093
  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.

1094
:pyeval:`errors.ECODE_NORES`
1095 1096 1097 1098
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

1099
:pyeval:`errors.ECODE_INVAL`
1100 1101 1102
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

1103
:pyeval:`errors.ECODE_STATE`
1104 1105 1106 1107
  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.

1108
:pyeval:`errors.ECODE_NOENT`
1109 1110 1111
  Entity not found. For example, information has been requested for an
  unknown instance.

1112
:pyeval:`errors.ECODE_EXISTS`
1113 1114 1115
  Entity already exists. For example, instance creation has been
  requested for an already-existing instance.

1116
:pyeval:`errors.ECODE_NOTUNIQUE`
1117 1118
  Resource not unique (e.g. MAC or IP duplication).

1119
:pyeval:`errors.ECODE_FAULT`
1120 1121 1122 1123
  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.

1124
:pyeval:`errors.ECODE_ENVIRON`
1125 1126 1127 1128 1129 1130
  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.

1131

Iustin Pop's avatar
Iustin Pop committed
1132 1133
``DELETE``
~~~~~~~~~~
1134

Iustin Pop's avatar
Iustin Pop committed
1135
Cancel a not-yet-started job.
1136

1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

``/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
1161 1162
``/2/nodes``
++++++++++++
1163

Iustin Pop's avatar
Iustin Pop committed
1164
Nodes resource.
1165

Iustin Pop's avatar
Iustin Pop committed
1166
It supports the following commands: ``GET``.
1167

Iustin Pop's avatar
Iustin Pop committed
1168 1169
``GET``
~~~~~~~
1170

Iustin Pop's avatar
Iustin Pop committed
1171
Returns a list of all nodes.
1172

Iustin Pop's avatar
Iustin Pop committed
1173
Example::
1174 1175 1176 1177

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
1178
        "uri": "\/nodes\/node1.example.com"
1179 1180 1181
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
1182
        "uri": "\/nodes\/node2.example.com"
1183 1184 1185
      }
    ]

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

Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1191

Iustin Pop's avatar
Iustin Pop committed
1192
Example::
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209

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

1210 1211 1212 1213 1214 1215 1216
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

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

1217 1218
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`

1219 1220 1221
``/2/nodes/[node_name]/evacuate``
+++++++++++++++++++++++++++++++++

1222
Evacuates instances off a node.
1223 1224 1225 1226 1227 1228

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

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

1229 1230
Returns a job ID. The result of the job will contain the IDs of the
individual jobs submitted to evacuate the node.
1231

1232
Body parameters:
1233

1234 1235
.. opcode_params:: OP_NODE_EVACUATE
   :exclude: nodes
1236

1237 1238 1239
Up to and including Ganeti 2.4 query arguments were used. Those are no
longer supported. The new request can be detected by the presence of the
:pyeval:`rlib2._NODE_EVAC_RES1` feature string.
1240

1241 1242 1243 1244
Job result:

.. opcode_result:: OP_NODE_EVACUATE

1245

1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

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

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

1256
If no mode is explicitly specified, each instances' hypervisor default
1257 1258 1259 1260
migration mode will be used. Body parameters:

.. opcode_params:: OP_NODE_MIGRATE
   :exclude: node_name
1261

1262 1263 1264
The query arguments used up to and including Ganeti 2.4 are deprecated
and should no longer be used. The new request format can be detected by
the presence of the :pyeval:`rlib2._NODE_MIGRATE_REQV1` feature string.
1265 1266


1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
``/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-candidate
  - offline
  - regular

1281 1282 1283 1284
Note that the 'master' role is a special, and currently it can't be
modified via RAPI, only via the command line (``gnt-cluster
master-failover``).

1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
``GET``
~~~~~~~

Returns the current node role.

Example::

    "master-candidate"

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

Change the node role.

1299 1300
The request is a string which should be PUT to this URI. The result will
be a job id.
1301

1302
It supports the bool ``force`` argument.
1303

1304 1305 1306 1307 1308 1309 1310 1311
``/2/nodes/[node_name]/storage``
++++++++++++++++++++++++++++++++

Manages storage units on the node.

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

1312 1313 1314 1315 1316 1317
.. pyassert::

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

1318
Requests a list of storage units on a node. Requires the parameters
1319 1320
``storage_type`` (one of :pyeval:`constants.ST_FILE`,
:pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`) and
1321 1322
``output_fields``. The result will be a job id, using which the result
can be retrieved.
1323

1324 1325 1326 1327 1328 1329 1330 1331
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++

Modifies storage units on the node.

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

1332
Modifies parameters of storage units on the node. Requires the
1333 1334
parameters ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
:pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`)
1335
and ``name`` (name of the storage unit).  Parameters can be passed
1336 1337
additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool)
is supported. The result will be a job id.
1338

1339 1340 1341 1342 1343 1344 1345 1346
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++

Repairs a storage unit on the node.

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