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

Michele Tartara's avatar
Michele Tartara committed
94 95 96 97 98
When using the RAPI, username and password can be sent to the server
by using the standard HTTP basic access authentication. This means that
for accessing the protected URL ``https://cluster.example.com/resource``,
the address ``https://username:password@cluster.example.com/resource`` should
be used instead.
99 100
be used instead. Alternatively, the appropriate parameter of your HTTP client
(such as ``-u`` for ``curl``) can be used.
101 102

.. [#pwhash] Using the MD5 hash of username, realm and password is
103 104
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
   and 3.3. The reason for using it over another algorithm is forward
105 106 107 108 109 110
   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.


111 112 113
Protocol
--------

114
The protocol used is JSON_ over HTTP designed after the REST_ principle.
115
HTTP Basic authentication as per :rfc:`2617` is supported.
116 117 118 119

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

120 121 122 123
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).

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 151 152 153 154 155 156 157
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.


158 159 160
PUT or POST?
------------

161 162 163
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.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

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

184 185 186
Generic parameters
------------------

187 188
A few parameter mean the same thing across all resources which implement
it.
189 190 191 192

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

Iustin Pop's avatar
Iustin Pop committed
193 194 195 196 197
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.
198 199 200 201

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

202 203 204
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.
205

Iustin Pop's avatar
Iustin Pop committed
206 207 208
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.
209

210 211 212 213 214 215
``force``
+++++++++++

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

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
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::

231
  constants.IPOLICY_ALL_KEYS == set([constants.ISPECS_MINMAX,
232 233
                                     constants.ISPECS_STD,
                                     constants.IPOLICY_DTS,
234 235
                                     constants.IPOLICY_VCPU_RATIO,
                                     constants.IPOLICY_SPINDLE_RATIO])
236 237 238 239 240 241 242 243 244


.. pyassert::

  (set(constants.ISPECS_PARAMETER_TYPES.keys()) ==
   set([constants.ISPEC_MEM_SIZE,
        constants.ISPEC_DISK_SIZE,
        constants.ISPEC_DISK_COUNT,
        constants.ISPEC_CPU_COUNT,
245 246
        constants.ISPEC_NIC_COUNT,
        constants.ISPEC_SPINDLE_USE]))
247 248 249 250 251 252

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


253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
:pyeval:`constants.ISPECS_MINMAX`
  A dict with the following two fields:

  |ispec-min|, |ispec-max|
    A sub- `dict` with the following fields, which sets the limit 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
    :pyeval:`constants.ISPEC_SPINDLE_USE`
      The numbers of virtual disk spindles used by this instance. They
      are not real in the sense of actual HDD spindles, but useful for
      accounting the spindle usage on the residing node
|ispec-std|
  A sub- `dict` with the same fields as |ispec-min| and |ispec-max| above,
  which sets the standard values of the instances.
277 278 279 280
: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`)
281 282
:pyeval:`constants.IPOLICY_SPINDLE_RATIO`
  Maximum ratio of instances to their node's ``spindle_count`` (`float`)
283

284 285 286
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
287 288
You can access the API using your favorite programming language as long
as it supports network connections.
289

290 291 292 293 294
Ganeti RAPI client
++++++++++++++++++

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

295 296 297
Shell
+++++

298
.. highlight:: shell-example
Iustin Pop's avatar
Iustin Pop committed
299

Michele Tartara's avatar
Michele Tartara committed
300
Using ``wget``::
301

302
   $ wget -q -O - https://%CLUSTERNAME%:5080/2/info
303

Michele Tartara's avatar
Michele Tartara committed
304
or ``curl``::
305

306
  $ curl https://%CLUSTERNAME%:5080/2/info
307

Michele Tartara's avatar
Michele Tartara committed
308
Note: with ``curl``, the request method (GET, POST, PUT) can be specified
309 310 311 312
using the ``-X`` command line option, and the username/password can be
specified with the ``-u`` option. In case of POST requests with a body, the
Content-Type can be set to JSON (as per the Protocol_ section) using the
parameter ``-H "Content-Type: application/json"``.
313 314 315 316

Python
++++++

Iustin Pop's avatar
Iustin Pop committed
317 318 319
.. highlight:: python

::
320 321

  import urllib2
Tim Boring's avatar
Tim Boring committed
322
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
323 324 325 326 327 328
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
334 335
.. highlight:: javascript

336 337
::

Tim Boring's avatar
Tim Boring committed
338
  var url = 'https://CLUSTERNAME:5080/2/info';
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
  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
357
.. highlight:: javascript
358

Iustin Pop's avatar
Iustin Pop committed
359 360
``/``
+++++
361

362 363
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
364

365 366 367 368 369
``/2``
++++++

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

370 371
.. _rapi-res-info:

Iustin Pop's avatar
Iustin Pop committed
372 373
``/2/info``
+++++++++++
374

Iustin Pop's avatar
Iustin Pop committed
375
Cluster information resource.
376

377 378
.. rapi_resource_details:: /2/info

379

380 381
.. _rapi-res-info+get:

Iustin Pop's avatar
Iustin Pop committed
382 383
``GET``
~~~~~~~
384

Iustin Pop's avatar
Iustin Pop committed
385
Returns cluster information.
386

Iustin Pop's avatar
Iustin Pop committed
387
Example::
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414

  {
    "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
       }
415 416 417
      },

  }
418

419

420 421
.. _rapi-res-redistribute-config:

422 423 424 425 426
``/2/redistribute-config``
++++++++++++++++++++++++++

Redistribute configuration to all nodes.

427
.. rapi_resource_details:: /2/redistribute-config
428

429 430 431

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

432 433 434 435 436
``PUT``
~~~~~~~

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

437 438 439 440
Job result:

.. opcode_result:: OP_CLUSTER_REDIST_CONF

441

442 443
.. _rapi-res-features:

444 445 446
``/2/features``
+++++++++++++++

447 448
.. rapi_resource_details:: /2/features

449 450 451

.. _rapi-res-features+get:

452 453 454 455 456 457
``GET``
~~~~~~~

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

458 459 460 461 462 463 464 465
.. 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`
466
  Instance creation request data version 1 supported
