rapi.rst 48.2 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
.. _rapi-users:
20 21 22 23 24

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

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

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
Lines starting with the hash sign (``#``) are treated as comments. 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 (separated by comma without
spaces). Available options:

.. pyassert::

  rapi.RAPI_ACCESS_ALL == set([
    rapi.RAPI_ACCESS_WRITE,
    rapi.RAPI_ACCESS_READ,
    ])

:pyeval:`rapi.RAPI_ACCESS_WRITE`
  Enables the user to execute operations modifying the cluster. Implies
  :pyeval:`rapi.RAPI_ACCESS_READ` access.
:pyeval:`rapi.RAPI_ACCESS_READ`
  Allow access to operations querying for information.
46 47 48 49 50

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
51 52 53
'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.
54 55 56 57 58 59 60 61 62 63 64 65 66

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

67
  # Monitoring can query for values
68
  monitoring {HA1}ec018ffe72b8e75bb4d508ed5b6d079c read
69

70 71 72
  # A user who can read and write (the former is implied by granting
  # write access)
  superuser {HA1}ec018ffe72b8e75bb4d508ed5b6d079c read,write
73

74 75

.. [#pwhash] Using the MD5 hash of username, realm and password is
76 77
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
   and 3.3. The reason for using it over another algorithm is forward
78 79 80 81 82 83
   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.


84 85 86
Protocol
--------

87
The protocol used is JSON_ over HTTP designed after the REST_ principle.
88
HTTP Basic authentication as per :rfc:`2617` is supported.
89 90 91 92

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

93 94 95 96
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).

97

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
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.


131 132 133
PUT or POST?
------------

134 135 136
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.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156

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

157 158 159
Generic parameters
------------------

160 161
A few parameter mean the same thing across all resources which implement
it.
162 163 164 165

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

Iustin Pop's avatar
Iustin Pop committed
166 167 168 169 170
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.
171 172 173 174

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

175 176 177
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.
178

Iustin Pop's avatar
Iustin Pop committed
179 180 181
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.
182

183 184 185 186 187 188
``force``
+++++++++++

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

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
Parameter details
-----------------

Some parameters are not straight forward, so we describe them in details
here.

.. _rapi-ipolicy:

``ipolicy``
+++++++++++

The instance policy specification is a dict with the following fields:

.. pyassert::

  constants.IPOLICY_ALL_KEYS == set([constants.ISPECS_MIN,
                                     constants.ISPECS_MAX,
                                     constants.ISPECS_STD,
                                     constants.IPOLICY_DTS,
208 209
                                     constants.IPOLICY_VCPU_RATIO,
                                     constants.IPOLICY_SPINDLE_RATIO])
210 211 212 213 214 215 216 217 218


.. pyassert::

  (set(constants.ISPECS_PARAMETER_TYPES.keys()) ==
   set([constants.ISPEC_MEM_SIZE,
        constants.ISPEC_DISK_SIZE,
        constants.ISPEC_DISK_COUNT,
        constants.ISPEC_CPU_COUNT,
219 220
        constants.ISPEC_NIC_COUNT,
        constants.ISPEC_SPINDLE_USE]))
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

.. |ispec-min| replace:: :pyeval:`constants.ISPECS_MIN`
.. |ispec-max| replace:: :pyeval:`constants.ISPECS_MAX`
.. |ispec-std| replace:: :pyeval:`constants.ISPECS_STD`


|ispec-min|, |ispec-max|, |ispec-std|
  A sub- `dict` with the following fields, which sets the limit and standard
  values of the instances:

  :pyeval:`constants.ISPEC_MEM_SIZE`
    The size in MiB of the memory used
  :pyeval:`constants.ISPEC_DISK_SIZE`
    The size in MiB of the disk used
  :pyeval:`constants.ISPEC_DISK_COUNT`
    The numbers of disks used
  :pyeval:`constants.ISPEC_CPU_COUNT`
    The numbers of cpus used
  :pyeval:`constants.ISPEC_NIC_COUNT`
    The numbers of nics used
241 242
  :pyeval:`constants.ISPEC_SPINDLE_USE`
    The numbers of virtual disk spindles used by this instance. They are
