rapi.rst 49 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
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
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
spaces).

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
'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 case insensitive.

Options control a user's access permissions. The section
:ref:`rapi-access-permissions` lists the permissions required for each
resource. If the ``--require-authentication`` command line option is
given to the ``ganeti-rapi`` daemon, all requests require
authentication. Available options:
47 48 49 50 51 52 53 54

.. pyassert::

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

55 56 57 58 59 60 61 62
.. pyassert::

  rlib2.R_2_nodes_name_storage.GET_ACCESS == [rapi.RAPI_ACCESS_WRITE]

.. pyassert::

  rlib2.R_2_jobs_id_wait.GET_ACCESS == [rapi.RAPI_ACCESS_WRITE]

63 64
:pyeval:`rapi.RAPI_ACCESS_WRITE`
  Enables the user to execute operations modifying the cluster. Implies
65 66 67 68 69 70 71
  :pyeval:`rapi.RAPI_ACCESS_READ` access. Resources blocking other
  operations for read-only access, such as
  :ref:`/2/nodes/[node_name]/storage <rapi-res-nodes-node_name-storage+get>`
  or blocking server-side processes, such as
  :ref:`/2/jobs/[job_id]/wait <rapi-res-jobs-job_id-wait+get>`, use
  :pyeval:`rapi.RAPI_ACCESS_WRITE` to control access to their
  :pyeval:`http.HTTP_GET` method.
72 73
:pyeval:`rapi.RAPI_ACCESS_READ`
  Allow access to operations querying for information.
74 75 76 77 78 79 80 81 82 83 84 85 86

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

87
  # Monitoring can query for values
88
  monitoring {HA1}ec018ffe72b8e75bb4d508ed5b6d079c read
89

90 91 92
  # A user who can read and write (the former is implied by granting
  # write access)
  superuser {HA1}ec018ffe72b8e75bb4d508ed5b6d079c read,write
93

94 95

.. [#pwhash] Using the MD5 hash of username, realm and password is
96 97
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
   and 3.3. The reason for using it over another algorithm is forward
98 99 100 101 102 103
   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.


104 105 106
Protocol
--------

107
The protocol used is JSON_ over HTTP designed after the REST_ principle.
108
HTTP Basic authentication as per :rfc:`2617` is supported.
109 110 111 112

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

113 114 115 116
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).

117

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
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.


151 152 153
PUT or POST?
------------

154 155 156
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.
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

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

177 178 179
Generic parameters
------------------

180 181
A few parameter mean the same thing across all resources which implement
it.
182 183 184 185

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

Iustin Pop's avatar
Iustin Pop committed
186 187 188 189 190
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.
191 192 193 194

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

195 196 197
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.
198

Iustin Pop's avatar
Iustin Pop committed
199 200 201
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.
202

203 204 205 206 207 208
``force``
+++++++++++

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

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
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,
228 229
                                     constants.IPOLICY_VCPU_RATIO,
                                     constants.IPOLICY_SPINDLE_RATIO])
230 231 232 233 234 235 236 237 238


.. pyassert::

  (set(constants.ISPECS_PARAMETER_TYPES.keys()) ==
   set([constants.ISPEC_MEM_SIZE,
        constants.ISPEC_DISK_SIZE,
        constants.ISPEC_DISK_COUNT,
        constants.ISPEC_CPU_COUNT,
239 240
        constants.ISPEC_NIC_COUNT,
        constants.ISPEC_SPINDLE_USE]))
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260

.. |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
261 262
  :pyeval:`constants.ISPEC_SPINDLE_USE`
    The numbers of virtual disk spindles used by this instance. They are
263 264
    not real in the sense of actual HDD spindles, but useful for
    accounting the spindle usage on the residing node
