/usr/lib/python3/dist-packages/profitbricks/client.py is in python3-profitbricks 4.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 | # Copyright 2015-2017 ProfitBricks GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import base64
import getpass
import json
import logging
import os
import re
import time
import requests
import six
try:
import configparser
except ImportError:
import ConfigParser as configparser
from six.moves.urllib.parse import urlencode
try:
import keyring
HAS_KEYRING = True
except ImportError:
HAS_KEYRING = False
from profitbricks import (
API_HOST, __version__
)
from profitbricks.errors import (
PBNotAuthorizedError,
PBNotFoundError,
PBValidationError,
PBRateLimitExceededError,
PBError,
PBFailedRequest,
PBTimeoutError,
)
from .utils import ask, find_item_by_name
_LIBRARY_NAME = "profitbricks-sdk-python"
# ProfitBricks Object Classes
class ProfitBricksService(object):
"""
ProfitBricksClient Base Class
"""
def __init__(self, username=None, password=None, host_base=API_HOST,
host_cert=None, ssl_verify=True, headers=None, client_user_agent=None,
use_config=True, use_keyring=HAS_KEYRING, config_filename=None):
if headers is None:
headers = dict()
self._config = None
self._config_filename = None
self.username = self._get_username(username, use_config, config_filename)
self.password = self._get_password(password, use_config, config_filename, use_keyring)
self.host_base = host_base
self.host_cert = host_cert
self.verify = ssl_verify
self.headers = headers
self.user_agent = '{}/{}'.format(_LIBRARY_NAME, __version__)
if client_user_agent:
self.user_agent = client_user_agent + ' ' + self.user_agent
def _read_config(self, filename=None):
"""
Read the user configuration
"""
if filename:
self._config_filename = filename
else:
try:
import appdirs
except ImportError:
raise Exception("Missing dependency for determining config path. Please install "
"the 'appdirs' Python module.")
self._config_filename = appdirs.user_config_dir(_LIBRARY_NAME, "ProfitBricks") + ".ini"
if not self._config:
self._config = configparser.ConfigParser()
self._config.optionxform = str
self._config.read(self._config_filename)
def _save_config(self, filename=None):
"""
Save the given user configuration.
"""
if filename is None:
filename = self._config_filename
parent_path = os.path.dirname(filename)
if not os.path.isdir(parent_path):
os.makedirs(parent_path)
with open(filename, "w") as configfile:
self._config.write(configfile)
def _get_username(self, username=None, use_config=True, config_filename=None):
"""Determine the username
If a username is given, this name is used. Otherwise the configuration
file will be consulted if `use_config` is set to True. The user is asked
for the username if the username is not available. Then the username is
stored in the configuration file.
:param username: Username (used directly if given)
:type username: ``str``
:param use_config: Whether to read username from configuration file
:type use_config: ``bool``
:param config_filename: Path to the configuration file
:type config_filename: ``str``
"""
if not username and use_config:
if self._config is None:
self._read_config(config_filename)
username = self._config.get("credentials", "username", fallback=None)
if not username:
username = input("Please enter your username: ").strip()
while not username:
username = input("No username specified. Please enter your username: ").strip()
if 'credendials' not in self._config:
self._config.add_section('credentials')
self._config.set("credentials", "username", username)
self._save_config()
return username
def _get_password(self, password, use_config=True, config_filename=None,
use_keyring=HAS_KEYRING):
"""
Determine the user password
If the password is given, this password is used. Otherwise
this function will try to get the password from the user's keyring
if `use_keyring` is set to True.
:param username: Username (used directly if given)
:type username: ``str``
:param use_config: Whether to read username from configuration file
:type use_config: ``bool``
:param config_filename: Path to the configuration file
:type config_filename: ``str``
"""
if not password and use_config:
if self._config is None:
self._read_config(config_filename)
password = self._config.get("credentials", "password", fallback=None)
if not password and use_keyring:
logger = logging.getLogger(__name__)
question = ("Please enter your password for {}: ".format(self.username))
if HAS_KEYRING:
password = keyring.get_password(_LIBRARY_NAME, self.username)
if password is None:
password = getpass.getpass(question)
try:
keyring.set_password(_LIBRARY_NAME, self.username, password)
except keyring.errors.PasswordSetError as error:
logger.warning("Storing password in keyring '%s' failed: %s",
_LIBRARY_NAME, error)
else:
logger.warning("Install the 'keyring' Python module to store your password "
"securely in your keyring!")
password = self._config.get("credentials", "password", fallback=None)
if password is None:
password = getpass.getpass(question)
store_plaintext_passwords = self._config.get(
"preferences", "store-plaintext-passwords", fallback=None)
if store_plaintext_passwords != "no":
question = ("Do you want to store your password in plain text in " +
self._config_filename())
answer = ask(question, ["yes", "no", "never"], "no")
if answer == "yes":
self._config.set("credentials", "password", password)
self._save_config()
elif answer == "never":
if "preferences" not in self._config:
self._config.add_section("preferences")
self._config.set("preferences", "store-plaintext-passwords", "no")
self._save_config()
return password
# Contract Resources Functions
def list_contracts(self, depth=1):
"""
Retrieves information about the resource limits
for a particular contract and the current resource usage.
"""
response = self._perform_request('/contracts?depth=' + str(depth))
return response
# Data Center Functions
def get_datacenter(self, datacenter_id, depth=1):
"""
Retrieves a data center by its ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s?depth=%s' % (datacenter_id, str(depth)))
return response
def get_datacenter_by_name(self, name, depth=1):
"""
Retrieves a data center by its name.
Either returns the data center response or raises an Exception
if no or more than one data center was found with the name.
The search for the name is done in this relaxing way:
- exact name match
- case-insentive name match
- data center starts with the name
- data center starts with the name (case insensitive)
- name appears in the data center name
- name appears in the data center name (case insensitive)
:param name: The name of the data center.
:type name: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
all_data_centers = self.list_datacenters(depth=depth)['items']
data_center = find_item_by_name(all_data_centers, lambda i: i['properties']['name'], name)
if len(data_center) == 0:
raise NameError("No data center found with name "
"containing '{name}'.".format(name=name))
if len(data_center) > 1:
raise NameError("Found {n} data centers with the name '{name}': {names}".format(
n=len(data_center),
name=name,
names=", ".join(d['properties']['name'] for d in data_center)
))
return data_center[0]
def list_datacenters(self, depth=1):
"""
Retrieves a list of all data centers.
"""
response = self._perform_request('/datacenters?depth=' + str(depth))
return response
def delete_datacenter(self, datacenter_id):
"""
Removes the data center and all its components such as servers, NICs,
load balancers, volumes.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s' % (datacenter_id),
method='DELETE')
return response
def create_datacenter(self, datacenter):
"""
Creates a data center -- both simple and complex are supported.
"""
server_items = []
volume_items = []
lan_items = []
loadbalancer_items = []
entities = dict()
properties = {
"name": datacenter.name
}
# Omit 'location', if not provided, to receive
# a meaningful error message.
if datacenter.location:
properties['location'] = datacenter.location
# Optional Properties
if datacenter.description:
properties['description'] = datacenter.description
# Servers
if len(datacenter.servers) > 0:
for server in datacenter.servers:
server_items.append(self._create_server_dict(server))
servers = {
"items": server_items
}
server_entities = {
"servers": servers
}
entities.update(server_entities)
# Volumes
if len(datacenter.volumes) > 0:
for volume in datacenter.volumes:
volume_items.append(self._create_volume_dict(volume))
volumes = {
"items": volume_items
}
volume_entities = {
"volumes": volumes
}
entities.update(volume_entities)
# Load Balancers
if len(datacenter.loadbalancers) > 0:
for loadbalancer in datacenter.loadbalancers:
loadbalancer_items.append(
self._create_loadbalancer_dict(
loadbalancer
)
)
loadbalancers = {
"items": loadbalancer_items
}
loadbalancer_entities = {
"loadbalancers": loadbalancers
}
entities.update(loadbalancer_entities)
# LANs
if len(datacenter.lans) > 0:
for lan in datacenter.lans:
lan_items.append(
self._create_lan_dict(lan)
)
lans = {
"items": lan_items
}
lan_entities = {
"lans": lans
}
entities.update(lan_entities)
if len(entities) == 0:
raw = {
"properties": properties,
}
else:
raw = {
"properties": properties,
"entities": entities
}
data = json.dumps(raw)
response = self._perform_request(
url='/datacenters',
method='POST',
data=data)
return response
def update_datacenter(self, datacenter_id, **kwargs):
"""
Updates a data center with the parameters provided.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/datacenters/%s' % (
datacenter_id),
method='PATCH',
data=json.dumps(data))
return response
# Firewall Rule Functions
def get_firewall_rule(self, datacenter_id,
server_id, nic_id, firewall_rule_id):
"""
Retrieves a single firewall rule by ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param firewall_rule_id: The unique ID of the firewall rule.
:type firewall_rule_id: ``str``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/nics/%s/firewallrules/%s' % (
datacenter_id,
server_id,
nic_id,
firewall_rule_id))
return response
def get_firewall_rules(self, datacenter_id, server_id, nic_id, depth=1):
"""
Retrieves a list of firewall rules available in the account.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/nics/%s/firewallrules?depth=%s' % (
datacenter_id,
server_id,
nic_id,
str(depth)))
return response
def delete_firewall_rule(self, datacenter_id, server_id,
nic_id, firewall_rule_id):
"""
Removes a firewall rule from the NIC.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param firewall_rule_id: The unique ID of the firewall rule.
:type firewall_rule_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/nics/%s/firewallrules/%s' % (
datacenter_id,
server_id,
nic_id,
firewall_rule_id),
method='DELETE')
return response
def create_firewall_rule(self, datacenter_id, server_id,
nic_id, firewall_rule):
"""
Creates a firewall rule on the specified NIC and server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param firewall_rule: A firewall rule dict.
:type firewall_rule: ``dict``
"""
properties = {
"name": firewall_rule.name
}
if firewall_rule.protocol:
properties['protocol'] = firewall_rule.protocol
# Optional Properties
if firewall_rule.source_mac:
properties['sourceMac'] = firewall_rule.source_mac
if firewall_rule.source_ip:
properties['sourceIp'] = firewall_rule.source_ip
if firewall_rule.target_ip:
properties['targetIp'] = firewall_rule.target_ip
if firewall_rule.port_range_start:
properties['portRangeStart'] = firewall_rule.port_range_start
if firewall_rule.port_range_end:
properties['portRangeEnd'] = firewall_rule.port_range_end
if firewall_rule.icmp_type:
properties['icmpType'] = firewall_rule.icmp_type
if firewall_rule.icmp_code:
properties['icmpCode'] = firewall_rule.icmp_code
data = {
"properties": properties
}
response = self._perform_request(
url='/datacenters/%s/servers/%s/nics/%s/firewallrules' % (
datacenter_id,
server_id,
nic_id),
method='POST',
data=json.dumps(data))
return response
def update_firewall_rule(self, datacenter_id, server_id,
nic_id, firewall_rule_id, **kwargs):
"""
Updates a firewall rule.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param firewall_rule_id: The unique ID of the firewall rule.
:type firewall_rule_id: ``str``
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
if attr == 'source_mac':
data['sourceMac'] = kwargs[attr]
elif attr == 'source_ip':
data['sourceIp'] = kwargs[attr]
elif attr == 'target_ip':
data['targetIp'] = kwargs[attr]
elif attr == 'port_range_start':
data['portRangeStart'] = kwargs[attr]
elif attr == 'port_range_end':
data['portRangeEnd'] = kwargs[attr]
elif attr == 'icmp_type':
data['icmpType'] = kwargs[attr]
elif attr == 'icmp_code':
data['icmpCode'] = kwargs[attr]
else:
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/datacenters/%s/servers/%s/nics/%s/firewallrules/%s' % (
datacenter_id,
server_id,
nic_id,
firewall_rule_id),
method='PATCH',
data=json.dumps(data))
return response
# Image Functions
def get_image(self, image_id):
"""
Retrieves a single image by ID.
:param image_id: The unique ID of the image.
:type image_id: ``str``
"""
response = self._perform_request('/images/%s' % image_id)
return response
def list_images(self, depth=1):
"""
Retrieves a list of images available in the data center.
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request('/images?depth=' + str(depth))
return response
def delete_image(self, image_id):
"""
Removes only user created images.
:param image_id: The unique ID of the image.
:type image_id: ``str``
"""
response = self._perform_request(url='/images/' + image_id,
method='DELETE')
return response
def update_image(self, image_id, **kwargs):
"""
Replace all properties of an image.
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(url='/images/' + image_id,
method='PATCH',
data=json.dumps(data))
return response
# IP block Functions
def get_ipblock(self, ipblock_id):
"""
Retrieves a single IP block by ID.
:param ipblock_id: The unique ID of the IP block.
:type ipblock_id: ``str``
"""
response = self._perform_request('/ipblocks/%s' % ipblock_id)
return response
def list_ipblocks(self, depth=1):
"""
Retrieves a list of IP blocks available in the account.
"""
response = self._perform_request('/ipblocks?depth=%s' % str(depth))
return response
def delete_ipblock(self, ipblock_id):
"""
Removes a single IP block from your account.
:param ipblock_id: The unique ID of the IP block.
:type ipblock_id: ``str``
"""
response = self._perform_request(
url='/ipblocks/' + ipblock_id, method='DELETE')
return response
def reserve_ipblock(self, ipblock):
"""
Reserves an IP block within your account.
"""
properties = {
"name": ipblock.name
}
if ipblock.location:
properties['location'] = ipblock.location
if ipblock.size:
properties['size'] = str(ipblock.size)
raw = {
"properties": properties,
}
data = self._underscore_to_camelcase(json.dumps(raw))
response = self._perform_request(
url='/ipblocks', method='POST', data=data)
return response
# LAN Functions
def get_lan(self, datacenter_id, lan_id, depth=1):
"""
Retrieves a single LAN by ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param lan_id: The unique ID of the LAN.
:type lan_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/lans/%s?depth=%s' % (
datacenter_id,
lan_id,
str(depth)))
return response
def list_lans(self, datacenter_id, depth=1):
"""
Retrieves a list of LANs available in the account.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/lans?depth=%s' % (
datacenter_id,
str(depth)))
return response
def delete_lan(self, datacenter_id, lan_id):
"""
Removes a LAN from the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param lan_id: The unique ID of the LAN.
:type lan_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/lans/%s' % (
datacenter_id, lan_id), method='DELETE')
return response
def create_lan(self, datacenter_id, lan):
"""
Creates a LAN in the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param lan: The LAN object to be created.
:type lan: ``dict``
"""
data = self._underscore_to_camelcase(
json.dumps(
self._create_lan_dict(lan)
)
)
response = self._perform_request(
url='/datacenters/%s/lans' % datacenter_id,
method='POST',
data=data)
return response
def update_lan(self, datacenter_id, lan_id, name=None,
public=None, ip_failover=None):
"""
Updates a LAN
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param lan_id: The unique ID of the LAN.
:type lan_id: ``str``
:param name: The new name of the LAN.
:type name: ``str``
:param public: Indicates if the LAN is public.
:type public: ``bool``
:param ip_failover: A list of IP fail-over dicts.
:type ip_failover: ``list``
"""
data = {}
if name:
data['name'] = name
if public is not None:
data['public'] = public
if ip_failover:
data['ipFailover'] = ip_failover
response = self._perform_request(
url='/datacenters/%s/lans/%s' % (datacenter_id, lan_id),
method='PATCH',
data=json.dumps(data))
return response
def get_lan_members(self, datacenter_id, lan_id, depth=1):
"""
Retrieves the list of NICs that are part of the LAN.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param lan_id: The unique ID of the LAN.
:type lan_id: ``str``
"""
response = self._perform_request(
'/datacenters/%s/lans/%s/nics?depth=%s' % (
datacenter_id,
lan_id,
str(depth)))
return response
# Load balancer Functions
def get_loadbalancer(self, datacenter_id, loadbalancer_id):
"""
Retrieves a single load balancer by ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
"""
response = self._perform_request(
'/datacenters/%s/loadbalancers/%s' % (
datacenter_id, loadbalancer_id))
return response
def list_loadbalancers(self, datacenter_id, depth=1):
"""
Retrieves a list of load balancers in the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/loadbalancers?depth=%s' % (
datacenter_id, str(depth)))
return response
def delete_loadbalancer(self, datacenter_id, loadbalancer_id):
"""
Removes the load balancer from the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/loadbalancers/%s' % (
datacenter_id, loadbalancer_id), method='DELETE')
return response
def create_loadbalancer(self, datacenter_id, loadbalancer):
"""
Creates a load balancer within the specified data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer: The load balancer object to be created.
:type loadbalancer: ``dict``
"""
data = self._underscore_to_camelcase(
json.dumps(
self._create_loadbalancer_dict(loadbalancer)
)
)
response = self._perform_request(
url='/datacenters/%s/loadbalancers' % datacenter_id,
method='POST',
data=data)
return response
def update_loadbalancer(self, datacenter_id,
loadbalancer_id, **kwargs):
"""
Updates a load balancer
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/datacenters/%s/loadbalancers/%s' % (datacenter_id,
loadbalancer_id),
method='PATCH',
data=json.dumps(data))
return response
def get_loadbalancer_members(self, datacenter_id, loadbalancer_id,
depth=1):
"""
Retrieves the list of NICs that are associated with a load balancer.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/loadbalancers/%s/balancednics?depth=%s' % (
datacenter_id, loadbalancer_id, str(depth)))
return response
def add_loadbalanced_nics(self, datacenter_id,
loadbalancer_id, nic_id):
"""
Associates a NIC with the given load balancer.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
:param nic_id: The ID of the NIC.
:type nic_id: ``str``
"""
data = '{ "id": "' + nic_id + '" }'
response = self._perform_request(
url='/datacenters/%s/loadbalancers/%s/balancednics' % (
datacenter_id,
loadbalancer_id),
method='POST',
data=data)
return response
def get_loadbalanced_nic(self, datacenter_id,
loadbalancer_id, nic_id, depth=1):
"""
Gets the properties of a load balanced NIC.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/loadbalancers/%s/balancednics/%s?depth=%s' % (
datacenter_id,
loadbalancer_id,
nic_id,
str(depth)))
return response
def remove_loadbalanced_nic(self, datacenter_id,
loadbalancer_id, nic_id):
"""
Removes a NIC from the load balancer.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param loadbalancer_id: The unique ID of the load balancer.
:type loadbalancer_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/loadbalancers/%s/balancednics/%s' % (
datacenter_id,
loadbalancer_id,
nic_id),
method='DELETE')
return response
# Location Functions
def get_location(self, location_id, depth=0):
"""
Retrieves a single location by ID.
:param location_id: The unique ID of the location.
:type location_id: ``str``
"""
response = self._perform_request('/locations/%s?depth=%s' % (location_id, depth))
return response
def list_locations(self, depth=0):
"""
Retrieves a list of locations available in the account.
"""
response = self._perform_request('/locations?depth=%s' % (depth))
return response
# NIC Functions
def get_nic(self, datacenter_id, server_id, nic_id, depth=1):
"""
Retrieves a NIC by its ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/nics/%s?depth=%s' % (
datacenter_id,
server_id,
nic_id,
str(depth)))
return response
def list_nics(self, datacenter_id, server_id, depth=1):
"""
Retrieves a list of all NICs bound to the specified server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/nics?depth=%s' % (
datacenter_id,
server_id,
str(depth)))
return response
def delete_nic(self, datacenter_id, server_id, nic_id):
"""
Removes a NIC from the server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/nics/%s' % (
datacenter_id,
server_id,
nic_id),
method='DELETE')
return response
def create_nic(self, datacenter_id, server_id, nic):
"""
Creates a NIC on the specified server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic: A NIC dict.
:type nic: ``dict``
"""
data = json.dumps(self._create_nic_dict(nic))
response = self._perform_request(
url='/datacenters/%s/servers/%s/nics' % (
datacenter_id,
server_id),
method='POST',
data=data)
return response
def update_nic(self, datacenter_id, server_id,
nic_id, **kwargs):
"""
Updates a NIC with the parameters provided.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param nic_id: The unique ID of the NIC.
:type nic_id: ``str``
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/datacenters/%s/servers/%s/nics/%s' % (
datacenter_id,
server_id,
nic_id),
method='PATCH',
data=json.dumps(data))
return response
# Request Functions
def get_request(self, request_id, status=False):
"""
Retrieves a single request by ID.
:param request_id: The unique ID of the request.
:type request_id: ``str``
:param status: Retreive the full status of the request.
:type status: ``bool``
"""
if status:
response = self._perform_request(
'/requests/' + request_id + '/status')
else:
response = self._perform_request(
'/requests/%s' % request_id)
return response
def list_requests(self, depth=1):
"""
Retrieves a list of requests available in the account.
"""
response = self._perform_request(
'/requests?depth=%s' % str(depth))
return response
# Server Functions
def get_server(self, datacenter_id, server_id, depth=1):
"""
Retrieves a server by its ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s?depth=%s' % (
datacenter_id,
server_id,
str(depth)))
return response
def list_servers(self, datacenter_id, depth=1):
"""
Retrieves a list of all servers bound to the specified data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers?depth=%s' % (datacenter_id, str(depth)))
return response
def delete_server(self, datacenter_id, server_id):
"""
Removes the server from your data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s' % (
datacenter_id,
server_id),
method='DELETE')
return response
def create_server(self, datacenter_id, server):
"""
Creates a server within the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server: A dict of the server to be created.
:type server: ``dict``
"""
data = json.dumps(self._create_server_dict(server))
response = self._perform_request(
url='/datacenters/%s/servers' % (datacenter_id),
method='POST',
data=data)
return response
def update_server(self, datacenter_id, server_id, **kwargs):
"""
Updates a server with the parameters provided.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
"""
data = {}
for attr in kwargs.keys():
if attr == 'boot_volume':
boot_volume_properties = {
"id": kwargs[attr]
}
boot_volume_entities = {
"bootVolume": boot_volume_properties
}
data.update(boot_volume_entities)
else:
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/datacenters/%s/servers/%s' % (
datacenter_id,
server_id),
method='PATCH',
data=json.dumps(data))
return response
def get_attached_volumes(self, datacenter_id, server_id, depth=1):
"""
Retrieves a list of volumes attached to the server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/volumes?depth=%s' % (
datacenter_id,
server_id,
str(depth)))
return response
def get_attached_volume(self, datacenter_id, server_id, volume_id):
"""
Retrieves volume information.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/volumes/%s' % (
datacenter_id,
server_id,
volume_id))
return response
def attach_volume(self, datacenter_id, server_id, volume_id):
"""
Attaches a volume to a server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
"""
data = '{ "id": "' + volume_id + '" }'
response = self._perform_request(
url='/datacenters/%s/servers/%s/volumes' % (
datacenter_id,
server_id),
method='POST',
data=data)
return response
def detach_volume(self, datacenter_id, server_id, volume_id):
"""
Detaches a volume from a server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/volumes/%s' % (
datacenter_id,
server_id,
volume_id),
method='DELETE')
return response
def get_attached_cdroms(self, datacenter_id, server_id, depth=1):
"""
Retrieves a list of CDROMs attached to the server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/cdroms?depth=%s' % (
datacenter_id,
server_id,
str(depth)))
return response
def get_attached_cdrom(self, datacenter_id, server_id, cdrom_id):
"""
Retrieves an attached CDROM.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param cdrom_id: The unique ID of the CDROM.
:type cdrom_id: ``str``
"""
response = self._perform_request(
'/datacenters/%s/servers/%s/cdroms/%s' % (
datacenter_id,
server_id,
cdrom_id))
return response
def attach_cdrom(self, datacenter_id, server_id, cdrom_id):
"""
Attaches a CDROM to a server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param cdrom_id: The unique ID of the CDROM.
:type cdrom_id: ``str``
"""
data = '{ "id": "' + cdrom_id + '" }'
response = self._perform_request(
url='/datacenters/%s/servers/%s/cdroms' % (
datacenter_id,
server_id),
method='POST',
data=data)
return response
def detach_cdrom(self, datacenter_id, server_id, cdrom_id):
"""
Detaches a volume from a server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
:param cdrom_id: The unique ID of the CDROM.
:type cdrom_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/cdroms/%s' % (
datacenter_id,
server_id,
cdrom_id),
method='DELETE')
return response
def start_server(self, datacenter_id, server_id):
"""
Starts the server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/start' % (
datacenter_id,
server_id),
method='POST-ACTION')
return response
def stop_server(self, datacenter_id, server_id):
"""
Stops the server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/stop' % (
datacenter_id,
server_id),
method='POST-ACTION')
return response
def reboot_server(self, datacenter_id, server_id):
"""
Reboots the server.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param server_id: The unique ID of the server.
:type server_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/servers/%s/reboot' % (
datacenter_id,
server_id),
method='POST-ACTION')
return response
# Snapshot Functions
def get_snapshot(self, snapshot_id):
"""
Retrieves a single snapshot by ID.
:param snapshot_id: The unique ID of the snapshot.
:type snapshot_id: ``str``
"""
response = self._perform_request('/snapshots/%s' % snapshot_id)
return response
def list_snapshots(self, depth=1):
"""
Retrieves a list of snapshots available in the account.
"""
response = self._perform_request(
'/snapshots?depth=%s' % str(depth))
return response
def delete_snapshot(self, snapshot_id):
"""
Removes a snapshot from your account.
:param snapshot_id: The unique ID of the snapshot.
:type snapshot_id: ``str``
"""
response = self._perform_request(
url='/snapshots/' + snapshot_id, method='DELETE')
return response
def update_snapshot(self, snapshot_id, **kwargs):
"""
Removes a snapshot from your account.
:param snapshot_id: The unique ID of the snapshot.
:type snapshot_id: ``str``
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/snapshots/' + snapshot_id, method='PATCH', data=json.dumps(data))
return response
def create_snapshot(self, datacenter_id, volume_id,
name=None, description=None):
"""
Creates a snapshot of the specified volume.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
:param name: The name given to the volume.
:type name: ``str``
:param description: The description given to the volume.
:type description: ``str``
"""
data = {'name': name, 'description': description}
response = self._perform_request(
'/datacenters/%s/volumes/%s/create-snapshot' % (
datacenter_id, volume_id),
method='POST-ACTION-JSON',
data=urlencode(data))
return response
def restore_snapshot(self, datacenter_id, volume_id, snapshot_id):
"""
Restores a snapshot to the specified volume.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
:param snapshot_id: The unique ID of the snapshot.
:type snapshot_id: ``str``
"""
data = {'snapshotId': snapshot_id}
response = self._perform_request(
url='/datacenters/%s/volumes/%s/restore-snapshot' % (
datacenter_id,
volume_id),
method='POST-ACTION',
data=urlencode(data))
return response
def remove_snapshot(self, snapshot_id):
"""
Removes a snapshot.
:param snapshot_id: The ID of the snapshot
you wish to remove.
:type snapshot_id: ``str``
"""
response = self._perform_request(
url='/snapshots/' + snapshot_id, method='DELETE')
return response
# User Management Functions
def list_groups(self, depth=1):
"""
Retrieves a list of all groups.
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request('/um/groups?depth=' + str(depth))
return response
def get_group(self, group_id, depth=1):
"""
Retrieves a single group by ID.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/um/groups/%s?depth=%s' % (group_id, str(depth)))
return response
def create_group(self, group):
"""
Creates a new group and set group privileges.
:param group: The group object to be created.
:type group: ``dict``
"""
data = json.dumps(self._create_group_dict(group))
response = self._perform_request(
url='/um/groups',
method='POST',
data=data)
return response
def update_group(self, group_id, **kwargs):
"""
Updates a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
"""
properties = {}
# make the key camel-case transformable
if 'create_datacenter' in kwargs:
kwargs['create_data_center'] = kwargs.pop('create_datacenter')
for attr in kwargs.keys():
properties[self._underscore_to_camelcase(attr)] = kwargs[attr]
data = {
"properties": properties
}
response = self._perform_request(
url='/um/groups/%s' % group_id,
method='PUT',
data=json.dumps(data))
return response
def delete_group(self, group_id):
"""
Removes a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
"""
response = self._perform_request(
url='/um/groups/%s' % group_id,
method='DELETE')
return response
def list_shares(self, group_id, depth=1):
"""
Retrieves a list of all shares though a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/um/groups/%s/shares?depth=%s' % (group_id, str(depth)))
return response
def get_share(self, group_id, resource_id, depth=1):
"""
Retrieves a specific resource share available to a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param resource_id: The unique ID of the resource.
:type resource_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/um/groups/%s/shares/%s?depth=%s'
% (group_id, resource_id, str(depth)))
return response
def add_share(self, group_id, resource_id, **kwargs):
"""
Shares a resource through a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param resource_id: The unique ID of the resource.
:type resource_id: ``str``
"""
properties = {}
for attr in kwargs.keys():
properties[self._underscore_to_camelcase(attr)] = kwargs[attr]
data = {
"properties": properties
}
response = self._perform_request(
url='/um/groups/%s/shares/%s' % (group_id, resource_id),
method='POST',
data=json.dumps(data))
return response
def update_share(self, group_id, resource_id, **kwargs):
"""
Updates the permissions of a group for a resource share.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param resource_id: The unique ID of the resource.
:type resource_id: ``str``
"""
properties = {}
for attr in kwargs.keys():
properties[self._underscore_to_camelcase(attr)] = kwargs[attr]
data = {
"properties": properties
}
response = self._perform_request(
url='/um/groups/%s/shares/%s' % (group_id, resource_id),
method='PUT',
data=json.dumps(data))
return response
def delete_share(self, group_id, resource_id):
"""
Removes a resource share from a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param resource_id: The unique ID of the resource.
:type resource_id: ``str``
"""
response = self._perform_request(
url='/um/groups/%s/shares/%s' % (group_id, resource_id),
method='DELETE')
return response
def list_users(self, depth=1):
"""
Retrieves a list of all users.
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request('/um/users?depth=' + str(depth))
return response
def get_user(self, user_id, depth=1):
"""
Retrieves a single user by ID.
:param user_id: The unique ID of the user.
:type user_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/um/users/%s?depth=%s' % (user_id, str(depth)))
return response
def create_user(self, user):
"""
Creates a new user.
:param user: The user object to be created.
:type user: ``dict``
"""
data = self._create_user_dict(user=user)
response = self._perform_request(
url='/um/users',
method='POST',
data=json.dumps(data))
return response
def update_user(self, user_id, **kwargs):
"""
Updates a user.
:param user_id: The unique ID of the user.
:type user_id: ``str``
"""
properties = {}
for attr in kwargs.keys():
properties[self._underscore_to_camelcase(attr)] = kwargs[attr]
data = {
"properties": properties
}
response = self._perform_request(
url='/um/users/%s' % user_id,
method='PUT',
data=json.dumps(data))
return response
def delete_user(self, user_id):
"""
Removes a user.
:param user_id: The unique ID of the user.
:type user_id: ``str``
"""
response = self._perform_request(
url='/um/users/%s' % user_id,
method='DELETE')
return response
def list_group_users(self, group_id, depth=1):
"""
Retrieves a list of all users that are members of a particular group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/um/groups/%s/users?depth=%s' % (group_id, str(depth)))
return response
def add_group_user(self, group_id, user_id):
"""
Adds an existing user to a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param user_id: The unique ID of the user.
:type user_id: ``str``
"""
data = {
"id": user_id
}
response = self._perform_request(
url='/um/groups/%s/users' % group_id,
method='POST',
data=json.dumps(data))
return response
def remove_group_user(self, group_id, user_id):
"""
Removes a user from a group.
:param group_id: The unique ID of the group.
:type group_id: ``str``
:param user_id: The unique ID of the user.
:type user_id: ``str``
"""
response = self._perform_request(
url='/um/groups/%s/users/%s' % (group_id, user_id),
method='DELETE')
return response
def list_resources(self, resource_type=None, depth=1):
"""
Retrieves a list of all resources.
:param resource_type: The resource type: datacenter, image,
snapshot or ipblock. Default is None,
i.e., all resources are listed.
:type resource_type: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
if resource_type is not None:
response = self._perform_request(
'/um/resources/%s?depth=%s' % (resource_type, str(depth)))
else:
response = self._perform_request(
'/um/resources?depth=' + str(depth))
return response
def get_resource(self, resource_type, resource_id, depth=1):
"""
Retrieves a single resource of a particular type.
:param resource_type: The resource type: datacenter, image,
snapshot or ipblock.
:type resource_type: ``str``
:param resource_id: The unique ID of the resource.
:type resource_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/um/resources/%s/%s?depth=%s' % (
resource_type, resource_id, str(depth)))
return response
# Volume Functions
def get_volume(self, datacenter_id, volume_id):
"""
Retrieves a single volume by ID.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
"""
response = self._perform_request(
'/datacenters/%s/volumes/%s' % (datacenter_id, volume_id))
return response
def list_volumes(self, datacenter_id, depth=1):
"""
Retrieves a list of volumes in the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param depth: The depth of the response data.
:type depth: ``int``
"""
response = self._perform_request(
'/datacenters/%s/volumes?depth=%s' % (datacenter_id, str(depth)))
return response
def delete_volume(self, datacenter_id, volume_id):
"""
Removes a volume from the data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
"""
response = self._perform_request(
url='/datacenters/%s/volumes/%s' % (
datacenter_id, volume_id), method='DELETE')
return response
def create_volume(self, datacenter_id, volume):
"""
Creates a volume within the specified data center.
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param volume: A volume dict.
:type volume: ``dict``
"""
data = (json.dumps(self._create_volume_dict(volume)))
response = self._perform_request(
url='/datacenters/%s/volumes' % datacenter_id,
method='POST',
data=data)
return response
def update_volume(self, datacenter_id, volume_id, **kwargs):
"""
Updates a volume
:param datacenter_id: The unique ID of the data center.
:type datacenter_id: ``str``
:param volume_id: The unique ID of the volume.
:type volume_id: ``str``
"""
data = {}
for attr in kwargs.keys():
data[self._underscore_to_camelcase(attr)] = kwargs[attr]
response = self._perform_request(
url='/datacenters/%s/volumes/%s' % (
datacenter_id,
volume_id),
method='PATCH',
data=json.dumps(data))
return response
def wait_for_completion(self, response, timeout=3600, initial_wait=5, scaleup=10):
"""
Poll resource request status until resource is provisioned.
:param response: A response dict, which needs to have a 'requestId' item.
:type response: ``dict``
:param timeout: Maximum waiting time in seconds. None means infinite waiting time.
:type timeout: ``int``
:param initial_wait: Initial polling interval in seconds.
:type initial_wait: ``int``
:param scaleup: Double polling interval every scaleup steps, which will be doubled.
:type scaleup: ``int``
"""
if not response:
return
logger = logging.getLogger(__name__)
wait_period = initial_wait
next_increase = time.time() + wait_period * scaleup
if timeout:
timeout = time.time() + timeout
while True:
request = self.get_request(request_id=response['requestId'], status=True)
if request['metadata']['status'] == 'DONE':
break
elif request['metadata']['status'] == 'FAILED':
raise PBFailedRequest(
'Request {0} failed to complete: {1}'.format(
response['requestId'], request['metadata']['message']),
response['requestId']
)
current_time = time.time()
if timeout and current_time > timeout:
raise PBTimeoutError('Timed out waiting for request {0}.'.format(
response['requestId']), response['requestId'])
if current_time > next_increase:
wait_period *= 2
next_increase = time.time() + wait_period * scaleup
scaleup *= 2
logger.info("Request %s is in state '%s'. Sleeping for %i seconds...",
response['requestId'], request['metadata']['status'], wait_period)
time.sleep(wait_period)
def _wrapped_request(self, method, url,
params=None,
data=None,
headers=None,
cookies=None,
files=None,
auth=None,
timeout=None,
allow_redirects=True,
proxies=None,
hooks=None,
stream=None):
headers.update(self.headers)
session = requests.Session()
return session.request(method, url, params, data, headers, cookies,
files, auth, timeout, allow_redirects, proxies,
hooks, stream, self.verify, self.host_cert)
def _perform_request(self, url, method='GET', data=None, headers=None):
if headers is None:
headers = dict()
headers.update({'Authorization': 'Basic %s' % (base64.b64encode(
self._b('%s:%s' % (self.username,
self.password))).decode('utf-8'))})
url = self._build_url(url)
headers.update({'User-Agent': self.user_agent})
if method == 'POST' or method == 'PUT':
response = self._wrapped_request(method, url, data=data,
headers=headers)
headers.update({'Content-Type': 'application/json'})
elif method == 'POST-ACTION-JSON' or method == 'POST-ACTION':
headers.update({'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8'})
response = self._wrapped_request('POST', url, data=data,
headers=headers)
if response.status_code == 202 and method == 'POST-ACTION':
return True
elif response.status_code == 401:
raise response.raise_for_status()
elif method == 'PATCH':
headers.update({'Content-Type': 'application/json'})
response = self._wrapped_request(method, url, data=data,
headers=headers)
else:
headers.update({'Content-Type': 'application/json'})
response = self._wrapped_request(method, url, params=data,
headers=headers)
if method == 'DELETE':
if response.status_code == 202:
return True
try:
if not response.ok:
err = response.json()
code = err['httpStatus']
msg = err['messages']
if response.status_code == 401:
raise PBNotAuthorizedError(code, msg, url)
if response.status_code == 404:
raise PBNotFoundError(code, msg, url)
if response.status_code == 422:
raise PBValidationError(code, msg, url)
if response.status_code == 429:
raise PBRateLimitExceededError(code, msg, url)
else:
raise PBError(code, msg, url)
except ValueError:
raise Exception('Failed to parse the response', response.text)
json_response = response.json()
if 'location' in response.headers:
json_response['requestId'] = self._request_id(response.headers)
return json_response
@staticmethod
def _request_id(headers):
# The request URL has currently the format:
# {host_base}/requests/{request ID}/status
# Thus search for a UUID.
match = re.search('/requests/([-A-Fa-f0-9]+)/', headers['location'])
if match:
return match.group(1)
else:
raise Exception("Failed to extract request ID from response "
"header 'location': '{location}'".format(location=headers['location']))
def _build_url(self, uri):
url = self.host_base + uri
return url
@staticmethod
def _b(s, encoding='utf-8'):
"""
Returns the given string as a string of bytes. That means in
Python2 as a str object, and in Python3 as a bytes object.
Raises a TypeError, if it cannot be converted.
"""
if six.PY2:
# This is Python2
if isinstance(s, str):
return s
elif isinstance(s, unicode): # noqa, pylint: disable=undefined-variable
return s.encode(encoding)
else:
# And this is Python3
if isinstance(s, bytes):
return s
elif isinstance(s, str):
return s.encode(encoding)
raise TypeError("Invalid argument %r for _b()" % (s,))
@staticmethod
def _underscore_to_camelcase(value):
"""
Convert Python snake case back to mixed case.
"""
def camelcase():
yield str.lower
while True:
yield str.capitalize
c = camelcase()
return "".join(next(c)(x) if x else '_' for x in value.split("_"))
@staticmethod
def _create_lan_dict(lan):
items = []
entities = dict()
properties = {
"name": lan.name
}
# Optional Properties
if lan.public is not None:
properties['public'] = str(lan.public).lower()
if len(lan.nics) > 0:
for nic in lan.nics:
nics_properties = {
"id": nic
}
items.append(nics_properties)
item_entities = {
"items": items
}
nics_entities = {
"nics": item_entities
}
entities.update(nics_entities)
if len(entities) == 0:
raw = {
"properties": properties,
}
else:
raw = {
"properties": properties,
"entities": entities
}
return raw
@staticmethod
def _create_loadbalancer_dict(loadbalancer):
items = []
entities = dict()
properties = {}
if loadbalancer.name:
properties['name'] = loadbalancer.name
# Optional Properties
if loadbalancer.ip:
properties['ip'] = loadbalancer.ip
if loadbalancer.dhcp is not None:
properties['dhcp'] = str(loadbalancer.dhcp).lower()
if len(loadbalancer.balancednics) > 0:
for nic in loadbalancer.balancednics:
balancednic_properties = {
"id": nic
}
items.append(balancednic_properties)
item_entities = {
"items": items
}
balancednics_entities = {
"balancednics": item_entities
}
entities.update(balancednics_entities)
if len(loadbalancer.balancednics) == 0:
raw = {
"properties": properties,
}
else:
raw = {
"properties": properties,
"entities": entities
}
return raw
def _create_nic_dict(self, nic):
items = []
properties = {
"name": nic.name
}
if nic.lan:
properties['lan'] = nic.lan
# Optional Properties
if nic.nat:
properties['nat'] = nic.nat
if nic.ips:
properties['ips'] = nic.ips
if nic.dhcp is not None:
properties['dhcp'] = nic.dhcp
if nic.firewall_active is not None:
properties['firewallActive'] = nic.firewall_active
if len(nic.firewall_rules) > 0:
for rule in nic.firewall_rules:
items.append(self._create_firewallrules_dict(rule))
rules = {
"items": items
}
entities = {
"firewallrules": rules
}
if len(nic.firewall_rules) == 0:
raw = {
"properties": properties,
}
else:
raw = {
"properties": properties,
"entities": entities
}
return raw
@staticmethod
def _create_firewallrules_dict(rule):
properties = {}
if rule.name:
properties['name'] = rule.name
if rule.protocol:
properties['protocol'] = rule.protocol
if rule.source_mac:
properties['sourceMac'] = rule.source_mac
if rule.source_ip:
properties['sourceIp'] = rule.source_ip
if rule.target_ip:
properties['targetIp'] = rule.target_ip
if rule.port_range_start:
properties['portRangeStart'] = rule.port_range_start
if rule.port_range_end:
properties['portRangeEnd'] = rule.port_range_end
if rule.icmp_type:
properties['icmpType'] = rule.icmp_type
if rule.icmp_code:
properties['icmpCode'] = rule.icmp_code
raw = {
"properties": properties
}
return raw
def _create_server_dict(self, server):
volume_items = []
nic_items = []
entities = dict()
properties = {
"name": server.name
}
# Omit required attributes, if not provided,
# to receive a proper error message.
if server.ram:
properties['ram'] = server.ram
if server.cores:
properties['cores'] = server.cores
# Optional Properties
if server.availability_zone:
properties['availabilityZone'] = server.availability_zone
if server.boot_cdrom:
properties['bootCdrom'] = server.boot_cdrom
if server.boot_volume_id:
boot_volume = {
"id": server.boot_volume_id
}
properties['bootVolume'] = boot_volume
if server.cpu_family:
properties['cpuFamily'] = server.cpu_family
if len(server.create_volumes) > 0:
for volume in server.create_volumes:
volume_items.append(self._create_volume_dict(volume))
volumes = {
"items": volume_items
}
volume_entities = {
"volumes": volumes
}
entities.update(volume_entities)
if len(server.nics) > 0:
for nic in server.nics:
nic_items.append(self._create_nic_dict(nic))
nics = {
"items": nic_items
}
nic_entities = {
"nics": nics
}
entities.update(nic_entities)
# Attach Existing Volume(s)
if len(server.attach_volumes) > 0:
for volume in server.attach_volumes:
volume_properties = {
"id": volume
}
volume_items.append(volume_properties)
volumes = {
"items": volume_items
}
volume_entities = {
"volumes": volumes
}
entities.update(volume_entities)
if len(entities) == 0:
raw = {
"properties": properties,
}
else:
raw = {
"properties": properties,
"entities": entities
}
return raw
@staticmethod
def _create_volume_dict(volume):
properties = {
"name": volume.name
}
# Omit 'size' attributes, if not provided,
# to receive a proper error message.
if volume.size:
properties['size'] = int(volume.size)
# Optional Properties
if volume.availability_zone:
properties['availabilityZone'] = volume.availability_zone
if volume.image:
properties['image'] = volume.image
if volume.image_alias:
properties['imageAlias'] = volume.image_alias
if volume.bus:
properties['bus'] = volume.bus
if volume.disk_type:
properties['type'] = volume.disk_type
if volume.image is None and volume.image_alias is None:
properties['licenceType'] = volume.licence_type
# if volume.licence_type:
# properties['licenceType'] = volume.licence_type
if volume.image_password:
properties['imagePassword'] = volume.image_password
if volume.ssh_keys:
properties['sshKeys'] = volume.ssh_keys
raw = {
"properties": properties
}
return raw
@staticmethod
def _create_group_dict(group):
properties = {}
if group.name:
properties['name'] = group.name
# Optional Properties
if group.reserve_ip:
properties['reserveIp'] = group.reserve_ip
if group.create_snapshot:
properties['createSnapshot'] = group.create_snapshot
if group.create_datacenter:
properties['createDataCenter'] = \
group.create_datacenter
if group.access_activity_log:
properties['accessActivityLog'] = \
group.access_activity_log
raw = {
"properties": properties
}
return raw
@staticmethod
def _create_user_dict(user):
properties = {}
if user.firstname:
properties['firstname'] = user.firstname
if user.lastname:
properties['lastname'] = user.lastname
if user.email:
properties['email'] = user.email
if user.password:
properties['password'] = user.password
# Optional Properties
if user.administrator:
properties['administrator'] = user.administrator
if user.force_sec_auth:
properties['forceSecAuth'] = user.force_sec_auth
raw = {
"properties": properties
}
return raw
class Datacenter(object):
def __init__(self, name=None, location=None, description=None,
volumes=None, servers=None, lans=None, loadbalancers=None):
"""
The Datacenter class initializer.
:param name: The data center name..
:type name: ``str``
:param location: The data center geographical location.
:type location: ``str``
:param description: Optional description.
:type description: ``str``
:param volumes: List of volume dicts.
:type volumes: ``list``
:param servers: List of server dicts.
:type servers: ``list``
:param lans: List of LAN dicts.
:type lans: ``list``
:param loadbalancers: List of load balancer dicts.
:type loadbalancers: ``list``
"""
if volumes is None:
volumes = []
if servers is None:
servers = []
if lans is None:
lans = []
if loadbalancers is None:
loadbalancers = []
self.name = name
self.description = description
self.location = location
self.servers = servers
self.volumes = volumes
self.lans = lans
self.loadbalancers = loadbalancers
def __repr__(self):
return (('<Datacenter: name=%s, location=%s, description=%s> ...>')
% (self.name, self.location, self.description))
class FirewallRule(object):
def __init__(self, name=None, protocol=None,
source_mac=None, source_ip=None,
target_ip=None, port_range_start=None,
port_range_end=None, icmp_type=None,
icmp_code=None):
"""
FirewallRule class initializer.
:param name: The name of the firewall rule.
:type name: ``str``
:param protocol: Either TCP or UDP
:type protocol: ``str``
:param source_mac: Source MAC you want to restrict.
:type source_mac: ``str``
:param source_ip: Source IP you want to restrict.
:type source_ip: ``str``
:param target_ip: Target IP you want to restrict.
:type target_ip: ``str``
:param port_range_start: Optional port range.
:type port_range_start: ``str``
:param port_range_end: Optional port range.
:type port_range_end: ``str``
:param icmp_type: Defines the allowed type.
:type icmp_type: ``str``
:param icmp_code: Defines the allowed code.
:type icmp_code: ``str``
"""
self.name = name
self.protocol = protocol
self.source_mac = source_mac
self.source_ip = source_ip
self.target_ip = target_ip
self.port_range_start = port_range_start
self.port_range_end = port_range_end
if icmp_type is not None:
icmp_type = str(icmp_type)
self.icmp_type = icmp_type
if icmp_code is not None:
icmp_code = str(icmp_code)
self.icmp_code = icmp_code
def __repr__(self):
return (('<FirewallRule: name=%s, protocol=%s, source_mac=%s, '
'source_ip=%s, target_ip=%s, port_range_start=%s, '
'port_range_end=%s, icmp_type=%s, icmp_code=%s> ...>')
% (self.name, self.protocol, self.source_mac,
self.source_ip, self.target_ip, self.port_range_start,
self.port_range_end, self.icmp_type, self.icmp_code))
class IPBlock(object):
def __init__(self, name=None, location=None, size=None):
"""
IPBlock class initializer.
:param name: The name of the IP block.
:type name: ``str``
:param location: The location for the IP block.
:type location: ``str``
:param size: The number of IPs in the block.
:type size: ``str``
"""
self.name = name
self.location = location
self.size = size
def __repr__(self):
return (('<IPBlock: location=%s, size=%s>')
% (self.location, self.size))
class LAN(object):
"""
This is the main class for managing LAN resources.
"""
def __init__(self, name=None, public=None, nics=None):
"""
LAN class initializer.
:param name: The name of the LAN.
:type name: ``str``
:param public: Indicates if the LAN is public.
:type public: ``bool``
:param nics: A list of NICs
:type nics: ``list``
"""
if nics is None:
nics = []
self.name = name
self.public = public
self.nics = nics
def __repr__(self):
return (('<LAN: name=%s, public=%s> ...>')
% (self.name, str(self.public)))
class LoadBalancer(object):
"""
This is the main class for managing load balancer resources.
"""
def __init__(self, name=None, ip=None,
dhcp=None, balancednics=None):
"""
LoadBalancer class initializer.
:param name: The name of the load balancer.
:type name: ``str``
:param ip: The IP for the load balancer.
:type ip: ``str``
:param dhcp: Indicates if the load balancer
uses DHCP or not.
:type dhcp: ``bool``
:param balancednics: A list of NICs associated
with the load balancer.
:type balancednics: ``list``
"""
if balancednics is None:
balancednics = []
self.name = name
self.ip = ip
self.dhcp = dhcp
self.balancednics = balancednics
def __repr__(self):
return (('<LoadBalancer: name=%s, ip=%s, dhcp=%s> ...>')
% (self.name, self.ip, str(self.dhcp)))
class NIC(object):
def __init__(self, name=None, ips=None,
dhcp=None, lan=None, firewall_active=None,
firewall_rules=None, nat=None):
"""
NIC class initializer.
:param name: The name of the NIC.
:type name: ``str``
:param ips: A list of IPs.
:type ips: ``list``
:param dhcp: Enable or disable DHCP. Default is enabled.
:type dhcp: ``bool``
:param lan: ID of the LAN in which the NIC should reside.
:type lan: ``str``
:param nat: Enable or disable NAT. Default is disabled.
:type nat: ``bool``
:param firewall_active: Turns the firewall on or off;
default is disabled.
:type firewall_active: ``bool``
:param firewall_rules: List of firewall rule dicts.
:type firewall_rules: ``list``
"""
if firewall_rules is None:
firewall_rules = []
self.name = name
self.nat = nat
self.ips = ips
self.dhcp = dhcp
self.lan = lan
self.firewall_active = firewall_active
self.firewall_rules = firewall_rules
def __repr__(self):
return (('<NIC: name=%s, ips=%s, dhcp=%s,lan=%s, '
'firewall_active=%s> ...>')
% (self.name, self.ips, str(self.dhcp),
self.lan, str(self.firewall_active)))
class Server(object):
"""
This is the main class for managing server resources.
"""
def __init__(self, name=None, cores=None, ram=None, availability_zone=None,
boot_volume_id=None, boot_cdrom=None, cpu_family=None,
create_volumes=None, attach_volumes=None, nics=None):
"""
Server class initializer.
:param name: The name of your server..
:type name: ``str``
:param cores: The number of cores for the server.
:type cores: ``str``
:param ram: The amount of memory for the server.
:type ram: ``str``
:param availability_zone: The availability zone for the server.
:type availability_zone: ``str``
:param boot_volume_id: The ID of the boot volume.
:type boot_volume_id: ``str``
:param boot_cdrom: Attach a CDROM.
:type boot_cdrom: ``str``
:param cpu_family: Set the desired CPU type.
:type cpu_family: ``str``
:param create_volumes: List of volume dicts to create.
:type create_volumes: ``list``
:param attach_volumes: List of volume IDs to attach.
:type attach_volumes: ``list``
:param nics: List of NIC dicts to create.
:type nics: ``list``
"""
if create_volumes is None:
create_volumes = []
if attach_volumes is None:
attach_volumes = []
if nics is None:
nics = []
self.name = name
self.cores = cores
self.ram = ram
self.availability_zone = availability_zone
self.boot_volume_id = boot_volume_id
self.boot_cdrom = boot_cdrom
self.cpu_family = cpu_family
self.create_volumes = create_volumes
self.attach_volumes = attach_volumes
self.nics = nics
def __repr__(self):
return (('<Server: name=%s, cores=%s, ram=%s, '
'availability_zone=%s, boot_volume_id=%s, '
'boot_cdrom=%s, ...>')
% (self.name, self.cores, self.ram,
self.availability_zone, self.boot_volume_id, self.boot_cdrom))
class Volume(object):
def __init__(self, name=None, size=None, bus='VIRTIO', image=None,
image_alias=None, disk_type='HDD', licence_type='UNKNOWN',
image_password=None, ssh_keys=None, availability_zone='AUTO'):
"""
Volume class initializer.
:param name: The name of the volume.
:type name: ``str``
:param size: The size of the volume.
:type size: ``str``
:param bus: The bus type. Def. VIRTIO.
:type bus: ``str``
:param image: The image ID to use.
:type image: ``str``
:param image_alias: An alias of the image to use.
:type image_alias: ``str``
:param disk_type: The type of storage. Def. HDD
:type disk_type: ``str``
:param licence_type: The licence type.
:type licence_type: ``str``
:param ssh_keys: A list of public SSH keys.
:type ssh_keys: ``list``
:param availability_zone: The availability zone for the server.
:type availability_zone: ``str``
"""
if ssh_keys is None:
ssh_keys = []
self.name = name
self.availability_zone = availability_zone
self.size = size
self.image = image
self.image_alias = image_alias
self.bus = bus
self.disk_type = disk_type
self.licence_type = licence_type
self.image_password = image_password
self.ssh_keys = ssh_keys
def __repr__(self):
return (('<Volume: name=%s, size=%s, image=%s, image_alias=%s,'
'bus=%s, disk_type=%s, ...>')
% (self.name, str(self.size), self.image,
self.image_alias, self.bus, self.disk_type))
class Snapshot(object):
def __init__(self, name=None, description=None, licence_type='UNKNOWN', size=None,
location=None):
"""
Snapshot class initializer.
:param name: The name of the snapshot.
:type name: ``str``
:param name: The description of the snapshot.
:type name: ``str``
:param size: The size of the snapshot.
:type size: ``str``
:param licence_type: The licence type.
:type licence_type: ``str``
"""
self.name = name
self.description = description
self.size = int(size)
self.licence_type = licence_type
self.location = location
def __repr__(self):
return ('<Snapshot: name={}, description={}, size={},location={}, ...>'.format(
self.name, self.description, str(self.size), self.location))
class Group(object):
def __init__(self, name=None, create_datacenter=None,
create_snapshot=None, reserve_ip=None,
access_activity_log=None):
"""
Group class initializer.
:param name: The name of the group.
:type name: ``str``
:param create_datacenter: Indicates if the group is allowed
to create virtual data centers.
:type create_datacenter: ``bool``
:param create_snapshot: Indicates if the group is allowed
to create snapshots.
:type create_snapshot: ``bool``
:param reserve_ip: Indicates if the group is allowed
to reserve IP addresses.
:type reserve_ip: ``bool``
:param access_activity_log: Indicates if the group is allowed
to access activity log.
:type access_activity_log: ``bool``
"""
self.name = name
self.create_datacenter = create_datacenter
self.create_snapshot = create_snapshot
self.reserve_ip = reserve_ip
self.access_activity_log = access_activity_log
def __repr__(self):
return ('<Group: name=%s, create_datacenter=%s, create_snapshot=%s, '
'reserve_ip=%s, access_activity_log=%s>'
% (self.name, str(self.create_datacenter),
str(self.create_snapshot), str(self.reserve_ip),
str(self.access_activity_log)))
class User(object):
def __init__(self, firstname=None, lastname=None,
email=None, password=None,
administrator=None,
force_sec_auth=None):
"""
User class initializer.
:param firstname: The user's first name.
:type firstname: ``str``
:param lastname: The user's last name.
:type lastname: ``str``
:param email: The user's email.
:type email: ``str``
:param password: A password for the user.
:type password: ``str``
:param administrator: Indicates if the user have
administrative rights.
:type administrator: ``bool``
:param force_sec_auth: Indicates if secure (two-factor)
authentication should be forced
for the user.
:type force_sec_auth: ``bool``
"""
self.firstname = firstname
self.lastname = lastname
self.email = email
self.password = password
self.administrator = administrator
self.force_sec_auth = force_sec_auth
def __repr__(self):
return ('<Group: firstname=%s, lastname=%s, email=%s, '
'password=%s, administrator=%s, force_sec_auth=%s>'
% (self.firstname, self.lastname,
self.email, self.password,
str(self.administrator),
str(self.force_sec_auth)))
|