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
244 It supports the following commands: ``GET``.
249 Shows the list of mapped resources.
251 Returns: a dictionary with 'name' and 'uri' keys for each of them.
256 The ``/2`` resource, the root of the version 2 API.
258 It supports the following commands: ``GET``.
263 Show the list of mapped resources.
265 Returns: a dictionary with ``name`` and ``uri`` keys for each of them.
270 Cluster information resource.
272 It supports the following commands: ``GET``.
277 Returns cluster information.
282 "config_version": 2000000,
284 "software_version": "2.0.0~beta2",
285 "os_api_version": 10,
287 "candidate_pool_size": 10,
288 "enabled_hypervisors": [
294 "default_hypervisor": "fake",
295 "master": "node1.example.com",
300 "protocol_version": 20,
303 "auto_balance": true,
311 ``/2/redistribute-config``
312 ++++++++++++++++++++++++++
314 Redistribute configuration to all nodes.
316 It supports the following commands: ``PUT``.
321 Redistribute configuration to all nodes. The result will be a job id.
330 Returns a list of features supported by the RAPI server. Available
335 rlib2.ALL_FEATURES == set([rlib2._INST_CREATE_REQV1,
336 rlib2._INST_REINSTALL_REQV1,
337 rlib2._NODE_MIGRATE_REQV1,
338 rlib2._NODE_EVAC_RES1])
340 :pyeval:`rlib2._INST_CREATE_REQV1`
341 Instance creation request data version 1 supported.
342 :pyeval:`rlib2._INST_REINSTALL_REQV1`
343 Instance reinstall supports body parameters.
344 :pyeval:`rlib2._NODE_MIGRATE_REQV1`
345 Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
346 request body parameters.
347 :pyeval:`rlib2._NODE_EVAC_RES1`
348 Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
349 a new-style result (see resource description)
353 ++++++++++++++++++++++++++++++++++++++++
355 Modifies cluster parameters.
357 Supports the following commands: ``PUT``.
366 .. opcode_params:: OP_CLUSTER_SET_PARAMS
374 It supports the following commands: ``GET``, ``POST``.
379 Returns a list of all existing node groups.
386 "uri": "\/2\/groups\/group1"
390 "uri": "\/2\/groups\/group2"
394 If the optional bool *bulk* argument is provided and set to a true value
395 (i.e ``?bulk=1``), the output contains detailed information about node
398 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
410 "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
418 "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
425 Creates a node group.
427 If the optional bool *dry-run* argument is provided, the job will not be
428 actually executed, only the pre-execution checks will be done.
430 Returns: a job ID that can be used later for polling.
434 .. opcode_params:: OP_GROUP_ADD
436 Earlier versions used a parameter named ``name`` which, while still
437 supported, has been renamed to ``group_name``.
440 ``/2/groups/[group_name]``
441 ++++++++++++++++++++++++++
443 Returns information about a node group.
445 It supports the following commands: ``GET``, ``DELETE``.
450 Returns information about a node group, similar to the bulk output from
453 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
458 Deletes a node group.
460 It supports the ``dry-run`` argument.
463 ``/2/groups/[group_name]/modify``
464 +++++++++++++++++++++++++++++++++
466 Modifies the parameters of a node group.
468 Supports the following commands: ``PUT``.
477 .. opcode_params:: OP_GROUP_SET_PARAMS
482 .. opcode_result:: OP_GROUP_SET_PARAMS
485 ``/2/groups/[group_name]/rename``
486 +++++++++++++++++++++++++++++++++
488 Renames a node group.
490 Supports the following commands: ``PUT``.
499 .. opcode_params:: OP_GROUP_RENAME
504 .. opcode_result:: OP_GROUP_RENAME
507 ``/2/groups/[group_name]/assign-nodes``
508 +++++++++++++++++++++++++++++++++++++++
510 Assigns nodes to a group.
512 Supports the following commands: ``PUT``.
517 Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.
521 .. opcode_params:: OP_GROUP_ASSIGN_NODES
522 :exclude: group_name, force, dry_run
525 ``/2/groups/[group_name]/tags``
526 +++++++++++++++++++++++++++++++
528 Manages per-nodegroup tags.
530 Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
535 Returns a list of tags.
539 ["tag1", "tag2", "tag3"]
546 The request as a list of strings should be ``PUT`` to this URI. The
547 result will be a job id.
549 It supports the ``dry-run`` argument.
557 In order to delete a set of tags, the DELETE request should be addressed
560 /tags?tag=[tag]&tag=[tag]
562 It supports the ``dry-run`` argument.
568 The instances resource.
570 It supports the following commands: ``GET``, ``POST``.
575 Returns a list of all available instances.
581 "name": "web.example.com",
582 "uri": "\/instances\/web.example.com"
585 "name": "mail.example.com",
586 "uri": "\/instances\/mail.example.com"
590 If the optional bool *bulk* argument is provided and set to a true value
591 (i.e ``?bulk=1``), the output contains detailed information about
594 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
605 "name": "web.example.com",
606 "tags": ["tag1", "tag2"],
614 "pnode": "node1.example.com",
615 "nic.macs": ["01:23:45:67:89:01"],
616 "snodes": ["node2.example.com"],
617 "disk_template": "drbd",
631 If the optional bool *dry-run* argument is provided, the job will not be
632 actually executed, only the pre-execution checks will be done. Query-ing
633 the job result will return, in both dry-run and normal case, the list of
634 nodes selected for the instance.
636 Returns: a job ID that can be used later for polling.
640 ``__version__`` (int, required)
641 Must be ``1`` (older Ganeti versions used a different format for
642 instance creation requests, version ``0``, but that format is no
645 .. opcode_params:: OP_INSTANCE_CREATE
647 Earlier versions used parameters named ``name`` and ``os``. These have
648 been replaced by ``instance_name`` and ``os_type`` to match the
649 underlying opcode. The old names can still be used.
653 .. opcode_result:: OP_INSTANCE_CREATE
656 ``/2/instances/[instance_name]``
657 ++++++++++++++++++++++++++++++++
659 Instance-specific resource.
661 It supports the following commands: ``GET``, ``DELETE``.
666 Returns information about an instance, similar to the bulk output from
669 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
676 It supports the ``dry-run`` argument.
679 ``/2/instances/[instance_name]/info``
680 +++++++++++++++++++++++++++++++++++++++
682 It supports the following commands: ``GET``.
687 Requests detailed information about the instance. An optional parameter,
688 ``static`` (bool), can be set to return only static information from the
689 configuration without querying the instance's nodes. The result will be
693 ``/2/instances/[instance_name]/reboot``
694 +++++++++++++++++++++++++++++++++++++++
696 Reboots URI for an instance.
698 It supports the following commands: ``POST``.
703 Reboots the instance.
705 The URI takes optional ``type=soft|hard|full`` and
706 ``ignore_secondaries=0|1`` parameters.
708 ``type`` defines the reboot type. ``soft`` is just a normal reboot,
709 without terminating the hypervisor. ``hard`` means full shutdown
710 (including terminating the hypervisor process) and startup again.
711 ``full`` is like ``hard`` but also recreates the configuration from
712 ground up as if you would have done a ``gnt-instance shutdown`` and
713 ``gnt-instance start`` on it.
715 ``ignore_secondaries`` is a bool argument indicating if we start the
716 instance even if secondary disks are failing.
718 It supports the ``dry-run`` argument.
721 ``/2/instances/[instance_name]/shutdown``
722 +++++++++++++++++++++++++++++++++++++++++
724 Instance shutdown URI.
726 It supports the following commands: ``PUT``.
731 Shutdowns an instance.
733 It supports the ``dry-run`` argument.
735 .. opcode_params:: OP_INSTANCE_SHUTDOWN
736 :exclude: instance_name, dry_run
739 ``/2/instances/[instance_name]/startup``
740 ++++++++++++++++++++++++++++++++++++++++
742 Instance startup URI.
744 It supports the following commands: ``PUT``.
751 The URI takes an optional ``force=1|0`` parameter to start the
752 instance even if secondary disks are failing.
754 It supports the ``dry-run`` argument.
756 ``/2/instances/[instance_name]/reinstall``
757 ++++++++++++++++++++++++++++++++++++++++++++++
759 Installs the operating system again.
761 It supports the following commands: ``POST``.
770 ``os`` (string, required)
771 Instance operating system.
772 ``start`` (bool, defaults to true)
773 Whether to start instance after reinstallation.
775 Dictionary with (temporary) OS parameters.
777 For backwards compatbility, this resource also takes the query
778 parameters ``os`` (OS template name) and ``nostartup`` (bool). New
779 clients should use the body parameters.
782 ``/2/instances/[instance_name]/replace-disks``
783 ++++++++++++++++++++++++++++++++++++++++++++++
785 Replaces disks on an instance.
787 It supports the following commands: ``POST``.
796 .. opcode_params:: OP_INSTANCE_REPLACE_DISKS
797 :exclude: instance_name
799 Ganeti 2.4 and below used query parameters. Those are deprecated and
800 should no longer be used.
803 ``/2/instances/[instance_name]/activate-disks``
804 +++++++++++++++++++++++++++++++++++++++++++++++
806 Activate disks on an instance.
808 It supports the following commands: ``PUT``.
813 Takes the bool parameter ``ignore_size``. When set ignore the recorded
814 size (useful for forcing activation when recorded size is wrong).
817 ``/2/instances/[instance_name]/deactivate-disks``
818 +++++++++++++++++++++++++++++++++++++++++++++++++
820 Deactivate disks on an instance.
822 It supports the following commands: ``PUT``.
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]/evacuate``
1244 +++++++++++++++++++++++++++++++++
1246 Evacuates instances off a node.
1248 It supports the following commands: ``POST``.
1253 Returns a job ID. The result of the job will contain the IDs of the
1254 individual jobs submitted to evacuate the node.
1258 .. opcode_params:: OP_NODE_EVACUATE
1261 Up to and including Ganeti 2.4 query arguments were used. Those are no
1262 longer supported. The new request can be detected by the presence of the
1263 :pyeval:`rlib2._NODE_EVAC_RES1` feature string.
1267 .. opcode_result:: OP_NODE_EVACUATE
1270 ``/2/nodes/[node_name]/migrate``
1271 +++++++++++++++++++++++++++++++++
1273 Migrates all primary instances from a node.
1275 It supports the following commands: ``POST``.
1280 If no mode is explicitly specified, each instances' hypervisor default
1281 migration mode will be used. Body parameters:
1283 .. opcode_params:: OP_NODE_MIGRATE
1286 The query arguments used up to and including Ganeti 2.4 are deprecated
1287 and should no longer be used. The new request format can be detected by
1288 the presence of the :pyeval:`rlib2._NODE_MIGRATE_REQV1` feature string.
1292 .. opcode_result:: OP_NODE_MIGRATE
1295 ``/2/nodes/[node_name]/role``
1296 +++++++++++++++++++++++++++++
1300 It supports the following commands: ``GET``, ``PUT``.
1302 The role is always one of the following:
1309 Note that the 'master' role is a special, and currently it can't be
1310 modified via RAPI, only via the command line (``gnt-cluster
1316 Returns the current node role.
1325 Change the node role.
1327 The request is a string which should be PUT to this URI. The result will
1330 It supports the bool ``force`` argument.
1333 ``/2/nodes/[node_name]/modify``
1334 +++++++++++++++++++++++++++++++
1336 Modifies the parameters of a node. Supports the following commands:
1346 .. opcode_params:: OP_NODE_SET_PARAMS
1351 .. opcode_result:: OP_NODE_SET_PARAMS
1354 ``/2/nodes/[node_name]/storage``
1355 ++++++++++++++++++++++++++++++++
1357 Manages storage units on the node.
1364 constants.VALID_STORAGE_TYPES == set([constants.ST_FILE,
1365 constants.ST_LVM_PV,
1366 constants.ST_LVM_VG])
1368 Requests a list of storage units on a node. Requires the parameters
1369 ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
1370 :pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`) and
1371 ``output_fields``. The result will be a job id, using which the result
1374 ``/2/nodes/[node_name]/storage/modify``
1375 +++++++++++++++++++++++++++++++++++++++
1377 Modifies storage units on the node.
1382 Modifies parameters of storage units on the node. Requires the
1383 parameters ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
1384 :pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`)
1385 and ``name`` (name of the storage unit). Parameters can be passed
1386 additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool)
1387 is supported. The result will be a job id.
1389 ``/2/nodes/[node_name]/storage/repair``
1390 +++++++++++++++++++++++++++++++++++++++
1392 Repairs a storage unit on the node.
1399 constants.VALID_STORAGE_OPERATIONS == {
1400 constants.ST_LVM_VG: set([constants.SO_FIX_CONSISTENCY]),
1403 Repairs a storage unit on the node. Requires the parameters
1404 ``storage_type`` (currently only :pyeval:`constants.ST_LVM_VG` can be
1405 repaired) and ``name`` (name of the storage unit). The result will be a
1408 ``/2/nodes/[node_name]/tags``
1409 +++++++++++++++++++++++++++++
1411 Manages per-node tags.
1413 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1418 Returns a list of tags.
1422 ["tag1", "tag2", "tag3"]
1429 The request as a list of strings should be PUT to this URI. The result
1432 It supports the ``dry-run`` argument.
1439 In order to delete a set of tags, the DELETE request should be addressed
1442 /tags?tag=[tag]&tag=[tag]
1444 It supports the ``dry-run`` argument.
1447 ``/2/query/[resource]``
1448 +++++++++++++++++++++++
1450 Requests resource information. Available fields can be found in man
1451 pages and using ``/2/query/[resource]/fields``. The resource is one of
1452 :pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2
1453 design document <design-query2>` for more details.
1455 Supports the following commands: ``GET``, ``PUT``.
1460 Returns list of included fields and actual data. Takes a query parameter
1461 named "fields", containing a comma-separated list of field names. Does
1462 not support filtering.
1467 Returns list of included fields and actual data. The list of requested
1468 fields can either be given as the query parameter "fields" or as a body
1469 parameter with the same name. The optional body parameter "filter" can
1470 be given and must be either ``null`` or a list containing filter
1474 ``/2/query/[resource]/fields``
1475 ++++++++++++++++++++++++++++++
1477 Request list of available fields for a resource. The resource is one of
1478 :pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the
1479 :doc:`query2 design document <design-query2>` for more details.
1481 Supports the following commands: ``GET``.
1486 Returns a list of field descriptions for available fields. Takes an
1487 optional query parameter named "fields", containing a comma-separated
1488 list of field names.
1496 It supports the following commands: ``GET``.
1501 Return a list of all OSes.
1503 Can return error 500 in case of a problem. Since this is a costly
1504 operation for Ganeti 2.0, it is not recommended to execute it too often.
1513 Manages cluster tags.
1515 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1520 Returns the cluster tags.
1524 ["tag1", "tag2", "tag3"]
1531 The request as a list of strings should be PUT to this URI. The result
1534 It supports the ``dry-run`` argument.
1542 In order to delete a set of tags, the DELETE request should be addressed
1545 /tags?tag=[tag]&tag=[tag]
1547 It supports the ``dry-run`` argument.
1553 The version resource.
1555 This resource should be used to determine the remote API version and to
1556 adapt clients accordingly.
1558 It supports the following commands: ``GET``.
1563 Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
1566 .. vim: set textwidth=72 :