Revision 682e2375
| b/doc/rapi.rst | ||
|---|---|---|
| 395 | 395 |
(i.e ``?bulk=1``), the output contains detailed information about node |
| 396 | 396 |
groups as a list. |
| 397 | 397 |
|
| 398 |
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))` |
|
| 399 |
|
|
| 398 | 400 |
Example:: |
| 399 | 401 |
|
| 400 | 402 |
[ |
| ... | ... | |
| 448 | 450 |
Returns information about a node group, similar to the bulk output from |
| 449 | 451 |
the node group list. |
| 450 | 452 |
|
| 453 |
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))` |
|
| 454 |
|
|
| 451 | 455 |
``DELETE`` |
| 452 | 456 |
~~~~~~~~~~ |
| 453 | 457 |
|
| ... | ... | |
| 579 | 583 |
(i.e ``?bulk=1``), the output contains detailed information about |
| 580 | 584 |
instances as a list. |
| 581 | 585 |
|
| 586 |
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))` |
|
| 587 |
|
|
| 582 | 588 |
Example:: |
| 583 | 589 |
|
| 584 | 590 |
[ |
| ... | ... | |
| 648 | 654 |
Returns information about an instance, similar to the bulk output from |
| 649 | 655 |
the instance list. |
| 650 | 656 |
|
| 657 |
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))` |
|
| 658 |
|
|
| 651 | 659 |
``DELETE`` |
| 652 | 660 |
~~~~~~~~~~ |
| 653 | 661 |
|
| ... | ... | |
| 943 | 951 |
Returns a dictionary containing information about the instance's |
| 944 | 952 |
console. Contained keys: |
| 945 | 953 |
|
| 954 |
.. pyassert:: |
|
| 955 |
|
|
| 956 |
constants.CONS_ALL == frozenset([ |
|
| 957 |
constants.CONS_MESSAGE, |
|
| 958 |
constants.CONS_SSH, |
|
| 959 |
constants.CONS_VNC, |
|
| 960 |
]) |
|
| 961 |
|
|
| 946 | 962 |
``instance`` |
| 947 | 963 |
Instance name. |
| 948 | 964 |
``kind`` |
| 949 |
Console type, one of ``ssh``, ``vnc`` or ``msg``. |
|
| 965 |
Console type, one of :pyeval:`constants.CONS_SSH`, |
|
| 966 |
:pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_MESSAGE`. |
|
| 950 | 967 |
``message`` |
| 951 |
Message to display (``msg`` type only).
|
|
| 968 |
Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
|
|
| 952 | 969 |
``host`` |
| 953 |
Host to connect to (``ssh`` and ``vnc`` only). |
|
| 970 |
Host to connect to (:pyeval:`constants.CONS_SSH` and |
|
| 971 |
:pyeval:`constants.CONS_VNC` only). |
|
| 954 | 972 |
``port`` |
| 955 |
TCP port to connect to (``vnc`` only).
|
|
| 973 |
TCP port to connect to (:pyeval:`constants.CONS_VNC` only).
|
|
| 956 | 974 |
``user`` |
| 957 |
Username to use (``ssh`` only).
|
|
| 975 |
Username to use (:pyeval:`constants.CONS_SSH` only).
|
|
| 958 | 976 |
``command`` |
| 959 |
Command to execute on machine (``ssh`` only)
|
|
| 977 |
Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
|
|
| 960 | 978 |
``display`` |
| 961 |
VNC display number (``vnc`` only).
|
|
| 979 |
VNC display number (:pyeval:`constants.CONS_VNC` only).
|
|
| 962 | 980 |
|
| 963 | 981 |
|
| 964 | 982 |
``/2/instances/[instance_name]/tags`` |
| ... | ... | |
| 1019 | 1037 |
(i.e. ``?bulk=1``), the output contains detailed information about jobs |
| 1020 | 1038 |
as a list. |
| 1021 | 1039 |
|
| 1040 |
Returned fields for bulk requests (unlike other bulk requests, these |
|
| 1041 |
fields are not the same as for per-job requests): |
|
| 1042 |
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))` |
|
| 1043 |
|
|
| 1022 | 1044 |
``/2/jobs/[job_id]`` |
| 1023 | 1045 |
++++++++++++++++++++ |
| 1024 | 1046 |
|
| ... | ... | |
| 1030 | 1052 |
``GET`` |
| 1031 | 1053 |
~~~~~~~ |
| 1032 | 1054 |
|
| 1033 |
Returns a job status. |
|
| 1034 |
|
|
| 1035 |
Returns: a dictionary with job parameters. |
|
| 1055 |
Returns a dictionary with job parameters, containing the fields |
|
| 1056 |
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`. |
|
| 1036 | 1057 |
|
| 1037 | 1058 |
The result includes: |
| 1038 | 1059 |
|
| ... | ... | |
| 1164 | 1185 |
} |
| 1165 | 1186 |
] |
| 1166 | 1187 |
|
| 1167 |
If the optional 'bulk' argument is provided and set to 'true' value (i.e |
|
| 1168 |
'?bulk=1'), the output contains detailed information about nodes as a |
|
| 1169 |
list. |
|
| 1188 |
If the optional bool *bulk* argument is provided and set to a true value |
|
| 1189 |
(i.e ``?bulk=1``), the output contains detailed information about nodes |
|
| 1190 |
as a list. |
|
| 1191 |
|
|
| 1192 |
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))` |
|
| 1170 | 1193 |
|
| 1171 | 1194 |
Example:: |
| 1172 | 1195 |
|
| ... | ... | |
| 1193 | 1216 |
|
| 1194 | 1217 |
It supports the following commands: ``GET``. |
| 1195 | 1218 |
|
| 1219 |
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))` |
|
| 1220 |
|
|
| 1196 | 1221 |
``/2/nodes/[node_name]/evacuate`` |
| 1197 | 1222 |
+++++++++++++++++++++++++++++++++ |
| 1198 | 1223 |
|
Also available in: Unified diff