467
:pyeval:`rlib2._INST_REINSTALL_REQV1`
468
  Instance reinstall supports body parameters
469 470
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
471
  request body parameters
472 473 474
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
475 476


477 478
.. _rapi-res-modify:

479 480 481 482 483
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

484
.. rapi_resource_details:: /2/modify
485

486 487 488

.. _rapi-res-modify+put:

489 490 491 492 493 494 495
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

496
.. opcode_params:: OP_CLUSTER_SET_PARAMS
497

498 499 500 501
Job result:

.. opcode_result:: OP_CLUSTER_SET_PARAMS

502

503 504
.. _rapi-res-groups:

505 506 507 508 509
``/2/groups``
+++++++++++++

The groups resource.

510 511
.. rapi_resource_details:: /2/groups

512

513 514
.. _rapi-res-groups+get:

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
``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.

537
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
538

539 540 541 542 543 544 545 546 547 548
Example::

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

551 552 553 554 555 556 557
      },
      {
        "name": "group2",
        "node_cnt": 1,
        "node_list": [
          "node3.example.com"
        ],
558 559 560 561
        "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c",

      },

562 563
    ]

564 565 566

.. _rapi-res-groups+post:

567 568 569 570 571 572 573 574 575 576 577 578
``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:

579 580 581 582
.. opcode_params:: OP_GROUP_ADD

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

584 585 586 587
Job result:

.. opcode_result:: OP_GROUP_ADD

588

589 590
.. _rapi-res-groups-group_name:

591
``/2/groups/[group_name]``
592
++++++++++++++++++++++++++
593 594 595

Returns information about a node group.

596 597
.. rapi_resource_details:: /2/groups/[group_name]

598

599 600
.. _rapi-res-groups-group_name+get:

601 602 603 604 605 606
``GET``
~~~~~~~

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

607
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
608

609 610
.. _rapi-res-groups-group_name+delete:

611 612 613 614 615 616 617
``DELETE``
~~~~~~~~~~

Deletes a node group.

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

618 619 620 621
Job result:

.. opcode_result:: OP_GROUP_REMOVE

622

623 624
.. _rapi-res-groups-group_name-modify:

625 626 627 628 629
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

630 631
.. rapi_resource_details:: /2/groups/[group_name]/modify

632

633 634
.. _rapi-res-groups-group_name-modify+put:

635 636 637 638 639 640 641
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

642 643
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
644

645 646 647 648
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

649

650 651
.. _rapi-res-groups-group_name-rename:

652 653 654 655 656
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

657 658
.. rapi_resource_details:: /2/groups/[group_name]/rename

659

660 661
.. _rapi-res-groups-group_name-rename+put:

662 663 664 665 666 667 668
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

669 670
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
671

672 673 674 675
Job result:

.. opcode_result:: OP_GROUP_RENAME

676

677 678
.. _rapi-res-groups-group_name-assign-nodes:

679 680 681 682 683
``/2/groups/[group_name]/assign-nodes``
+++++++++++++++++++++++++++++++++++++++

Assigns nodes to a group.

684
.. rapi_resource_details:: /2/groups/[group_name]/assign-nodes
685

686 687
.. _rapi-res-groups-group_name-assign-nodes+put:

688 689 690 691 692 693 694
``PUT``
~~~~~~~

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

Body parameters:

695 696
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
697

698 699 700 701
Job result:

.. opcode_result:: OP_GROUP_ASSIGN_NODES