265 266 267 268
: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`)
269 270
:pyeval:`constants.IPOLICY_SPINDLE_RATIO`
  Maximum ratio of instances to their node's ``spindle_count`` (`float`)
271

272 273 274
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
275 276
You can access the API using your favorite programming language as long
as it supports network connections.
277

278 279 280 281 282
Ganeti RAPI client
++++++++++++++++++

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

283 284 285
Shell
+++++

286
.. highlight:: shell-example
Iustin Pop's avatar
Iustin Pop committed
287

288 289
Using wget::

290
   $ wget -q -O - https://%CLUSTERNAME%:5080/2/info
291 292 293

or curl::

294
  $ curl https://%CLUSTERNAME%:5080/2/info
295 296 297 298 299


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
300 301 302
.. highlight:: python

::
303 304

  import urllib2
Tim Boring's avatar
Tim Boring committed
305
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
306 307 308 309 310 311
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
317 318
.. highlight:: javascript

319 320
::

Tim Boring's avatar
Tim Boring committed
321
  var url = 'https://CLUSTERNAME:5080/2/info';
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
  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
340
.. highlight:: javascript
341

Iustin Pop's avatar
Iustin Pop committed
342 343
``/``
+++++
344

345 346
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
347

348 349 350 351 352
``/2``
++++++

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

353 354
.. _rapi-res-info:

Iustin Pop's avatar
Iustin Pop committed
355 356
``/2/info``
+++++++++++
357

Iustin Pop's avatar
Iustin Pop committed
358
Cluster information resource.
359

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

362 363
.. _rapi-res-info+get:

Iustin Pop's avatar
Iustin Pop committed
364 365
``GET``
~~~~~~~
366

Iustin Pop's avatar
Iustin Pop committed
367
Returns cluster information.
368

Iustin Pop's avatar
Iustin Pop committed
369
Example::
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

  {
    "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
       }
397 398 399
      },

  }
400

401

402 403
.. _rapi-res-redistribute-config:

404 405 406 407 408 409 410
``/2/redistribute-config``
++++++++++++++++++++++++++

Redistribute configuration to all nodes.

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

411 412 413

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

414 415 416 417 418
``PUT``
~~~~~~~

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

419 420 421 422
Job result:

.. opcode_result:: OP_CLUSTER_REDIST_CONF

423

424 425
.. _rapi-res-features:

426 427 428
``/2/features``
+++++++++++++++

429 430 431

.. _rapi-res-features+get:

432 433 434 435 436 437
``GET``
~~~~~~~

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

438 439 440 441 442 443 444 445
.. 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`
446
  Instance creation request data version 1 supported
447
:pyeval:`rlib2._INST_REINSTALL_REQV1`
448
  Instance reinstall supports body parameters
449 450
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
451
  request body parameters
452 453 454
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
455 456


457 458
.. _rapi-res-modify:

459 460 461 462 463 464 465
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

466 467 468

.. _rapi-res-modify+put:

469 470 471 472 473 474 475
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

476
.. opcode_params:: OP_CLUSTER_SET_PARAMS
477

478 479 480 481
Job result:

.. opcode_result:: OP_CLUSTER_SET_PARAMS

482

483 484
.. _rapi-res-groups:

485 486 487 488 489
``/2/groups``
+++++++++++++

The groups resource.

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

492 493
.. _rapi-res-groups+get:

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
``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.

516
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
517

518 519 520 521 522 523 524 525 526 527
Example::

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

530 531 532 533 534 535 536
      },
      {
        "name": "group2",
        "node_cnt": 1,
        "node_list": [
          "node3.example.com"
        ],
537 538 539 540
        "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c",

      },

541 542
    ]

543 544 545

.. _rapi-res-groups+post:

546 547 548 549 550 551 552 553 554 555 556 557
``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:

558 559 560 561
.. opcode_params:: OP_GROUP_ADD

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

563 564 565 566
Job result:

.. opcode_result:: OP_GROUP_ADD

567

568 569
.. _rapi-res-groups-group_name:

570
``/2/groups/[group_name]``
571
++++++++++++++++++++++++++
572 573 574

Returns information about a node group.

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

577 578
.. _rapi-res-groups-group_name+get:

579 580 581 582 583 584
``GET``
~~~~~~~

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

585
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
586

587 588
.. _rapi-res-groups-group_name+delete:

589 590 591 592 593 594 595
``DELETE``
~~~~~~~~~~

Deletes a node group.

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

596 597 598 599
Job result:

