Revision 180fdc32 doc/rapi.rst

b/doc/rapi.rst
330 330

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

  
333
.. _rapi-res-info:
334

  
333 335
``/2/info``
334 336
+++++++++++
335 337

  
......
337 339

  
338 340
It supports the following commands: ``GET``.
339 341

  
342
.. _rapi-res-info+get:
343

  
340 344
``GET``
341 345
~~~~~~~
342 346

  
......
375 379
  }
376 380

  
377 381

  
382
.. _rapi-res-redistribute-config:
383

  
378 384
``/2/redistribute-config``
379 385
++++++++++++++++++++++++++
380 386

  
......
382 388

  
383 389
It supports the following commands: ``PUT``.
384 390

  
391

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

  
385 394
``PUT``
386 395
~~~~~~~
387 396

  
......
392 401
.. opcode_result:: OP_CLUSTER_REDIST_CONF
393 402

  
394 403

  
404
.. _rapi-res-features:
405

  
395 406
``/2/features``
396 407
+++++++++++++++
397 408

  
409

  
410
.. _rapi-res-features+get:
411

  
398 412
``GET``
399 413
~~~~~~~
400 414

  
......
420 434
  a new-style result (see resource description)
421 435

  
422 436

  
437
.. _rapi-res-modify:
438

  
423 439
``/2/modify``
424 440
++++++++++++++++++++++++++++++++++++++++
425 441

  
......
427 443

  
428 444
Supports the following commands: ``PUT``.
429 445

  
446

  
447
.. _rapi-res-modify+put:
448

  
430 449
``PUT``
431 450
~~~~~~~
432 451

  
......
441 460
.. opcode_result:: OP_CLUSTER_SET_PARAMS
442 461

  
443 462

  
463
.. _rapi-res-groups:
464

  
444 465
``/2/groups``
445 466
+++++++++++++
446 467

  
......
448 469

  
449 470
It supports the following commands: ``GET``, ``POST``.
450 471

  
472
.. _rapi-res-groups+get:
473

  
451 474
``GET``
452 475
~~~~~~~
453 476

  
......
497 520
498 521
    ]
499 522

  
523

  
524
.. _rapi-res-groups+post:
525

  
500 526
``POST``
501 527
~~~~~~~~
502 528

  
......
519 545
.. opcode_result:: OP_GROUP_ADD
520 546

  
521 547

  
548
.. _rapi-res-groups-group_name:
549

  
522 550
``/2/groups/[group_name]``
523 551
++++++++++++++++++++++++++
524 552

  
......
526 554

  
527 555
It supports the following commands: ``GET``, ``DELETE``.
528 556

  
557
.. _rapi-res-groups-group_name+get:
558

  
529 559
``GET``
530 560
~~~~~~~
531 561

  
......
534 564

  
535 565
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
536 566

  
567
.. _rapi-res-groups-group_name+delete:
568

  
537 569
``DELETE``
538 570
~~~~~~~~~~
539 571

  
......
546 578
.. opcode_result:: OP_GROUP_REMOVE
547 579

  
548 580

  
581
.. _rapi-res-groups-group_name-modify:
582

  
549 583
``/2/groups/[group_name]/modify``
550 584
+++++++++++++++++++++++++++++++++
551 585

  
......
553 587

  
554 588
Supports the following commands: ``PUT``.
555 589

  
590
.. _rapi-res-groups-group_name-modify+put:
591

  
556 592
``PUT``
557 593
~~~~~~~
558 594

  
......
568 604
.. opcode_result:: OP_GROUP_SET_PARAMS
569 605

  
570 606

  
607
.. _rapi-res-groups-group_name-rename:
608

  
571 609
``/2/groups/[group_name]/rename``
572 610
+++++++++++++++++++++++++++++++++
573 611

  
......
575 613

  
576 614
Supports the following commands: ``PUT``.
577 615

  
616
.. _rapi-res-groups-group_name-rename+put:
617

  
578 618
``PUT``
579 619
~~~~~~~
580 620

  
......
590 630
.. opcode_result:: OP_GROUP_RENAME
591 631

  
592 632

  
633
.. _rapi-res-groups-group_name-assign-nodes:
634

  
593 635
``/2/groups/[group_name]/assign-nodes``
594 636
+++++++++++++++++++++++++++++++++++++++
595 637

  
......
597 639

  
598 640
Supports the following commands: ``PUT``.
599 641

  
642
.. _rapi-res-groups-group_name-assign-nodes+put:
643

  
600 644
``PUT``
601 645
~~~~~~~
602 646

  
......
611 655

  
612 656
.. opcode_result:: OP_GROUP_ASSIGN_NODES
613 657

  
658
.. _rapi-res-groups-group_name-tags:
614 659

  
615 660
``/2/groups/[group_name]/tags``
616 661
+++++++++++++++++++++++++++++++
......
619 664

  
620 665
Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
621 666

  
667
.. _rapi-res-groups-group_name-tags+get:
668

  
622 669
``GET``
623 670
~~~~~~~
624 671

  
......
628 675

  
629 676
    ["tag1", "tag2", "tag3"]
