/usr/lib/python3/dist-packages/profitbricks-4.1.1.egg-info/PKG-INFO 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 | Metadata-Version: 1.1
Name: profitbricks
Version: 4.1.1
Summary: ProfitBricks API Client Library for Python
Home-page: https://github.com/profitbricks/profitbricks-sdk-python
Author: Matt Baldwin (stackpointcloud.com)
Author-email: baldwin@stackpointcloud.com
License: Apache 2.0
Description-Content-Type: UNKNOWN
Description: # Python SDK
Version: profitbricks-sdk-python **4.1.1**
## Table of Contents
* [Description](#description)
* [Getting Started](#getting-started)
* [Installation](#installation)
* [Authenticating](#authenticating)
* [Error Handling](#error-handling)
* [Reference](#reference)
* [Data Centers](#data-centers)
* [List Data Centers](#list-data-centers)
* [Retrieve a Data Center](#retrieve-a-data-center)
* [Create a Data Center](#create-a-data-center)
* [Update a Data Center](#update-a-data-center)
* [Delete a Data Center](#delete-a-data-center)
* [Locations](#locations)
* [List Locations](#list-locations)
* [Get a Location](#get-a-location)
* [Servers](#servers)
* [List Servers](#list-servers)
* [Retrieve a Server](#retrieve-a-server)
* [Create a Server](#create-a-server)
* [Update a Server](#update-a-server)
* [Delete a Server](#delete-a-server)
* [List Attached Volumes](#list-attached-volumes)
* [Attach a Volume](#attach-a-volume)
* [Retrieve an Attached Volume](#retrieve-an-attached-volume)
* [Detach a Volume](#detach-a-volume)
* [List Attached CD-ROMs](#list-attached-cd-roms)
* [Attach a CD-ROM](#attach-a-cd-rom)
* [Retrieve an Attached CD-ROM](#retrieve-an-attached-cd-rom)
* [Detach a CD-ROM](#detach-a-cd-rom)
* [Reboot a Server](#reboot-a-server)
* [Start a Server](#start-a-server)
* [Stop a Server](#stop-a-server)
* [Images](#images)
* [List Images](#list-images)
* [Get an Image](#get-an-image)
* [Update an Image](#update-an-image)
* [Delete an Image](#delete-an-image)
* [Volumes](#volumes)
* [List Volumes](#list-volumes)
* [Get a Volume](#get-a-volume)
* [Create a Volume](#create-a-volume)
* [Update a Volume](#update-a-volume)
* [Delete a Volume](#delete-a-volume)
* [Create a Volume Snapshot](#create-a-volume-snapshot)
* [Restore a Volume Snapshot](#restore-a-volume-snapshot)
* [Snapshots](#snapshots)
* [List Snapshots](#list-snapshots)
* [Get a Snapshot](#get-a-snapshot)
* [Update a Snapshot](#update-a-snapshot)
* [Delete a Snapshot](#delete-a-snapshot)
* [IP Blocks](#ip-blocks)
* [List IP Blocks](#list-ip-blocks)
* [Get an IP Block](#get-an-ip-block)
* [Create an IP Block](#create-an-ip-block)
* [Delete an IP Block](#delete-an-ip-block)
* [LANs](#lans)
* [List LANs](#list-lans)
* [Create a LAN](#create-a-lan)
* [Get a LAN](#get-a-lan)
* [Get LAN Members](#get-lan-members)
* [Update a LAN](#update-a-lan)
* [Delete a LAN](#delete-a-lan)
* [Network Interfaces (NICs)](#network-interfaces-nics)
* [List NICs](#list-nics)
* [Get a NIC](#get-a-nic)
* [Create a NIC](#create-a-nic)
* [Update a NIC](#update-a-nic)
* [Delete a NIC](#delete-a-nic)
* [Firewall Rules](#firewall-rules)
* [List Firewall Rules](#list-firewall-rules)
* [Get a Firewall Rule](#get-a-firewall-rule)
* [Create a Firewall Rule](#create-a-firewall-rule)
* [Update a Firewall Rule](#update-a-firewall-rule)
* [Delete a Firewall Rule](#delete-a-firewall-rule)
* [Load Balancers](#load-balancers)
* [List Load Balancers](#list-load-balancers)
* [Get a Load Balancer](#get-a-load-balancer)
* [Create a Load Balancer](#create-a-load-balancer)
* [Update a Load Balancer](#update-a-load-balancer)
* [List Load Balanced NICs](#list-load-balanced-nics)
* [Get a Load Balanced NIC](#get-a-load-balanced-nic)
* [Associate NIC to a Load Balancer](#associate-nic-to-a-load-balancer)
* [Remove a NIC Association](#remove-a-nic-association)
* [User Management](#user-management)
* [List Groups](#list-groups)
* [Get a Group](#get-a-group)
* [Create a Group](#create-a-group)
* [Update a Group](#update-a-group)
* [Delete a Group](#delete-a-group)
* [List Shares](#list-shares)
* [Get a Share](#get-a-share)
* [Add a Share](#add-a-share)
* [Update a Share](#update-a-share)
* [Delete a Share](#delete-a-share)
* [List Users](#list-users)
* [Get a User](#get-a-user)
* [Create a User](#create-a-user)
* [Update a User](#update-a-user)
* [Delete a User](#delete-a-user)
* [List Users in a Group](#list-users-in-a-group)
* [Add User to Group](#add-user-to-group)
* [Remove User from a Group](#remove-user-from-a-group)
* [List Resources](#list-resources)
* [Get a Resource](#get-a-resource)
* [Contract Resources](#contract-resources)
* [List Contract Resources](#list-contract-resources)
* [Requests](#requests)
* [List Requests](#list-requests)
* [Get a Request](#get-a-request)
* [Get a Request Status](#get-a-request-status)
* [Examples](#examples)
* [List All Data Centers](#list-all-data-centers)
* [Search for Images](#search-for-images)
* [Reserve an IP Block](#reserve-an-ip-block)
* [Wait for Resources](#wait-for-resources)
* [Component Build](#component-build)
* [Composite Build](#composite-build)
* [Support](#support)
* [Testing](#testing)
* [Contributing](#contributing)
## Description
The ProfitBricks SDK for Python provides you with access to the ProfitBricks Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python.
This guide will walk you through getting setup with the library and performing various actions against the API.
The SDK for Python wraps the ProfitBricks Cloud API. All API operations are performed over SSL and authenticated using your ProfitBricks portal credentials. The API can be accessed within an instance running in ProfitBricks or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.
## Getting Started
Before you begin you will need to have [signed-up](https://www.profitbricks.com/signup) for a ProfitBricks account. The credentials you setup during sign-up will be used to authenticate against the Cloud API.
### Installation
The ProfitBricks SDK for Python is available on [PyPi](https://pypi.python.org/pypi/profitbricks). You can install the latest stable version using `pip`:
pip install profitbricks
Done!
### Authenticating
Connecting to ProfitBricks is handled by first setting up your authentication credentials.
from profitbricks.client import ProfitBricksService
client = ProfitBricksService(
username='YOUR_USERNAME', password='YOUR_PASSWORD')
Replace the values for *YOUR_USERNAME* and *YOUR_PASSWORD* with the ProfitBricks credentials you established during sign-up.
You can now use `client` for any future request.
### Error Handling
The SDK will raise custom exceptions when the Cloud API returns an error. There are five exception types:
| Exception | HTTP Code | Description |
|---|:-:|---|
| PBNotAuthorizedError | 401 | The supplied user credentials are invalid. |
| PBNotFoundError | 404 | The requested resource cannot be found. |
| PBValidationError | 422 | The request body includes invalid JSON. |
| PBRateLimitExceededError | 429 | The Cloud API rate limit has been exceeded. |
| PBError | Other | A generic exception for all other status codes. |
## Reference
This section provides details on all the available operations and the parameters they accept. Brief code snippets demonstrating usage are also included.
`client` is the `ProfitBricksService` class imported `from profitbricks.client import ProfitBricksService`
Many of the *get_* or *list_* operations will accept an optional *depth* parameter. Setting this to a value between 0 and 5 affects the amount of data that is returned. The detail returned varies somewhat depending on the resource being queried, however it generally follows this pattern.
| Depth | Description |
|:-:|---|
| 0 | Only direct properties are included. Children are not included. |
| 1 | Direct properties and children's references are returned. |
| 2 | Direct properties and children's properties are returned. |
| 3 | Direct properties, children's properties, and descendant's references are returned. |
| 4 | Direct properties, children's properties, and descendant's properties are returned. |
| 5 | Returns all available properties. |
This SDK sets the *depth=1* by default as that works well in the majority of cases. You may find that setting *depth* to a lower or higher value could simplify a later operation by reducing or increasing the data available in the response object.
### Data Centers
Virtual Data Centers (VDCs) are the foundation of the ProfitBricks platform. VDCs act as logical containers for all other objects you will be creating, e.g., servers. You can provision as many VDCs as you want. VDCs have their own private network and are logically segmented from each other to create isolation.
#### List Data Centers
This operation will list all currently provisioned VDCs that your account credentials provide access to.
There are no request arguments that need to be supplied. You may supply the optional *depth* parameter.
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_datacenters()
---
#### Retrieve a Data Center
Use this to retrieve details about a specific VDC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_datacenter(datacenter_id='UUID')
---
#### Create a Data Center
Use this operation to create a new VDC. You can create a "simple" VDC by supplying just the required *name* and *location* parameters. This operation also has the capability of provisioning a "complex" VDC by supplying additional parameters for servers, volumes, LANs, and/or load balancers.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| name | **yes** | string | The name of the VDC. |
| location | **yes** | string | The physical ProfitBricks location where the VDC will be created. |
| description | no | string | A description for the VDC, e.g. staging, production. |
| servers | no | list | Details about creating one or more servers. See [create a server](#create-a-server). |
| volumes | no | list | Details about creating one or more volumes. See [create a volume](#create-a-volume). |
| lans | no | list | Details about creating one or more LANs. See [create a lan](#create-a-lan). |
| loadbalancers | no | list | Details about creating one or more load balancers. See [create a load balancer](#create-a-load-balancer). |
The following table outlines the locations currently supported:
| Value| Country | City |
|---|---|---|
| us/las | United States | Las Vegas |
| us/ewr | United States | Newark |
| de/fra | Germany | Frankfurt |
| de/fkb | Germany | Karlsruhe |
datacenter = Datacenter(
name='Data Center Name',
description='My new data center',
location='de/fkb')
response = client.create_datacenter(datacenter=datacenter)
**NOTES**:
* The value for `name` cannot contain the following characters: (@, /, , |, ‘’, ‘).
* You cannot change the VDC `location` once it has been provisioned.
---
#### Update a Data Center
After retrieving a VDC, either by ID or as a create response object, you can change its properties by calling the `update_datacenter` method. Some parameters may not be changed using `update_datacenter`.
The following table describes the available request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| name | no | string | The new name of the VDC. |
| description | no | string | The new description of the VDC. |
response = client.update_datacenter(
datacenter_id='UUID',
name='New Name'
description='New description')
---
#### Delete a Data Center
This will remove all objects within the VDC and remove the VDC object itself.
**NOTE**: This is a highly destructive operation which should be used with extreme caution!
The following table describes the available request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC that you want to delete. |
response = client.delete_datacenter(datacenter_id='UUID')
---
### Locations
Locations are the physical ProfitBricks data centers where you can provision your VDCs.
#### List Locations
The `list_locations` operation will return the list of currently available locations.
There are no request parameters to supply.
response = client.list_locations()
---
#### Get a Location
Retrieves the attributes of a specific location.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| location_id | **yes** | string | The ID consisting of country/city. |
client.get_location('us/las')
---
### Servers
#### List Servers
You can retrieve a list of all the servers provisioned inside a specific VDC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_servers(datacenter_id='UUID')
---
#### Retrieve a Server
Returns information about a specific server such as its configuration, provisioning status, etc.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_server(
datacenter_id='UUID',
server_id='UUID')
---
#### Create a Server
Creates a server within an existing VDC. You can configure additional properties such as specifying a boot volume and connecting the server to a LAN.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| name | **yes** | string | The name of the server. |
| cores | **yes** | int | The total number of cores for the server. |
| ram | **yes** | int | The amount of memory for the server in MB, e.g. 2048. Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if you set `ram_hot_plug` to *True* then you must use a minimum of 1024 MB. |
| availability_zone | no | string | The availability zone in which the server should exist. |
| cpu_family | no | string | Sets the CPU type. "AMD_OPTERON" or "INTEL_XEON". Defaults to "AMD_OPTERON". |
| boot_volume_id | no | string | Reference to a volume used for booting. If not *null* then `boot_cdrom` has to be *null*. |
| boot_cdrom | no | string | Reference to a CD-ROM used for booting. If not *null* then `boot_volume_id` has to be *null*. |
| attach_volumes | no | list | A list of volumes that you want to connect to the server. |
| create_volumes | no | list | A list of volumes that you want to create and attach to the server.|
| nics | no | list | A list of NICs you wish to create at the time the server is provisioned. |
The following table outlines the server availability zones currently supported:
| Availability Zone | Comment |
|---|---|
| AUTO | Automatically Selected Zone |
| ZONE_1 | Fire Zone 1 |
| ZONE_2 | Fire Zone 2 |
server = Server(
name='Server Name',
cores=1,
ram=2048,
description='My new server',
location='de/fkb')
response = client.create_server(
datacenter_id='UUID',
server=server)
---
#### Update a Server
Perform updates to the attributes of a server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| name | no | string | The name of the server. |
| cores | no | int | The number of cores for the server. |
| ram | no | int | The amount of memory in the server. |
| availability_zone | no | string | The new availability zone for the server. |
| cpu_family | no | string | Sets the CPU type. "AMD_OPTERON" or "INTEL_XEON". Defaults to "AMD_OPTERON". |
| boot_volume_id | no | string | Reference to a volume used for booting. If not *null* then `boot_cdrom` has to be *null*. |
| boot_cdrom | no | string | Reference to a CD-ROM used for booting. If not *null* then `boot_volume_id` has to be *null*. |
After retrieving a server, either by ID or as a create response object, you can change its properties and call the `update_server` method:
response = client.update_server(
datacenter_id='UUID',
server_id='UUID',
name='New Name')
---
#### Delete a Server
This will remove a server from a data center. **NOTE**: This will not automatically remove the storage volume(s) attached to a server. A separate operation is required to delete a storage volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
After retrieving a server, either by ID or as a create response object, you can call the `delete_server` method directly on the object:
response = client.delete_server(
datacenter_id='UUID',
server_id='UUID')
---
#### List Attached Volumes
Retrieves a list of volumes attached to the server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
After retrieving a server, either by ID or as a create response object, you can call the `get_attached_volumes` method directly on the object:
response = client.get_attached_volumes(
datacenter_id='UUID',
server_id='UUID')
---
#### Attach a Volume
This will attach a pre-existing storage volume to the server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| volume_id | **yes** | string | The ID of a storage volume. |
After retrieving a server, either by ID or as a create response object, you can call the `attach_volume` method directly on the object:
response = client.attach_volume(
datacenter_id='UUID',
server_id='UUID',
volume_id='UUID')
---
#### Retrieve an Attached Volume
This will retrieve the properties of an attached volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| volume_id | **yes** | string | The ID of the attached volume. |
After retrieving a server, either by ID or as a create response object, you can call the `get_attached_volume` method directly on the object:
response = client.get_attached_volume(
datacenter_id='UUID',
server_id='UUID',
volume_id='UUID')
---
#### Detach a Volume
This will detach the volume from the server. Depending on the volume `hot_unplug` settings, this may result in the server being rebooted.
This will NOT delete the volume from your VDC. You will need to make a separate request to delete a volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| volume_id | **yes** | string | The ID of the attached volume. |
After retrieving a server, either by ID or as a create response object, you can call the `detach_volume` method directly on the object:
response = client.detach_volume(
datacenter_id='UUID',
server_id='UUID',
volume_id='UUID')
---
#### List Attached CD-ROMs
Retrieves a list of CD-ROMs attached to a server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
After retrieving a server, either by ID or as a create response object, you can call the `get_attached_cdroms` method directly on the object:
response = client.get_attached_cdroms(
datacenter_id='UUID',
server_id='UUID')
---
#### Attach a CD-ROM
You can attach a CD-ROM to an existing server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| cdrom_id | **yes** | string | The ID of a CD-ROM. |
After retrieving a server, either by ID or as a create response object, you can call the `attach_cdrom` method directly on the object:
response = client.attach_cdrom(
datacenter_id='UUID',
server_id='UUID',
cdrom_id='UUID')
---
#### Retrieve an Attached CD-ROM
You can retrieve a specific CD-ROM attached to the server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| cdrom_id | **yes** | string | The ID of the attached CD-ROM. |
After retrieving a server, either by ID or as a create response object, you can call the `get_attached_cdrom` method directly on the object:
response = client.get_attached_cdrom(
datacenter_id='UUID',
server_id='UUID',
cdrom_id='UUID')
---
#### Detach a CD-ROM
This will detach a CD-ROM from the server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| cdrom_id | **yes** | string | The ID of the attached CD-ROM. |
After retrieving a server, either by ID or as a create response object, you can call the `detach_cdrom` method directly on the object:
response = client.detach_cdrom(
datacenter_id='UUID',
server_id='UUID',
cdrom_id='UUID')
---
#### Reboot a Server
This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
After retrieving a server, either by ID or as a create response object, you can call the `reboot_server` method directly on the object:
response = client.reboot_server(
datacenter_id='UUID',
server_id='UUID')
---
#### Start a Server
This will start a server. If the server's public IP was deallocated then a new IP will be assigned.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
After retrieving a server, either by ID or as a create response object, you can call the `start_server` method directly on the object:
response = client.start_server(
datacenter_id='UUID',
server_id='UUID')
---
#### Stop a Server
This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
After retrieving a server, either by ID or as a create response object, you can call the `stop_server` method directly on the object:
response = client.stop_server(
datacenter_id='UUID',
server_id='UUID')
---
### Images
#### List Images
Retrieve a list of images.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_images()
---
#### Get an Image
Retrieves the attributes of a specific image.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| image_id | **yes** | string | The ID of the image. |
response = client.get_image('UUID')
---
#### Update an Image
Updates the attributes of a specific user created image. You cannot update the properties of a public image supplied by ProfitBricks.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| image_id | **yes** | string | The ID of the image. |
| name | no | string | The name of the image. |
| description | no | string | The description of the image. |
| licence_type | no | string | The snapshot's licence type: LINUX, WINDOWS, WINDOWS2016, UNKNOWN or OTHER. |
| cpu_hot_plug | no | bool | This volume is capable of CPU hot plug (no reboot required) |
| cpu_hot_unplug | no | bool | This volume is capable of CPU hot unplug (no reboot required) |
| ram_hot_plug | no | bool | This volume is capable of memory hot plug (no reboot required) |
| ram_hot_unplug | no | bool | This volume is capable of memory hot unplug (no reboot required) |
| nic_hot_plug | no | bool | This volume is capable of NIC hot plug (no reboot required) |
| nic_hot_unplug | no | bool | This volume is capable of NIC hot unplug (no reboot required) |
| disc_virtio_hot_plug | no | bool | This volume is capable of VirtIO drive hot plug (no reboot required) |
| disc_virtio_hot_unplug | no | bool | This volume is capable of VirtIO drive hot unplug (no reboot required) |
| disc_scsi_hot_plug | no | bool | This volume is capable of SCSI drive hot plug (no reboot required) |
| disc_scsi_hot_unplug | no | bool | This volume is capable of SCSI drive hot unplug (no reboot required) |
You can change an image's properties by calling the `update_image` method:
response = client.update_image(
image_id='UUID',
name='New Name',
description='New description',
licence_type='LINUX')
---
#### Delete an Image
Deletes a specific user created image. You cannot delete public images supplied by ProfitBricks.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| image_id | **yes** | string | The ID of the image. |
response = client.delete_image('UUID')
---
### Volumes
#### List Volumes
Retrieve a list of volumes within the VDC. If you want to retrieve a list of volumes attached to a server please see the [List Attached Volumes](#list-attached-volumes) entry in the Server section for details.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_volumes(datacenter_id='UUID')
---
#### Get a Volume
Retrieves the attributes of a given volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| volume_id | **yes** | string | The ID of the volume. |
response = client.get_volume(
datacenter_id='UUID',
volume_id='UUID')
---
#### Create a Volume
Creates a volume within the VDC. This will NOT attach the volume to a server. Please see the [Attach a Volume](#attach-a-volume) entry in the Server section for details on how to attach storage volumes.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| name | no | string | The name of the volume. |
| size | **yes** | int | The size of the volume in GB. |
| bus | no | string | The bus type of the volume (VIRTIO or IDE). Default: VIRTIO. |
| image | **yes** | string | The image or snapshot ID. |
| image_alias | **yes** | string | The alias of the image. |
| type | **yes** | string | The volume type, HDD or SSD. |
| licence_type | **yes** | string | The licence type of the volume. Options: LINUX, WINDOWS, WINDOWS2016, UNKNOWN, OTHER |
| image_password | **yes** | string | One-time password is set on the Image for the appropriate root or administrative account. This field may only be set in creation requests. When reading, it always returns *null*. The password has to contain 8-50 characters. Only these characters are allowed: [abcdefghjkmnpqrstuvxABCDEFGHJKLMNPQRSTUVX23456789] |
| ssh_keys | **yes** | string | SSH keys to allow access to the volume via SSH. |
| availability_zone | no | string | The storage availability zone assigned to the volume. Valid values: AUTO, ZONE_1, ZONE_2, or ZONE_3. This only applies to HDD volumes. Leave blank or set to AUTO when provisioning SSD volumes. |
The following table outlines the various licence types you can define:
| Licence Type | Comment |
|---|---|
| WINDOWS2016 | Use this for the Microsoft Windows Server 2016 operating system. |
| WINDOWS | Use this for the Microsoft Windows Server 2008 and 2012 operating systems. |
| LINUX |Use this for Linux distributions such as CentOS, Ubuntu, Debian, etc. |
| OTHER | Use this for any volumes that do not match one of the other licence types. |
| UNKNOWN | This value may be inherited when you've uploaded an image and haven't set the license type. Use one of the options above instead. |
The following table outlines the storage availability zones currently supported:
| Availability Zone | Comment |
|---|---|
| AUTO | Automatically Selected Zone |
| ZONE_1 | Fire Zone 1 |
| ZONE_2 | Fire Zone 2 |
| ZONE_3 | Fire Zone 3 |
**Note:** You will need to provide either the `image`, `image_alias` or the `licence_type` parameters when creating a volume. A `licence_type` is required, but if `image` or `image_alias` is supplied, it is already set and cannot be changed.
Obtain a proper image alias via [List Locations](#list-locations) operation.
**Note:** Either the `image_password` or `ssh_keys` parameters need to be supplied when creating a volume using one of the official ProfitBricks images. Only official ProfitBricks provided images support the `ssh_keys` and `image_password` parameters.
volume = Volume(
name='name',
size=20,
bus='VIRTIO',
type='HDD',
licence_type='LINUX',
availability_zone='ZONE_3')
response = client.create_volume(
datacenter_id='UUID',
volume=volume)
---
#### Update a Volume
You can update -- in full or partially -- various attributes on the volume; however, some restrictions are in place:
You can increase the size of an existing storage volume. You cannot reduce the size of an existing storage volume. The volume size will be increased without requiring a reboot if the relevant hot plug settings have been set to *true*. The additional capacity is not added automatically added to any partition, therefore you will need to handle that inside the OS afterwards. Once you have increased the volume size you cannot decrease the volume size.
Since an existing volume is being modified, none of the request parameters are specifically required as long as the changes being made satisfy the requirements for creating a volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| volume_id | **yes** | string | The ID of the volume. |
| name | no | string | The name of the volume. |
| size | no | int | The size of the volume in GB. Only increase when updating. |
| bus | no | string | The bus type of the volume (VIRTIO or IDE). Default: VIRTIO. |
| image | no | string | The image or snapshot ID. |
| type | no | string | The volume type, HDD or SSD. |
| licence_type | no | string | The licence type of the volume. Options: LINUX, WINDOWS, WINDOWS2016, UNKNOWN, OTHER |
| availability_zone | no | string | The storage availability zone assigned to the volume. Valid values: AUTO, ZONE_1, ZONE_2, or ZONE_3. This only applies to HDD volumes. Leave blank or set to AUTO when provisioning SSD volumes. |
After retrieving a volume, either by ID or as a create response object, you can change its properties and call the `update_volume` method:
response = client.update_volume(
datacenter_id='UUID',
volume_id='UUID',
size=6,
name='New Name')
---
#### Delete a Volume
Deletes the specified volume. This will result in the volume being removed from your data center. Use this with caution.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| volume_id | **yes** | string | The ID of the volume. |
After retrieving a volume, either by ID or as a create response object, you can call the `delete_volume` method directly on the object:
response = client.delete_volume(
datacenter_id='UUID',
volume_id='UUID')
---
#### Create a Volume Snapshot
Creates a snapshot of a volume within the VDC. You can use a snapshot to create a new storage volume or to restore a storage volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| volume_id | **yes** | string | The ID of the volume. |
| name | no | string | The name of the snapshot. |
| description | no | string | The description of the snapshot. |
After retrieving a volume, either by ID or as a create response object, you can call the `create_snapshot` method directly on the object:
response = client.create_snapshot(
datacenter_id='UUID',
volume_id='UUID',
name='Snapshot Name',
description='Snapshot description')
---
#### Restore a Volume Snapshot
This will restore a snapshot onto a volume. A snapshot is created as just another image that can be used to create new volumes or to restore an existing volume.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| volume_id | **yes** | string | The ID of the volume. |
| snapshot_id | **yes** | string | The ID of the snapshot. |
After retrieving a volume, either by ID or as a create response object, you can call the `restore_snapshot` method directly on the object:
response = client.restore_snapshot(
datacenter_id='UUID',
volume_id='UUID',
snapshot_id='UUID')
---
### Snapshots
#### List Snapshots
You can retrieve a list of all available snapshots.
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_snapshots()
---
#### Get a Snapshot
Retrieves the attributes of a specific snapshot.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| snapshot_id | **yes** | string | The ID of the snapshot. |
response = client.get_snapshot(snapshot_id='UUID')
---
#### Update a Snapshot
Perform updates to attributes of a snapshot.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| snapshot_id | **yes** | string | The ID of the snapshot. |
| name | no | string | The name of the snapshot. |
| description | no | string | The description of the snapshot. |
| licence_type | no | string | The snapshot's licence type: LINUX, WINDOWS, WINDOWS2016, UNKNOWN or OTHER. |
| cpu_hot_plug | no | bool | This volume is capable of CPU hot plug (no reboot required) |
| cpu_hot_unplug | no | bool | This volume is capable of CPU hot unplug (no reboot required) |
| ram_hot_plug | no | bool | This volume is capable of memory hot plug (no reboot required) |
| ram_hot_unplug | no | bool | This volume is capable of memory hot unplug (no reboot required) |
| nic_hot_plug | no | bool | This volume is capable of NIC hot plug (no reboot required) |
| nic_hot_unplug | no | bool | This volume is capable of NIC hot unplug (no reboot required) |
| disc_virtio_hot_plug | no | bool | This volume is capable of VirtIO drive hot plug (no reboot required) |
| disc_virtio_hot_unplug | no | bool | This volume is capable of VirtIO drive hot unplug (no reboot required) |
| disc_scsi_hot_plug | no | bool | This volume is capable of SCSI drive hot plug (no reboot required) |
| disc_scsi_hot_unplug | no | bool | This volume is capable of SCSI drive hot unplug (no reboot required) |
After retrieving a snapshot, either by ID or as a create response object, you can change its properties and call the `update_snapshot` method:
response = client.update_snapshot(
snapshot_id='UUID',
name='New Name',
description='New description')
---
#### Delete a Snapshot
Deletes the specified snapshot.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| snapshot_id | **yes** | string | The ID of the snapshot. |
After retrieving a snapshot, either by ID or as a create response object, you can call the `delete_snapshot` method directly on the object:
response = client.delete_snapshot(snapshot_id='deleting_snapshot_id')
---
### IP Blocks
The IP block operations assist with managing reserved /static public IP addresses.
#### List IP Blocks
Retrieve a list of available IP blocks.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_ipblocks()
---
#### Get an IP Block
Retrieves the attributes of a specific IP block.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| ipblock_id | **yes** | string | The ID of the IP block. |
response = client.get_ipblock('UUID')
---
#### Create an IP Block
Creates an IP block. IP blocks are attached to a location, so you must specify a valid `location` along with a `size` parameter indicating the number of IP addresses you want to reserve in the IP block. Servers or other resources using an IP address from an IP block must be in the same `location`.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| location | **yes** | string | This must be one of the locations: us/las, us/ewr, de/fra, de/fkb. |
| size | **yes** | int | The size of the IP block you want. |
| name | no | string | A descriptive name for the IP block |
The following table outlines the locations currently supported:
| Value| Country | City |
|---|---|---|
| us/las | United States | Las Vegas |
| us/ewr | United States | Newark |
| de/fra | Germany | Frankfurt |
| de/fkb | Germany | Karlsruhe |
To create an IP block, establish the parameters and then call `reserve_ipblock`.
ipblock = IPBlock(
name='IP Block Name',
size=4,
location='de/fkb')
response = client.reserve_ipblock(ipblock)
---
#### Delete an IP Block
Deletes the specified IP Block.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| ipblock_id | **yes** | string | The ID of the IP block. |
After retrieving an IP block, either by ID or as a create response object, you can call the `delete_ipblock` method directly on the object:
response = client.delete_ipblock('UUID')
---
### LANs
#### List LANs
Retrieve a list of LANs within the VDC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_lans(datacenter_id='UUID')
---
#### Create a LAN
Creates a LAN within a VDC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| name | no | string | The name of your LAN. |
| public | **Yes** | bool | Boolean indicating if the LAN faces the public Internet or not. |
| nics | no | list | A list of NICs associated with the LAN. |
response = client.create_lan(
datacenter_id='UUID',
name='LAN Name',
public=False)
---
#### Get a LAN
Retrieves the attributes of a given LAN.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| lan_id | **yes** | int | The ID of the LAN. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_lan(
datacenter_id='UUID',
lan_id=ID)
---
#### Get LAN Members
Retrieves the list of NICs that are part of the LAN.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| lan_id | **yes** | int | The ID of the LAN. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_lan_members(
datacenter_id='UUID',
lan_id=ID)
---
#### Update a LAN
Perform updates to attributes of a LAN.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| lan_id | **yes** | int | The ID of the LAN. |
| name | no | string | A descriptive name for the LAN. |
| public | no | bool | Boolean indicating if the LAN faces the public Internet or not. |
| ip_failover | no | list | A list of IP fail-over dicts. |
After retrieving a LAN, either by ID or as a create response object, you can change its properties and call the `update_lan` method:
ip_failover = dict()
ip_failover['ip'] = 'IP_address'
ip_failover['nicUuid'] = 'UUID'
response = client.update_lan(
datacenter_id='UUID',
lan_id=ID,
name='New LAN Name',
public=True,
ip_failover=[ip_failover])
---
#### Delete a LAN
Deletes the specified LAN.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| lan_id | **yes** | string | The ID of the LAN. |
After retrieving a LAN, either by ID or as a create response object, you can call the `delete_lan` method directly on the object:
response = client.delete_lan(
datacenter_id='datacenter_id',
lan_id=ID)
---
### Network Interfaces (NICs)
#### List NICs
Retrieve a list of LANs within the VDC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_nics(
datacenter_id='UUID',
server_id='UUID')
---
#### Get a NIC
Retrieves the attributes of a given NIC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| nic_id | **yes** | string | The ID of the NIC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_nic(
datacenter_id='UUID',
server_id='UUID',
nic_id='UUID')
---
#### Create a NIC
Adds a NIC to the target server.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string| The ID of the server. |
| name | no | string | The name of the NIC. |
| ips | no | list | IP addresses assigned to the NIC. |
| dhcp | no | bool | Set to *false* if you wish to disable DHCP on the NIC. Default: *true*. |
| lan | **yes** | int | The LAN ID the NIC will sit on. If the LAN ID does not exist it will be created. |
| nat | no | bool | Indicates the private IP address has outbound access to the public internet. |
| firewall_active | no | bool | Set this to *true* to enable the ProfitBricks firewall, *false* to disable. |
| firewall_rules | no | list | A list of firewall rules associated with the NIC. |
nic = NIC(
name='NIC Name',
dhcp=True,
lan=1,
nat=False)
response = client.create_nic(
datacenter_id='UUID',
server_id='UUID',
nic=nic)
---
#### Update a NIC
You can update -- in full or partially -- various attributes on the NIC; however, some restrictions are in place:
The primary address of a NIC connected to a load balancer can only be changed by changing the IP of the load balancer. You can also add additional reserved, public IPs to the NIC.
The user can specify and assign private IPs manually. Valid IP addresses for private networks are 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string| The ID of the server. |
| nic_id | **yes** | string| The ID of the NIC. |
| name | no | string | The name of the NIC. |
| ips | no | list | IPs assigned to the NIC represented as a list of strings. |
| dhcp | no | bool | Boolean value that indicates if the NIC is using DHCP or not. |
| lan | no | int | The LAN ID the NIC sits on. |
| nat | no | bool | Indicates the private IP address has outbound access to the public internet. |
| firewall_active | no | bool | Set this to *true* to enable the ProfitBricks firewall, *false* to disable. |
After retrieving a NIC, either by ID or as a create response object, you can call the `update_nic` method directly on the object:
response = client.update_nic(
datacenter_id='UUID',
server_id='UUID',
nic_id='UUID',
name='New Name')
---
#### Delete a NIC
Deletes the specified NIC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string| The ID of the server. |
| nic_id | **yes** | string| The ID of the NIC. |
After retrieving a NIC, either by ID or as a create response object, you can call the `delete_nic` method directly on the object:
response = client.delete_nic(
datacenter_id='UUID',
server_id='UUID',
nic_id='UUID')
---
### Firewall Rules
#### List Firewall Rules
Retrieves a list of firewall rules associated with a particular NIC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| nic_id | **yes** | string | The ID of the NIC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_firewall_rules(
datacenter_id='UUID',
server_id='UUID',
nic_id='UUID')
---
#### Get a Firewall Rule
Retrieves the attributes of a given firewall rule.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| nic_id | **yes** | string | The ID of the NIC. |
| firewall_rule_id | **yes** | string | The ID of the firewall rule. |
response = client.get_firewall_rule(
datacenter_id='UUID',
loadbalancer_id='UUID',
nic_id='UUID',
firewall_rule_id='UUID')
---
#### Create a Firewall Rule
This will add a firewall rule to the NIC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| nic_id | **yes** | string | The ID of the NIC. |
| name | no | string | The name of the firewall rule. |
| protocol | **yes** | string | The protocol for the rule: TCP, UDP, ICMP, ANY. |
| source_mac | no | string | Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee:ff. A *null* value allows all source MAC address. |
| source_ip | no | string | Only traffic originating from the respective IPv4 address is allowed. A *null* value allows all source IPs. |
| target_ip | no | string | In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed. A *null* value allows all target IPs. |
| port_range_start | no | string | Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen. Leave `port_range_start` and `port_range_end` value as *null* to allow all ports. |
| port_range_end | no | string | Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen. Leave `port_range_start` and `port_range_end` value as *null* to allow all ports. |
| icmp_type | no | string | Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. A *null* value allows all types. |
| icmp_code | no | string | Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. A *null* value allows all codes. |
fwrule = FirewallRule(
name='Allow SSH',
protocol='TCP',
source_mac='01:23:45:67:89:00',
port_range_start=22,
port_range_end=22)
response = client.create_firewall_rule(
datacenter_id='UUID',
loadbalancer_id='UUID',
nic_id='UUID',
firewall_rule=fwrule)
---
#### Update a Firewall Rule
Perform updates to attributes of a firewall rule.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| nic_id | **yes** | string | The ID of the NIC. |
| firewall_rule_id | **yes** | string | The ID of the firewall rule. |
| name | no | string | The name of the firewall rule. |
| source_mac | no | string | Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee:ff. A *null* value allows all source MAC address. |
| source_ip | no | string | Only traffic originating from the respective IPv4 address is allowed. A *null* value allows all source IPs. |
| target_ip | no | string | In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed. A *null* value allows all target IPs. |
| port_range_start | no | string | Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen. Leave `port_range_start` and `port_range_end` value as *null* to allow all ports. |
| port_range_end | no | string | Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen. Leave `port_range_start` and `port_range_end` value as *null* to allow all ports. |
| icmp_type | no | string | Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. A *null* value allows all types. |
| icmp_code | no | string | Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. A *null* value allows all codes. |
After retrieving a firewall rule, either by ID or as a create response object, you can change its properties and call the `update_firewall_rule` method:
response = client.update_firewall_rule(
datacenter_id='UUID',
loadbalancer_id='UUID',
nic_id='UUID',
firewall_rule_id='UUID',
name="Updated Name")
---
#### Delete a Firewall Rule
Removes the specific firewall rule.
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| server_id | **yes** | string | The ID of the server. |
| nic_id | **yes** | string | The ID of the NIC. |
| firewall_rule_id | **yes** | string | The ID of the firewall rule. |
After retrieving a firewall rule, either by ID or as a create response object, you can call the `delete_firewall_rule` method directly on the object:
response = client.delete_firewall_rule(
datacenter_id='UUID',
server_id='UUID',
nic_id='UUID',
firewall_rule_id='UUID')
---
### Load Balancers
#### List Load Balancers
Retrieve a list of load balancers within the data center.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_loadbalancers(datacenter_id='UUID')
---
#### Get a Load Balancer
Retrieves the attributes of a given load balancer.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| loadbalancer_id | **yes** | string | The ID of the load balancer. |
response = client.get_loadbalancer(
datacenter_id='UUID',
loadbalancer_id='UUID')
---
#### Create a Load Balancer
Creates a load balancer within the VDC. Load balancers can be used for public or private IP traffic.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| name | **yes** | string | The name of the load balancer. |
| ip | no | string | IPv4 address of the load balancer. All attached NICs will inherit this IP. |
| dhcp | no | bool | Indicates if the load balancer will reserve an IP using DHCP. |
| balancednics | no | list | List of NICs taking part in load-balancing. All balanced NICs inherit the IP of the load balancer. |
loadbalancer = LoadBalancer(
name='Load Balancer Name',
dhcp=True)
response = client.create_loadbalancer(
datacenter_id='UUID',
loadbalancer=loadbalancer)
---
#### Update a Load Balancer
Perform updates to attributes of a load balancer.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| name | no | string | The name of the load balancer. |
| ip | no | string | The IP of the load balancer. |
| dhcp | no | bool | Indicates if the load balancer will reserve an IP using DHCP. |
After retrieving a load balancer, either by ID or as a create response object, you can change it's properties and call the `update_loadbalancer` method:
response = client.update_loadbalancer(
datacenter_id='UUID',
loadbalancer_id='UUID',
name="New Name")
---
#### Delete a Load Balancer
Deletes the specified load balancer.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| load_balancer_id | **yes** | string | The ID of the load balancer. |
After retrieving a load balancer, either by ID or as a create response object, you can call the `delete_loadbalancer` method directly on the object:
response = client.delete_loadbalancer(
datacenter_id='UUID',
loadbalancer_id='UUID')
---
#### List Load Balanced NICs
This will retrieve a list of NICs associated with the load balancer.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| loadbalancer_id | **yes** | string | The ID of the load balancer. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
After retrieving a load balancer, either by ID or as a create response object, you can call the `get_loadbalancer_members` method directly on the object:
response = client.get_loadbalancer_members(
datacenter_id='UUID',
loadbalancer_id='UUID')
---
#### Get a Load Balanced NIC
Retrieves the attributes of a given load balanced NIC.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| loadbalancer_id | **yes** | string | The ID of the load balancer. |
| nic_id | **yes** | string | The ID of the NIC. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
After retrieving a load balancer, either by ID or as a create response object, you can call the `get_loadbalanced_nic` method directly on the object:
response = client.get_loadbalanced_nic(
datacenter_id='UUID',
loadbalancer_id='UUID',
nic_id='UUID')
---
#### Associate NIC to a Load Balancer
This will associate a NIC to a load balancer, enabling the NIC to participate in load-balancing.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| loadbalancer_id | **yes** | string | The ID of the load balancer. |
| nic_id | **yes** | string | The ID of the NIC. |
After retrieving a load balancer, either by ID or as a create response object, you can call the `add_loadbalanced_nics` method directly on the object:
response = client.add_loadbalanced_nics(
datacenter_id='UUID',
loadbalancer_id='UUID',
nic_id='UUID')
---
#### Remove a NIC Association
Removes the association of a NIC with a load balancer.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| datacenter_id | **yes** | string | The ID of the VDC. |
| loadbalancer_id | **yes** | string | The ID of the load balancer. |
| nic_id | **yes** | string | The ID of the load balancer. |
After retrieving a load balancer, either by ID or as a create response object, you can call the `remove_loadbalanced_nic` method directly on the object:
response = client.remove_loadbalanced_nic(
datacenter_id='UUID',
loadbalancer_id='UUID',
nic_id='UUID')
---
### User Management
#### List Groups
Retrieves a list of all groups.
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_groups()
---
#### Get a Group
Retrieves the attributes of a given group.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_group(group_id='UUID')
---
#### Create a Group
Creates a new group and set group privileges.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| name | **yes** | string | The ID of the group. |
| create_datacenter | no | bool | Indicates if the group is allowed to create virtual data centers. |
| create_snapshot | no | bool | Indicates if the group is allowed to create snapshots. |
| reserve_ip | no | bool | Indicates if the group is allowed to reserve IP addresses. |
| access_activity_log | no | bool | Indicates if the group is allowed to access activity log. |
group = Group(
name='my-group',
create_datacenter=True,
create_snapshot=False,
reserve_ip=True,
access_activity_log=False)
response = client.create_group(group)
---
#### Update a Group
Updates a group's name or privileges.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| name | **yes** | string | The ID of the group. |
| create_datacenter | no | bool | Indicates if the group is allowed to create virtual data centers. |
| create_snapshot | no | bool | Indicates if the group is allowed to create snapshots. |
| reserve_ip | no | bool | Indicates if the group is allowed to reserve IP addresses. |
| access_activity_log | no | bool | Indicates if the group is allowed to access activity log. |
response = client.update_group(
group_id='UUID',
name='my-group',
create_datacenter=False,
create_snapshot=True,
reserve_ip=False,
access_activity_log=True)
---
#### Delete a Group
Deletes the specified group.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
response = client.delete_group(group_id='UUID')
---
#### List Shares
Retrieves a list of all shares though a group.
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_shares(group_id='UUID')
---
#### Get a Share
Retrieves a specific resource share available to a group.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| resource_id | **yes** | string | The ID of the resource. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_share(
group_id='UUID',
resource_id='UUID')
---
#### Add a Share
Shares a resource through a group.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| resource_id | **yes** | string | The ID of the resource. |
| edit_privilege | no | string | Indicates that the group has permission to edit privileges on the resource. |
| share_privilege | no | string | Indicates that the group has permission to share the resource. |
response = client.add_share(
group_id='UUID',
resource_id='UUID',
edit_privilege=True,
share_privilege=True)
---
#### Update a Share
Updates the permissions of a group for a resource share.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| resource_id | **yes** | string | The ID of the resource. |
| edit_privilege | no | string | Indicates that the group has permission to edit privileges on the resource. |
| share_privilege | no | string | Indicates that the group has permission to share the resource. |
response = client.update_share(
group_id='UUID',
resource_id='UUID',
edit_privilege=True,
share_privilege=True)
---
#### Delete a Share
Removes a resource share from a group.
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| resource_id | **yes** | string | The ID of the resource. |
response = client.delete_share(
group_id='UUID',
resource_id='UUID')
---
#### List Users
Retrieves a list of all users.
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_users()
---
#### Get a User
Retrieves a single user.
| Name | Required | Type | Description |
|---|:-:|---|---|
| user_id | **yes** | string | The ID of the user. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_user(user_id='UUID')
---
#### Create a User
Creates a new user.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| firstname | **yes** | string | A name for the user. |
| lastname | **yes** | bool | A name for the user. |
| email | **yes** | bool | An e-mail address for the user. |
| password | **yes** | bool | A password for the user. |
| administrator | no | bool | Assigns the user have administrative rights. |
| force_sec_auth | no | bool | Indicates if secure (two-factor) authentication should be forced for the user. |
user = User(
firstname='John',
lastname='Doe',
email='no-reply@example.com',
password='secretpassword123',
administrator=True,
force_sec_auth=False)
response = client.create_user(user)
---
#### Update a User
Updates an existing user.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| user_id | **yes** | string | The ID of the user. |
| firstname | **yes** | string | A name for the user. |
| lastname | **yes** | bool | A name for the user. |
| email | **yes** | bool | An e-mail address for the user. |
| administrator | **yes** | bool | Assigns the user have administrative rights. |
| force_sec_auth | **yes** | bool | Indicates if secure (two-factor) authentication should be forced for the user. |
response = client.update_user(
user_id='UUID',
firstname='John',
lastname='Doe',
email='no-reply@example.com',
administrator=True,
force_sec_auth=False)
---
#### Delete a User
Removes a user.
| Name | Required | Type | Description |
|---|:-:|---|---|
| user_id | **yes** | string | The ID of the user. |
response = client.delete_user(user_id='UUID')
---
#### List Users in a Group
Retrieves a list of all users that are members of a particular group.
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_group_users(group_id='UUID')
---
#### Add User to Group
Adds an existing user to a group.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| user_id | **yes** | string | The ID of the user. |
response = client.add_group_user(
group_id='UUID',
user_id='UUID')
---
#### Remove User from a Group
Removes a user from a group.
| Name | Required | Type | Description |
|---|:-:|---|---|
| group_id | **yes** | string | The ID of the group. |
| user_id | **yes** | string | The ID of the user. |
response = client.remove_group_user(
group_id='UUID',
user_id='UUID')
---
#### List Resources
Retrieves a list of all resources. Alternatively, Retrieves all resources of a particular type.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| resource_type | no | string | The resource type: `datacenter`, `image`, `snapshot` or `ipblock`. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_resources()
response = client.list_resources(resource_type='snapshot')
---
#### Get a Resource
Retrieves a single resource of a particular type.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| resource_type | **yes** | string | The resource type: `datacenter`, `image`, `snapshot` or `ipblock`. |
| resource_id | **yes** | string | The ID of the resource. |
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.get_resource(resource_id='UUID')
response = client.get_resource(
resource_type='datacenter',
resource_id='UUID')
---
### Contract Resources
#### List Contract Resources
Retrieves information about the resource limits for a particular contract and the current resource usage.
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_contracts()
---
### Requests
Each call to the ProfitBricks Cloud API is assigned a request ID. These operations can be used to get information about the requests that have been submitted and their current status.
#### List Requests
Retrieve a list of requests.
| Name | Required | Type | Description |
|---|:-:|---|---|
| depth | no | int | An integer value of 0 - 5 that affects the amount of detail returned. |
response = client.list_requests()
---
#### Get a Request
Retrieves the attributes of a specific request. This operation shares the same `get_request` method used for getting request status, however the response it determined by the boolean value you pass for *status*. To get details about the request itself, you want to pass a *status* of *False*.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| request_id | **yes** | string | The ID of the request. |
| status | **yes** | bool | Set to *False* to have the request details returned. |
response = client.get_request(
request_id='UUID',
status=False)
---
#### Get a Request Status
Retrieves the status of a request. This operation shares the same `get_request` method used for getting the details of a request, however the response it determined by the boolean value you pass for *status*. To get the request status, you want to pass a *status* of *True*.
The following table describes the request arguments:
| Name | Required | Type | Description |
|---|:-:|---|---|
| request_id | **yes** | string | The ID of the request. |
| status | **yes** | boolean | Set to *True* to have the status of the request returned. |
response = client.get_request(
request_id='UUID',
status=True)
---
## Examples
Below are some examples using the SDK for Python. These examples will assume credentials are being set with environment variables:
export PROFITBRICKS_USERNAME=username
export PROFITBRICKS_PASSWORD=password
### List All Data Centers
This simple example will list all data centers under an account.
#!/usr/bin/python
import json
import os
from profitbricks.client import ProfitBricksService
# Instatiate ProfitBricks connection
client = ProfitBricksService(
username=os.getenv('PROFITBRICKS_USERNAME'),
password=os.getenv('PROFITBRICKS_PASSWORD'))
# List data centers
datacenters = client.list_datacenters()
print json.dumps(datacenters, indent=4)
### Search for Images
The following example will provide a method for retrieving a list of images based on a partial case-insensitive name and location match.
#!/usr/bin/python
import os
from profitbricks.client import ProfitBricksService
def find_image(conn, name, location):
'''
Find image by partial name and location
'''
images = []
for item in conn.list_images()['items']:
if (item['properties']['location'] == location and
item['properties']['imageType'] == 'HDD' and
name.lower() in item['properties']['name'].lower()):
images.append(item)
return images
# Instantiate ProfitBricks connection
client = ProfitBricksService(
username=os.getenv('PROFITBRICKS_USERNAME'),
password=os.getenv('PROFITBRICKS_PASSWORD'))
# Search criteria based on partial case-insensitive name and location
name = 'Ubuntu'
location = 'de/fkb'
# Find images based on above search criteria
for image in find_image(client, name, location):
print "{0}\t{1}\t{2}".format(
image['id'],
image['properties']['name'],
image['properties']['location'])
### Reserve an IP Block
Here we will reserve a public IP block.
#!/usr/bin/python
import json
import os
from profitbricks.client import ProfitBricksService, IPBlock
# Instatiate ProfitBricks connection
client = ProfitBricksService(
username=os.getenv('PROFITBRICKS_USERNAME'),
password=os.getenv('PROFITBRICKS_PASSWORD'))
ipblock = IPBlock(location='us/las', size=5)
response = client.reserve_ipblock(ipblock)
print json.dumps(response, indent=4)
### Wait for Resources
The remaining examples will require dependent resources. A volume cannot be attached to a server before the server and volume are finished provisioning. Therefore, we require the `wait_for_completion` method that will stop and wait for the server and volume to finish provisioning before attaching the volume to the server.
### Component Build
ProfitBricks allows servers to be built by their individual components. That is, by connecting customized components such as servers, volumes, and NICs together. For example, a server can be provisioned in one request followed by one or more NICs and volumes in following requests. The volumes can then be attached separately to the server.
It is important to note that you will need to wait for each individual component to finish provisioning before it can be used in subsequent operations. This behavior is demonstrated below.
#!/usr/bin/python
import json
import os
from profitbricks.client import ProfitBricksService
from profitbricks.client import (
Datacenter, LAN, Server, NIC, Volume, FirewallRule)
client = ProfitBricksService(
username=os.getenv('PROFITBRICKS_USERNAME'),
password=os.getenv('PROFITBRICKS_PASSWORD'))
timeout = 1800
# Create data center
datacenter = Datacenter(
name='Python SDK Data Center',
description='Python SDK data center',
location='us/las')
response = client.create_datacenter(datacenter=datacenter)
client.wait_for_completion(response, timeout)
datacenter_id = response['id']
# Create public LAN
lan = LAN(name="Public LAN", public=True)
response = client.create_lan(datacenter_id, lan=lan)
client.wait_for_completion(response, timeout)
lan_id = response['id']
# Create server
server = Server(
name='Python SDK Server',
ram=4096,
cores=4,
cpu_family='INTEL_XEON')
response = client.create_server(datacenter_id=datacenter_id, server=server)
client.wait_for_completion(response, timeout)
server_id = response['id']
# Create public NIC
nic = NIC(
name='Public NIC',
dhcp=True,
lan=lan_id,
firewall_active=True,
nat=False)
response = client.create_nic(
datacenter_id=datacenter_id,
server_id=server_id,
nic=nic)
client.wait_for_completion(response, timeout)
nic_id = response['id']
# Create firwall rule
fwrule = FirewallRule(
name='Allow SSH',
protocol='TCP',
source_ip='0.0.0.0',
port_range_start=22,
port_range_end=22,
icmp_type=None)
response = client.create_firewall_rule(
datacenter_id=datacenter_id,
server_id=server_id,
nic_id=nic_id,
firewall_rule=fwrule)
client.wait_for_completion(response, timeout)
# Create system volume
volume1 = Volume(
name='System Volume',
size=20,
image='0d4f97f0-1689-11e7-97ce-525400f64d8d',
bus='VIRTIO',
type='HDD',
ssh_keys=['ssh-rsa AAAAB3NzaC1yc2EAAAADAQ...'],
image_password='s3cr3tpass0rd',
availability_zone='ZONE_3')
response = client.create_volume(
datacenter_id=datacenter_id,
volume=volume1)
client.wait_for_completion(response, timeout)
volume1_id = response['id']
# Attach system volume
response = client.attach_volume(
datacenter_id=datacenter_id,
server_id=server_id,
volume_id=volume1_id)
client.wait_for_completion(response, timeout)
# Create data volume
volume2 = Volume(
name='Data Volume',
size=100,
type='SSD',
bus='VIRTIO',
license_type='OTHER')
response = client.create_volume(
datacenter_id=datacenter_id,
volume=volume2)
client.wait_for_completion(response, timeout)
volume2_id = response['id']
# Attach data volume
response = client.attach_volume(
datacenter_id=datacenter_id,
server_id=server_id,
volume_id=volume2_id)
client.wait_for_completion(response, timeout)
live_datacenter = client.get_datacenter(datacenter_id=datacenter_id, depth=5)
print json.dumps(live_datacenter, indent=4)
### Composite Build
The ProfitBricks platform also allows fully operational servers to be provisioned with a single request. This is accomplished by nesting related resources.
Multiple servers, volumes, LANs, and load balancers can be nested under a data center, multiple NICs and volumes can be nested under servers, and firewall rules under NICs.
This example will demonstrate composite resources.
#!/usr/bin/python
import json
import os
from profitbricks.client import ProfitBricksService
from profitbricks.client import Datacenter, Server, NIC, Volume, FirewallRule
# Instatiate ProfitBricks connection
client = ProfitBricksService(
username=os.getenv('PROFITBRICKS_USERNAME'),
password=os.getenv('PROFITBRICKS_PASSWORD'))
# Define a firewall rule
fwrule1 = FirewallRule(
name='Allow SSH',
protocol='TCP',
source_ip='0.0.0.0',
port_range_start=22,
port_range_end=22,
icmp_type=None)
# Define a public NIC
nic1 = NIC(
name='Public NIC',
dhcp=True,
lan=1,
firewall_active=True,
firewall_rules=[fwrule1],
nat=False)
# Define a private NIC
nic2 = NIC(
name='Private NIC',
dhcp=True,
lan=2)
# Define a system volume
volume1 = Volume(
name='System Volume',
size=20,
image='0d4f97f0-1689-11e7-97ce-525400f64d8d',
bus='VIRTIO',
type='HDD',
ssh_keys=['ssh-rsa AAAAB3NzaC1yc2EAAAADAQ...'],
image_password='s3cr3tpass0rd',
availability_zone='ZONE_3')
# Define a data volume
volume2 = Volume(
name='Data Volume',
size=100,
type='SSD',
bus='VIRTIO',
licence_type='OTHER')
# Define a server with associated NICs and volumes
server = Server(
name='Python SDK Server',
ram=4096,
cores=4,
cpu_family='INTEL_XEON',
nics=[nic1, nic2],
create_volumes=[volume1, volume2])
# Define a data center with the server
datacenter = Datacenter(
name='Python SDK Data Center',
description='Python SDK data center',
location='us/las',
servers=[server])
# Initiate the data center and nested resource provisioning
response = client.create_datacenter(datacenter)
# Wait for the data center and nested resources to finish provisioning
client.wait_for_completion(response)
datacenter_id = response['id']
# Set the first LAN to public
response = client.update_lan(
datacenter_id=datacenter_id,
lan_id=1,
name='Public LAN',
public=True)
client.wait_for_completion(response)
# Print the data center properties and nested resources
response = client.get_datacenter(datacenter_id=datacenter_id, depth=5)
print json.dumps(response, indent=4)
## Support
You can find additional examples in the repository `examples` directory. If you find any issues, please let us know via the [DevOps Central community](https://devops.profitbricks.com) or [GitHub's issue system](https://github.com/profitbricks/profitbricks-sdk-python/issues) and we'll check it out.
## Testing
You can find a full list of tests inside the `tests` folder. To run all available tests:
export PROFITBRICKS_USERNAME=username
export PROFITBRICKS_PASSWORD=password
pip install -r requirements.txt
python -m unittest discover tests
To run a single test:
python -m unittest discover tests test_datacenter.py
## Contributing
1. Fork it ( https://github.com/profitbricks/profitbricks-sdk-python/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
Keywords: profitbricks api client cloud
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Internet :: WWW/HTTP
|