.. opcode_result:: OP_GROUP_REMOVE

600

601 602
.. _rapi-res-groups-group_name-modify:

603 604 605 606 607 608 609
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

610 611
.. _rapi-res-groups-group_name-modify+put:

612 613 614 615 616 617 618
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

619 620
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
621

622 623 624 625
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

626

627 628
.. _rapi-res-groups-group_name-rename:

629 630 631 632 633 634 635
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

Supports the following commands: ``PUT``.

636 637
.. _rapi-res-groups-group_name-rename+put:

638 639 640 641 642 643 644
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

645 646
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
647

648 649 650 651
Job result:

.. opcode_result:: OP_GROUP_RENAME

652

653 654
.. _rapi-res-groups-group_name-assign-nodes:

655 656 657 658 659 660 661
``/2/groups/[group_name]/assign-nodes``
+++++++++++++++++++++++++++++++++++++++

Assigns nodes to a group.

Supports the following commands: ``PUT``.

662 663
.. _rapi-res-groups-group_name-assign-nodes+put:

664 665 666 667 668 669 670
``PUT``
~~~~~~~

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

Body parameters:

671 672
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
673

674 675 676 677
Job result:

.. opcode_result:: OP_GROUP_ASSIGN_NODES

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

680 681 682 683 684 685 686
``/2/groups/[group_name]/tags``
+++++++++++++++++++++++++++++++

Manages per-nodegroup tags.

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

687 688
.. _rapi-res-groups-group_name-tags+get:

689 690 691 692 693 694 695 696 697
``GET``
~~~~~~~

Returns a list of tags.

Example::

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

698 699
.. _rapi-res-groups-group_name-tags+put:

700 701 702 703 704 705 706 707 708
``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.
709 710


711 712
.. _rapi-res-groups-group_name-tags+delete:

713 714 715 716 717 718 719 720 721 722 723 724 725
``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.


726 727
.. _rapi-res-networks:

728 729 730 731 732 733 734
``/2/networks``
+++++++++++++++

The networks resource.

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

735 736 737

.. _rapi-res-networks+get:

738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
``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,
778 779
        'tags': ['nfdhcpd'],

780
      },
781

782 783
    ]

784 785 786

.. _rapi-res-networks+post:

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
``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


806 807
.. _rapi-res-networks-network_name:

808 809 810 811 812 813 814
``/2/networks/[network_name]``
++++++++++++++++++++++++++++++

Returns information about a network.

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

815 816 817

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

818 819 820 821 822 823 824 825
``GET``
~~~~~~~

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

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

826 827 828

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

829 830 831 832 833 834 835 836 837 838 839 840
``DELETE``
~~~~~~~~~~

Deletes a network.

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

Job result:

.. opcode_result:: OP_NETWORK_REMOVE


841 842
.. _rapi-res-networks-network_name-modify:

843 844 845 846 847 848 849
``/2/networks/[network_name]/modify``
+++++++++++++++++++++++++++++++++++++

Modifies the parameters of a network.

Supports the following commands: ``PUT``.

850 851 852

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

853 854 855 856 857 858 859 860 861 862 863 864 865 866
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

.. opcode_params:: OP_NETWORK_SET_PARAMS

Job result:

.. opcode_result:: OP_NETWORK_SET_PARAMS


867 868
.. _rapi-res-networks-network_name-connect:

869 870 871 872 873 874 875
``/2/networks/[network_name]/connect``
++++++++++++++++++++++++++++++++++++++

Connects a network to a nodegroup.

Supports the following commands: ``PUT``.

876 877 878

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

879 880 881 882 883 884 885 886 887 888 889 890 891 892
``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


893 894
.. _rapi-res-networks-network_name-disconnect:

895 896 897 898 899 900 901
``/2/networks/[network_name]/disconnect``
+++++++++++++++++++++++++++++++++++++++++

Disonnects a network from a nodegroup.

Supports the following commands: ``PUT``.

902 903 904

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

905 906 907 908 909 910 911 912 913 914 915 916 917 918
``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


919 920
.. _rapi-res-networks-network_name-tags:

921 922 923 924 925 926 927
``/2/networks/[network_name]/tags``
+++++++++++++++++++++++++++++++++++

Manages per-network tags.

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

928 929 930

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

931 932 933 934 935 936 937 938 939
``GET``
~~~~~~~

Returns a list of tags.

Example::

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

940 941 942

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

943 944 945 946 947 948 949 950 951
``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.
952 953


954 955
.. _rapi-res-networks-network_name-tags+delete:

956 957 958 959 960 961 962 963 964 965 966 967 968
``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.


969 970
.. _rapi-res-instances-multi-alloc:

971 972 973 974 975 976 977
``/2/instances-multi-alloc``
++++++++++++++++++++++++++++

Tries to allocate multiple instances.

It supports the following commands: ``POST``

978 979 980

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

981 982 983 984 985 986 987 988 989 990 991 992
``POST``
~~~~~~~~

The parameters:

.. opcode_params:: OP_INSTANCE_MULTI_ALLOC

Job result:

.. opcode_result:: OP_INSTANCE_MULTI_ALLOC


993 994
.. _rapi-res-instances:

Iustin Pop's avatar
Iustin Pop committed
995 996
``/2/instances``
++++++++++++++++
997

Iustin Pop's avatar
Iustin Pop committed
998
The instances resource.
999

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

1002 1003 1004

.. _rapi-res-instances+get:

Iustin Pop's avatar
Iustin Pop committed
1005 1006
``GET``
~~~~~~~
1007

Iustin Pop's avatar
Iustin Pop committed
1008
Returns a list of all available instances.
1009

Iustin Pop's avatar
Iustin Pop committed
1010
Example::
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022

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

1023 1024 1025
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.
1026

1027
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
1028

Iustin Pop's avatar
Iustin Pop committed
1029
Example::
1030 1031 1032

    [
      {
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
        "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,

1055
      },
1056

1057 1058 1059
    ]


1060 1061
.. _rapi-res-instances+post:

Iustin Pop's avatar
Iustin Pop committed
1062 1063
``POST``
~~~~~~~~
1064

Iustin Pop's avatar
Iustin Pop committed
1065
Creates an instance.
1066

1067 1068 1069 1070
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.
1071

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

1074 1075 1076 1077
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
1078 1079
  instance creation requests, version ``0``, but that format is no
  longer supported)
1080 1081 1082 1083 1084 1085

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

1087 1088 1089 1090
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

1091

1092 1093
.. _rapi-res-instances-instance_name:

Iustin Pop's avatar
Iustin Pop committed
1094 1095
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
1096

Iustin Pop's avatar
Iustin Pop committed
1097
Instance-specific resource.
1098

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

1101 1102 1103

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

Iustin Pop's avatar
Iustin Pop committed
1104 1105
``GET``
~~~~~~~
1106

Iustin Pop's avatar
Iustin Pop committed
1107 1108
Returns information about an instance, similar to the bulk output from
the instance list.
1109

1110
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
1111

1112 1113 1114

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

Iustin Pop's avatar
Iustin Pop committed
1115 1116
``DELETE``
~~~~~~~~~~
1117

Iustin Pop's avatar
Iustin Pop committed
1118
Deletes an instance.
1119

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

1122 1123 1124 1125
Job result:

.. opcode_result:: OP_INSTANCE_REMOVE

1126

1127 1128
.. _rapi-res-instances-instance_name-info:

1129 1130 1131 1132 1133
``/2/instances/[instance_name]/info``
+++++++++++++++++++++++++++++++++++++++

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

1134 1135 1136

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

1137 1138 1139 1140 1141
``GET``
~~~~~~~

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

1145 1146 1147 1148
Job result:

.. opcode_result:: OP_INSTANCE_QUERY_DATA

1149

1150 1151
.. _rapi-res-instances-instance_name-reboot:

Iustin Pop's avatar
Iustin Pop committed
1152 1153
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
1154

Iustin Pop's avatar
Iustin Pop committed
1155
Reboots URI for an instance.
1156

Iustin Pop's avatar
Iustin Pop committed
1157
It supports the following commands: ``POST``.
1158