243 244
    not real in the sense of actual HDD spindles, but useful for
    accounting the spindle usage on the residing node
245 246 247 248
:pyeval:`constants.IPOLICY_DTS`
  A `list` of disk templates allowed for instances using this policy
:pyeval:`constants.IPOLICY_VCPU_RATIO`
  Maximum ratio of virtual to physical CPUs (`float`)
249 250
:pyeval:`constants.IPOLICY_SPINDLE_RATIO`
  Maximum ratio of instances to their node's ``spindle_count`` (`float`)
251

252 253 254
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
255 256
You can access the API using your favorite programming language as long
as it supports network connections.
257

258 259 260 261 262
Ganeti RAPI client
++++++++++++++++++

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

263 264 265
Shell
+++++

266
.. highlight:: shell-example
Iustin Pop's avatar
Iustin Pop committed
267

268 269
Using wget::

270
   $ wget -q -O - https://%CLUSTERNAME%:5080/2/info
271 272 273

or curl::

274
  $ curl https://%CLUSTERNAME%:5080/2/info
275 276 277 278 279


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
280 281 282
.. highlight:: python

::
283 284

  import urllib2
Tim Boring's avatar
Tim Boring committed
285
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
286 287 288 289 290 291
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
297 298
.. highlight:: javascript

299 300
::

Tim Boring's avatar
Tim Boring committed
301
  var url = 'https://CLUSTERNAME:5080/2/info';
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  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
320
.. highlight:: javascript
321

Iustin Pop's avatar
Iustin Pop committed
322 323
``/``
+++++
324

325 326
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
327

328 329 330 331 332
``/2``
++++++

Has no function, but for legacy reasons the ``GET`` method is supported.

333 334
.. _rapi-res-info:

Iustin Pop's avatar
Iustin Pop committed
335 336
``/2/info``
+++++++++++
337

Iustin Pop's avatar
Iustin Pop committed
338
Cluster information resource.
339

Iustin Pop's avatar
Iustin Pop committed
340
It supports the following commands: ``GET``.
341

342 343
.. _rapi-res-info+get:

Iustin Pop's avatar
Iustin Pop committed
344 345
``GET``
~~~~~~~
346

Iustin Pop's avatar
Iustin Pop committed
347
Returns cluster information.
348

Iustin Pop's avatar
Iustin Pop committed
349
Example::
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

  {
    "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
       }
377 378 379
      },

  }
380

381

382 383
.. _rapi-res-redistribute-config:

384 385 386 387 388 389 390
``/2/redistribute-config``
++++++++++++++++++++++++++

Redistribute configuration to all nodes.

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

391 392 393

.. _rapi-res-redistribute-config+put:

394 395 396 397 398
``PUT``
~~~~~~~

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

399 400 401 402
Job result:

.. opcode_result:: OP_CLUSTER_REDIST_CONF

403

404 405
.. _rapi-res-features:

406 407 408
``/2/features``
+++++++++++++++

409 410 411

.. _rapi-res-features+get:

412 413 414 415 416 417
``GET``
~~~~~~~

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