702
.. _rapi-res-groups-group_name-tags:
703

704 705 706 707 708
``/2/groups/[group_name]/tags``
+++++++++++++++++++++++++++++++

Manages per-nodegroup tags.

709 710
.. rapi_resource_details:: /2/groups/[group_name]/tags

711

712 713
.. _rapi-res-groups-group_name-tags+get:

714 715 716 717 718 719 720 721 722
``GET``
~~~~~~~

Returns a list of tags.

Example::

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

723 724
.. _rapi-res-groups-group_name-tags+put:

725 726 727 728 729 730 731 732 733
``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.
734 735


736 737
.. _rapi-res-groups-group_name-tags+delete:

738 739 740 741 742 743 744 745 746 747 748 749 750
``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.


751 752
.. _rapi-res-networks:

753 754 755 756 757
``/2/networks``
+++++++++++++++

The networks resource.

758
.. rapi_resource_details:: /2/networks
759

760 761 762

.. _rapi-res-networks+get:

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
``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,
803 804
        'tags': ['nfdhcpd'],

805
      },
806

807 808
    ]

809 810 811

.. _rapi-res-networks+post:

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
``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


831 832
.. _rapi-res-networks-network_name:

833 834 835 836 837
``/2/networks/[network_name]``
++++++++++++++++++++++++++++++

Returns information about a network.

838
.. rapi_resource_details:: /2/networks/[network_name]
839

840 841 842

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

843 844 845 846 847 848 849 850
``GET``
~~~~~~~

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

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

851 852 853

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

854 855 856 857 858 859 860 861 862 863 864 865
``DELETE``
~~~~~~~~~~

Deletes a network.

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

Job result:

.. opcode_result:: OP_NETWORK_REMOVE


866 867
.. _rapi-res-networks-network_name-modify:

868 869 870 871 872
``/2/networks/[network_name]/modify``
+++++++++++++++++++++++++++++++++++++

Modifies the parameters of a network.

873
.. rapi_resource_details:: /2/networks/[network_name]/modify
874

875 876 877

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

878 879 880 881 882 883 884 885 886 887 888 889 890 891
``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

.. opcode_params:: OP_NETWORK_SET_PARAMS

Job result:

.. opcode_result:: OP_NETWORK_SET_PARAMS


892 893
.. _rapi-res-networks-network_name-connect:

894 895 896 897 898
``/2/networks/[network_name]/connect``
++++++++++++++++++++++++++++++++++++++

Connects a network to a nodegroup.

899
.. rapi_resource_details:: /2/networks/[network_name]/connect
900

901 902 903

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

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


918 919
.. _rapi-res-networks-network_name-disconnect:

920 921 922 923 924
``/2/networks/[network_name]/disconnect``
+++++++++++++++++++++++++++++++++++++++++

Disonnects a network from a nodegroup.

925
.. rapi_resource_details:: /2/networks/[network_name]/disconnect
926

927 928 929

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

930 931 932 933 934 935 936 937 938 939 940 941 942 943
``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


944 945
.. _rapi-res-networks-network_name-tags:

946 947 948 949 950
``/2/networks/[network_name]/tags``
+++++++++++++++++++++++++++++++++++

Manages per-network tags.

951
.. rapi_resource_details:: /2/networks/[network_name]/tags
952

953 954 955

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

956 957 958 959 960 961 962 963 964
``GET``
~~~~~~~

Returns a list of tags.

Example::

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

965 966 967

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

968 969 970 971 972 973 974 975 976
``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.
977 978


979 980
.. _rapi-res-networks-network_name-tags+delete:

981 982 983 984 985 986 987 988 989 990 991 992 993
``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.


994 995
.. _rapi-res-instances-multi-alloc:

996 997 998 999 1000
``/2/instances-multi-alloc``
++++++++++++++++++++++++++++

Tries to allocate multiple instances.

1001
.. rapi_resource_details:: /2/instances-multi-alloc
1002

1003 1004 1005

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

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
``POST``
~~~~~~~~

The parameters:

.. opcode_params:: OP_INSTANCE_MULTI_ALLOC

Job result:

.. opcode_result:: OP_INSTANCE_MULTI_ALLOC


1018 1019
.. _rapi-res-instances:

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

Iustin Pop's avatar
Iustin Pop committed
1023
The instances resource.
1024

1025
.. rapi_resource_details:: /2/instances
1026

1027 1028 1029

.. _rapi-res-instances+get:

Iustin Pop's avatar
Iustin Pop committed
1030 1031
``GET``
~~~~~~~
1032

Iustin Pop's avatar
Iustin Pop committed
1033
Returns a list of all available instances.
1034

Iustin Pop's avatar
Iustin Pop committed
1035
Example::
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047

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

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

1052
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
1053

