Revision cc67d8eb
b/doc/rapi.rst | ||
---|---|---|
361 | 361 |
|
362 | 362 |
Redistribute configuration to all nodes. The result will be a job id. |
363 | 363 |
|
364 |
Job result: |
|
365 |
|
|
366 |
.. opcode_result:: OP_CLUSTER_REDIST_CONF |
|
367 |
|
|
364 | 368 |
|
365 | 369 |
``/2/features`` |
366 | 370 |
+++++++++++++++ |
... | ... | |
406 | 410 |
|
407 | 411 |
.. opcode_params:: OP_CLUSTER_SET_PARAMS |
408 | 412 |
|
413 |
Job result: |
|
414 |
|
|
415 |
.. opcode_result:: OP_CLUSTER_SET_PARAMS |
|
416 |
|
|
409 | 417 |
|
410 | 418 |
``/2/groups`` |
411 | 419 |
+++++++++++++ |
... | ... | |
477 | 485 |
Earlier versions used a parameter named ``name`` which, while still |
478 | 486 |
supported, has been renamed to ``group_name``. |
479 | 487 |
|
488 |
Job result: |
|
489 |
|
|
490 |
.. opcode_result:: OP_GROUP_ADD |
|
491 |
|
|
480 | 492 |
|
481 | 493 |
``/2/groups/[group_name]`` |
482 | 494 |
++++++++++++++++++++++++++ |
... | ... | |
500 | 512 |
|
501 | 513 |
It supports the ``dry-run`` argument. |
502 | 514 |
|
515 |
Job result: |
|
516 |
|
|
517 |
.. opcode_result:: OP_GROUP_REMOVE |
|
518 |
|
|
503 | 519 |
|
504 | 520 |
``/2/groups/[group_name]/modify`` |
505 | 521 |
+++++++++++++++++++++++++++++++++ |
... | ... | |
562 | 578 |
.. opcode_params:: OP_GROUP_ASSIGN_NODES |
563 | 579 |
:exclude: group_name, force, dry_run |
564 | 580 |
|
581 |
Job result: |
|
582 |
|
|
583 |
.. opcode_result:: OP_GROUP_ASSIGN_NODES |
|
584 |
|
|
565 | 585 |
|
566 | 586 |
``/2/groups/[group_name]/tags`` |
567 | 587 |
+++++++++++++++++++++++++++++++ |
... | ... | |
716 | 736 |
|
717 | 737 |
It supports the ``dry-run`` argument. |
718 | 738 |
|
739 |
Job result: |
|
740 |
|
|
741 |
.. opcode_result:: OP_INSTANCE_REMOVE |
|
742 |
|
|
719 | 743 |
|
720 | 744 |
``/2/instances/[instance_name]/info`` |
721 | 745 |
+++++++++++++++++++++++++++++++++++++++ |
... | ... | |
730 | 754 |
configuration without querying the instance's nodes. The result will be |
731 | 755 |
a job id. |
732 | 756 |
|
757 |
Job result: |
|
758 |
|
|
759 |
.. opcode_result:: OP_INSTANCE_QUERY_DATA |
|
760 |
|
|
733 | 761 |
|
734 | 762 |
``/2/instances/[instance_name]/reboot`` |
735 | 763 |
+++++++++++++++++++++++++++++++++++++++ |
... | ... | |
758 | 786 |
|
759 | 787 |
It supports the ``dry-run`` argument. |
760 | 788 |
|
789 |
Job result: |
|
790 |
|
|
791 |
.. opcode_result:: OP_INSTANCE_REBOOT |
|
792 |
|
|
761 | 793 |
|
762 | 794 |
``/2/instances/[instance_name]/shutdown`` |
763 | 795 |
+++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
776 | 808 |
.. opcode_params:: OP_INSTANCE_SHUTDOWN |
777 | 809 |
:exclude: instance_name, dry_run |
778 | 810 |
|
811 |
Job result: |
|
812 |
|
|
813 |
.. opcode_result:: OP_INSTANCE_SHUTDOWN |
|
814 |
|
|
779 | 815 |
|
780 | 816 |
``/2/instances/[instance_name]/startup`` |
781 | 817 |
++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
794 | 830 |
|
795 | 831 |
It supports the ``dry-run`` argument. |
796 | 832 |
|
833 |
Job result: |
|
834 |
|
|
835 |
.. opcode_result:: OP_INSTANCE_STARTUP |
|
836 |
|
|
837 |
|
|
797 | 838 |
``/2/instances/[instance_name]/reinstall`` |
798 | 839 |
++++++++++++++++++++++++++++++++++++++++++++++ |
799 | 840 |
|
... | ... | |
840 | 881 |
Ganeti 2.4 and below used query parameters. Those are deprecated and |
841 | 882 |
should no longer be used. |
842 | 883 |
|
884 |
Job result: |
|
885 |
|
|
886 |
.. opcode_result:: OP_INSTANCE_REPLACE_DISKS |
|
887 |
|
|
843 | 888 |
|
844 | 889 |
``/2/instances/[instance_name]/activate-disks`` |
845 | 890 |
+++++++++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
854 | 899 |
Takes the bool parameter ``ignore_size``. When set ignore the recorded |
855 | 900 |
size (useful for forcing activation when recorded size is wrong). |
856 | 901 |
|
902 |
Job result: |
|
903 |
|
|
904 |
.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS |
|
905 |
|
|
857 | 906 |
|
858 | 907 |
``/2/instances/[instance_name]/deactivate-disks`` |
859 | 908 |
+++++++++++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
867 | 916 |
|
868 | 917 |
Takes no parameters. |
869 | 918 |
|
919 |
Job result: |
|
920 |
|
|
921 |
.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS |
|
922 |
|
|
870 | 923 |
|
871 | 924 |
``/2/instances/[instance_name]/recreate-disks`` |
872 | 925 |
+++++++++++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
884 | 937 |
.. opcode_params:: OP_INSTANCE_RECREATE_DISKS |
885 | 938 |
:exclude: instance_name |
886 | 939 |
|
940 |
Job result: |
|
941 |
|
|
942 |
.. opcode_result:: OP_INSTANCE_RECREATE_DISKS |
|
943 |
|
|
887 | 944 |
|
888 | 945 |
``/2/instances/[instance_name]/disk/[disk_index]/grow`` |
889 | 946 |
+++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
902 | 959 |
.. opcode_params:: OP_INSTANCE_GROW_DISK |
903 | 960 |
:exclude: instance_name, disk |
904 | 961 |
|
962 |
Job result: |
|
963 |
|
|
964 |
.. opcode_result:: OP_INSTANCE_GROW_DISK |
|
965 |
|
|
905 | 966 |
|
906 | 967 |
``/2/instances/[instance_name]/prepare-export`` |
907 | 968 |
+++++++++++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
915 | 976 |
|
916 | 977 |
Takes one parameter, ``mode``, for the export mode. Returns a job ID. |
917 | 978 |
|
979 |
Job result: |
|
980 |
|
|
981 |
.. opcode_result:: OP_BACKUP_PREPARE |
|
982 |
|
|
918 | 983 |
|
919 | 984 |
``/2/instances/[instance_name]/export`` |
920 | 985 |
+++++++++++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
934 | 999 |
:exclude: instance_name |
935 | 1000 |
:alias: target_node=destination |
936 | 1001 |
|
1002 |
Job result: |
|
1003 |
|
|
1004 |
.. opcode_result:: OP_BACKUP_EXPORT |
|
1005 |
|
|
937 | 1006 |
|
938 | 1007 |
``/2/instances/[instance_name]/migrate`` |
939 | 1008 |
++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
952 | 1021 |
.. opcode_params:: OP_INSTANCE_MIGRATE |
953 | 1022 |
:exclude: instance_name, live |
954 | 1023 |
|
1024 |
Job result: |
|
1025 |
|
|
1026 |
.. opcode_result:: OP_INSTANCE_MIGRATE |
|
1027 |
|
|
955 | 1028 |
|
956 | 1029 |
``/2/instances/[instance_name]/failover`` |
957 | 1030 |
+++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
970 | 1043 |
.. opcode_params:: OP_INSTANCE_FAILOVER |
971 | 1044 |
:exclude: instance_name |
972 | 1045 |
|
1046 |
Job result: |
|
1047 |
|
|
1048 |
.. opcode_result:: OP_INSTANCE_FAILOVER |
|
1049 |
|
|
973 | 1050 |
|
974 | 1051 |
``/2/instances/[instance_name]/rename`` |
975 | 1052 |
++++++++++++++++++++++++++++++++++++++++ |
... | ... | |
1308 | 1385 |
|
1309 | 1386 |
Returns a job ID. |
1310 | 1387 |
|
1388 |
Job result: |
|
1389 |
|
|
1390 |
.. opcode_result:: OP_NODE_POWERCYCLE |
|
1391 |
|
|
1311 | 1392 |
|
1312 | 1393 |
``/2/nodes/[node_name]/evacuate`` |
1313 | 1394 |
+++++++++++++++++++++++++++++++++ |
... | ... | |
1398 | 1479 |
|
1399 | 1480 |
It supports the bool ``force`` argument. |
1400 | 1481 |
|
1482 |
Job result: |
|
1483 |
|
|
1484 |
.. opcode_result:: OP_NODE_SET_PARAMS |
|
1485 |
|
|
1401 | 1486 |
|
1402 | 1487 |
``/2/nodes/[node_name]/modify`` |
1403 | 1488 |
+++++++++++++++++++++++++++++++ |
... | ... | |
1455 | 1540 |
additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool) |
1456 | 1541 |
is supported. The result will be a job id. |
1457 | 1542 |
|
1543 |
Job result: |
|
1544 |
|
|
1545 |
.. opcode_result:: OP_NODE_MODIFY_STORAGE |
|
1546 |
|
|
1547 |
|
|
1458 | 1548 |
``/2/nodes/[node_name]/storage/repair`` |
1459 | 1549 |
+++++++++++++++++++++++++++++++++++++++ |
1460 | 1550 |
|
... | ... | |
1474 | 1564 |
repaired) and ``name`` (name of the storage unit). The result will be a |
1475 | 1565 |
job id. |
1476 | 1566 |
|
1567 |
Job result: |
|
1568 |
|
|
1569 |
.. opcode_result:: OP_REPAIR_NODE_STORAGE |
|
1570 |
|
|
1571 |
|
|
1477 | 1572 |
``/2/nodes/[node_name]/tags`` |
1478 | 1573 |
+++++++++++++++++++++++++++++ |
1479 | 1574 |
|
Also available in: Unified diff