1159 1160 1161

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

Iustin Pop's avatar
Iustin Pop committed
1162 1163
``POST``
~~~~~~~~
1164

Iustin Pop's avatar
Iustin Pop committed
1165
Reboots the instance.
1166

1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
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.
1179

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

1182 1183 1184 1185
Job result:

.. opcode_result:: OP_INSTANCE_REBOOT

1186

1187 1188
.. _rapi-res-instances-instance_name-shutdown:

Iustin Pop's avatar
Iustin Pop committed
1189 1190
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
1191

Iustin Pop's avatar
Iustin Pop committed
1192
Instance shutdown URI.
1193

Iustin Pop's avatar
Iustin Pop committed
1194
It supports the following commands: ``PUT``.
1195

1196 1197 1198

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

Iustin Pop's avatar
Iustin Pop committed
1199 1200
``PUT``
~~~~~~~
1201

Iustin Pop's avatar
Iustin Pop committed
1202
Shutdowns an instance.
1203

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

1206 1207 1208
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

1209 1210 1211 1212
Job result:

.. opcode_result:: OP_INSTANCE_SHUTDOWN

1213

1214 1215
.. _rapi-res-instances-instance_name-startup:

Iustin Pop's avatar
Iustin Pop committed
1216 1217
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
1218

Iustin Pop's avatar
Iustin Pop committed
1219
Instance startup URI.
1220

Iustin Pop's avatar
Iustin Pop committed
1221
It supports the following commands: ``PUT``.
1222

1223 1224 1225

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

Iustin Pop's avatar
Iustin Pop committed
1226 1227
``PUT``
~~~~~~~
1228

Iustin Pop's avatar
Iustin Pop committed
1229
Startup an instance.
1230

1231 1232
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
1233

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

1236 1237 1238 1239 1240
Job result:

.. opcode_result:: OP_INSTANCE_STARTUP


1241 1242
.. _rapi-res-instances-instance_name-reinstall:

1243 1244 1245 1246 1247 1248 1249
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

1250 1251 1252

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

1253 1254 1255
``POST``
~~~~~~~~

1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
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.
1270

1271

1272 1273
.. _rapi-res-instances-instance_name-replace-disks:

1274 1275 1276 1277 1278 1279 1280
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

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

1281 1282 1283

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

1284 1285 1286
``POST``
~~~~~~~~

1287 1288 1289
Returns a job ID.

Body parameters:
1290

1291 1292
.. opcode_params:: OP_INSTANCE_REPLACE_DISKS
   :exclude: instance_name
1293

1294 1295
Ganeti 2.4 and below used query parameters. Those are deprecated and
should no longer be used.
1296

1297 1298 1299 1300
Job result:

.. opcode_result:: OP_INSTANCE_REPLACE_DISKS

1301

1302 1303
.. _rapi-res-instances-instance_name-activate-disks:

1304 1305 1306 1307 1308 1309 1310
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

1311 1312 1313

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

1314 1315 1316
``PUT``
~~~~~~~

1317
Takes the bool parameter ``ignore_size``. When set ignore the recorded
1318 1319
size (useful for forcing activation when recorded size is wrong).

1320 1321 1322 1323
Job result:

.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS

1324

1325 1326
.. _rapi-res-instances-instance_name-deactivate-disks:

1327 1328 1329 1330 1331 1332 1333
``/2/instances/[instance_name]/deactivate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

Deactivate disks on an instance.

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

1334 1335 1336

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

1337 1338 1339 1340 1341
``PUT``
~~~~~~~

Takes no parameters.

1342 1343 1344 1345
Job result:

.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS

1346

1347 1348
.. _rapi-res-instances-instance_name-recreate-disks:

1349 1350 1351 1352 1353 1354
``/2/instances/[instance_name]/recreate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

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

1355 1356 1357

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

1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
``POST``
~~~~~~~~

Returns a job ID.

Body parameters:

.. opcode_params:: OP_INSTANCE_RECREATE_DISKS
   :exclude: instance_name

1368 1369 1370 1371
Job result:

.. opcode_result:: OP_INSTANCE_RECREATE_DISKS