4 Documents Ganeti version |version|
11 Ganeti supports a remote API for enable external tools to easily
12 retrieve information about a cluster's state. The remote API daemon,
13 *ganeti-rapi*, is automatically started on the master node. By default
14 it runs on TCP port 5080, but this can be changed either in
15 ``.../constants.py`` or via the command line parameter *-p*. SSL mode,
16 which is used by default, can also be disabled by passing command line
23 ``ganeti-rapi`` reads users and passwords from a file (usually
24 ``/var/lib/ganeti/rapi/users``) on startup. Changes to the file will be
27 Each line consists of two or three fields separated by whitespace. The
28 first two fields are for username and password. The third field is
29 optional and can be used to specify per-user options. Currently,
30 ``write`` is the only option supported and enables the user to execute
31 operations modifying the cluster. Lines starting with the hash sign
32 (``#``) are treated as comments.
34 Passwords can either be written in clear text or as a hash. Clear text
35 passwords may not start with an opening brace (``{``) or they must be
36 prefixed with ``{cleartext}``. To use the hashed form, get the MD5 hash
37 of the string ``$username:Ganeti Remote API:$password`` (e.g. ``echo -n
38 'jack:Ganeti Remote API:abc123' | openssl md5``) [#pwhash]_ and prefix
39 it with ``{ha1}``. Using the scheme prefix for all passwords is
40 recommended. Scheme prefixes are not case sensitive.
44 # Give Jack and Fred read-only access
46 fred {cleartext}foo555
48 # Give write access to an imaginary instance creation script
49 autocreator xyz789 write
51 # Hashed password for Jessica
52 jessica {HA1}7046452df2cbb530877058712cf17bd4 write
55 .. [#pwhash] Using the MD5 hash of username, realm and password is
56 described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
57 and 3.3. The reason for using it over another algorithm is forward
58 compatibility. If ``ganeti-rapi`` were to implement HTTP Digest
59 authentication in the future, the same hash could be used.
60 In the current version ``ganeti-rapi``'s realm, ``Ganeti Remote
61 API``, can only be changed by modifying the source code.
67 The protocol used is JSON_ over HTTP designed after the REST_ principle.
68 HTTP Basic authentication as per :rfc:`2617` is supported.
70 .. _JSON: http://www.json.org/
71 .. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
73 HTTP requests with a body (e.g. ``PUT`` or ``POST``) require the request
74 header ``Content-type`` be set to ``application/json`` (see :rfc:`2616`
75 (HTTP/1.1), section 7.2.1).
78 A note on JSON as used by RAPI
79 ++++++++++++++++++++++++++++++
81 JSON_ as used by Ganeti RAPI does not conform to the specification in
82 :rfc:`4627`. Section 2 defines a JSON text to be either an object
83 (``{"key": "value", …}``) or an array (``[1, 2, 3, …]``). In violation
84 of this RAPI uses plain strings (``"master-candidate"``, ``"1234"``) for
85 some requests or responses. Changing this now would likely break
86 existing clients and cause a lot of trouble.
90 Unlike Python's `JSON encoder and decoder
91 <http://docs.python.org/library/json.html>`_, other programming
92 languages or libraries may only provide a strict implementation, not
93 allowing plain values. For those, responses can usually be wrapped in an
94 array whose first element is then used, e.g. the response ``"1234"``
95 becomes ``["1234"]``. This works equally well for more complex values.
100 # Insert code to get response here
101 response = "\"1234\""
103 decoded = JSON.parse("[#{response}]").first
105 Short of modifying the encoder to allow encoding to a less strict
106 format, requests will have to be formatted by hand. Newer RAPI requests
107 already use a dictionary as their input data and shouldn't cause any
114 According to :rfc:`2616` the main difference between PUT and POST is
115 that POST can create new resources but PUT can only create the resource
116 the URI was pointing to on the PUT request.
118 Unfortunately, due to historic reasons, the Ganeti RAPI library is not
119 consistent with this usage, so just use the methods as documented below
122 For more details have a look in the source code at
123 ``lib/rapi/rlib2.py``.
126 Generic parameter types
127 -----------------------
129 A few generic refered parameter types and the values they allow.
134 A boolean option will accept ``1`` or ``0`` as numbers but not
135 i.e. ``True`` or ``False``.
140 A few parameter mean the same thing across all resources which implement
146 Bulk-mode means that for the resources which usually return just a list
147 of child resources (e.g. ``/2/instances`` which returns just instance
148 names), the output will instead contain detailed data for all these
149 subresources. This is more efficient than query-ing the sub-resources
155 The boolean *dry-run* argument, if provided and set, signals to Ganeti
156 that the job should not be executed, only the pre-execution checks will
159 This is useful in trying to determine (without guarantees though, as in
160 the meantime the cluster state could have changed) if the operation is
161 likely to succeed or at least start executing.
166 Force operation to continue even if it will cause the cluster to become
167 inconsistent (e.g. because there are not enough master candidates).
172 You can access the API using your favorite programming language as long
173 as it supports network connections.
178 Ganeti includes a standalone RAPI client, ``lib/rapi/client.py``.
187 wget -q -O - https://CLUSTERNAME:5080/2/info
191 curl https://CLUSTERNAME:5080/2/info
197 .. highlight:: python
202 f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
209 .. warning:: While it's possible to use JavaScript, it poses several
210 potential problems, including browser blocking request due to
211 non-standard ports or different domain names. Fetching the data on
212 the webserver is easier.
214 .. highlight:: javascript
218 var url = 'https://CLUSTERNAME:5080/2/info';
220 var xmlreq = new XMLHttpRequest();
221 xmlreq.onreadystatechange = function () {
222 if (xmlreq.readyState != 4) return;
223 if (xmlreq.status == 200) {
224 info = eval("(" + xmlreq.responseText + ")");
227 alert('Error fetching cluster info');
231 xmlreq.open('GET', url, true);
237 .. highlight:: javascript
242 The root resource. Has no function, but for legacy reasons the ``GET``
248 Has no function, but for legacy reasons the ``GET`` method is supported.
253 Cluster information resource.
255 It supports the following commands: ``GET``.
260 Returns cluster information.
265 "config_version": 2000000,
267 "software_version": "2.0.0~beta2",
268 "os_api_version": 10,
270 "candidate_pool_size": 10,
271 "enabled_hypervisors": [
277 "default_hypervisor": "fake",
278 "master": "node1.example.com",
283 "protocol_version": 20,
286 "auto_balance": true,
294 ``/2/redistribute-config``
295 ++++++++++++++++++++++++++
297 Redistribute configuration to all nodes.
299 It supports the following commands: ``PUT``.
304 Redistribute configuration to all nodes. The result will be a job id.
313 Returns a list of features supported by the RAPI server. Available
318 rlib2.ALL_FEATURES == set([rlib2._INST_CREATE_REQV1,
319 rlib2._INST_REINSTALL_REQV1,
320 rlib2._NODE_MIGRATE_REQV1,
321 rlib2._NODE_EVAC_RES1])
323 :pyeval:`rlib2._INST_CREATE_REQV1`
324 Instance creation request data version 1 supported.
325 :pyeval:`rlib2._INST_REINSTALL_REQV1`
326 Instance reinstall supports body parameters.
327 :pyeval:`rlib2._NODE_MIGRATE_REQV1`
328 Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
329 request body parameters.
330 :pyeval:`rlib2._NODE_EVAC_RES1`
331 Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
332 a new-style result (see resource description)
336 ++++++++++++++++++++++++++++++++++++++++
338 Modifies cluster parameters.
340 Supports the following commands: ``PUT``.
349 .. opcode_params:: OP_CLUSTER_SET_PARAMS
357 It supports the following commands: ``GET``, ``POST``.
362 Returns a list of all existing node groups.
369 "uri": "\/2\/groups\/group1"
373 "uri": "\/2\/groups\/group2"
377 If the optional bool *bulk* argument is provided and set to a true value
378 (i.e ``?bulk=1``), the output contains detailed information about node
381 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
393 "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
401 "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
408 Creates a node group.
410 If the optional bool *dry-run* argument is provided, the job will not be
411 actually executed, only the pre-execution checks will be done.
413 Returns: a job ID that can be used later for polling.
417 .. opcode_params:: OP_GROUP_ADD
419 Earlier versions used a parameter named ``name`` which, while still
420 supported, has been renamed to ``group_name``.
423 ``/2/groups/[group_name]``
424 ++++++++++++++++++++++++++
426 Returns information about a node group.
428 It supports the following commands: ``GET``, ``DELETE``.
433 Returns information about a node group, similar to the bulk output from
436 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
441 Deletes a node group.
443 It supports the ``dry-run`` argument.
446 ``/2/groups/[group_name]/modify``
447 +++++++++++++++++++++++++++++++++
449 Modifies the parameters of a node group.
451 Supports the following commands: ``PUT``.
460 .. opcode_params:: OP_GROUP_SET_PARAMS
465 .. opcode_result:: OP_GROUP_SET_PARAMS
468 ``/2/groups/[group_name]/rename``
469 +++++++++++++++++++++++++++++++++
471 Renames a node group.
473 Supports the following commands: ``PUT``.
482 .. opcode_params:: OP_GROUP_RENAME
487 .. opcode_result:: OP_GROUP_RENAME
490 ``/2/groups/[group_name]/assign-nodes``
491 +++++++++++++++++++++++++++++++++++++++
493 Assigns nodes to a group.
495 Supports the following commands: ``PUT``.
500 Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.
504 .. opcode_params:: OP_GROUP_ASSIGN_NODES
505 :exclude: group_name, force, dry_run
508 ``/2/groups/[group_name]/tags``
509 +++++++++++++++++++++++++++++++
511 Manages per-nodegroup tags.
513 Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
518 Returns a list of tags.
522 ["tag1", "tag2", "tag3"]
529 The request as a list of strings should be ``PUT`` to this URI. The
530 result will be a job id.
532 It supports the ``dry-run`` argument.
540 In order to delete a set of tags, the DELETE request should be addressed
543 /tags?tag=[tag]&tag=[tag]
545 It supports the ``dry-run`` argument.
551 The instances resource.
553 It supports the following commands: ``GET``, ``POST``.
558 Returns a list of all available instances.
564 "name": "web.example.com",
565 "uri": "\/instances\/web.example.com"
568 "name": "mail.example.com",
569 "uri": "\/instances\/mail.example.com"
573 If the optional bool *bulk* argument is provided and set to a true value
574 (i.e ``?bulk=1``), the output contains detailed information about
577 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
588 "name": "web.example.com",
589 "tags": ["tag1", "tag2"],
597 "pnode": "node1.example.com",
598 "nic.macs": ["01:23:45:67:89:01"],
599 "snodes": ["node2.example.com"],
600 "disk_template": "drbd",
614 If the optional bool *dry-run* argument is provided, the job will not be
615 actually executed, only the pre-execution checks will be done. Query-ing
616 the job result will return, in both dry-run and normal case, the list of
617 nodes selected for the instance.
619 Returns: a job ID that can be used later for polling.
623 ``__version__`` (int, required)
624 Must be ``1`` (older Ganeti versions used a different format for
625 instance creation requests, version ``0``, but that format is no
628 .. opcode_params:: OP_INSTANCE_CREATE
630 Earlier versions used parameters named ``name`` and ``os``. These have
631 been replaced by ``instance_name`` and ``os_type`` to match the
632 underlying opcode. The old names can still be used.
636 .. opcode_result:: OP_INSTANCE_CREATE
639 ``/2/instances/[instance_name]``
640 ++++++++++++++++++++++++++++++++
642 Instance-specific resource.
644 It supports the following commands: ``GET``, ``DELETE``.
649 Returns information about an instance, similar to the bulk output from
652 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
659 It supports the ``dry-run`` argument.
662 ``/2/instances/[instance_name]/info``
663 +++++++++++++++++++++++++++++++++++++++
665 It supports the following commands: ``GET``.
670 Requests detailed information about the instance. An optional parameter,
671 ``static`` (bool), can be set to return only static information from the
672 configuration without querying the instance's nodes. The result will be
676 ``/2/instances/[instance_name]/reboot``
677 +++++++++++++++++++++++++++++++++++++++
679 Reboots URI for an instance.
681 It supports the following commands: ``POST``.
686 Reboots the instance.
688 The URI takes optional ``type=soft|hard|full`` and
689 ``ignore_secondaries=0|1`` parameters.
691 ``type`` defines the reboot type. ``soft`` is just a normal reboot,
692 without terminating the hypervisor. ``hard`` means full shutdown
693 (including terminating the hypervisor process) and startup again.
694 ``full`` is like ``hard`` but also recreates the configuration from
695 ground up as if you would have done a ``gnt-instance shutdown`` and
696 ``gnt-instance start`` on it.
698 ``ignore_secondaries`` is a bool argument indicating if we start the
699 instance even if secondary disks are failing.
701 It supports the ``dry-run`` argument.
704 ``/2/instances/[instance_name]/shutdown``
705 +++++++++++++++++++++++++++++++++++++++++
707 Instance shutdown URI.
709 It supports the following commands: ``PUT``.
714 Shutdowns an instance.
716 It supports the ``dry-run`` argument.
718 .. opcode_params:: OP_INSTANCE_SHUTDOWN
719 :exclude: instance_name, dry_run
722 ``/2/instances/[instance_name]/startup``
723 ++++++++++++++++++++++++++++++++++++++++
725 Instance startup URI.
727 It supports the following commands: ``PUT``.
734 The URI takes an optional ``force=1|0`` parameter to start the
735 instance even if secondary disks are failing.
737 It supports the ``dry-run`` argument.
739 ``/2/instances/[instance_name]/reinstall``
740 ++++++++++++++++++++++++++++++++++++++++++++++
742 Installs the operating system again.
744 It supports the following commands: ``POST``.
753 ``os`` (string, required)
754 Instance operating system.
755 ``start`` (bool, defaults to true)
756 Whether to start instance after reinstallation.
758 Dictionary with (temporary) OS parameters.
760 For backwards compatbility, this resource also takes the query
761 parameters ``os`` (OS template name) and ``nostartup`` (bool). New
762 clients should use the body parameters.
765 ``/2/instances/[instance_name]/replace-disks``
766 ++++++++++++++++++++++++++++++++++++++++++++++
768 Replaces disks on an instance.
770 It supports the following commands: ``POST``.
779 .. opcode_params:: OP_INSTANCE_REPLACE_DISKS
780 :exclude: instance_name
782 Ganeti 2.4 and below used query parameters. Those are deprecated and
783 should no longer be used.
786 ``/2/instances/[instance_name]/activate-disks``
787 +++++++++++++++++++++++++++++++++++++++++++++++
789 Activate disks on an instance.
791 It supports the following commands: ``PUT``.
796 Takes the bool parameter ``ignore_size``. When set ignore the recorded
797 size (useful for forcing activation when recorded size is wrong).
800 ``/2/instances/[instance_name]/deactivate-disks``
801 +++++++++++++++++++++++++++++++++++++++++++++++++
803 Deactivate disks on an instance.
805 It supports the following commands: ``PUT``.
813 ``/2/instances/[instance_name]/recreate-disks``
814 +++++++++++++++++++++++++++++++++++++++++++++++++
816 Recreate disks of an instance. Supports the following commands:
826 .. opcode_params:: OP_INSTANCE_RECREATE_DISKS
827 :exclude: instance_name
830 ``/2/instances/[instance_name]/disk/[disk_index]/grow``
831 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
833 Grows one disk of an instance.
835 Supports the following commands: ``POST``.
844 .. opcode_params:: OP_INSTANCE_GROW_DISK
845 :exclude: instance_name, disk
848 ``/2/instances/[instance_name]/prepare-export``
849 +++++++++++++++++++++++++++++++++++++++++++++++++
851 Prepares an export of an instance.
853 It supports the following commands: ``PUT``.
858 Takes one parameter, ``mode``, for the export mode. Returns a job ID.
861 ``/2/instances/[instance_name]/export``
862 +++++++++++++++++++++++++++++++++++++++++++++++++
866 It supports the following commands: ``PUT``.
875 .. opcode_params:: OP_BACKUP_EXPORT
876 :exclude: instance_name
877 :alias: target_node=destination
880 ``/2/instances/[instance_name]/migrate``
881 ++++++++++++++++++++++++++++++++++++++++
883 Migrates an instance.
885 Supports the following commands: ``PUT``.
894 .. opcode_params:: OP_INSTANCE_MIGRATE
895 :exclude: instance_name, live
898 ``/2/instances/[instance_name]/failover``
899 +++++++++++++++++++++++++++++++++++++++++
901 Does a failover of an instance.
903 Supports the following commands: ``PUT``.
912 .. opcode_params:: OP_INSTANCE_FAILOVER
913 :exclude: instance_name
916 ``/2/instances/[instance_name]/rename``
917 ++++++++++++++++++++++++++++++++++++++++
921 Supports the following commands: ``PUT``.
930 .. opcode_params:: OP_INSTANCE_RENAME
931 :exclude: instance_name
935 .. opcode_result:: OP_INSTANCE_RENAME
938 ``/2/instances/[instance_name]/modify``
939 ++++++++++++++++++++++++++++++++++++++++
941 Modifies an instance.
943 Supports the following commands: ``PUT``.
952 .. opcode_params:: OP_INSTANCE_SET_PARAMS
953 :exclude: instance_name
957 .. opcode_result:: OP_INSTANCE_SET_PARAMS
960 ``/2/instances/[instance_name]/console``
961 ++++++++++++++++++++++++++++++++++++++++
963 Request information for connecting to instance's console.
965 Supports the following commands: ``GET``.
970 Returns a dictionary containing information about the instance's
971 console. Contained keys:
975 constants.CONS_ALL == frozenset([
976 constants.CONS_MESSAGE,
979 constants.CONS_SPICE,
985 Console type, one of :pyeval:`constants.CONS_SSH`,
986 :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
987 or :pyeval:`constants.CONS_MESSAGE`.
989 Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
991 Host to connect to (:pyeval:`constants.CONS_SSH`,
992 :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
994 TCP port to connect to (:pyeval:`constants.CONS_VNC` or
995 :pyeval:`constants.CONS_SPICE` only).
997 Username to use (:pyeval:`constants.CONS_SSH` only).
999 Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
1001 VNC display number (:pyeval:`constants.CONS_VNC` only).
1004 ``/2/instances/[instance_name]/tags``
1005 +++++++++++++++++++++++++++++++++++++
1007 Manages per-instance tags.
1009 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1014 Returns a list of tags.
1018 ["tag1", "tag2", "tag3"]
1025 The request as a list of strings should be ``PUT`` to this URI. The
1026 result will be a job id.
1028 It supports the ``dry-run`` argument.
1036 In order to delete a set of tags, the DELETE request should be addressed
1039 /tags?tag=[tag]&tag=[tag]
1041 It supports the ``dry-run`` argument.
1047 The ``/2/jobs`` resource.
1049 It supports the following commands: ``GET``.
1054 Returns a dictionary of jobs.
1056 Returns: a dictionary with jobs id and uri.
1058 If the optional bool *bulk* argument is provided and set to a true value
1059 (i.e. ``?bulk=1``), the output contains detailed information about jobs
1062 Returned fields for bulk requests (unlike other bulk requests, these
1063 fields are not the same as for per-job requests):
1064 :pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`
1066 ``/2/jobs/[job_id]``
1067 ++++++++++++++++++++
1072 It supports the following commands: ``GET``, ``DELETE``.
1077 Returns a dictionary with job parameters, containing the fields
1078 :pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.
1080 The result includes:
1082 - id: job ID as a number
1083 - status: current job status as a string
1084 - ops: involved OpCodes as a list of dictionaries for each opcodes in
1086 - opstatus: OpCodes status as a list
1087 - opresult: OpCodes results as a list
1089 For a successful opcode, the ``opresult`` field corresponding to it will
1090 contain the raw result from its :term:`LogicalUnit`. In case an opcode
1091 has failed, its element in the opresult list will be a list of two
1094 - first element the error type (the Ganeti internal error name)
1095 - second element a list of either one or two elements:
1097 - the first element is the textual error description
1098 - the second element, if any, will hold an error classification
1100 The error classification is most useful for the ``OpPrereqError``
1101 error type - these errors happen before the OpCode has started
1102 executing, so it's possible to retry the OpCode without side
1103 effects. But whether it make sense to retry depends on the error
1108 errors.ECODE_ALL == set([errors.ECODE_RESOLVER, errors.ECODE_NORES,
1109 errors.ECODE_INVAL, errors.ECODE_STATE, errors.ECODE_NOENT,
1110 errors.ECODE_EXISTS, errors.ECODE_NOTUNIQUE, errors.ECODE_FAULT,
1111 errors.ECODE_ENVIRON])
1113 :pyeval:`errors.ECODE_RESOLVER`
1114 Resolver errors. This usually means that a name doesn't exist in DNS,
1115 so if it's a case of slow DNS propagation the operation can be retried
1118 :pyeval:`errors.ECODE_NORES`
1119 Not enough resources (iallocator failure, disk space, memory,
1120 etc.). If the resources on the cluster increase, the operation might
1123 :pyeval:`errors.ECODE_INVAL`
1124 Wrong arguments (at syntax level). The operation will not ever be
1125 accepted unless the arguments change.
1127 :pyeval:`errors.ECODE_STATE`
1128 Wrong entity state. For example, live migration has been requested for
1129 a down instance, or instance creation on an offline node. The
1130 operation can be retried once the resource has changed state.
1132 :pyeval:`errors.ECODE_NOENT`
1133 Entity not found. For example, information has been requested for an
1136 :pyeval:`errors.ECODE_EXISTS`
1137 Entity already exists. For example, instance creation has been
1138 requested for an already-existing instance.
1140 :pyeval:`errors.ECODE_NOTUNIQUE`
1141 Resource not unique (e.g. MAC or IP duplication).
1143 :pyeval:`errors.ECODE_FAULT`
1144 Internal cluster error. For example, a node is unreachable but not set
1145 offline, or the ganeti node daemons are not working, etc. A
1146 ``gnt-cluster verify`` should be run.
1148 :pyeval:`errors.ECODE_ENVIRON`
1149 Environment error (e.g. node disk error). A ``gnt-cluster verify``
1152 Note that in the above list, by entity we refer to a node or instance,
1153 while by a resource we refer to an instance's disk, or NIC, etc.
1159 Cancel a not-yet-started job.
1162 ``/2/jobs/[job_id]/wait``
1163 +++++++++++++++++++++++++
1168 Waits for changes on a job. Takes the following body parameters in a
1172 The job fields on which to watch for changes.
1174 ``previous_job_info``
1175 Previously received field values or None if not yet available.
1177 ``previous_log_serial``
1178 Highest log serial number received so far or None if not yet
1181 Returns None if no changes have been detected and a dict with two keys,
1182 ``job_info`` and ``log_entries`` otherwise.
1190 It supports the following commands: ``GET``.
1195 Returns a list of all nodes.
1201 "id": "node1.example.com",
1202 "uri": "\/nodes\/node1.example.com"
1205 "id": "node2.example.com",
1206 "uri": "\/nodes\/node2.example.com"
1210 If the optional bool *bulk* argument is provided and set to a true value
1211 (i.e ``?bulk=1``), the output contains detailed information about nodes
1214 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1223 "name": "www.example.com",
1234 ``/2/nodes/[node_name]``
1235 +++++++++++++++++++++++++++++++++
1237 Returns information about a node.
1239 It supports the following commands: ``GET``.
1241 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1243 ``/2/nodes/[node_name]/powercycle``
1244 +++++++++++++++++++++++++++++++++++
1246 Powercycles a node. Supports the following commands: ``POST``.
1254 ``/2/nodes/[node_name]/evacuate``
1255 +++++++++++++++++++++++++++++++++
1257 Evacuates instances off a node.
1259 It supports the following commands: ``POST``.
1264 Returns a job ID. The result of the job will contain the IDs of the
1265 individual jobs submitted to evacuate the node.
1269 .. opcode_params:: OP_NODE_EVACUATE
1272 Up to and including Ganeti 2.4 query arguments were used. Those are no
1273 longer supported. The new request can be detected by the presence of the
1274 :pyeval:`rlib2._NODE_EVAC_RES1` feature string.
1278 .. opcode_result:: OP_NODE_EVACUATE
1281 ``/2/nodes/[node_name]/migrate``
1282 +++++++++++++++++++++++++++++++++
1284 Migrates all primary instances from a node.
1286 It supports the following commands: ``POST``.
1291 If no mode is explicitly specified, each instances' hypervisor default
1292 migration mode will be used. Body parameters:
1294 .. opcode_params:: OP_NODE_MIGRATE
1297 The query arguments used up to and including Ganeti 2.4 are deprecated
1298 and should no longer be used. The new request format can be detected by
1299 the presence of the :pyeval:`rlib2._NODE_MIGRATE_REQV1` feature string.
1303 .. opcode_result:: OP_NODE_MIGRATE
1306 ``/2/nodes/[node_name]/role``
1307 +++++++++++++++++++++++++++++
1311 It supports the following commands: ``GET``, ``PUT``.
1313 The role is always one of the following:
1320 Note that the 'master' role is a special, and currently it can't be
1321 modified via RAPI, only via the command line (``gnt-cluster
1327 Returns the current node role.
1336 Change the node role.
1338 The request is a string which should be PUT to this URI. The result will
1341 It supports the bool ``force`` argument.
1344 ``/2/nodes/[node_name]/modify``
1345 +++++++++++++++++++++++++++++++
1347 Modifies the parameters of a node. Supports the following commands:
1357 .. opcode_params:: OP_NODE_SET_PARAMS
1362 .. opcode_result:: OP_NODE_SET_PARAMS
1365 ``/2/nodes/[node_name]/storage``
1366 ++++++++++++++++++++++++++++++++
1368 Manages storage units on the node.
1375 constants.VALID_STORAGE_TYPES == set([constants.ST_FILE,
1376 constants.ST_LVM_PV,
1377 constants.ST_LVM_VG])
1379 Requests a list of storage units on a node. Requires the parameters
1380 ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
1381 :pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`) and
1382 ``output_fields``. The result will be a job id, using which the result
1385 ``/2/nodes/[node_name]/storage/modify``
1386 +++++++++++++++++++++++++++++++++++++++
1388 Modifies storage units on the node.
1393 Modifies parameters of storage units on the node. Requires the
1394 parameters ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
1395 :pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`)
1396 and ``name`` (name of the storage unit). Parameters can be passed
1397 additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool)
1398 is supported. The result will be a job id.
1400 ``/2/nodes/[node_name]/storage/repair``
1401 +++++++++++++++++++++++++++++++++++++++
1403 Repairs a storage unit on the node.
1410 constants.VALID_STORAGE_OPERATIONS == {
1411 constants.ST_LVM_VG: set([constants.SO_FIX_CONSISTENCY]),
1414 Repairs a storage unit on the node. Requires the parameters
1415 ``storage_type`` (currently only :pyeval:`constants.ST_LVM_VG` can be
1416 repaired) and ``name`` (name of the storage unit). The result will be a
1419 ``/2/nodes/[node_name]/tags``
1420 +++++++++++++++++++++++++++++
1422 Manages per-node tags.
1424 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1429 Returns a list of tags.
1433 ["tag1", "tag2", "tag3"]
1440 The request as a list of strings should be PUT to this URI. The result
1443 It supports the ``dry-run`` argument.
1450 In order to delete a set of tags, the DELETE request should be addressed
1453 /tags?tag=[tag]&tag=[tag]
1455 It supports the ``dry-run`` argument.
1458 ``/2/query/[resource]``
1459 +++++++++++++++++++++++
1461 Requests resource information. Available fields can be found in man
1462 pages and using ``/2/query/[resource]/fields``. The resource is one of
1463 :pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2
1464 design document <design-query2>` for more details.
1466 Supports the following commands: ``GET``, ``PUT``.
1471 Returns list of included fields and actual data. Takes a query parameter
1472 named "fields", containing a comma-separated list of field names. Does
1473 not support filtering.
1478 Returns list of included fields and actual data. The list of requested
1479 fields can either be given as the query parameter "fields" or as a body
1480 parameter with the same name. The optional body parameter "filter" can
1481 be given and must be either ``null`` or a list containing filter
1485 ``/2/query/[resource]/fields``
1486 ++++++++++++++++++++++++++++++
1488 Request list of available fields for a resource. The resource is one of
1489 :pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the
1490 :doc:`query2 design document <design-query2>` for more details.
1492 Supports the following commands: ``GET``.
1497 Returns a list of field descriptions for available fields. Takes an
1498 optional query parameter named "fields", containing a comma-separated
1499 list of field names.
1507 It supports the following commands: ``GET``.
1512 Return a list of all OSes.
1514 Can return error 500 in case of a problem. Since this is a costly
1515 operation for Ganeti 2.0, it is not recommended to execute it too often.
1524 Manages cluster tags.
1526 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1531 Returns the cluster tags.
1535 ["tag1", "tag2", "tag3"]
1542 The request as a list of strings should be PUT to this URI. The result
1545 It supports the ``dry-run`` argument.
1553 In order to delete a set of tags, the DELETE request should be addressed
1556 /tags?tag=[tag]&tag=[tag]
1558 It supports the ``dry-run`` argument.
1564 The version resource.
1566 This resource should be used to determine the remote API version and to
1567 adapt clients accordingly.
1569 It supports the following commands: ``GET``.
1574 Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
1577 .. vim: set textwidth=72 :