Iustin Pop's avatar
Iustin Pop committed
1054
Example::
1055 1056 1057

    [
      {
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
        "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,

1080
      },
1081

1082 1083 1084
    ]


1085 1086
.. _rapi-res-instances+post:

Iustin Pop's avatar
Iustin Pop committed
1087 1088
``POST``
~~~~~~~~
1089

Iustin Pop's avatar
Iustin Pop committed
1090
Creates an instance.
1091

1092 1093 1094 1095
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.
1096

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

1099 1100 1101 1102
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
1103 1104
  instance creation requests, version ``0``, but that format is no
  longer supported)
1105 1106 1107 1108 1109 1110

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

1112 1113 1114 1115
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

1116

1117 1118
.. _rapi-res-instances-instance_name:

Iustin Pop's avatar
Iustin Pop committed
1119 1120
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
1121

Iustin Pop's avatar
Iustin Pop committed
1122
Instance-specific resource.
1123

1124
.. rapi_resource_details:: /2/instances/[instance_name]
1125

1126 1127 1128

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

Iustin Pop's avatar
Iustin Pop committed
1129 1130
``GET``
~~~~~~~
1131

Iustin Pop's avatar
Iustin Pop committed
1132 1133
Returns information about an instance, similar to the bulk output from
the instance list.
1134

1135
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
1136

1137 1138 1139

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

Iustin Pop's avatar
Iustin Pop committed
1140 1141
``DELETE``
~~~~~~~~~~
1142

Iustin Pop's avatar
Iustin Pop committed
1143
Deletes an instance.
1144

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

1147 1148 1149 1150
Job result:

.. opcode_result:: OP_INSTANCE_REMOVE

1151

1152 1153
.. _rapi-res-instances-instance_name-info:

1154 1155 1156
``/2/instances/[instance_name]/info``
+++++++++++++++++++++++++++++++++++++++

1157
.. rapi_resource_details:: /2/instances/[instance_name]/info
1158

1159 1160 1161

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

1162 1163 1164 1165 1166
``GET``
~~~~~~~

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

1170 1171 1172 1173
Job result:

.. opcode_result:: OP_INSTANCE_QUERY_DATA

1174

1175 1176
.. _rapi-res-instances-instance_name-reboot:

Iustin Pop's avatar
Iustin Pop committed
1177 1178
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
1179

Iustin Pop's avatar
Iustin Pop committed
1180
Reboots URI for an instance.
1181

1182
.. rapi_resource_details:: /2/instances/[instance_name]/reboot
1183

1184 1185 1186

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

Iustin Pop's avatar
Iustin Pop committed
1187 1188
``POST``
~~~~~~~~
1189

Iustin Pop's avatar
Iustin Pop committed
1190
Reboots the instance.
1191

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
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.
1204

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

1207 1208 1209 1210
Job result:

.. opcode_result:: OP_INSTANCE_REBOOT

1211

1212 1213
.. _rapi-res-instances-instance_name-shutdown:

Iustin Pop's avatar
Iustin Pop committed
1214 1215
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
1216

Iustin Pop's avatar
Iustin Pop committed
1217
Instance shutdown URI.
1218

1219
.. rapi_resource_details:: /2/instances/[instance_name]/shutdown
1220

1221 1222 1223

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

Iustin Pop's avatar
Iustin Pop committed
1224 1225
``PUT``
~~~~~~~
1226

Iustin Pop's avatar
Iustin Pop committed
1227
Shutdowns an instance.
1228

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

1231 1232 1233
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

1234 1235 1236 1237
Job result:

.. opcode_result:: OP_INSTANCE_SHUTDOWN

1238

1239 1240
.. _rapi-res-instances-instance_name-startup:

Iustin Pop's avatar
Iustin Pop committed
1241 1242
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
1243

Iustin Pop's avatar
Iustin Pop committed
1244
Instance startup URI.
1245

1246
.. rapi_resource_details:: /2/instances/[instance_name]/startup
1247

1248 1249 1250

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

Iustin Pop's avatar
Iustin Pop committed
1251 1252
``PUT``
~~~~~~~
1253

Iustin Pop's avatar
Iustin Pop committed
1254
Startup an instance.
1255

1256 1257
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
1258

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

1261 1262 1263 1264 1265
Job result:

.. opcode_result:: OP_INSTANCE_STARTUP


1266 1267
.. _rapi-res-instances-instance_name-reinstall:

1268 1269 1270 1271 1272
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

1273
.. rapi_resource_details:: /2/instances/[instance_name]/reinstall
1274

1275 1276 1277

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

1278 1279 1280
``POST``
~~~~~~~~

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
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.
1295

1296

1297 1298
.. _rapi-res-instances-instance_name-replace-disks:

1299 1300 1301 1302 1303
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

1304
.. rapi_resource_details:: /2/instances/[instance_name]/replace-disks