418 419 420 421 422 423 424 425
.. 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`
426
  Instance creation request data version 1 supported
427
:pyeval:`rlib2._INST_REINSTALL_REQV1`
428
  Instance reinstall supports body parameters
429 430
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
431
  request body parameters
432 433 434
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
435 436


437 438
.. _rapi-res-modify:

439 440 441 442 443 444 445
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

446 447 448

.. _rapi-res-modify+put:

449 450 451 452 453 454 455
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

456
.. opcode_params:: OP_CLUSTER_SET_PARAMS
457

458 459 460 461
Job result:

.. opcode_result:: OP_CLUSTER_SET_PARAMS

462

463 464
.. _rapi-res-groups:

465 466 467 468 469
``/2/groups``
+++++++++++++

The groups resource.

470
It supports the following commands: ``GET``, ``POST``.
471

472 473
.. _rapi-res-groups+get:

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
``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.

496
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
497

498 499 500 501 502 503 504 505 506 507
Example::

    [
      {
        "name": "group1",
        "node_cnt": 2,
        "node_list": [
          "node1.example.com",
          "node2.example.com"
        ],
508 509
        "uuid": "0d7d407c-262e-49af-881a-6a430034bf43",

510 511 512 513 514 515 516
      },
      {
        "name": "group2",
        "node_cnt": 1,
        "node_list": [
          "node3.example.com"
        ],
517 518 519 520
        "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c",

      },

521 522
    ]

523 524 525

.. _rapi-res-groups+post:

526 527 528 529 530 531 532 533 534 535 536 537
``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:

538 539 540 541
.. opcode_params:: OP_GROUP_ADD

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

543 544 545 546
Job result:

.. opcode_result:: OP_GROUP_ADD

547

548 549
.. _rapi-res-groups-group_name:

550
``/2/groups/[group_name]``
551
++++++++++++++++++++++++++
552 553 554

Returns information about a node group.

555 556
It supports the following commands: ``GET``, ``DELETE``.

557 558
.. _rapi-res-groups-group_name+get:

559 560 561 562 563 564
``GET``
~~~~~~~

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

565
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
566

567 568
.. _rapi-res-groups-group_name+delete:

569 570 571 572 573 574 575
``DELETE``
~~~~~~~~~~

Deletes a node group.

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

576 577 578 579
Job result:

.. opcode_result:: OP_GROUP_REMOVE

580

581 582
.. _rapi-res-groups-group_name-modify:

583 584 585 586 587 588 589
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

590 591
.. _rapi-res-groups-group_name-modify+put:

592 593 594 595 596 597 598
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

599 600
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
601

602 603 604 605
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

606

607 608
.. _rapi-res-groups-group_name-rename:

609 610 611 612 613 614 615
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

Supports the following commands: ``PUT``.

616 617
.. _rapi-res-groups-group_name-rename+put:

618 619 620 621 622 623 624
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

625 626
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
627

628 629 630 631
Job result:

.. opcode_result:: OP_GROUP_RENAME

632

633 634
.. _rapi-res-groups-group_name-assign-nodes:

635 636 637 638 639 640 641
``/2/groups/[group_name]/assign-nodes``
+++++++++++++++++++++++++++++++++++++++

Assigns nodes to a group.

Supports the following commands: ``PUT``.

642 643
.. _rapi-res-groups-group_name-assign-nodes+put:

644 645 646 647 648 649 650
``PUT``
~~~~~~~

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

Body parameters:

651 652
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
653

654 655 656 657
Job result:

.. opcode_result:: OP_GROUP_ASSIGN_NODES

658
.. _rapi-res-groups-group_name-tags:
659

660 661 662 663 664 665 666
``/2/groups/[group_name]/tags``
+++++++++++++++++++++++++++++++

Manages per-nodegroup tags.

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

667 668
.. _rapi-res-groups-group_name-tags+get:

669 670 671 672 673 674 675 676 677
``GET``
~~~~~~~

Returns a list of tags.

Example::

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

678 679
.. _rapi-res-groups-group_name-tags+put:

680 681 682 683 684 685 686 687 688
``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.
689 690


691 692
.. _rapi-res-groups-group_name-tags+delete:

693 694 695 696 697 698 699 700 701 702 703 704 705
``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.


706 707
.. _rapi-res-networks:

708 709 710 711 712 713 714
``/2/networks``
+++++++++++++++

The networks resource.

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

715 716 717

.. _rapi-res-networks+get:

718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
``GET``
~~~~~~~

Returns a list of all existing networks.

Example::

    [
      {
        "name": "network1",
        "uri": "\/2\/networks\/network1"
      },
      {
        "name": "network2",
        "uri": "\/2\/networks\/network2"
      }
    ]

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

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

Example::

    [
      {
        'external_reservations': '10.0.0.0, 10.0.0.1, 10.0.0.15',
        'free_count': 13,
        'gateway': '10.0.0.1',
        'gateway6': None,
        'group_list': ['default(bridged, prv0)'],
        'inst_list': [],
        'mac_prefix': None,
        'map': 'XX.............X',
        'name': 'nat',
        'network': '10.0.0.0/28',
        'network6': None,
        'reserved_count': 3,
758 759
        'tags': ['nfdhcpd'],

760
      },
761

762 763
    ]

764 765 766

.. _rapi-res-networks+post:

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
``POST``
~~~~~~~~

Creates a network.

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:

.. opcode_params:: OP_NETWORK_ADD

Job result:

.. opcode_result:: OP_NETWORK_ADD


786 787
.. _rapi-res-networks-network_name:

788 789 790 791 792 793 794
``/2/networks/[network_name]``
++++++++++++++++++++++++++++++

Returns information about a network.

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

795 796 797

.. _rapi-res-networks-network_name+get:

798 799 800 801 802 803 804 805
``GET``
~~~~~~~

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

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

806 807 808

.. _rapi-res-networks-network_name+delete:

809 810 811 812 813 814 815 816 817 818 819 820
``DELETE``
~~~~~~~~~~

Deletes a network.

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

Job result:

.. opcode_result:: OP_NETWORK_REMOVE


821 822
.. _rapi-res-networks-network_name-modify:

823 824 825 826 827 828 829
``/2/networks/[network_name]/modify``
+++++++++++++++++++++++++++++++++++++

Modifies the parameters of a network.

Supports the following commands: ``PUT``.

830 831 832

.. _rapi-res-networks-network_name-modify+put:

833 834 835 836 837 838 839 840 841 842 843 844 845 846
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

.. opcode_params:: OP_NETWORK_SET_PARAMS

Job result:

.. opcode_result:: OP_NETWORK_SET_PARAMS


847 848
.. _rapi-res-networks-network_name-connect:

849 850 851 852 853 854 855
``/2/networks/[network_name]/connect``
++++++++++++++++++++++++++++++++++++++

Connects a network to a nodegroup.

Supports the following commands: ``PUT``.

856 857 858

.. _rapi-res-networks-network_name-connect+put:

859 860 861 862 863 864 865 866 867 868 869 870 871 872
``PUT``
~~~~~~~

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

Body parameters:

.. opcode_params:: OP_NETWORK_CONNECT

Job result:

.. opcode_result:: OP_NETWORK_CONNECT


873 874
.. _rapi-res-networks-network_name-disconnect:

875 876 877 878 879 880 881
``/2/networks/[network_name]/disconnect``
+++++++++++++++++++++++++++++++++++++++++

Disonnects a network from a nodegroup.

Supports the following commands: ``PUT``.

882 883 884

.. _rapi-res-networks-network_name-disconnect+put:

885 886 887 888 889 890 891 892 893 894 895 896 897 898
``PUT``
~~~~~~~

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

Body parameters:

.. opcode_params:: OP_NETWORK_DISCONNECT

Job result:

.. opcode_result:: OP_NETWORK_DISCONNECT


899 900
.. _rapi-res-networks-network_name-tags:

901 902 903 904 905 906 907
``/2/networks/[network_name]/tags``
+++++++++++++++++++++++++++++++++++

Manages per-network tags.

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

908 909 910

.. _rapi-res-networks-network_name-tags+get:

911 912 913 914 915 916 917 918 919
``GET``
~~~~~~~

Returns a list of tags.

Example::

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

920 921 922

.. _rapi-res-networks-network_name-tags+put:

923 924 925 926 927 928 929 930 931
``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.
932 933


934 935
.. _rapi-res-networks-network_name-tags+delete:

936 937 938 939 940 941 942 943 944 945 946 947 948
``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.


949 950
.. _rapi-res-instances-multi-alloc:

951 952 953 954 955 956 957
``/2/instances-multi-alloc``
++++++++++++++++++++++++++++

Tries to allocate multiple instances.

It supports the following commands: ``POST``

958 959 960

.. _rapi-res-instances-multi-alloc+post:

961 962 963 964 965 966 967 968 969 970 971 972
``POST``
~~~~~~~~

The parameters:

.. opcode_params:: OP_INSTANCE_MULTI_ALLOC

Job result:

.. opcode_result:: OP_INSTANCE_MULTI_ALLOC


973 974
.. _rapi-res-instances:

Iustin Pop's avatar
Iustin Pop committed
975 976
``/2/instances``
++++++++++++++++
977

Iustin Pop's avatar
Iustin Pop committed
978
The instances resource.
979

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

982 983 984

.. _rapi-res-instances+get:

Iustin Pop's avatar
Iustin Pop committed
985 986
``GET``
~~~~~~~
987

Iustin Pop's avatar
Iustin Pop committed
988
Returns a list of all available instances.
989

Iustin Pop's avatar
Iustin Pop committed
990
Example::
991 992 993 994 995 996 997 998 999 1000 1001 1002

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

1003 1004 1005
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.
1006

1007
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
1008

Iustin Pop's avatar
Iustin Pop committed
1009
Example::
1010 1011 1012

    [
      {
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
        "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,

1035
      },
1036

1037 1038 1039
    ]


1040 1041
.. _rapi-res-instances+post:

Iustin Pop's avatar
Iustin Pop committed
1042 1043
``POST``
~~~~~~~~
1044

Iustin Pop's avatar
Iustin Pop committed
1045
Creates an instance.
1046

1047 1048 1049 1050
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.
1051

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

1054 1055 1056 1057
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
1058 1059
  instance creation requests, version ``0``, but that format is no
  longer supported)
1060 1061 1062 1063 1064 1065

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

1067 1068 1069 1070
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

1071

1072 1073
.. _rapi-res-instances-instance_name:

Iustin Pop's avatar
Iustin Pop committed
1074 1075
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
1076

Iustin Pop's avatar
Iustin Pop committed
1077
Instance-specific resource.
1078

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

1081 1082 1083

.. _rapi-res-instances-instance_name+get:

Iustin Pop's avatar
Iustin Pop committed
1084 1085
``GET``
~~~~~~~
1086

Iustin Pop's avatar
Iustin Pop committed
1087 1088
Returns information about an instance, similar to the bulk output from
the instance list.
1089

1090
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
1091

1092 1093 1094

.. _rapi-res-instances-instance_name+delete:

Iustin Pop's avatar
Iustin Pop committed
1095 1096
``DELETE``
~~~~~~~~~~
1097

Iustin Pop's avatar
Iustin Pop committed
1098
Deletes an instance.
1099

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

1102 1103 1104 1105
Job result:

.. opcode_result:: OP_INSTANCE_REMOVE

1106

1107 1108
.. _rapi-res-instances-instance_name-info:

1109 1110 1111 1112 1113
``/2/instances/[instance_name]/info``
+++++++++++++++++++++++++++++++++++++++

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

1114 1115 1116

.. _rapi-res-instances-instance_name-info+get:

1117 1118 1119 1120 1121
``GET``
~~~~~~~

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

1125 1126 1127 1128
Job result:

.. opcode_result:: OP_INSTANCE_QUERY_DATA

1129

1130 1131
.. _rapi-res-instances-instance_name-reboot:

Iustin Pop's avatar
Iustin Pop committed
1132 1133
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
1134

Iustin Pop's avatar
Iustin Pop committed
1135
Reboots URI for an instance.
1136

Iustin Pop's avatar
Iustin Pop committed
1137
It supports the following commands: ``POST``.
1138

1139 1140 1141

.. _rapi-res-instances-instance_name-reboot+post:

Iustin Pop's avatar
Iustin Pop committed
1142 1143
``POST``
~~~~~~~~
1144

Iustin Pop's avatar
Iustin Pop committed
1145
Reboots the instance.
1146

1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
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.
1159

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

1162 1163 1164 1165
Job result:

.. opcode_result:: OP_INSTANCE_REBOOT

1166

1167 1168
.. _rapi-res-instances-instance_name-shutdown:

Iustin Pop's avatar
Iustin Pop committed
1169 1170
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
1171

Iustin Pop's avatar
Iustin Pop committed
1172
Instance shutdown URI.
1173

Iustin Pop's avatar
Iustin Pop committed
1174
It supports the following commands: ``PUT``.
1175

1176 1177 1178

.. _rapi-res-instances-instance_name-shutdown+put:

Iustin Pop's avatar
Iustin Pop committed
1179 1180
``PUT``
~~~~~~~
1181

Iustin Pop's avatar
Iustin Pop committed
1182
Shutdowns an instance.
1183

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

1186 1187 1188
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

1189 1190 1191 1192
Job result:

.. opcode_result:: OP_INSTANCE_SHUTDOWN

1193

1194 1195
.. _rapi-res-instances-instance_name-startup:

Iustin Pop's avatar
Iustin Pop committed
1196 1197
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
1198

Iustin Pop's avatar
Iustin Pop committed
1199
Instance startup URI.
1200

Iustin Pop's avatar
Iustin Pop committed
1201
It supports the following commands: ``PUT``.
1202

1203 1204 1205

.. _rapi-res-instances-instance_name-startup+put:

Iustin Pop's avatar
Iustin Pop committed
1206 1207
``PUT``
~~~~~~~
1208

Iustin Pop's avatar
Iustin Pop committed
1209
Startup an instance.
1210

1211 1212
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
1213

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

1216 1217 1218 1219 1220
Job result:

.. opcode_result:: OP_INSTANCE_STARTUP


1221 1222
.. _rapi-res-instances-instance_name-reinstall:

1223 1224 1225 1226 1227 1228 1229
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

1230 1231 1232

.. _rapi-res-instances-instance_name-reinstall+post:

1233 1234 1235
``POST``
~~~~~~~~

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
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.
1250

1251

1252 1253
.. _rapi-res-instances-instance_name-replace-disks:

1254 1255 1256 1257 1258 1259 1260
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

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

1261 1262 1263

.. _rapi-res-instances-instance_name-replace-disks+post:

1264 1265 1266
``POST``
~~~~~~~~

1267 1268 1269
Returns a job ID.

Body parameters:
1270

1271 1272
.. opcode_params:: OP_INSTANCE_REPLACE_DISKS
   :exclude: instance_name
1273

1274 1275
Ganeti 2.4 and below used query parameters. Those are deprecated and
should no longer be used.
1276

1277 1278 1279 1280
Job result:

.. opcode_result:: OP_INSTANCE_REPLACE_DISKS

1281

1282 1283
.. _rapi-res-instances-instance_name-activate-disks:

1284 1285 1286 1287 1288 1289 1290
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

1291 1292 1293

.. _rapi-res-instances-instance_name-activate-disks+put:

1294 1295 1296
``PUT``
~~~~~~~

1297
Takes the bool parameter ``ignore_size``. When set ignore the recorded
1298 1299
size (useful for forcing activation when recorded size is wrong).

1300 1301 1302 1303
Job result:

.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS

1304

1305 1306
.. _rapi-res-instances-instance_name-deactivate-disks:

1307 1308 1309 1310 1311 1312 1313
``/2/instances/[instance_name]/deactivate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

Deactivate disks on an instance.

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

1314 1315 1316

.. _rapi-res-instances-instance_name-deactivate-disks+put:

1317 1318 1319 1320 1321
``PUT``
~~~~~~~

Takes no parameters.

1322 1323 1324 1325
Job result:

.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS

1326

1327 1328
.. _rapi-res-instances-instance_name-recreate-disks:

1329 1330 1331 1332 1333 1334
``/2/instances/[instance_name]/recreate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

Recreate disks of an instance. Supports the following commands:
``POST``.

1335 1336 1337

.. _rapi-res-instances-instance_name-recreate-disks+post:

1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
``POST``
~~~~~~~~

Returns a job ID.

Body parameters:

.. opcode_params:: OP_INSTANCE_RECREATE_DISKS
   :exclude: instance_name

1348 1349 1350 1351
Job result:

.. opcode_result:: OP_INSTANCE_RECREATE_DISKS

1352

1353 1354
.. _rapi-res-instances-instance_name-disk-disk_index-grow:

1355 1356 1357 1358 1359 1360 1361
``/2/instances/[instance_name]/disk/[disk_index]/grow``
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

Grows one disk of an instance.

Supports the following commands: ``POST``.

1362 1363 1364

.. _rapi-res-instances-instance_name-disk-disk_index-grow+post:

1365 1366 1367 1368 1369 1370