630 677

  
678
.. _rapi-res-groups-group_name-tags+put:
679

  
631 680
``PUT``
632 681
~~~~~~~
633 682

  
......
639 688
It supports the ``dry-run`` argument.
640 689

  
641 690

  
691
.. _rapi-res-groups-group_name-tags+delete:
692

  
642 693
``DELETE``
643 694
~~~~~~~~~~
644 695

  
......
652 703
It supports the ``dry-run`` argument.
653 704

  
654 705

  
706
.. _rapi-res-networks:
707

  
655 708
``/2/networks``
656 709
+++++++++++++++
657 710

  
......
659 712

  
660 713
It supports the following commands: ``GET``, ``POST``.
661 714

  
715

  
716
.. _rapi-res-networks+get:
717

  
662 718
``GET``
663 719
~~~~~~~
664 720

  
......
705 761
706 762
    ]
707 763

  
764

  
765
.. _rapi-res-networks+post:
766

  
708 767
``POST``
709 768
~~~~~~~~
710 769

  
......
724 783
.. opcode_result:: OP_NETWORK_ADD
725 784

  
726 785

  
786
.. _rapi-res-networks-network_name:
787

  
727 788
``/2/networks/[network_name]``
728 789
++++++++++++++++++++++++++++++
729 790

  
......
731 792

  
732 793
It supports the following commands: ``GET``, ``DELETE``.
733 794

  
795

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

  
734 798
``GET``
735 799
~~~~~~~
736 800

  
......
739 803

  
740 804
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.NET_FIELDS))`.
741 805

  
806

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

  
742 809
``DELETE``
743 810
~~~~~~~~~~
744 811

  
......
751 818
.. opcode_result:: OP_NETWORK_REMOVE
752 819

  
753 820

  
821
.. _rapi-res-networks-network_name-modify:
822

  
754 823
``/2/networks/[network_name]/modify``
755 824
+++++++++++++++++++++++++++++++++++++
756 825

  
......
758 827

  
759 828
Supports the following commands: ``PUT``.
760 829

  
830

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

  
761 833
``PUT``
762 834
~~~~~~~
763 835

  
......
772 844
.. opcode_result:: OP_NETWORK_SET_PARAMS
773 845

  
774 846

  
847
.. _rapi-res-networks-network_name-connect:
848

  
775 849
``/2/networks/[network_name]/connect``
776 850
++++++++++++++++++++++++++++++++++++++
777 851

  
......
779 853

  
780 854
Supports the following commands: ``PUT``.
781 855

  
856

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

  
782 859
``PUT``
783 860
~~~~~~~
784 861

  
......
793 870
.. opcode_result:: OP_NETWORK_CONNECT
794 871

  
795 872

  
873
.. _rapi-res-networks-network_name-disconnect:
874

  
796 875
``/2/networks/[network_name]/disconnect``
797 876
+++++++++++++++++++++++++++++++++++++++++
798 877

  
......
800 879

  
801 880
Supports the following commands: ``PUT``.
802 881

  
882

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

  
803 885
``PUT``
804 886
~~~~~~~
805 887

  
......
814 896
.. opcode_result:: OP_NETWORK_DISCONNECT
815 897

  
816 898

  
899
.. _rapi-res-networks-network_name-tags:
900

  
817 901
``/2/networks/[network_name]/tags``
818 902
+++++++++++++++++++++++++++++++++++
819 903

  
......
821 905

  
822 906
Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
823 907

  
908

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

  
824 911
``GET``
825 912
~~~~~~~
826 913

  
......
830 917

  
831 918
    ["tag1", "tag2", "tag3"]
832 919

  
920

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

  
833 923
``PUT``
834 924
~~~~~~~
835 925

  
......
841 931
It supports the ``dry-run`` argument.
842 932

  
843 933

  
934
.. _rapi-res-networks-network_name-tags+delete:
935

  
844 936
``DELETE``
845 937
~~~~~~~~~~
846 938

  
......
854 946
It supports the ``dry-run`` argument.
855 947

  
856 948

  
949
.. _rapi-res-instances-multi-alloc:
950

  
857 951
``/2/instances-multi-alloc``
858 952
++++++++++++++++++++++++++++
859 953

  
......
861 955

  
862 956
It supports the following commands: ``POST``
863 957

  
958

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

  
864 961
``POST``
865 962
~~~~~~~~
866 963

  
......
873 970
.. opcode_result:: OP_INSTANCE_MULTI_ALLOC
874 971

  
875 972

  
973
.. _rapi-res-instances:
974

  
876 975
``/2/instances``
877 976
++++++++++++++++
878 977

  
......
880 979

  
881 980
It supports the following commands: ``GET``, ``POST``.
882 981

  
982

  
983
.. _rapi-res-instances+get:
984

  
883 985
``GET``
884 986
~~~~~~~
885 987

  
......
935 1037
    ]
936 1038

  
937 1039

  
1040
.. _rapi-res-instances+post:
1041

  
938 1042
``POST``
939 1043
~~~~~~~~
940 1044

  
......
965 1069
.. opcode_result:: OP_INSTANCE_CREATE
966 1070

  
967 1071

  
1072
.. _rapi-res-instances-instance_name:
1073

  
968 1074
``/2/instances/[instance_name]``
969 1075
++++++++++++++++++++++++++++++++
970 1076

  
......
972 1078

  
973 1079
It supports the following commands: ``GET``, ``DELETE``.
974 1080

  
1081

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

  
975 1084
``GET``
976 1085
~~~~~~~
977 1086

  
......
980 1089

  
981 1090
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
982 1091

  
1092

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

  
983 1095
``DELETE``
984 1096
~~~~~~~~~~
985 1097

  
......
992 1104
.. opcode_result:: OP_INSTANCE_REMOVE
993 1105

  
994 1106

  
1107
.. _rapi-res-instances-instance_name-info:
1108

  
995 1109
``/2/instances/[instance_name]/info``
996 1110
+++++++++++++++++++++++++++++++++++++++
997 1111

  
998 1112
It supports the following commands: ``GET``.
999 1113

  
1114

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

  
1000 1117
``GET``
1001 1118
~~~~~~~
1002 1119

  
......
1010 1127
.. opcode_result:: OP_INSTANCE_QUERY_DATA
1011 1128

  
1012 1129

  
1130
.. _rapi-res-instances-instance_name-reboot:
1131

  
1013 1132
``/2/instances/[instance_name]/reboot``
1014 1133
+++++++++++++++++++++++++++++++++++++++
1015 1134

  
......
1017 1136

  
1018 1137
It supports the following commands: ``POST``.
1019 1138

  
1139

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

  
1020 1142
``POST``
1021 1143
~~~~~~~~
1022 1144

  
......
1042 1164
.. opcode_result:: OP_INSTANCE_REBOOT
1043 1165

  
1044 1166

  
1167
.. _rapi-res-instances-instance_name-shutdown:
1168

  
1045 1169
``/2/instances/[instance_name]/shutdown``
1046 1170
+++++++++++++++++++++++++++++++++++++++++
1047 1171

  
......
1049 1173

  
1050 1174
It supports the following commands: ``PUT``.
1051 1175

  
1176

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

  
1052 1179
``PUT``
1053 1180
~~~~~~~
1054 1181

  
......
1064 1191
.. opcode_result:: OP_INSTANCE_SHUTDOWN
1065 1192

  
1066 1193

  
1194
.. _rapi-res-instances-instance_name-startup:
1195

  
1067 1196
``/2/instances/[instance_name]/startup``
1068 1197
++++++++++++++++++++++++++++++++++++++++
1069 1198

  
......
1071 1200

  
1072 1201
It supports the following commands: ``PUT``.
1073 1202

  
1203

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

  
1074 1206
``PUT``
1075 1207
~~~~~~~
1076 1208

  
......
1086 1218
.. opcode_result:: OP_INSTANCE_STARTUP
1087 1219

  
1088 1220

  
1221
.. _rapi-res-instances-instance_name-reinstall:
1222

  
1089 1223
``/2/instances/[instance_name]/reinstall``
1090 1224
++++++++++++++++++++++++++++++++++++++++++++++
1091 1225

  
......
1093 1227

  
1094 1228
It supports the following commands: ``POST``.
1095 1229

  
1230

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

  
1096 1233
``POST``
1097 1234
~~~~~~~~
1098 1235

  
......
1112 1249
clients should use the body parameters.
1113 1250

  
1114 1251

  
1252
.. _rapi-res-instances-instance_name-replace-disks:
1253

  
1115 1254
``/2/instances/[instance_name]/replace-disks``
1116 1255
++++++++++++++++++++++++++++++++++++++++++++++
1117 1256

  
......
1119 1258

  
1120 1259
It supports the following commands: ``POST``.
1121 1260

  
1261

  
1262
.. _rapi-res-instances-instance_name-replace-disks+post:
1263

  
1122 1264
``POST``
1123 1265
~~~~~~~~
1124 1266

  
......
1137 1279
.. opcode_result:: OP_INSTANCE_REPLACE_DISKS
1138 1280

  
1139 1281

  
1282
.. _rapi-res-instances-instance_name-activate-disks:
1283

  
1140 1284
``/2/instances/[instance_name]/activate-disks``
1141 1285
+++++++++++++++++++++++++++++++++++++++++++++++
1142 1286

  
......
1144 1288

  
1145 1289
It supports the following commands: ``PUT``.
1146 1290

  
1291

  
1292
.. _rapi-res-instances-instance_name-activate-disks+put:
1293

  
1147 1294
``PUT``
1148 1295
~~~~~~~
1149 1296

  
......
1155 1302
.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS
1156 1303

  
1157 1304

  
1305
.. _rapi-res-instances-instance_name-deactivate-disks:
1306

  
1158 1307
``/2/instances/[instance_name]/deactivate-disks``
1159 1308
+++++++++++++++++++++++++++++++++++++++++++++++++
1160 1309

  
......
1162 1311

  
1163 1312
It supports the following commands: ``PUT``.
1164 1313

  
1314

  
1315
.. _rapi-res-instances-instance_name-deactivate-disks+put:
1316

  
1165 1317
``PUT``
1166 1318
~~~~~~~
1167 1319

  
......
1172 1324
.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS
1173 1325

  
1174 1326

  
1327
.. _rapi-res-instances-instance_name-recreate-disks:
1328

  
1175 1329
``/2/instances/[instance_name]/recreate-disks``
1176 1330
+++++++++++++++++++++++++++++++++++++++++++++++++
1177 1331

  
1178 1332
Recreate disks of an instance. Supports the following commands:
1179 1333
``POST``.
1180 1334

  
1335

  
1336
.. _rapi-res-instances-instance_name-recreate-disks+post:
1337

  
1181 1338
``POST``
1182 1339
~~~~~~~~
1183 1340

  
......
1193 1350
.. opcode_result:: OP_INSTANCE_RECREATE_DISKS
1194 1351

  
1195 1352

  
1353
.. _rapi-res-instances-instance_name-disk-disk_index-grow:
1354

  
1196 1355
``/2/instances/[instance_name]/disk/[disk_index]/grow``
1197 1356
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
1198 1357

  
......
1200 1359

  
1201 1360
Supports the following commands: ``POST``.
1202 1361

  
1362

  
1363
.. _rapi-res-instances-instance_name-disk-disk_index-grow+post:
1364

  
1203 1365
``POST``
1204 1366
~~~~~~~~
1205 1367

  
......
1215 1377
.. opcode_result:: OP_INSTANCE_GROW_DISK
1216 1378

  
1217 1379

  
1380
.. _rapi-res-instances-instance_name-prepare-export:
1381

  
1218 1382
``/2/instances/[instance_name]/prepare-export``
1219 1383
+++++++++++++++++++++++++++++++++++++++++++++++++
1220 1384

  
......
1222 1386

  
1223 1387
It supports the following commands: ``PUT``.
1224 1388

  
1389

  
1390
.. _rapi-res-instances-instance_name-prepare-export+put:
1391

  
1225 1392
``PUT``
1226 1393
~~~~~~~
1227 1394

  
......
1232 1399
.. opcode_result:: OP_BACKUP_PREPARE
1233 1400

  
1234 1401

  
1402
.. _rapi-res-instances-instance_name-export:
1403

  
1235 1404
``/2/instances/[instance_name]/export``
1236 1405
+++++++++++++++++++++++++++++++++++++++++++++++++
1237 1406

  
......
1239 1408

  
1240 1409
It supports the following commands: ``PUT``.
1241 1410

  
1411

  
1412
.. _rapi-res-instances-instance_name-export+put:
1413

  
1242 1414
``PUT``
1243 1415
~~~~~~~
1244 1416

  
......
1255 1427
.. opcode_result:: OP_BACKUP_EXPORT
1256 1428

  
1257 1429

  
1430
.. _rapi-res-instances-instance_name-migrate:
1431

  
1258 1432
``/2/instances/[instance_name]/migrate``
1259 1433
++++++++++++++++++++++++++++++++++++++++
1260 1434

  
......
1262 1436

  
1263 1437
Supports the following commands: ``PUT``.
1264 1438

  
1439

  
1440
.. _rapi-res-instances-instance_name-migrate+put:
1441

  
1265 1442
``PUT``
1266 1443
~~~~~~~
1267 1444

  
......
1277 1454
.. opcode_result:: OP_INSTANCE_MIGRATE
1278 1455

  
1279 1456

  
1457
.. _rapi-res-instances-instance_name-failover:
1458

  
1280 1459
``/2/instances/[instance_name]/failover``
1281 1460
+++++++++++++++++++++++++++++++++++++++++
1282 1461

  
......
1284 1463

  
1285 1464
Supports the following commands: ``PUT``.
1286 1465

  
1466

  
1467
.. _rapi-res-instances-instance_name-failover+put:
1468

  
1287 1469
``PUT``
1288 1470
~~~~~~~
1289 1471

  
......
1299 1481
.. opcode_result:: OP_INSTANCE_FAILOVER
1300 1482

  
1301 1483

  
1484
.. _rapi-res-instances-instance_name-rename:
1485

  
1302 1486
``/2/instances/[instance_name]/rename``
1303 1487
++++++++++++++++++++++++++++++++++++++++
1304 1488

  
......
1306 1490

  
1307 1491
Supports the following commands: ``PUT``.
1308 1492

  
1493

  
1494
.. _rapi-res-instances-instance_name-rename+put:
1495

  
1309 1496
``PUT``
1310 1497
~~~~~~~
1311 1498

  
......
1321 1508
.. opcode_result:: OP_INSTANCE_RENAME
1322 1509

  
1323 1510

  
1511
.. _rapi-res-instances-instance_name-modify:
1512

  
1324 1513
``/2/instances/[instance_name]/modify``
1325 1514
++++++++++++++++++++++++++++++++++++++++
1326 1515

  
......
1328 1517

  
1329 1518
Supports the following commands: ``PUT``.
1330 1519

  
1520

  
1521
.. _rapi-res-instances-instance_name-modify+put:
1522

  
1331 1523
``PUT``
1332 1524
~~~~~~~
1333 1525

  
......
1343 1535
.. opcode_result:: OP_INSTANCE_SET_PARAMS
1344 1536

  
1345 1537

  
1538
.. _rapi-res-instances-instance_name-console:
1539

  
1346 1540
``/2/instances/[instance_name]/console``
1347 1541
++++++++++++++++++++++++++++++++++++++++
1348 1542

  
......
1358 1552
one of the following options:
1359 1553
:pyeval:`utils.CommaJoin(rlib2.R_2_instances_name_console.GET_ACCESS)`.
1360 1554

  
1555

  
1556
.. _rapi-res-instances-instance_name-console+get:
1557

  
1361 1558
``GET``
1362 1559
~~~~~~~
1363 1560

  
......
1409 1606
  VNC display number (:pyeval:`constants.CONS_VNC` only)
1410 1607

  
1411 1608

  
1609
.. _rapi-res-instances-instance_name-tags:
1610

  
1412 1611
``/2/instances/[instance_name]/tags``
1413 1612
+++++++++++++++++++++++++++++++++++++
1414 1613

  
......
1416 1615

  
1417 1616
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1418 1617

  
1618

  
1619
.. _rapi-res-instances-instance_name-tags+get:
1620

  
1419 1621
``GET``
1420 1622
~~~~~~~
1421 1623

  
......
1425 1627

  
1426 1628
    ["tag1", "tag2", "tag3"]
1427 1629

  
1630

  
1631
.. _rapi-res-instances-instance_name-tags+put:
1632

  
1428 1633
``PUT``
1429 1634
~~~~~~~
1430 1635

  
......
1436 1641
It supports the ``dry-run`` argument.
1437 1642

  
1438 1643

  
1644
.. _rapi-res-instances-instance_name-tags+delete:
1645

  
1439 1646
``DELETE``
1440 1647
~~~~~~~~~~
1441 1648

  
......
1449 1656
It supports the ``dry-run`` argument.
1450 1657

  
1451 1658

  
1659
.. _rapi-res-jobs:
1660

  
1452 1661
``/2/jobs``
1453 1662
+++++++++++
1454 1663

  
......
1456 1665

  
1457 1666
It supports the following commands: ``GET``.
1458 1667

  
1668

  
1669
.. _rapi-res-jobs+get:
1670

  
1459 1671
``GET``
1460 1672
~~~~~~~
1461 1673

  
......
1471 1683
fields are not the same as for per-job requests):
1472 1684
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`.
1473 1685

  
1686

  
1687
.. _rapi-res-jobs-job_id:
1688

  
1474 1689
``/2/jobs/[job_id]``
1475 1690
++++++++++++++++++++
1476 1691

  
......
1479 1694

  
1480 1695
It supports the following commands: ``GET``, ``DELETE``.
1481 1696

  
1697

  
1698
.. _rapi-res-jobs-job_id+get:
1699

  
1482 1700
``GET``
1483 1701
~~~~~~~
1484 1702

  
......
1565 1783
while by a resource we refer to an instance's disk, or NIC, etc.
1566 1784

  
1567 1785

  
1786
.. _rapi-res-jobs-job_id+delete:
1787

  
1568 1788
``DELETE``
1569 1789
~~~~~~~~~~
1570 1790

  
1571 1791
Cancel a not-yet-started job.
1572 1792

  
1573 1793

  
1794
.. _rapi-res-jobs-job_id-wait:
1795

  
1574 1796
``/2/jobs/[job_id]/wait``
1575 1797
+++++++++++++++++++++++++
1576 1798

  
1799

  
1800
.. _rapi-res-jobs-job_id-wait+get:
1801

  
1577 1802
``GET``
1578 1803
~~~~~~~
1579 1804

  
......
1594 1819
``job_info`` and ``log_entries`` otherwise.
1595 1820

  
1596 1821

  
1822
.. _rapi-res-nodes:
1823

  
1597 1824
``/2/nodes``
1598 1825
++++++++++++
1599 1826

  
......
1601 1828

  
1602 1829
It supports the following commands: ``GET``.
1603 1830

  
1831

  
1832
.. _rapi-res-nodes+get:
1833

  
1604 1834
``GET``
1605 1835
~~~~~~~
1606 1836

  
......
1644 1874
1645 1875
    ]
1646 1876

  
1877

  
1878
.. _rapi-res-nodes-node_name:
1879

  
1647 1880
``/2/nodes/[node_name]``
1648 1881
+++++++++++++++++++++++++++++++++
1649 1882

  
......
1651 1884

  
1652 1885
It supports the following commands: ``GET``.
1653 1886

  
1887

  
1888
.. _rapi-res-nodes-node_name+get:
1889

  
1890
``GET``
1891
~~~~~~~
1892

  
1654 1893
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`.
1655 1894

  
1895

  
1896

  
1897
.. _rapi-res-nodes-node_name-powercycle:
1898

  
1656 1899
``/2/nodes/[node_name]/powercycle``
1657 1900
+++++++++++++++++++++++++++++++++++
1658 1901

  
1659 1902
Powercycles a node. Supports the following commands: ``POST``.
1660 1903

  
1904

  
1905
.. _rapi-res-nodes-node_name-powercycle+post:
1906

  
1661 1907
``POST``
1662 1908
~~~~~~~~
1663 1909

  
......
1668 1914
.. opcode_result:: OP_NODE_POWERCYCLE
1669 1915

  
1670 1916

  
1917
.. _rapi-res-nodes-node_name-evacuate:
1918

  
1671 1919
``/2/nodes/[node_name]/evacuate``
1672 1920
+++++++++++++++++++++++++++++++++
1673 1921

  
......
1675 1923

  
1676 1924
It supports the following commands: ``POST``.
1677 1925

  
1926

  
1927
.. _rapi-res-nodes-node_name-evacuate+post:
1928

  
1678 1929
``POST``
1679 1930
~~~~~~~~
1680 1931

  
......
1695 1946
.. opcode_result:: OP_NODE_EVACUATE
1696 1947

  
1697 1948

  
1949
.. _rapi-res-nodes-node_name-migrate:
1950

  
1698 1951
``/2/nodes/[node_name]/migrate``
1699 1952
+++++++++++++++++++++++++++++++++
1700 1953

  
......
1702 1955

  
1703 1956
It supports the following commands: ``POST``.
1704 1957

  
1958
.. _rapi-res-nodes-node_name-migrate+post:
1959

  
1705 1960
``POST``
1706 1961
~~~~~~~~
1707 1962

  
......
1720 1975
.. opcode_result:: OP_NODE_MIGRATE
1721 1976

  
1722 1977

  
1978
.. _rapi-res-nodes-node_name-role:
1979

  
1723 1980
``/2/nodes/[node_name]/role``
1724 1981
+++++++++++++++++++++++++++++
1725 1982

  
......
1738 1995
modified via RAPI, only via the command line (``gnt-cluster
1739 1996
master-failover``).
1740 1997

  
1998

  
1999
.. _rapi-res-nodes-node_name-role+get:
2000

  
1741 2001
``GET``
1742 2002
~~~~~~~
1743 2003

  
......
1747 2007

  
1748 2008
    "master-candidate"
1749 2009

  
2010

  
2011
.. _rapi-res-nodes-node_name-role+put:
2012

  
1750 2013
``PUT``
1751 2014
~~~~~~~
1752 2015

  
......
1762 2025
.. opcode_result:: OP_NODE_SET_PARAMS
1763 2026

  
1764 2027

  
2028
.. _rapi-res-nodes-node_name-modify:
2029

  
1765 2030
``/2/nodes/[node_name]/modify``
1766 2031
+++++++++++++++++++++++++++++++
1767 2032

  
1768 2033
Modifies the parameters of a node. Supports the following commands:
1769 2034
``POST``.
1770 2035

  
2036

  
2037
.. _rapi-res-nodes-node_name-modify+post:
2038

  
1771 2039
``POST``
1772 2040
~~~~~~~~
1773 2041

  
......
1783 2051
.. opcode_result:: OP_NODE_SET_PARAMS
1784 2052

  
1785 2053

  
2054
.. _rapi-res-nodes-node_name-storage:
2055

  
1786 2056
``/2/nodes/[node_name]/storage``
1787 2057
++++++++++++++++++++++++++++++++
1788 2058

  
1789 2059
Manages storage units on the node.
1790 2060

  
2061
.. _rapi-res-nodes-node_name-storage+get:
2062

  
1791 2063
``GET``
1792 2064
~~~~~~~
1793 2065

  
......
1803 2075
``output_fields``. The result will be a job id, using which the result
1804 2076
can be retrieved.
1805 2077

  
2078

  
2079
.. _rapi-res-nodes-node_name-storage-modify:
2080

  
1806 2081
``/2/nodes/[node_name]/storage/modify``
1807 2082
+++++++++++++++++++++++++++++++++++++++
1808 2083

  
1809 2084
Modifies storage units on the node.
1810 2085

  
2086

  
2087
.. _rapi-res-nodes-node_name-storage-modify+put:
2088

  
1811 2089
``PUT``
1812 2090
~~~~~~~
1813 2091

  
......
1823 2101
.. opcode_result:: OP_NODE_MODIFY_STORAGE
1824 2102

  
1825 2103

  
2104
.. _rapi-res-nodes-node_name-storage-repair:
2105

  
1826 2106
``/2/nodes/[node_name]/storage/repair``
1827 2107
+++++++++++++++++++++++++++++++++++++++
1828 2108

  
1829 2109
Repairs a storage unit on the node.
1830 2110

  
2111

  
2112
.. _rapi-res-nodes-node_name-storage-repair+put:
2113

  
1831 2114
``PUT``
1832 2115
~~~~~~~
1833 2116

  
......
1847 2130
.. opcode_result:: OP_REPAIR_NODE_STORAGE
1848 2131

  
1849 2132

  
2133
.. _rapi-res-nodes-node_name-tags:
2134

  
1850 2135
``/2/nodes/[node_name]/tags``
1851 2136
+++++++++++++++++++++++++++++
1852 2137

  
......
1854 2139

  
1855 2140
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1856 2141

  
2142

  
2143
.. _rapi-res-nodes-node_name-tags+get:
2144

  
1857 2145
``GET``
1858 2146
~~~~~~~
1859 2147

  
......
1863 2151

  
1864 2152
    ["tag1", "tag2", "tag3"]
1865 2153

  
2154

  
2155
.. _rapi-res-nodes-node_name-tags+put:
2156

  
1866 2157
``PUT``
1867 2158
~~~~~~~
1868 2159

  
......
1873 2164

  
1874 2165
It supports the ``dry-run`` argument.
1875 2166

  
2167

  
2168
.. _rapi-res-nodes-node_name-tags+delete:
2169

  
1876 2170
``DELETE``
1877 2171
~~~~~~~~~~
1878 2172

  
......
1886 2180
It supports the ``dry-run`` argument.
1887 2181

  
1888 2182

  
2183
.. _rapi-res-query-resource:
2184

  
1889 2185
``/2/query/[resource]``
1890 2186
+++++++++++++++++++++++
1891 2187

  
......
1904 2200
authentication with one of the following options:
1905 2201
:pyeval:`utils.CommaJoin(rlib2.R_2_query.GET_ACCESS)`.
1906 2202

  
2203

  
2204
.. _rapi-res-query-resource+get:
2205

  
1907 2206
``GET``
1908 2207
~~~~~~~
1909 2208

  
......
1911 2210
named "fields", containing a comma-separated list of field names. Does
1912 2211
not support filtering.
1913 2212

  
2213

  
2214
.. _rapi-res-query-resource+put:
2215

  
1914 2216
``PUT``
1915 2217
~~~~~~~
1916 2218

  
......
1921 2223
operators.
1922 2224

  
1923 2225

  
2226
.. _rapi-res-query-resource-fields:
2227

  
1924 2228
``/2/query/[resource]/fields``
1925 2229
++++++++++++++++++++++++++++++
1926 2230

  
......
1930 2234

  
1931 2235
Supports the following commands: ``GET``.
1932 2236

  
2237

  
2238
.. _rapi-res-query-resource-fields+get:
2239

  
1933 2240
``GET``
1934 2241
~~~~~~~
1935 2242

  
......
1938 2245
list of field names.
1939 2246

  
1940 2247

  
2248
.. _rapi-res-os:
2249

  
1941 2250
``/2/os``
1942 2251
+++++++++
1943 2252

  
......
1945 2254

  
1946 2255
It supports the following commands: ``GET``.
1947 2256

  
2257

  
2258
.. _rapi-res-os+get:
2259

  
1948 2260
``GET``
1949 2261
~~~~~~~
1950 2262

  
......
1957 2269

  
1958 2270
    ["debian-etch"]
1959 2271

  
2272

  
2273
.. _rapi-res-tags:
2274

  
1960 2275
``/2/tags``
1961 2276
+++++++++++
1962 2277

  
......
1964 2279

  
1965 2280
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1966 2281

  
2282

  
2283
.. _rapi-res-tags+get:
2284

  
1967 2285
``GET``
1968 2286
~~~~~~~
1969 2287

  
......
1973 2291

  
1974 2292
    ["tag1", "tag2", "tag3"]
1975 2293

  
2294

  
2295
.. _rapi-res-tags+put:
2296

  
1976 2297
``PUT``
1977 2298
~~~~~~~
1978 2299

  
......
1984 2305
It supports the ``dry-run`` argument.
1985 2306

  
1986 2307

  
2308
.. _rapi-res-tags+delete:
2309

  
1987 2310
``DELETE``
1988 2311
~~~~~~~~~~
1989 2312

  
......
1997 2320
It supports the ``dry-run`` argument.
1998 2321

  
1999 2322

  
2323
.. _rapi-res-version:
2324

  
2000 2325
``/version``
2001 2326
++++++++++++
2002 2327

  
......
2007 2332

  
2008 2333
It supports the following commands: ``GET``.
2009 2334

  
2335
.. _rapi-res-version+get:
2336

  
2010 2337
``GET``
2011 2338
~~~~~~~
2012 2339

  

Also available in: Unified diff