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 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443
|
# 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 typing as ty
from openstack import exceptions
from openstack.network.v2 import _base
from openstack.network.v2 import address_group as _address_group
from openstack.network.v2 import address_scope as _address_scope
from openstack.network.v2 import agent as _agent
from openstack.network.v2 import (
auto_allocated_topology as _auto_allocated_topology,
)
from openstack.network.v2 import availability_zone
from openstack.network.v2 import bgp_peer as _bgp_peer
from openstack.network.v2 import bgp_speaker as _bgp_speaker
from openstack.network.v2 import bgpvpn as _bgpvpn
from openstack.network.v2 import (
bgpvpn_network_association as _bgpvpn_network_association,
)
from openstack.network.v2 import (
bgpvpn_port_association as _bgpvpn_port_association,
)
from openstack.network.v2 import (
bgpvpn_router_association as _bgpvpn_router_association,
)
from openstack.network.v2 import (
default_security_group_rule as _default_security_group_rule,
)
from openstack.network.v2 import extension
from openstack.network.v2 import firewall_group as _firewall_group
from openstack.network.v2 import firewall_policy as _firewall_policy
from openstack.network.v2 import firewall_rule as _firewall_rule
from openstack.network.v2 import flavor as _flavor
from openstack.network.v2 import floating_ip as _floating_ip
from openstack.network.v2 import health_monitor as _health_monitor
from openstack.network.v2 import l3_conntrack_helper as _l3_conntrack_helper
from openstack.network.v2 import listener as _listener
from openstack.network.v2 import load_balancer as _load_balancer
from openstack.network.v2 import local_ip as _local_ip
from openstack.network.v2 import local_ip_association as _local_ip_association
from openstack.network.v2 import metering_label as _metering_label
from openstack.network.v2 import metering_label_rule as _metering_label_rule
from openstack.network.v2 import ndp_proxy as _ndp_proxy
from openstack.network.v2 import network as _network
from openstack.network.v2 import network_ip_availability
from openstack.network.v2 import (
network_segment_range as _network_segment_range,
)
from openstack.network.v2 import pool as _pool
from openstack.network.v2 import pool_member as _pool_member
from openstack.network.v2 import port as _port
from openstack.network.v2 import port_binding as _port_binding
from openstack.network.v2 import port_forwarding as _port_forwarding
from openstack.network.v2 import (
qos_bandwidth_limit_rule as _qos_bandwidth_limit_rule,
)
from openstack.network.v2 import (
qos_dscp_marking_rule as _qos_dscp_marking_rule,
)
from openstack.network.v2 import (
qos_minimum_bandwidth_rule as _qos_minimum_bandwidth_rule,
)
from openstack.network.v2 import (
qos_minimum_packet_rate_rule as _qos_minimum_packet_rate_rule,
)
from openstack.network.v2 import qos_policy as _qos_policy
from openstack.network.v2 import qos_rule_type as _qos_rule_type
from openstack.network.v2 import quota as _quota
from openstack.network.v2 import rbac_policy as _rbac_policy
from openstack.network.v2 import router as _router
from openstack.network.v2 import security_group as _security_group
from openstack.network.v2 import security_group_rule as _security_group_rule
from openstack.network.v2 import segment as _segment
from openstack.network.v2 import service_profile as _service_profile
from openstack.network.v2 import service_provider as _service_provider
from openstack.network.v2 import sfc_flow_classifier as _sfc_flow_classifier
from openstack.network.v2 import sfc_port_chain as _sfc_port_chain
from openstack.network.v2 import sfc_port_pair as _sfc_port_pair
from openstack.network.v2 import sfc_port_pair_group as _sfc_port_pair_group
from openstack.network.v2 import sfc_service_graph as _sfc_sservice_graph
from openstack.network.v2 import subnet as _subnet
from openstack.network.v2 import subnet_pool as _subnet_pool
from openstack.network.v2 import tap_flow as _tap_flow
from openstack.network.v2 import tap_mirror as _tap_mirror
from openstack.network.v2 import tap_service as _tap_service
from openstack.network.v2 import trunk as _trunk
from openstack.network.v2 import vpn_endpoint_group as _vpn_endpoint_group
from openstack.network.v2 import vpn_ike_policy as _ike_policy
from openstack.network.v2 import vpn_ipsec_policy as _ipsec_policy
from openstack.network.v2 import (
vpn_ipsec_site_connection as _ipsec_site_connection,
)
from openstack.network.v2 import vpn_service as _vpn_service
from openstack import proxy
from openstack import resource
class Proxy(proxy.Proxy):
_resource_registry = {
"address_group": _address_group.AddressGroup,
"address_scope": _address_scope.AddressScope,
"agent": _agent.Agent,
"auto_allocated_topology": (
_auto_allocated_topology.AutoAllocatedTopology
),
"availability_zone": availability_zone.AvailabilityZone,
"bgp_peer": _bgp_peer.BgpPeer,
"bgp_speaker": _bgp_speaker.BgpSpeaker,
"bgpvpn": _bgpvpn.BgpVpn,
"bgpvpn_network_association": (
_bgpvpn_network_association.BgpVpnNetworkAssociation
),
"bgpvpn_port_association": (
_bgpvpn_port_association.BgpVpnPortAssociation
),
"bgpvpn_router_association": (
_bgpvpn_router_association.BgpVpnRouterAssociation
),
"default_security_group_rule": (
_default_security_group_rule.DefaultSecurityGroupRule
),
"extension": extension.Extension,
"firewall_group": _firewall_group.FirewallGroup,
"firewall_policy": _firewall_policy.FirewallPolicy,
"firewall_rule": _firewall_rule.FirewallRule,
"flavor": _flavor.Flavor,
"floating_ip": _floating_ip.FloatingIP,
"health_monitor": _health_monitor.HealthMonitor,
"l3_conntrack_helper": _l3_conntrack_helper.ConntrackHelper,
"listener": _listener.Listener,
"load_balancer": _load_balancer.LoadBalancer,
"local_ip": _local_ip.LocalIP,
"local_ip_association": _local_ip_association.LocalIPAssociation,
"metering_label": _metering_label.MeteringLabel,
"metering_label_rule": _metering_label_rule.MeteringLabelRule,
"ndp_proxy": _ndp_proxy.NDPProxy,
"network": _network.Network,
"network_ip_availability": (
network_ip_availability.NetworkIPAvailability
),
"network_segment_range": _network_segment_range.NetworkSegmentRange,
"pool": _pool.Pool,
"pool_member": _pool_member.PoolMember,
"port": _port.Port,
"port_forwarding": _port_forwarding.PortForwarding,
"qos_bandwidth_limit_rule": (
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule
),
"qos_dscp_marking_rule": _qos_dscp_marking_rule.QoSDSCPMarkingRule,
"qos_minimum_bandwidth_rule": (
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule
),
"qos_minimum_packet_rate_rule": (
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule
),
"qos_policy": _qos_policy.QoSPolicy,
"qos_rule_type": _qos_rule_type.QoSRuleType,
"quota": _quota.Quota,
"rbac_policy": _rbac_policy.RBACPolicy,
"router": _router.Router,
"security_group": _security_group.SecurityGroup,
"security_group_rule": _security_group_rule.SecurityGroupRule,
"segment": _segment.Segment,
"service_profile": _service_profile.ServiceProfile,
"service_provider": _service_provider.ServiceProvider,
"sfc_flow_classifier": _sfc_flow_classifier.SfcFlowClassifier,
"sfc_port_chain": _sfc_port_chain.SfcPortChain,
"sfc_port_pair": _sfc_port_pair.SfcPortPair,
"sfc_port_pair_group": _sfc_port_pair_group.SfcPortPairGroup,
"sfc_service_graph": _sfc_sservice_graph.SfcServiceGraph,
"subnet": _subnet.Subnet,
"subnet_pool": _subnet_pool.SubnetPool,
"tap_flow": _tap_flow.TapFlow,
"tap_mirror": _tap_mirror.TapMirror,
"tap_service": _tap_service.TapService,
"trunk": _trunk.Trunk,
"vpn_endpoint_group": _vpn_endpoint_group.VpnEndpointGroup,
"vpn_ike_policy": _ike_policy.VpnIkePolicy,
"vpn_ipsec_policy": _ipsec_policy.VpnIpsecPolicy,
"vpn_ipsec_site_connection": (
_ipsec_site_connection.VpnIPSecSiteConnection
),
"vpn_service": _vpn_service.VpnService,
}
@proxy._check_resource(strict=False)
def _update(
self,
resource_type: type[resource.ResourceT],
value: ty.Union[str, resource.ResourceT],
base_path: ty.Optional[str] = None,
if_revision: ty.Optional[int] = None,
**attrs: ty.Any,
) -> resource.ResourceT:
if (
issubclass(resource_type, _base.NetworkResource)
and if_revision is not None
):
attrs.update({'if_match': f'revision_number={if_revision}'})
res = self._get_resource(resource_type, value, **attrs)
return res.commit(self, base_path=base_path)
@proxy._check_resource(strict=False)
def _delete(
self,
resource_type: type[resource.ResourceT],
value: ty.Union[str, resource.ResourceT],
ignore_missing: bool = True,
if_revision: ty.Optional[int] = None,
**attrs: ty.Any,
) -> ty.Optional[resource.ResourceT]:
if (
issubclass(resource_type, _base.NetworkResource)
and if_revision is not None
):
attrs.update({'if_match': f'revision_number={if_revision}'})
res = self._get_resource(resource_type, value, **attrs)
try:
rv = res.delete(self)
except exceptions.NotFoundException:
if ignore_missing:
return None
raise
return rv
def create_address_group(self, **attrs):
"""Create a new address group from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.address_group.AddressGroup`,
comprised of the properties on the AddressGroup class.
:returns: The results of address group creation
:rtype: :class:`~openstack.network.v2.address_group.AddressGroup`
"""
return self._create(_address_group.AddressGroup, **attrs)
def delete_address_group(self, address_group, ignore_missing=True):
"""Delete an address group
:param address_group: The value can be either the ID of an
address group or
a :class:`~openstack.network.v2.address_group.AddressGroup`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will
be raised when the address group does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent address group.
:returns: ``None``
"""
self._delete(
_address_group.AddressGroup,
address_group,
ignore_missing=ignore_missing,
)
def find_address_group(self, name_or_id, ignore_missing=True, **query):
"""Find a single address group
:param name_or_id: The name or ID of an address group.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.address_group.AddressGroup`
or None
"""
return self._find(
_address_group.AddressGroup,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_address_group(self, address_group):
"""Get a single address group
:param address_group: The value can be the ID of an address group or a
:class:`~openstack.network.v2.address_group.AddressGroup` instance.
:returns: One :class:`~openstack.network.v2.address_group.AddressGroup`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_address_group.AddressGroup, address_group)
def address_groups(self, **query):
"""Return a generator of address groups
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
* ``name``: Address group name
* ``description``: Address group description
* ``project_id``: Owner project ID
:returns: A generator of address group objects
:rtype: :class:`~openstack.network.v2.address_group.AddressGroup`
"""
return self._list(_address_group.AddressGroup, **query)
def update_address_group(
self,
address_group: ty.Union[str, _address_group.AddressGroup],
**attrs: ty.Any,
) -> _address_group.AddressGroup:
"""Update an address group
:param address_group: Either the ID of an address group or a
:class:`~openstack.network.v2.address_group.AddressGroup` instance.
:param attrs: The attributes to update on the address group
represented by ``value``.
:returns: The updated address group
:rtype: :class:`~openstack.network.v2.address_group.AddressGroup`
"""
return self._update(
_address_group.AddressGroup, address_group, **attrs
)
def add_addresses_to_address_group(self, address_group, addresses):
"""Add addresses to a address group
:param address_group: Either the ID of an address group or a
:class:`~openstack.network.v2.address_group.AddressGroup` instance.
:param list addresses: List of address strings.
:returns: AddressGroup with updated addresses
:rtype: :class:`~openstack.network.v2.address_group.AddressGroup`
"""
ag = self._get_resource(_address_group.AddressGroup, address_group)
return ag.add_addresses(self, addresses)
def remove_addresses_from_address_group(self, address_group, addresses):
"""Remove addresses from a address group
:param address_group: Either the ID of an address group or a
:class:`~openstack.network.v2.address_group.AddressGroup` instance.
:param list addresses: List of address strings.
:returns: AddressGroup with updated addresses
:rtype: :class:`~openstack.network.v2.address_group.AddressGroup`
"""
ag = self._get_resource(_address_group.AddressGroup, address_group)
return ag.remove_addresses(self, addresses)
def create_address_scope(self, **attrs):
"""Create a new address scope from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.address_scope.AddressScope`,
comprised of the properties on the AddressScope class.
:returns: The results of address scope creation
:rtype: :class:`~openstack.network.v2.address_scope.AddressScope`
"""
return self._create(_address_scope.AddressScope, **attrs)
def delete_address_scope(self, address_scope, ignore_missing=True):
"""Delete an address scope
:param address_scope: The value can be either the ID of an
address scope or
a :class:`~openstack.network.v2.address_scope.AddressScope`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the address scope does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent address scope.
:returns: ``None``
"""
self._delete(
_address_scope.AddressScope,
address_scope,
ignore_missing=ignore_missing,
)
def find_address_scope(self, name_or_id, ignore_missing=True, **query):
"""Find a single address scope
:param name_or_id: The name or ID of an address scope.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.address_scope.AddressScope`
or None
"""
return self._find(
_address_scope.AddressScope,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_address_scope(self, address_scope):
"""Get a single address scope
:param address_scope: The value can be the ID of an address scope or a
:class:`~openstack.network.v2.address_scope.AddressScope` instance.
:returns: One :class:`~openstack.network.v2.address_scope.AddressScope`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_address_scope.AddressScope, address_scope)
def address_scopes(self, **query):
"""Return a generator of address scopes
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
* ``name``: Address scope name
* ``ip_version``: Address scope IP address version
* ``tenant_id``: Owner tenant ID
* ``shared``: Address scope is shared (boolean)
:returns: A generator of address scope objects
:rtype: :class:`~openstack.network.v2.address_scope.AddressScope`
"""
return self._list(_address_scope.AddressScope, **query)
def update_address_scope(self, address_scope, **attrs):
"""Update an address scope
:param address_scope: Either the ID of an address scope or a
:class:`~openstack.network.v2.address_scope.AddressScope` instance.
:param attrs: The attributes to update on the address scope
represented by ``value``.
:returns: The updated address scope
:rtype: :class:`~openstack.network.v2.address_scope.AddressScope`
"""
return self._update(
_address_scope.AddressScope, address_scope, **attrs
)
def agents(self, **query):
"""Return a generator of network agents
:param dict query: Optional query parameters to be sent to limit the
resources being returned.
* ``agent_type``: Agent type.
* ``availability_zone``: The availability zone for an agent.
* ``binary``: The name of the agent's application binary.
* ``description``: The description of the agent.
* ``host``: The host (host name or host address) the agent is
running on.
* ``topic``: The message queue topic used.
* ``is_admin_state_up``: The administrative state of the agent.
* ``is_alive``: Whether the agent is alive.
:returns: A generator of agents
:rtype: :class:`~openstack.network.v2.agent.Agent`
"""
return self._list(_agent.Agent, **query)
def delete_agent(self, agent, ignore_missing=True):
"""Delete a network agent
:param agent: The value can be the ID of a agent or a
:class:`~openstack.network.v2.agent.Agent` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the agent does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent agent.
:returns: ``None``
"""
self._delete(_agent.Agent, agent, ignore_missing=ignore_missing)
def get_agent(self, agent):
"""Get a single network agent
:param agent: The value can be the ID of a agent or a
:class:`~openstack.network.v2.agent.Agent` instance.
:returns: One :class:`~openstack.network.v2.agent.Agent`
:rtype: :class:`~openstack.network.v2.agent.Agent`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_agent.Agent, agent)
def update_agent(self, agent, **attrs):
"""Update a network agent
:param agent: The value can be the ID of a agent or a
:class:`~openstack.network.v2.agent.Agent` instance.
:param attrs: The attributes to update on the agent represented
by ``value``.
:returns: One :class:`~openstack.network.v2.agent.Agent`
:rtype: :class:`~openstack.network.v2.agent.Agent`
"""
return self._update(_agent.Agent, agent, **attrs)
def dhcp_agent_hosting_networks(self, agent, **query):
"""A generator of networks hosted by a DHCP agent.
:param agent: Either the agent id of an instance of
:class:`~openstack.network.v2.network_agent.Agent`
:param query: kwargs query: Optional query parameters to be sent
to limit the resources being returned.
:return: A generator of networks
"""
agent_obj = self._get_resource(_agent.Agent, agent)
return self._list(
_network.DHCPAgentHostingNetwork, agent_id=agent_obj.id, **query
)
def add_dhcp_agent_to_network(self, agent, network):
"""Add a DHCP Agent to a network
:param agent: Either the agent id of an instance of
:class:`~openstack.network.v2.network_agent.Agent`
:param network: Network instance
:return:
"""
network = self._get_resource(_network.Network, network)
agent = self._get_resource(_agent.Agent, agent)
return agent.add_agent_to_network(self, network.id)
def remove_dhcp_agent_from_network(self, agent, network):
"""Remove a DHCP Agent from a network
:param agent: Either the agent id of an instance of
:class:`~openstack.network.v2.network_agent.Agent`
:param network: Network instance
:return:
"""
network = self._get_resource(_network.Network, network)
agent = self._get_resource(_agent.Agent, agent)
return agent.remove_agent_from_network(self, network.id)
def network_hosting_dhcp_agents(self, network, **query):
"""A generator of DHCP agents hosted on a network.
:param network: The instance of
:class:`~openstack.network.v2.network.Network`
:param dict query: Optional query parameters to be sent to limit the
resources returned.
:return: A generator of hosted DHCP agents
"""
net = self._get_resource(_network.Network, network)
return self._list(
_agent.NetworkHostingDHCPAgent, network_id=net.id, **query
)
def get_auto_allocated_topology(self, project=None):
"""Get the auto-allocated topology of a given tenant
:param project:
The value is the ID or name of a project
:returns: The auto-allocated topology
:rtype:
:class:`~openstack.network.v2.auto_allocated_topology.AutoAllocatedTopology`
"""
# If project option is not given, grab project id from session
if project is None:
project = self.get_project_id()
return self._get(
_auto_allocated_topology.AutoAllocatedTopology, project
)
def delete_auto_allocated_topology(
self, project=None, ignore_missing=False
):
"""Delete auto-allocated topology
:param project:
The value is the ID or name of a project
:param ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the topology does not exist.
When set to ``True``, no exception will be raised when
attempting to delete nonexistant topology
:returns: ``None``
"""
# If project option is not given, grab project id from session
if project is None:
project = self.get_project_id()
self._delete(
_auto_allocated_topology.AutoAllocatedTopology,
project,
ignore_missing=ignore_missing,
)
def validate_auto_allocated_topology(self, project=None):
"""Validate the resources for auto allocation
:param project:
The value is the ID or name of a project
:returns: Whether all resources are correctly configured or not
:rtype:
:class:`~openstack.network.v2.auto_allocated_topology.ValidateTopology`
"""
# If project option is not given, grab project id from session
if project is None:
project = self.get_project_id()
return self._get(
_auto_allocated_topology.ValidateTopology,
project=project,
requires_id=False,
)
def availability_zones(self, **query):
"""Return a generator of availability zones
:param dict query: optional query parameters to be set to limit the
returned resources. Valid parameters include:
* ``name``: The name of an availability zone.
* ``resource``: The type of resource for the availability zone.
:returns: A generator of availability zone objects
:rtype:
:class:`~openstack.network.v2.availability_zone.AvailabilityZone`
"""
return self._list(availability_zone.AvailabilityZone)
def create_bgp_peer(self, **attrs):
"""Create a new BGP Peer from attributes"""
return self._create(_bgp_peer.BgpPeer, **attrs)
def delete_bgp_peer(self, peer, ignore_missing=True):
"""Delete a BGP Peer"""
self._delete(_bgp_peer.BgpPeer, peer, ignore_missing=ignore_missing)
def find_bgp_peer(self, name_or_id, ignore_missing=True, **query):
"""Find a single BGP Peer"""
return self._find(
_bgp_peer.BgpPeer,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_bgp_peer(self, peer):
"""Get a signle BGP Peer"""
return self._get(_bgp_peer.BgpPeer, peer)
def update_bgp_peer(self, peer, **attrs):
"""Update a BGP Peer"""
return self._update(_bgp_peer.BgpPeer, peer, **attrs)
def bgp_peers(self, **query):
"""Return a generator of BGP Peers"""
return self._list(_bgp_peer.BgpPeer, **query)
def create_bgp_speaker(self, **attrs):
"""Create a new BGP Speaker"""
return self._create(_bgp_speaker.BgpSpeaker, **attrs)
def delete_bgp_speaker(self, speaker, ignore_missing=True):
"""Delete a BGP Speaker"""
self._delete(
_bgp_speaker.BgpSpeaker, speaker, ignore_missing=ignore_missing
)
def find_bgp_speaker(self, name_or_id, ignore_missing=True, **query):
"""Find a single BGP Peer"""
return self._find(
_bgp_speaker.BgpSpeaker,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_bgp_speaker(self, speaker):
"""Get a signle BGP Speaker"""
return self._get(_bgp_speaker.BgpSpeaker, speaker)
def update_bgp_speaker(self, speaker, **attrs):
"""Update a BGP Speaker"""
return self._update(_bgp_speaker.BgpSpeaker, speaker, **attrs)
def bgp_speakers(self, **query):
"""Return a generator of BGP Peers"""
return self._list(_bgp_speaker.BgpSpeaker, **query)
def add_bgp_peer_to_speaker(self, speaker, peer_id):
"""Bind the BGP peer to the specified BGP Speaker."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, speaker)
return speaker.add_bgp_peer(self, peer_id)
def remove_bgp_peer_from_speaker(self, speaker, peer_id):
"""Unbind the BGP peer from a BGP Speaker."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, speaker)
return speaker.remove_bgp_peer(self, peer_id)
def add_gateway_network_to_speaker(self, speaker, network_id):
"""Add a network to the specified BGP speaker."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, speaker)
return speaker.add_gateway_network(self, network_id)
def remove_gateway_network_from_speaker(self, speaker, network_id):
"""Remove a network from the specified BGP speaker."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, speaker)
return speaker.remove_gateway_network(self, network_id)
def get_advertised_routes_of_speaker(self, speaker):
"""List all routes advertised by the specified BGP Speaker."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, speaker)
return speaker.get_advertised_routes(self)
def get_bgp_dragents_hosting_speaker(self, speaker):
"""List all BGP dynamic agents which are hosting the
specified BGP Speaker."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, speaker)
return speaker.get_bgp_dragents(self)
def add_bgp_speaker_to_dragent(self, bgp_agent, bgp_speaker_id):
"""Add a BGP Speaker to the specified dynamic routing agent."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, bgp_speaker_id)
speaker.add_bgp_speaker_to_dragent(self, bgp_agent)
def get_bgp_speakers_hosted_by_dragent(self, bgp_agent):
"""List all BGP Seakers hosted on the specified dynamic routing
agent."""
agent = self._get_resource(_agent.Agent, bgp_agent)
return agent.get_bgp_speakers_hosted_by_dragent(self)
def remove_bgp_speaker_from_dragent(self, bgp_agent, bgp_speaker_id):
"""Delete the BGP Speaker hosted by the specified dynamic
routing agent."""
speaker = self._get_resource(_bgp_speaker.BgpSpeaker, bgp_speaker_id)
speaker.remove_bgp_speaker_from_dragent(self, bgp_agent)
def create_bgpvpn(self, **attrs):
"""Create a new BGPVPN
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.bgpvpn.BgpVpn`, comprised of the
properties on the BGPVPN class, for details see the Neutron
api-ref.
:returns: The result of BGPVPN creation
:rtype: :class:`~openstack.network.v2.bgpvpn.BgpVpn`
"""
return self._create(_bgpvpn.BgpVpn, **attrs)
def delete_bgpvpn(self, bgpvpn, ignore_missing=True):
"""Delete a BGPVPN
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the BGPVPN does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent BGPVPN.
:returns: ``None``
"""
self._delete(_bgpvpn.BgpVpn, bgpvpn, ignore_missing=ignore_missing)
def find_bgpvpn(self, name_or_id, ignore_missing=True, **query):
"""Find a single BGPVPN
:param name_or_id: The name or ID of a BGPVPN.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.bgpvpn.BGPVPN`
or None
"""
return self._find(
_bgpvpn.BgpVpn, name_or_id, ignore_missing=ignore_missing, **query
)
def get_bgpvpn(self, bgpvpn):
"""Get a signle BGPVPN
:param bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:returns: One :class:`~openstack.network.v2.bgpvpn.BgpVpn`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_bgpvpn.BgpVpn, bgpvpn)
def update_bgpvpn(self, bgppvpn, **attrs):
"""Update a BGPVPN
:param bgpvpn: Either the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param attrs: The attributes to update on the BGPVPN represented
by ``value``.
:returns: The updated BGPVPN
:rtype: :class:`~openstack.network.v2.bgpvpn.BgpVpn`
"""
return self._update(_bgpvpn.BgpVpn, bgppvpn, **attrs)
def bgpvpns(self, **query):
"""Return a generator of BGP VPNs
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of BgpVPN objects
:rtype: :class:`~openstack.network.v2.bgpvpn.BgpVpn`
"""
return self._list(_bgpvpn.BgpVpn, **query)
def create_bgpvpn_network_association(self, bgpvpn, **attrs):
"""Create a new BGPVPN Network Association
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation`,
comprised of the properties on the BgpVpnNetworkAssociation class.
:returns: The results of BgpVpnNetworkAssociation creation
:rtype: :class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._create(
_bgpvpn_network_association.BgpVpnNetworkAssociation,
bgpvpn_id=bgpvpn_res.id,
**attrs,
)
def delete_bgpvpn_network_association(
self, bgpvpn, net_association, ignore_missing=True
):
"""Delete a BGPVPN Network Association
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param net_association: The value can be either the ID of a
bgpvpn_network_association or
a :class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the BgpVpnNetworkAssociation does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent BgpVpnNetworkAssociation.
:returns: ``None``
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
self._delete(
_bgpvpn_network_association.BgpVpnNetworkAssociation,
net_association,
ignore_missing=ignore_missing,
bgpvpn_id=bgpvpn_res.id,
)
def get_bgpvpn_network_association(self, bgpvpn, net_association):
"""Get a signle BGPVPN Network Association
:param bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param net_association: The value can be the ID of a
BgpVpnNetworkAssociation or a
:class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation` instance.
:returns: One :class:`~openstack.network.v2.
bgpvpn_network_associaition.BgpVpnNetworkAssociation`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._get(
_bgpvpn_network_association.BgpVpnNetworkAssociation,
net_association,
bgpvpn_id=bgpvpn_res.id,
)
def bgpvpn_network_associations(self, bgpvpn, **query):
"""Return a generator of BGP VPN Network Associations
:param: bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of BgpVpnNetworkAssociation objects
:rtype: :class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._list(
_bgpvpn_network_association.BgpVpnNetworkAssociation,
bgpvpn_id=bgpvpn_res.id,
**query,
)
def create_bgpvpn_port_association(self, bgpvpn, **attrs):
"""Create a new BGPVPN Port Association
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.bgpvpn_port_association.
BgpVpnPortAssociation`,
comprised of the properties on the BgpVpnPortAssociation class.
:returns: The results of BgpVpnPortAssociation creation
:rtype: :class:`~openstack.network.v2.bgpvpn_port_association.
BgpVpnPortAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._create(
_bgpvpn_port_association.BgpVpnPortAssociation,
bgpvpn_id=bgpvpn_res.id,
**attrs,
)
def delete_bgpvpn_port_association(
self, bgpvpn, port_association, ignore_missing=True
):
"""Delete a BGPVPN Port Association
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param port_association: The value can be either the ID of a
bgpvpn_port_association or
a :class:`~openstack.network.v2.bgpvpn_port_association.
BgpVpnPortAssociation` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the BgpVpnPortAssociation does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent BgpVpnPortAssociation.
:returns: ``None``
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
self._delete(
_bgpvpn_port_association.BgpVpnPortAssociation,
port_association,
ignore_missing=ignore_missing,
bgpvpn_id=bgpvpn_res.id,
)
def find_bgpvpn_port_association(
self, name_or_id, bgpvpn_id, ignore_missing=True, **query
):
"""Find a single BGPVPN Port Association
:param name_or_id: The name or ID of a BgpVpnNetworkAssociation.
:param bgpvpn_id: The value can be the ID of a BGPVPN.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.bgpvpn.BGPVPN`
or None
"""
return self._find(
_bgpvpn_port_association.BgpVpnPortAssociation,
name_or_id,
ignore_missing=ignore_missing,
bgpvpn_id=bgpvpn_id,
**query,
)
def get_bgpvpn_port_association(self, bgpvpn, port_association):
"""Get a signle BGPVPN Port Association
:param bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param port_association: The value can be the ID of a
BgpVpnPortAssociation or a
:class:`~openstack.network.v2.bgpvpn_port_association.
BgpVpnPortAssociation` instance.
:returns: One :class:`~openstack.network.v2.
bgpvpn_port_associaition.BgpVpnPortAssociation`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._get(
_bgpvpn_port_association.BgpVpnPortAssociation,
port_association,
bgpvpn_id=bgpvpn_res.id,
)
def update_bgpvpn_port_association(
self, bgpvpn, port_association, **attrs
):
"""Update a BPGPN Port Association
:param bgpvpn: Either the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param port_association: The value can be the ID of a
BgpVpnPortAssociation or a
:class:`~openstack.network.v2.bgpvpn_port_association.
BgpVpnPortAssociation` instance.
:param attrs: The attributes to update on the BGPVPN represented
by ``value``.
:returns: The updated BgpVpnPortAssociation.
:rtype: :class:`~openstack.network.v2.bgpvpn.BgpVpn`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._update(
_bgpvpn_port_association.BgpVpnPortAssociation,
port_association,
bgpvpn_id=bgpvpn_res.id,
**attrs,
)
def bgpvpn_port_associations(self, bgpvpn, **query):
"""Return a generator of BGP VPN Port Associations
:param: bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of BgpVpnNetworkAssociation objects
:rtype: :class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._list(
_bgpvpn_port_association.BgpVpnPortAssociation,
bgpvpn_id=bgpvpn_res.id,
**query,
)
def create_bgpvpn_router_association(self, bgpvpn, **attrs):
"""Create a new BGPVPN Router Association
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.bgpvpn_router_association.
BgpVpnRouterAssociation`,
comprised of the properties on the BgpVpnRouterAssociation class.
:returns: The results of BgpVpnRouterAssociation creation
:rtype: :class:`~openstack.network.v2.bgpvpn_router_association.
BgpVpnRouterAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._create(
_bgpvpn_router_association.BgpVpnRouterAssociation,
bgpvpn_id=bgpvpn_res.id,
**attrs,
)
def delete_bgpvpn_router_association(
self, bgpvpn, router_association, ignore_missing=True
):
"""Delete a BGPVPN Router Association
:param bgpvpn: The value can be either the ID of a bgpvpn or
a :class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param port_association: The value can be either the ID of a
bgpvpn_router_association or
a :class:`~openstack.network.v2.bgpvpn_router_association.
BgpVpnRouterAssociation` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the BgpVpnRouterAssociation does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent BgpVpnRouterAsociation.
:returns: ``None``
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
self._delete(
_bgpvpn_router_association.BgpVpnRouterAssociation,
router_association,
ignore_missing=ignore_missing,
bgpvpn_id=bgpvpn_res.id,
)
def get_bgpvpn_router_association(self, bgpvpn, router_association):
"""Get a signle BGPVPN Router Association
:param bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param router_association: The value can be the ID of a
BgpVpnRouterAssociation or a
:class:`~openstack.network.v2.bgpvpn_router_association.
BgpVpnRouterAssociation` instance.
:returns: One :class:`~openstack.network.v2.
bgpvpn_router_associaition.BgpVpnRouterAssociation`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._get(
_bgpvpn_router_association.BgpVpnRouterAssociation,
router_association,
bgpvpn_id=bgpvpn_res.id,
)
def update_bgpvpn_router_association(
self, bgpvpn, router_association, **attrs
):
"""Update a BPGPN Router Association
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of BgpVpnNetworkAssociation objects
:rtype: :class:`~openstack.network.v2.bgpvpn_network_association.
BgpVpnNetworkAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._update(
_bgpvpn_router_association.BgpVpnRouterAssociation,
router_association,
bgpvpn_id=bgpvpn_res.id,
**attrs,
)
def bgpvpn_router_associations(self, bgpvpn, **query):
"""Return a generator of BGP VPN router Associations
:param: bgpvpn: The value can be the ID of a BGPVPN or a
:class:`~openstack.network.v2.bgpvpn.BgpVpn` instance.
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of BgpVpnRouterAssociation objects
:rtype: :class:`~openstack.network.v2.bgpvpn_router_association.
BgpVpnRouterAssociation`
"""
bgpvpn_res = self._get_resource(_bgpvpn.BgpVpn, bgpvpn)
return self._list(
_bgpvpn_router_association.BgpVpnRouterAssociation,
bgpvpn_id=bgpvpn_res.id,
**query,
)
def find_extension(self, name_or_id, ignore_missing=True, **query):
"""Find a single extension
:param name_or_id: The name or ID of a extension.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.extension.Extension`
or None
"""
return self._find(
extension.Extension,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def extensions(self, **query):
"""Return a generator of extensions
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Currently no
parameter is supported.
:returns: A generator of extension objects
:rtype: :class:`~openstack.network.v2.extension.Extension`
"""
return self._list(extension.Extension, **query)
def create_flavor(self, **attrs):
"""Create a new network service flavor from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.flavor.Flavor`,
comprised of the properties on the Flavor class.
:returns: The results of flavor creation
:rtype: :class:`~openstack.network.v2.flavor.Flavor`
"""
return self._create(_flavor.Flavor, **attrs)
def delete_flavor(self, flavor, ignore_missing=True):
"""Delete a network service flavor
:param flavor:
The value can be either the ID of a flavor or a
:class:`~openstack.network.v2.flavor.Flavor` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the flavor does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent flavor.
:returns: ``None``
"""
self._delete(_flavor.Flavor, flavor, ignore_missing=ignore_missing)
def find_flavor(self, name_or_id, ignore_missing=True, **query):
"""Find a single network service flavor
:param name_or_id: The name or ID of a flavor.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.flavor.Flavor` or None
"""
return self._find(
_flavor.Flavor, name_or_id, ignore_missing=ignore_missing, **query
)
def get_flavor(self, flavor):
"""Get a single network service flavor
:param flavor:
The value can be the ID of a flavor or a
:class:`~openstack.network.v2.flavor.Flavor` instance.
:returns: One :class:`~openstack.network.v2.flavor.Flavor`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_flavor.Flavor, flavor)
def update_flavor(self, flavor, **attrs):
"""Update a network service flavor
:param flavor: Either the id of a flavor or a
:class:`~openstack.network.v2.flavor.Flavor` instance.
:param attrs: The attributes to update on the flavor represented
by ``flavor``.
:returns: The updated flavor
:rtype: :class:`~openstack.network.v2.flavor.Flavor`
"""
return self._update(_flavor.Flavor, flavor, **attrs)
def flavors(self, **query):
"""Return a generator of network service flavors
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters
include:
* ``description``: The description of a flavor.
* ``is_enabled``: Whether a flavor is enabled.
* ``name``: The name of a flavor.
* ``service_type``: The service type to which a falvor applies.
:returns: A generator of flavor objects
:rtype: :class:`~openstack.network.v2.flavor.Flavor`
"""
return self._list(_flavor.Flavor, **query)
def associate_flavor_with_service_profile(self, flavor, service_profile):
"""Associate network flavor with service profile.
:param flavor:
Either the id of a flavor or a
:class:`~openstack.network.v2.flavor.Flavor` instance.
:param service_profile:
The value can be either the ID of a service profile or a
:class:`~openstack.network.v2.service_profile.ServiceProfile`
instance.
:return:
"""
flavor = self._get_resource(_flavor.Flavor, flavor)
service_profile = self._get_resource(
_service_profile.ServiceProfile, service_profile
)
return flavor.associate_flavor_with_service_profile(
self, service_profile.id
)
def disassociate_flavor_from_service_profile(
self, flavor, service_profile
):
"""Disassociate network flavor from service profile.
:param flavor:
Either the id of a flavor or a
:class:`~openstack.network.v2.flavor.Flavor` instance.
:param service_profile:
The value can be either the ID of a service profile or a
:class:`~openstack.network.v2.service_profile.ServiceProfile`
instance.
:return:
"""
flavor = self._get_resource(_flavor.Flavor, flavor)
service_profile = self._get_resource(
_service_profile.ServiceProfile, service_profile
)
return flavor.disassociate_flavor_from_service_profile(
self, service_profile.id
)
def create_local_ip(self, **attrs):
"""Create a new local ip from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.local_ip.LocalIP`,
comprised of the properties on the LocalIP class.
:returns: The results of local ip creation
:rtype: :class:`~openstack.network.v2.local_ip.LocalIP`
"""
return self._create(_local_ip.LocalIP, **attrs)
def delete_local_ip(self, local_ip, ignore_missing=True, if_revision=None):
"""Delete a local ip
:param local_ip: The value can be either the ID of a local ip or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the local ip does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent ip.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_local_ip.LocalIP,
local_ip,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_local_ip(self, name_or_id, ignore_missing=True, **query):
"""Find a local IP
:param name_or_id: The name or ID of an local IP.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.local_ip.LocalIP`
or None
"""
return self._find(
_local_ip.LocalIP,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_local_ip(self, local_ip):
"""Get a single local ip
:param local_ip: The value can be the ID of a local ip or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:returns: One :class:`~openstack.network.v2.local_ip.LocalIP`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_local_ip.LocalIP, local_ip)
def local_ips(self, **query):
"""Return a generator of local ips
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
* ``name``: Local IP name
* ``description``: Local IP description
* ``project_id``: Owner project ID
* ``network_id``: Local IP network
* ``local_port_id``: Local port ID
* ``local_ip_address``: The IP address of a Local IP
* ``ip_mode``: The Local IP mode
:returns: A generator of local ip objects
:rtype: :class:`~openstack.network.v2.local_ip.LocalIP`
"""
return self._list(_local_ip.LocalIP, **query)
def update_local_ip(self, local_ip, if_revision=None, **attrs):
"""Update a local ip
:param local_ip: Either the id of a local ip or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the ip represented
by ``value``.
:returns: The updated ip
:rtype: :class:`~openstack.network.v2.local_ip.LocalIP`
"""
return self._update(
_local_ip.LocalIP, local_ip, if_revision=if_revision, **attrs
)
def create_local_ip_association(self, local_ip, **attrs):
"""Create a new local ip association from attributes
:param local_ip: The value can be the ID of a Local IP or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:param attrs: Keyword arguments which will be used to create
a
:class:`~openstack.network.v2.local_ip_association.LocalIPAssociation`,
comprised of the properties on the LocalIP class.
:returns: The results of local ip association creation
:rtype:
:class:`~openstack.network.v2.local_ip_association.LocalIPAssociation`
"""
local_ip = self._get_resource(_local_ip.LocalIP, local_ip)
return self._create(
_local_ip_association.LocalIPAssociation,
local_ip_id=local_ip.id,
**attrs,
)
def delete_local_ip_association(
self, local_ip, fixed_port_id, ignore_missing=True, if_revision=None
):
"""Delete a local ip association
:param local_ip: The value can be the ID of a Local IP or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:param fixed_port_id: The value can be either the fixed port ID
or a :class:
`~openstack.network.v2.local_ip_association.LocalIPAssociation`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the local ip association does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent ip.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
local_ip = self._get_resource(_local_ip.LocalIP, local_ip)
self._delete(
_local_ip_association.LocalIPAssociation,
fixed_port_id,
local_ip_id=local_ip.id,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_local_ip_association(
self, name_or_id, local_ip, ignore_missing=True, **query
):
"""Find a local ip association
:param name_or_id: The name or ID of local ip association.
:param local_ip: The value can be the ID of a Local IP or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.local_ip_association.LocalIPAssociation`
or None
"""
local_ip = self._get_resource(_local_ip.LocalIP, local_ip)
return self._find(
_local_ip_association.LocalIPAssociation,
name_or_id,
local_ip_id=local_ip.id,
ignore_missing=ignore_missing,
**query,
)
def get_local_ip_association(self, local_ip_association, local_ip):
"""Get a single local ip association
:param local_ip: The value can be the ID of a Local IP or a
:class:`~openstack.network.v2.local_ip.LocalIP`
instance.
:param local_ip_association: The value can be the ID
of a local ip association or a
:class:`~openstack.network.v2.local_ip_association.LocalIPAssociation`
instance.
:returns: One
:class:`~openstack.network.v2.local_ip_association.LocalIPAssociation`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
local_ip = self._get_resource(_local_ip.LocalIP, local_ip)
return self._get(
_local_ip_association.LocalIPAssociation,
local_ip_association,
local_ip_id=local_ip.id,
)
def local_ip_associations(self, local_ip, **query):
"""Return a generator of local ip associations
:param local_ip: The value can be the ID of a Local IP or a
:class:`~openstack.network.v2.local_ip.LocalIP` instance.
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
* ``fixed_port_id``: The ID of the port to which a local IP
is associated
* ``fixed_ip``: The fixed ip address associated with a
a Local IP
* ``host``: Host where local ip is associated
:returns: A generator of local ip association objects
:rtype:
:class:`~openstack.network.v2.local_ip_association.LocalIPAssociation`
"""
local_ip = self._get_resource(_local_ip.LocalIP, local_ip)
return self._list(
_local_ip_association.LocalIPAssociation,
local_ip_id=local_ip.id,
**query,
)
def create_ip(self, **attrs):
"""Create a new floating ip from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.floating_ip.FloatingIP`,
comprised of the properties on the FloatingIP class.
:returns: The results of floating ip creation
:rtype: :class:`~openstack.network.v2.floating_ip.FloatingIP`
"""
return self._create(_floating_ip.FloatingIP, **attrs)
def delete_ip(self, floating_ip, ignore_missing=True, if_revision=None):
"""Delete a floating ip
:param floating_ip: The value can be either the ID of a floating ip
or a :class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the floating ip does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent ip.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_floating_ip.FloatingIP,
floating_ip,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_available_ip(self):
"""Find an available IP
:returns: One :class:`~openstack.network.v2.floating_ip.FloatingIP`
or None
"""
return _floating_ip.FloatingIP.find_available(self)
def find_ip(self, name_or_id, ignore_missing=True, **query):
"""Find a single IP
:param name_or_id: The name or ID of an IP.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.floating_ip.FloatingIP`
or None
"""
return self._find(
_floating_ip.FloatingIP,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_ip(self, floating_ip):
"""Get a single floating ip
:param floating_ip: The value can be the ID of a floating ip or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:returns: One :class:`~openstack.network.v2.floating_ip.FloatingIP`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_floating_ip.FloatingIP, floating_ip)
def ips(self, **query):
"""Return a generator of ips
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: The description of a floating IP.
* ``fixed_ip_address``: The fixed IP address associated with a
floating IP address.
* ``floating_ip_address``: The IP address of a floating IP.
* ``floating_network_id``: The ID of the network associated with
a floating IP.
* ``port_id``: The ID of the port to which a floating IP is
associated.
* ``project_id``: The ID of the project a floating IP is
associated with.
* ``router_id``: The ID of an associated router.
* ``status``: The status of a floating IP, which can be ``ACTIVE``
or ``DOWN``.
:returns: A generator of floating IP objects
:rtype: :class:`~openstack.network.v2.floating_ip.FloatingIP`
"""
return self._list(_floating_ip.FloatingIP, **query)
def update_ip(self, floating_ip, if_revision=None, **attrs):
"""Update a ip
:param floating_ip: Either the id of a ip or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the ip represented
by ``value``.
:returns: The updated ip
:rtype: :class:`~openstack.network.v2.floating_ip.FloatingIP`
"""
return self._update(
_floating_ip.FloatingIP,
floating_ip,
if_revision=if_revision,
**attrs,
)
def create_port_forwarding(self, **attrs):
"""Create a new floating ip port forwarding from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.port_forwarding.PortForwarding`,
comprised of the properties on the PortForwarding class.
:returns: The results of port forwarding creation
:rtype: :class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
return self._create(_port_forwarding.PortForwarding, **attrs)
def get_port_forwarding(self, port_forwarding, floating_ip):
"""Get a single port forwarding
:param port_forwarding: The value can be the ID of a port forwarding
or a :class:`~openstack.network.v2.port_forwarding.PortForwarding`
instance.
:param floating_ip: The value can be the ID of a Floating IP or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:returns: One
:class:`~openstack.network.v2.port_forwarding.PortForwarding`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
floating_ip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._get(
_port_forwarding.PortForwarding,
port_forwarding,
floatingip_id=floating_ip.id,
)
def find_port_forwarding(
self, pf_id, floating_ip, ignore_missing=True, **query
):
"""Find a single port forwarding
:param pf_id: The ID of a port forwarding.
:param floating_ip: The value can be the ID of a Floating IP or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns:
One :class:`~openstack.network.v2.port_forwarding.PortForwarding`
or None
"""
floating_ip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._find(
_port_forwarding.PortForwarding,
pf_id,
floatingip_id=floating_ip.id,
ignore_missing=ignore_missing,
**query,
)
def delete_port_forwarding(
self, port_forwarding, floating_ip, ignore_missing=True
):
"""Delete a port forwarding
:param port_forwarding: The value can be the ID of a port forwarding
or a :class:`~openstack.network.v2.port_forwarding.PortForwarding`
instance.
:param floating_ip: The value can be the ID of a Floating IP or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the floating ip does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent ip.
:returns: ``None``
"""
fip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
self._delete(
_port_forwarding.PortForwarding,
port_forwarding,
floatingip_id=fip.id,
ignore_missing=ignore_missing,
)
def port_forwardings(self, floating_ip, **query):
"""Return a generator of port forwardings
:param floating_ip: The value can be the ID of a Floating IP or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``internal_port_id``: The ID of internal port.
* ``external_port``: The external TCP/UDP/other port number
* ``protocol``: TCP/UDP/other protocol
:returns: A generator of port forwarding objects
:rtype: :class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
fip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._list(
_port_forwarding.PortForwarding, floatingip_id=fip.id, **query
)
def update_port_forwarding(self, port_forwarding, floating_ip, **attrs):
"""Update a port forwarding
:param port_forwarding: The value can be the ID of a port forwarding
or a :class:`~openstack.network.v2.port_forwarding.PortForwarding`
instance.
:param floating_ip: The value can be the ID of a Floating IP or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param attrs: The attributes to update on the ip represented
by ``value``.
:returns: The updated port_forwarding
:rtype: :class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
fip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._update(
_port_forwarding.PortForwarding,
port_forwarding,
floatingip_id=fip.id,
**attrs,
)
def create_health_monitor(self, **attrs):
"""Create a new health monitor from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.health_monitor.HealthMonitor`,
comprised of the properties on the HealthMonitor class.
:returns: The results of health monitor creation
:rtype: :class:`~openstack.network.v2.health_monitor.HealthMonitor`
"""
return self._create(_health_monitor.HealthMonitor, **attrs)
def delete_health_monitor(self, health_monitor, ignore_missing=True):
"""Delete a health monitor
:param health_monitor: The value can be either the ID of a
health monitor or a
:class:`~openstack.network.v2.health_monitor.HealthMonitor`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the health monitor does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent health monitor.
:returns: ``None``
"""
self._delete(
_health_monitor.HealthMonitor,
health_monitor,
ignore_missing=ignore_missing,
)
def find_health_monitor(self, name_or_id, ignore_missing=True, **query):
"""Find a single health monitor
:param name_or_id: The name or ID of a health monitor.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.health_monitor.HealthMonitor`
or None
"""
return self._find(
_health_monitor.HealthMonitor,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_health_monitor(self, health_monitor):
"""Get a single health monitor
:param health_monitor: The value can be the ID of a health monitor or a
:class:`~openstack.network.v2.health_monitor.HealthMonitor`
instance.
:returns: One
:class:`~openstack.network.v2.health_monitor.HealthMonitor`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_health_monitor.HealthMonitor, health_monitor)
def health_monitors(self, **query):
"""Return a generator of health monitors
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``delay``: the time in milliseconds between sending probes.
* ``expected_codes``: The expected HTTP codes for a pssing HTTP(S)
monitor.
* ``http_method``: The HTTP method a monitor uses for requests.
* ``is_admin_state_up``: The administrative state of a health
monitor.
* ``max_retries``: The maximum consecutive health probe attempts.
* ``project_id``: The ID of the project this health monitor is
associated with.
* ``timeout``: The maximum number of milliseconds for a monitor to
wait for a connection to be established before it
times out.
* ``type``: The type of probe sent by the load balancer for health
check, which can be ``PING``, ``TCP``, ``HTTP`` or
``HTTPS``.
* ``url_path``: The path portion of a URI that will be probed.
:returns: A generator of health monitor objects
:rtype: :class:`~openstack.network.v2.health_monitor.HealthMonitor`
"""
return self._list(_health_monitor.HealthMonitor, **query)
def update_health_monitor(self, health_monitor, **attrs):
"""Update a health monitor
:param health_monitor: Either the id of a health monitor or a
:class:`~openstack.network.v2.health_monitor.HealthMonitor`
instance.
:param attrs: The attributes to update on the health monitor
represented by ``value``.
:returns: The updated health monitor
:rtype: :class:`~openstack.network.v2.health_monitor.HealthMonitor`
"""
return self._update(
_health_monitor.HealthMonitor, health_monitor, **attrs
)
def create_listener(self, **attrs):
"""Create a new listener from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.listener.Listener`,
comprised of the properties on the Listener class.
:returns: The results of listener creation
:rtype: :class:`~openstack.network.v2.listener.Listener`
"""
return self._create(_listener.Listener, **attrs)
def delete_listener(self, listener, ignore_missing=True):
"""Delete a listener
:param listener: The value can be either the ID of a listner or a
:class:`~openstack.network.v2.listener.Listener` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the listner does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent listener.
:returns: ``None``
"""
self._delete(
_listener.Listener, listener, ignore_missing=ignore_missing
)
def find_listener(self, name_or_id, ignore_missing=True, **query):
"""Find a single listener
:param name_or_id: The name or ID of a listener.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.listener.Listener` or None
"""
return self._find(
_listener.Listener,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_listener(self, listener):
"""Get a single listener
:param listener: The value can be the ID of a listener or a
:class:`~openstack.network.v2.listener.Listener`
instance.
:returns: One :class:`~openstack.network.v2.listener.Listener`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_listener.Listener, listener)
def listeners(self, **query):
"""Return a generator of listeners
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``connection_limit``: The maximum number of connections
permitted for the load-balancer.
* ``default_pool_id``: The ID of the default pool.
* ``default_tls_container_ref``: A reference to a container of TLS
secret.
* ``description``: The description of a listener.
* ``is_admin_state_up``: The administrative state of the listener.
* ``name``: The name of a listener.
* ``project_id``: The ID of the project associated with a listener.
* ``protocol``: The protocol of the listener.
* ``protocol_port``: Port the listener will listen to.
:returns: A generator of listener objects
:rtype: :class:`~openstack.network.v2.listener.Listener`
"""
return self._list(_listener.Listener, **query)
def update_listener(self, listener, **attrs):
"""Update a listener
:param listener: Either the id of a listener or a
:class:`~openstack.network.v2.listener.Listener`
instance.
:param attrs: The attributes to update on the listener
represented by ``listener``.
:returns: The updated listener
:rtype: :class:`~openstack.network.v2.listener.Listener`
"""
return self._update(_listener.Listener, listener, **attrs)
def create_load_balancer(self, **attrs):
"""Create a new load balancer from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.load_balancer.LoadBalancer`,
comprised of the properties on the LoadBalancer class.
:returns: The results of load balancer creation
:rtype: :class:`~openstack.network.v2.load_balancer.LoadBalancer`
"""
return self._create(_load_balancer.LoadBalancer, **attrs)
def delete_load_balancer(self, load_balancer, ignore_missing=True):
"""Delete a load balancer
:param load_balancer: The value can be the ID of a load balancer or a
:class:`~openstack.network.v2.load_balancer.LoadBalancer`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the load balancer does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent load balancer.
:returns: ``None``
"""
self._delete(
_load_balancer.LoadBalancer,
load_balancer,
ignore_missing=ignore_missing,
)
def find_load_balancer(self, name_or_id, ignore_missing=True, **query):
"""Find a single load balancer
:param name_or_id: The name or ID of a load balancer.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.load_balancer.LoadBalancer`
or None
"""
return self._find(
_load_balancer.LoadBalancer,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_load_balancer(self, load_balancer):
"""Get a single load balancer
:param load_balancer: The value can be the ID of a load balancer or a
:class:`~openstack.network.v2.load_balancer.LoadBalancer`
instance.
:returns: One :class:`~openstack.network.v2.load_balancer.LoadBalancer`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_load_balancer.LoadBalancer, load_balancer)
def load_balancers(self, **query):
"""Return a generator of load balancers
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of load balancer objects
:rtype: :class:`~openstack.network.v2.load_balancer.LoadBalancer`
"""
return self._list(_load_balancer.LoadBalancer, **query)
def update_load_balancer(self, load_balancer, **attrs):
"""Update a load balancer
:param load_balancer: Either the id of a load balancer or a
:class:`~openstack.network.v2.load_balancer.LoadBalancer`
instance.
:param attrs: The attributes to update on the load balancer
represented by ``load_balancer``.
:returns: The updated load balancer
:rtype: :class:`~openstack.network.v2.load_balancer.LoadBalancer`
"""
return self._update(
_load_balancer.LoadBalancer, load_balancer, **attrs
)
def create_metering_label(self, **attrs):
"""Create a new metering label from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.metering_label.MeteringLabel`,
comprised of the properties on the MeteringLabel class.
:returns: The results of metering label creation
:rtype: :class:`~openstack.network.v2.metering_label.MeteringLabel`
"""
return self._create(_metering_label.MeteringLabel, **attrs)
def delete_metering_label(self, metering_label, ignore_missing=True):
"""Delete a metering label
:param metering_label:
The value can be either the ID of a metering label or a
:class:`~openstack.network.v2.metering_label.MeteringLabel`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the metering label does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent metering label.
:returns: ``None``
"""
self._delete(
_metering_label.MeteringLabel,
metering_label,
ignore_missing=ignore_missing,
)
def find_metering_label(self, name_or_id, ignore_missing=True, **query):
"""Find a single metering label
:param name_or_id: The name or ID of a metering label.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.metering_label.MeteringLabel`
or None
"""
return self._find(
_metering_label.MeteringLabel,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_metering_label(self, metering_label):
"""Get a single metering label
:param metering_label: The value can be the ID of a metering label or a
:class:`~openstack.network.v2.metering_label.MeteringLabel`
instance.
:returns: One
:class:`~openstack.network.v2.metering_label.MeteringLabel`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_metering_label.MeteringLabel, metering_label)
def metering_labels(self, **query):
"""Return a generator of metering labels
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: Description of a metering label.
* ``name``: Name of a metering label.
* ``is_shared``: Boolean indicating whether a metering label is
shared.
* ``project_id``: The ID of the project a metering label is
associated with.
:returns: A generator of metering label objects
:rtype: :class:`~openstack.network.v2.metering_label.MeteringLabel`
"""
return self._list(_metering_label.MeteringLabel, **query)
def update_metering_label(self, metering_label, **attrs):
"""Update a metering label
:param metering_label: Either the id of a metering label or a
:class:`~openstack.network.v2.metering_label.MeteringLabel`
instance.
:param attrs: The attributes to update on the metering label
represented by ``metering_label``.
:returns: The updated metering label
:rtype: :class:`~openstack.network.v2.metering_label.MeteringLabel`
"""
return self._update(
_metering_label.MeteringLabel, metering_label, **attrs
)
def create_metering_label_rule(self, **attrs):
"""Create a new metering label rule from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`,
comprised of the properties on the MeteringLabelRule class.
:returns: The results of metering label rule creation
:rtype:
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
"""
return self._create(_metering_label_rule.MeteringLabelRule, **attrs)
def delete_metering_label_rule(
self, metering_label_rule, ignore_missing=True
):
"""Delete a metering label rule
:param metering_label_rule:
The value can be either the ID of a metering label rule
or a
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised
when the metering label rule does not exist. When set to ``True``,
no exception will be set when attempting to delete a nonexistent
metering label rule.
:returns: ``None``
"""
self._delete(
_metering_label_rule.MeteringLabelRule,
metering_label_rule,
ignore_missing=ignore_missing,
)
def find_metering_label_rule(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single metering label rule
:param name_or_id: The name or ID of a metering label rule.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
or None
"""
return self._find(
_metering_label_rule.MeteringLabelRule,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_metering_label_rule(self, metering_label_rule):
"""Get a single metering label rule
:param metering_label_rule:
The value can be the ID of a metering label rule or a
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
instance.
:returns: One
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_metering_label_rule.MeteringLabelRule, metering_label_rule
)
def metering_label_rules(self, **query):
"""Return a generator of metering label rules
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``direction``: The direction in which metering label rule is
applied.
* ``metering_label_id``: The ID of a metering label this rule is
associated with.
* ``project_id``: The ID of the project the metering label rule is
associated with.
* ``remote_ip_prefix``: The remote IP prefix to be associated with
this metering label rule.
:returns: A generator of metering label rule objects
:rtype:
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
"""
return self._list(_metering_label_rule.MeteringLabelRule, **query)
def update_metering_label_rule(self, metering_label_rule, **attrs):
"""Update a metering label rule
:param metering_label_rule:
Either the id of a metering label rule or a
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
instance.
:param attrs: The attributes to update on the metering label rule
represented by ``metering_label_rule``.
:returns: The updated metering label rule
:rtype:
:class:`~openstack.network.v2.metering_label_rule.MeteringLabelRule`
"""
return self._update(
_metering_label_rule.MeteringLabelRule,
metering_label_rule,
**attrs,
)
def create_network(self, **attrs):
"""Create a new network from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.network.Network`,
comprised of the properties on the Network class.
:returns: The results of network creation
:rtype: :class:`~openstack.network.v2.network.Network`
"""
return self._create(_network.Network, **attrs)
def delete_network(self, network, ignore_missing=True, if_revision=None):
"""Delete a network
:param network:
The value can be either the ID of a network or a
:class:`~openstack.network.v2.network.Network` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the network does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent network.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_network.Network,
network,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_network(self, name_or_id, ignore_missing=True, **query):
"""Find a single network
:param name_or_id: The name or ID of a network.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.network.Network` or None
"""
return self._find(
_network.Network,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_network(self, network):
"""Get a single network
:param network:
The value can be the ID of a network or a
:class:`~openstack.network.v2.network.Network` instance.
:returns: One :class:`~openstack.network.v2.network.Network`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_network.Network, network)
def networks(self, **query):
"""Return a generator of networks
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``description``: The network description.
* ``ipv4_address_scope_id``: The ID of the IPv4 address scope for
the network.
* ``ipv6_address_scope_id``: The ID of the IPv6 address scope for
the network.
* ``is_admin_state_up``: Network administrative state
* ``is_port_security_enabled``: The port security status.
* ``is_router_external``: Network is external or not.
* ``is_shared``: Whether the network is shared across projects.
* ``name``: The name of the network.
* ``status``: Network status
* ``project_id``: Owner tenant ID
* ``provider_network_type``: Network physical mechanism
* ``provider_physical_network``: Physical network
* ``provider_segmentation_id``: VLAN ID for VLAN networks or Tunnel
ID for GENEVE/GRE/VXLAN networks
:returns: A generator of network objects
:rtype: :class:`~openstack.network.v2.network.Network`
"""
return self._list(_network.Network, **query)
def update_network(self, network, if_revision=None, **attrs):
"""Update a network
:param network: Either the id of a network or an instance of type
:class:`~openstack.network.v2.network.Network`.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the network represented
by ``network``.
:returns: The updated network
:rtype: :class:`~openstack.network.v2.network.Network`
"""
return self._update(
_network.Network, network, if_revision=if_revision, **attrs
)
def find_network_ip_availability(
self, name_or_id, ignore_missing=True, **query
):
"""Find IP availability of a network
:param name_or_id: The name or ID of a network.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.network_ip_availability.NetworkIPAvailability`
or None
"""
return self._find(
network_ip_availability.NetworkIPAvailability,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_network_ip_availability(self, network):
"""Get IP availability of a network
:param network:
The value can be the ID of a network or a
:class:`~openstack.network.v2.network.Network` instance.
:returns: One
:class:`~openstack.network.v2.network_ip_availability.NetworkIPAvailability`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
network_ip_availability.NetworkIPAvailability, network
)
def network_ip_availabilities(self, **query):
"""Return a generator of network ip availabilities
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``ip_version``: IP version of the network
* ``network_id``: ID of network to use when listening network IP
availability.
* ``network_name``: The name of the network for the particular
network IP availability.
* ``project_id``: Owner tenant ID
:returns: A generator of network ip availability objects
:rtype:
:class:`~openstack.network.v2.network_ip_availability.NetworkIPAvailability`
"""
return self._list(
network_ip_availability.NetworkIPAvailability, **query
)
def create_network_segment_range(self, **attrs):
"""Create a new network segment range from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.network_segment_range.NetworkSegmentRange`,
comprised of the properties on the
NetworkSegmentRange class.
:returns: The results of network segment range creation
:rtype:
:class:`~openstack.network.v2.network_segment_range.NetworkSegmentRange`
"""
return self._create(
_network_segment_range.NetworkSegmentRange, **attrs
)
def delete_network_segment_range(
self, network_segment_range, ignore_missing=True
):
"""Delete a network segment range
:param network_segment_range: The value can be either the ID of a
network segment range or a
:class:`~openstack.network.v2.network_segment_range.NetworkSegmentRange`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the network segment range does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent network segment range.
:returns: ``None``
"""
self._delete(
_network_segment_range.NetworkSegmentRange,
network_segment_range,
ignore_missing=ignore_missing,
)
def find_network_segment_range(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single network segment range
:param name_or_id: The name or ID of a network segment range.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.network_segment_range.NetworkSegmentRange`
or None
"""
return self._find(
_network_segment_range.NetworkSegmentRange,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_network_segment_range(self, network_segment_range):
"""Get a single network segment range
:param network_segment_range: The value can be the ID of a network
segment range or a
:class:`~openstack.network.v2.network_segment_range.NetworkSegmentRange`
instance.
:returns: One
:class:`~openstack.network.v2._network_segment_range.NetworkSegmentRange`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_network_segment_range.NetworkSegmentRange, network_segment_range
)
def network_segment_ranges(self, **query):
"""Return a generator of network segment ranges
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``name``: Name of the segments
* ``default``: The network segment range is loaded from the host
configuration file.
* ``shared``: The network segment range is shared with other
projects
* ``project_id``: ID of the project that owns the network
segment range
* ``network_type``: Network type for the network segment ranges
* ``physical_network``: Physical network name for the network
segment ranges
* ``minimum``: Minimum segmentation ID for the network segment
ranges
* ``maximum``: Maximum Segmentation ID for the network segment
ranges
* ``used``: Mapping of which segmentation ID in the range is
used by which tenant
* ``available``: List of available segmentation IDs in this
network segment range
:returns: A generator of network segment range objects
:rtype:
:class:`~openstack.network.v2._network_segment_range.NetworkSegmentRange`
"""
return self._list(_network_segment_range.NetworkSegmentRange, **query)
def update_network_segment_range(self, network_segment_range, **attrs):
"""Update a network segment range
:param network_segment_range: Either the ID of a network segment range
or a
:class:`~openstack.network.v2._network_segment_range.NetworkSegmentRange`
instance.
:param attrs: The attributes to update on the network segment range
represented by ``network_segment_range``.
:returns: The updated network segment range
:rtype:
:class:`~openstack.network.v2._network_segment_range.NetworkSegmentRange`
"""
return self._update(
_network_segment_range.NetworkSegmentRange,
network_segment_range,
**attrs,
)
def create_pool(self, **attrs):
"""Create a new pool from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.pool.Pool`,
comprised of the properties on the Pool class.
:returns: The results of pool creation
:rtype: :class:`~openstack.network.v2.pool.Pool`
"""
return self._create(_pool.Pool, **attrs)
def delete_pool(self, pool, ignore_missing=True):
"""Delete a pool
:param pool: The value can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the pool does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent pool.
:returns: ``None``
"""
self._delete(_pool.Pool, pool, ignore_missing=ignore_missing)
def find_pool(self, name_or_id, ignore_missing=True, **query):
"""Find a single pool
:param name_or_id: The name or ID of a pool.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.pool.Pool` or None
"""
return self._find(
_pool.Pool, name_or_id, ignore_missing=ignore_missing, **query
)
def get_pool(self, pool):
"""Get a single pool
:param pool: The value can be the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance.
:returns: One :class:`~openstack.network.v2.pool.Pool`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_pool.Pool, pool)
def pools(self, **query):
"""Return a generator of pools
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: The description for the pool.
* ``is_admin_state_up``: The administrative state of the pool.
* ``lb_algorithm``: The load-balancer algorithm used, which is one
of ``round-robin``, ``least-connections`` and so on.
* ``name``: The name of the node pool.
* ``project_id``: The ID of the project the pool is associated
with.
* ``protocol``: The protocol used by the pool, which is one of
``TCP``, ``HTTP`` or ``HTTPS``.
* ``provider``: The name of the provider of the load balancer
service.
* ``subnet_id``: The subnet on which the members of the pool are
located.
* ``virtual_ip_id``: The ID of the virtual IP used.
:returns: A generator of pool objects
:rtype: :class:`~openstack.network.v2.pool.Pool`
"""
return self._list(_pool.Pool, **query)
def update_pool(self, pool, **attrs):
"""Update a pool
:param pool: Either the id of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance.
:param attrs: The attributes to update on the pool represented
by ``pool``.
:returns: The updated pool
:rtype: :class:`~openstack.network.v2.pool.Pool`
"""
return self._update(_pool.Pool, pool, **attrs)
def create_pool_member(self, pool, **attrs):
"""Create a new pool member from attributes
:param pool: The pool can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance that
the member will be created in.
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.pool_member.PoolMember`,
comprised of the properties on the PoolMember class.
:returns: The results of pool member creation
:rtype: :class:`~openstack.network.v2.pool_member.PoolMember`
"""
poolobj = self._get_resource(_pool.Pool, pool)
return self._create(
_pool_member.PoolMember, pool_id=poolobj.id, **attrs
)
def delete_pool_member(self, pool_member, pool, ignore_missing=True):
"""Delete a pool member
:param pool_member:
The member can be either the ID of a pool member or a
:class:`~openstack.network.v2.pool_member.PoolMember` instance.
:param pool: The pool can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance that
the member belongs to.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the pool member does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent pool member.
:returns: ``None``
"""
poolobj = self._get_resource(_pool.Pool, pool)
self._delete(
_pool_member.PoolMember,
pool_member,
ignore_missing=ignore_missing,
pool_id=poolobj.id,
)
def find_pool_member(self, name_or_id, pool, ignore_missing=True, **query):
"""Find a single pool member
:param str name_or_id: The name or ID of a pool member.
:param pool: The pool can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance that
the member belongs to.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.pool_member.PoolMember`
or None
"""
poolobj = self._get_resource(_pool.Pool, pool)
return self._find(
_pool_member.PoolMember,
name_or_id,
ignore_missing=ignore_missing,
pool_id=poolobj.id,
**query,
)
def get_pool_member(self, pool_member, pool):
"""Get a single pool member
:param pool_member: The member can be the ID of a pool member or a
:class:`~openstack.network.v2.pool_member.PoolMember`
instance.
:param pool: The pool can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance that
the member belongs to.
:returns: One :class:`~openstack.network.v2.pool_member.PoolMember`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
poolobj = self._get_resource(_pool.Pool, pool)
return self._get(
_pool_member.PoolMember, pool_member, pool_id=poolobj.id
)
def pool_members(self, pool, **query):
"""Return a generator of pool members
:param pool: The pool can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance that
the member belongs to.
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``address``: The IP address of the pool member.
* ``is_admin_state_up``: The administrative state of the pool
member.
* ``name``: Name of the pool member.
* ``project_id``: The ID of the project this pool member is
associated with.
* ``protocol_port``: The port on which the application is hosted.
* ``subnet_id``: Subnet ID in which to access this pool member.
* ``weight``: A positive integer value that indicates the relative
portion of traffic that this member should receive from the
pool.
:returns: A generator of pool member objects
:rtype: :class:`~openstack.network.v2.pool_member.PoolMember`
"""
poolobj = self._get_resource(_pool.Pool, pool)
return self._list(_pool_member.PoolMember, pool_id=poolobj.id, **query)
def update_pool_member(self, pool_member, pool, **attrs):
"""Update a pool member
:param pool_member: Either the ID of a pool member or a
:class:`~openstack.network.v2.pool_member.PoolMember`
instance.
:param pool: The pool can be either the ID of a pool or a
:class:`~openstack.network.v2.pool.Pool` instance that
the member belongs to.
:param attrs: The attributes to update on the pool member
represented by ``pool_member``.
:returns: The updated pool member
:rtype: :class:`~openstack.network.v2.pool_member.PoolMember`
"""
poolobj = self._get_resource(_pool.Pool, pool)
return self._update(
_pool_member.PoolMember, pool_member, pool_id=poolobj.id, **attrs
)
def create_port(self, **attrs):
"""Create a new port from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.port.Port`,
comprised of the properties on the Port class.
:returns: The results of port creation
:rtype: :class:`~openstack.network.v2.port.Port`
"""
return self._create(_port.Port, **attrs)
def create_ports(self, data):
"""Create ports from the list of attributes
:param list data: List of dicts of attributes which will be used to
create a :class:`~openstack.network.v2.port.Port`,
comprised of the properties on the Port class.
:returns: A generator of port objects
:rtype: :class:`~openstack.network.v2.port.Port`
"""
return self._bulk_create(_port.Port, data)
def delete_port(self, port, ignore_missing=True, if_revision=None):
"""Delete a port
:param port: The value can be either the ID of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the port does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent port.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_port.Port,
port,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_port(self, name_or_id, ignore_missing=True, **query):
"""Find a single port
:param name_or_id: The name or ID of a port.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.port.Port` or None
"""
return self._find(
_port.Port, name_or_id, ignore_missing=ignore_missing, **query
)
def get_port(self, port):
"""Get a single port
:param port: The value can be the ID of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:returns: One :class:`~openstack.network.v2.port.Port`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_port.Port, port)
def ports(self, **query):
"""Return a generator of ports
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``description``: The port description.
* ``device_id``: Port device ID.
* ``device_owner``: Port device owner (e.g. ``network:dhcp``).
* ``ip_address``: IP addresses of an allowed address pair.
* ``is_admin_state_up``: The administrative state of the port.
* ``is_port_security_enabled``: The port security status.
* ``mac_address``: Port MAC address.
* ``name``: The port name.
* ``network_id``: ID of network that owns the ports.
* ``project_id``: The ID of the project who owns the network.
* ``status``: The port status. Value is ``ACTIVE`` or ``DOWN``.
* ``subnet_id``: The ID of the subnet.
:returns: A generator of port objects
:rtype: :class:`~openstack.network.v2.port.Port`
"""
return self._list(_port.Port, **query)
def update_port(
self,
port: ty.Union[str, _port.Port],
if_revision: ty.Optional[int] = None,
**attrs: ty.Any,
) -> _port.Port:
"""Update a port
:param port: Either the id of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the port represented
by ``port``.
:returns: The updated port
:rtype: :class:`~openstack.network.v2.port.Port`
"""
return self._update(_port.Port, port, if_revision=if_revision, **attrs)
def add_ip_to_port(self, port, ip):
ip.port_id = port.id
return ip.commit(self)
def remove_ip_from_port(self, ip):
ip.port_id = None
return ip.commit(self)
def get_subnet_ports(self, subnet_id):
result = []
ports = self.ports()
for puerta in ports:
for fixed_ip in puerta.fixed_ips:
if fixed_ip['subnet_id'] == subnet_id:
result.append(puerta)
return result
def create_port_binding(self, port, **attrs):
"""Create a port binding
:param port: The value can be the ID of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.port.Port`,
comprised of the properties on the Port class.
:returns: The results of port binding creation
:rtype: :class:`~openstack.network.v2.port_binding.PortBinding`
"""
port_id = self._get(_port.Port, port).id
return self._create(
_port_binding.PortBinding,
port_id=port_id,
**attrs,
)
def activate_port_binding(
self,
port,
**attrs,
):
"""Activate a port binding
:param port: The value can be the ID of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.port.Port`,
comprised of the properties on the Port class.
:returns: The results of port binding creation
:rtype: :class:`~openstack.network.v2.port_binding.PortBinding`
"""
port_id = self._get(_port.Port, port).id
host = attrs['host']
bindings_on_host = self.port_bindings(port=port_id, host=host)
# There can be only 1 binding on a host at a time
for binding in bindings_on_host:
return binding.activate_port_binding(self, **attrs)
def port_bindings(self, port, **query):
"""Get a single port binding
:param port: The value can be the ID of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``host``: The host on which the port is bound.
* ``vif_type``: The mechanism used for the port like bridge or ovs.
* ``vnic_type``: The type of the vnic, like normal or baremetal.
* ``status``: The port status. Value is ``ACTIVE`` or ``DOWN``.
:returns: A generator of PortBinding objects
:rtype: :class:`~openstack.network.v2.port_binding.PortBinding`
"""
port_id = self._get(_port.Port, port).id
return self._list(
_port_binding.PortBinding,
port_id=port_id,
**query,
)
def delete_port_binding(self, port, host):
"""Delete a Port Binding
:param port: The value can be either the ID of a port or a
:class:`~openstack.network.v2.port.Port` instance.
:param host: The host on which the port is bound.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be
raised when the port does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent port.
:returns: ``None``
"""
port_id = self._get(_port.Port, port).id
bindings_on_host = self.port_bindings(port=port_id, host=host)
# There can be only 1 binding on a host at a time
for binding in bindings_on_host:
return binding.delete_port_binding(self, host=host)
def create_qos_bandwidth_limit_rule(self, qos_policy, **attrs):
"""Create a new bandwidth limit rule
:param attrs: Keyword arguments which will be used to create
a
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`,
comprised of the properties on the
QoSBandwidthLimitRule class.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: The results of resource creation
:rtype:
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._create(
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule,
qos_policy_id=policy.id,
**attrs,
)
def delete_qos_bandwidth_limit_rule(
self, qos_rule, qos_policy, ignore_missing=True
):
"""Delete a bandwidth limit rule
:param qos_rule: The value can be either the ID of a bandwidth limit
rule or a
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent bandwidth limit rule.
:returns: ``None``
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
self._delete(
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule,
qos_rule,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
)
def find_qos_bandwidth_limit_rule(
self, qos_rule_id, qos_policy, ignore_missing=True, **query
):
"""Find a bandwidth limit rule
:param qos_rule_id: The ID of a bandwidth limit rule.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
or None
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._find(
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule,
qos_rule_id,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
**query,
)
def get_qos_bandwidth_limit_rule(self, qos_rule, qos_policy):
"""Get a single bandwidth limit rule
:param qos_rule: The value can be the ID of a minimum bandwidth rule or
a
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: One
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._get(
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule,
qos_rule,
qos_policy_id=policy.id,
)
def qos_bandwidth_limit_rules(self, qos_policy, **query):
"""Return a generator of bandwidth limit rules
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of bandwidth limit rule objects
:rtype:
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._list(
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule,
qos_policy_id=policy.id,
**query,
)
def update_qos_bandwidth_limit_rule(
self,
qos_rule,
qos_policy,
**attrs,
):
"""Update a bandwidth limit rule
:param qos_rule: Either the id of a bandwidth limit rule or a
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param attrs: The attributes to update on the bandwidth limit rule
represented by ``qos_rule``.
:returns: The updated minimum bandwidth rule
:rtype:
:class:`~openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._update(
_qos_bandwidth_limit_rule.QoSBandwidthLimitRule,
qos_rule,
qos_policy_id=policy.id,
**attrs,
)
def create_qos_dscp_marking_rule(self, qos_policy, **attrs):
"""Create a new QoS DSCP marking rule
:param attrs: Keyword arguments which will be used to create
a
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`,
comprised of the properties on the
QosDscpMarkingRule class.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: The results of router creation
:rtype:
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._create(
_qos_dscp_marking_rule.QoSDSCPMarkingRule,
qos_policy_id=policy.id,
**attrs,
)
def delete_qos_dscp_marking_rule(
self, qos_rule, qos_policy, ignore_missing=True
):
"""Delete a QoS DSCP marking rule
:param qos_rule: The value can be either the ID of a minimum bandwidth
rule or a
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent minimum bandwidth rule.
:returns: ``None``
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
self._delete(
_qos_dscp_marking_rule.QoSDSCPMarkingRule,
qos_rule,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
)
def find_qos_dscp_marking_rule(
self, qos_rule_id, qos_policy, ignore_missing=True, **query
):
"""Find a QoS DSCP marking rule
:param qos_rule_id: The ID of a QoS DSCP marking rule.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
or None
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._find(
_qos_dscp_marking_rule.QoSDSCPMarkingRule,
qos_rule_id,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
**query,
)
def get_qos_dscp_marking_rule(self, qos_rule, qos_policy):
"""Get a single QoS DSCP marking rule
:param qos_rule: The value can be the ID of a minimum bandwidth rule or
a
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: One
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._get(
_qos_dscp_marking_rule.QoSDSCPMarkingRule,
qos_rule,
qos_policy_id=policy.id,
)
def qos_dscp_marking_rules(self, qos_policy, **query):
"""Return a generator of QoS DSCP marking rules
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of QoS DSCP marking rule objects
:rtype:
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._list(
_qos_dscp_marking_rule.QoSDSCPMarkingRule,
qos_policy_id=policy.id,
**query,
)
def update_qos_dscp_marking_rule(self, qos_rule, qos_policy, **attrs):
"""Update a QoS DSCP marking rule
:param qos_rule: Either the id of a minimum bandwidth rule or a
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param attrs: The attributes to update on the QoS DSCP marking rule
represented by ``qos_rule``.
:returns: The updated QoS DSCP marking rule
:rtype:
:class:`~openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._update(
_qos_dscp_marking_rule.QoSDSCPMarkingRule,
qos_rule,
qos_policy_id=policy.id,
**attrs,
)
def create_qos_minimum_bandwidth_rule(self, qos_policy, **attrs):
"""Create a new minimum bandwidth rule
:param attrs: Keyword arguments which will be used to create
a
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`,
comprised of the properties on the
QoSMinimumBandwidthRule class.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: The results of resource creation
:rtype:
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._create(
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule,
qos_policy_id=policy.id,
**attrs,
)
def delete_qos_minimum_bandwidth_rule(
self, qos_rule, qos_policy, ignore_missing=True
):
"""Delete a minimum bandwidth rule
:param qos_rule: The value can be either the ID of a minimum bandwidth
rule or a
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent minimum bandwidth rule.
:returns: ``None``
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
self._delete(
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule,
qos_rule,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
)
def find_qos_minimum_bandwidth_rule(
self, qos_rule_id, qos_policy, ignore_missing=True, **query
):
"""Find a minimum bandwidth rule
:param qos_rule_id: The ID of a minimum bandwidth rule.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
or None
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._find(
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule,
qos_rule_id,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
**query,
)
def get_qos_minimum_bandwidth_rule(self, qos_rule, qos_policy):
"""Get a single minimum bandwidth rule
:param qos_rule: The value can be the ID of a minimum bandwidth rule or
a
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy`
instance.
:returns: One
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
:raises:
:class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._get(
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule,
qos_rule,
qos_policy_id=policy.id,
)
def qos_minimum_bandwidth_rules(self, qos_policy, **query):
"""Return a generator of minimum bandwidth rules
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of minimum bandwidth rule objects
:rtype:
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._list(
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule,
qos_policy_id=policy.id,
**query,
)
def update_qos_minimum_bandwidth_rule(self, qos_rule, qos_policy, **attrs):
"""Update a minimum bandwidth rule
:param qos_rule: Either the id of a minimum bandwidth rule or a
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy`
instance.
:param attrs: The attributes to update on the minimum bandwidth rule
represented by ``qos_rule``.
:returns: The updated minimum bandwidth rule
:rtype:
:class:`~openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._update(
_qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule,
qos_rule,
qos_policy_id=policy.id,
**attrs,
)
def create_qos_minimum_packet_rate_rule(self, qos_policy, **attrs):
"""Create a new minimum packet rate rule
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`,
comprised of the properties on the QoSMinimumPacketRateRule class.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: The results of resource creation
:rtype:
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._create(
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule,
qos_policy_id=policy.id,
**attrs,
)
def delete_qos_minimum_packet_rate_rule(
self, qos_rule, qos_policy, ignore_missing=True
):
"""Delete a minimum packet rate rule
:param qos_rule: The value can be either the ID of a minimum packet
rate rule or a
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the resource does not exist. When set to ``True``, no exception
will be set when attempting to delete a nonexistent minimum packet
rate rule.
:returns: ``None``
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
self._delete(
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule,
qos_rule,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
)
def find_qos_minimum_packet_rate_rule(
self, qos_rule_id, qos_policy, ignore_missing=True, **query
):
"""Find a minimum packet rate rule
:param qos_rule_id: The ID of a minimum packet rate rule.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the resource does not exist. When set to ``True``, None will be
returned when attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
or None
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._find(
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule,
qos_rule_id,
ignore_missing=ignore_missing,
qos_policy_id=policy.id,
**query,
)
def get_qos_minimum_packet_rate_rule(self, qos_rule, qos_policy):
"""Get a single minimum packet rate rule
:param qos_rule: The value can be the ID of a minimum packet rate rule
or a
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:returns: One
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._get(
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule,
qos_rule,
qos_policy_id=policy.id,
)
def qos_minimum_packet_rate_rules(self, qos_policy, **query):
"""Return a generator of minimum packet rate rules
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param kwargs query: Optional query parameters to be sent to limit the
resources being returned.
:returns: A generator of minimum packet rate rule objects
:rtype:
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._list(
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule,
qos_policy_id=policy.id,
**query,
)
def update_qos_minimum_packet_rate_rule(
self, qos_rule, qos_policy, **attrs
):
"""Update a minimum packet rate rule
:param qos_rule: Either the id of a minimum packet rate rule or a
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
instance.
:param qos_policy: The value can be the ID of the QoS policy that the
rule belongs or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param attrs: The attributes to update on the minimum packet rate rule
represented by ``qos_rule``.
:returns: The updated minimum packet rate rule
:rtype:
:class:`~openstack.network.v2.qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule`
"""
policy = self._get_resource(_qos_policy.QoSPolicy, qos_policy)
return self._update(
_qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule,
qos_rule,
qos_policy_id=policy.id,
**attrs,
)
def create_qos_policy(self, **attrs):
"""Create a new QoS policy from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.qos_policy.QoSPolicy`,
comprised of the properties on the
QoSPolicy class.
:returns: The results of QoS policy creation
:rtype: :class:`~openstack.network.v2.qos_policy.QoSPolicy`
"""
return self._create(_qos_policy.QoSPolicy, **attrs)
def delete_qos_policy(self, qos_policy, ignore_missing=True):
"""Delete a QoS policy
:param qos_policy: The value can be either the ID of a QoS policy or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the QoS policy does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent QoS policy.
:returns: ``None``
"""
self._delete(
_qos_policy.QoSPolicy, qos_policy, ignore_missing=ignore_missing
)
def find_qos_policy(self, name_or_id, ignore_missing=True, **query):
"""Find a single QoS policy
:param name_or_id: The name or ID of a QoS policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.qos_policy.QoSPolicy` or
None
"""
return self._find(
_qos_policy.QoSPolicy,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_qos_policy(self, qos_policy):
"""Get a single QoS policy
:param qos_policy: The value can be the ID of a QoS policy or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy`
instance.
:returns: One :class:`~openstack.network.v2.qos_policy.QoSPolicy`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_qos_policy.QoSPolicy, qos_policy)
def qos_policies(self, **query):
"""Return a generator of QoS policies
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: The description of a QoS policy.
* ``is_shared``: Whether the policy is shared among projects.
* ``name``: The name of a QoS policy.
* ``project_id``: The ID of the project who owns the network.
:returns: A generator of QoS policy objects
:rtype: :class:`~openstack.network.v2.qos_policy.QoSPolicy`
"""
return self._list(_qos_policy.QoSPolicy, **query)
def update_qos_policy(self, qos_policy, **attrs):
"""Update a QoS policy
:param qos_policy: Either the id of a QoS policy or a
:class:`~openstack.network.v2.qos_policy.QoSPolicy` instance.
:param attrs: The attributes to update on the QoS policy represented
by ``qos_policy``.
:returns: The updated QoS policy
:rtype: :class:`~openstack.network.v2.qos_policy.QoSPolicy`
"""
return self._update(_qos_policy.QoSPolicy, qos_policy, **attrs)
def find_qos_rule_type(self, rule_type_name, ignore_missing=True):
"""Find a single QoS rule type details
:param rule_type_name: The name of a QoS rule type.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.network.v2.qos_rule_type.QoSRuleType`
or None
"""
return self._find(
_qos_rule_type.QoSRuleType,
rule_type_name,
ignore_missing=ignore_missing,
)
def get_qos_rule_type(self, qos_rule_type):
"""Get details about single QoS rule type
:param qos_rule_type: The value can be the name of a QoS policy
rule type or a
:class:`~openstack.network.v2.qos_rule_type.QoSRuleType`
instance.
:returns: One :class:`~openstack.network.v2.qos_rule_type.QoSRuleType`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_qos_rule_type.QoSRuleType, qos_rule_type)
def qos_rule_types(self, **query):
"""Return a generator of QoS rule types
:param dict query: Optional query parameters to be sent to limit the
resources returned. Valid parameters include:
* ``type``: The type of the QoS rule type.
:returns: A generator of QoS rule type objects
:rtype: :class:`~openstack.network.v2.qos_rule_type.QoSRuleType`
"""
return self._list(_qos_rule_type.QoSRuleType, **query)
def delete_quota(self, quota, ignore_missing=True):
"""Delete a quota (i.e. reset to the default quota)
:param quota: The value can be either the ID of a quota or a
:class:`~openstack.network.v2.quota.Quota` instance.
The ID of a quota is the same as the project ID
for the quota.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when quota does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent quota.
:returns: ``None``
"""
self._delete(_quota.Quota, quota, ignore_missing=ignore_missing)
def get_quota(self, quota, details=False):
"""Get a quota
:param quota: The value can be the ID of a quota or a
:class:`~openstack.network.v2.quota.Quota` instance.
The ID of a quota is the same as the project ID
for the quota.
:param details: If set to True, details about quota usage will
be returned.
:returns: One :class:`~openstack.network.v2.quota.Quota`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
if details:
quota_obj = self._get_resource(_quota.Quota, quota)
quota = self._get(
_quota.QuotaDetails, project=quota_obj.id, requires_id=False
)
else:
quota = self._get(_quota.Quota, quota)
return quota
def get_quota_default(self, quota):
"""Get a default quota
:param quota: The value can be the ID of a default quota or a
:class:`~openstack.network.v2.quota.QuotaDefault`
instance. The ID of a default quota is the same
as the project ID for the default quota.
:returns: One :class:`~openstack.network.v2.quota.QuotaDefault`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
quota_obj = self._get_resource(_quota.Quota, quota)
return self._get(
_quota.QuotaDefault, project=quota_obj.id, requires_id=False
)
def quotas(self, **query):
"""Return a generator of quotas
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Currently no query
parameter is supported.
:returns: A generator of quota objects
:rtype: :class:`~openstack.network.v2.quota.Quota`
"""
return self._list(_quota.Quota, **query)
def update_quota(self, quota, **attrs):
"""Update a quota
:param quota: Either the ID of a quota or a
:class:`~openstack.network.v2.quota.Quota` instance.
The ID of a quota is the same as the project ID
for the quota.
:param attrs: The attributes to update on the quota represented
by ``quota``.
:returns: The updated quota
:rtype: :class:`~openstack.network.v2.quota.Quota`
"""
return self._update(_quota.Quota, quota, **attrs)
def create_rbac_policy(self, **attrs):
"""Create a new RBAC policy from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.rbac_policy.RBACPolicy`,
comprised of the properties on the RBACPolicy class.
:return: The results of RBAC policy creation
:rtype: :class:`~openstack.network.v2.rbac_policy.RBACPolicy`
"""
return self._create(_rbac_policy.RBACPolicy, **attrs)
def delete_rbac_policy(self, rbac_policy, ignore_missing=True):
"""Delete a RBAC policy
:param rbac_policy: The value can be either the ID of a RBAC policy or
a :class:`~openstack.network.v2.rbac_policy.RBACPolicy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the RBAC policy does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent RBAC policy.
:returns: ``None``
"""
self._delete(
_rbac_policy.RBACPolicy, rbac_policy, ignore_missing=ignore_missing
)
def find_rbac_policy(self, rbac_policy, ignore_missing=True, **query):
"""Find a single RBAC policy
:param rbac_policy: The ID of a RBAC policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.rbac_policy.RBACPolicy` or None
"""
return self._find(
_rbac_policy.RBACPolicy,
rbac_policy,
ignore_missing=ignore_missing,
**query,
)
def get_rbac_policy(self, rbac_policy):
"""Get a single RBAC policy
:param rbac_policy: The value can be the ID of a RBAC policy or a
:class:`~openstack.network.v2.rbac_policy.RBACPolicy` instance.
:returns: One :class:`~openstack.network.v2.rbac_policy.RBACPolicy`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_rbac_policy.RBACPolicy, rbac_policy)
def rbac_policies(self, **query):
"""Return a generator of RBAC policies
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Available parameters
include:
* ``action``: RBAC policy action
* ``object_type``: Type of the object that the RBAC policy affects
* ``target_project_id``: ID of the tenant that the RBAC policy
affects
* ``project_id``: Owner tenant ID
:returns: A generator of rbac objects
:rtype: :class:`~openstack.network.v2.rbac_policy.RBACPolicy`
"""
return self._list(_rbac_policy.RBACPolicy, **query)
def update_rbac_policy(self, rbac_policy, **attrs):
"""Update a RBAC policy
:param rbac_policy: Either the id of a RBAC policy or a
:class:`~openstack.network.v2.rbac_policy.RBACPolicy` instance.
:param attrs: The attributes to update on the RBAC policy
represented by ``rbac_policy``.
:returns: The updated RBAC policy
:rtype: :class:`~openstack.network.v2.rbac_policy.RBACPolicy`
"""
return self._update(_rbac_policy.RBACPolicy, rbac_policy, **attrs)
def create_router(self, **attrs):
"""Create a new router from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.router.Router`,
comprised of the properties on the Router class.
:returns: The results of router creation
:rtype: :class:`~openstack.network.v2.router.Router`
"""
return self._create(_router.Router, **attrs)
def delete_router(self, router, ignore_missing=True, if_revision=None):
"""Delete a router
:param router: The value can be either the ID of a router or a
:class:`~openstack.network.v2.router.Router` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the router does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent router.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_router.Router,
router,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_router(self, name_or_id, ignore_missing=True, **query):
"""Find a single router
:param name_or_id: The name or ID of a router.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.router.Router` or None
"""
return self._find(
_router.Router, name_or_id, ignore_missing=ignore_missing, **query
)
def get_router(self, router):
"""Get a single router
:param router: The value can be the ID of a router or a
:class:`~openstack.network.v2.router.Router` instance.
:returns: One :class:`~openstack.network.v2.router.Router`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_router.Router, router)
def routers(self, **query):
"""Return a generator of routers
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: The description of a router.
* ``flavor_id``: The ID of the flavor.
* ``is_admin_state_up``: Router administrative state is up or not
* ``is_distributed``: The distributed state of a router
* ``is_ha``: The highly-available state of a router
* ``name``: Router name
* ``project_id``: The ID of the project this router is associated
with.
* ``status``: The status of the router.
:returns: A generator of router objects
:rtype: :class:`~openstack.network.v2.router.Router`
"""
return self._list(_router.Router, **query)
def update_router(self, router, if_revision=None, **attrs):
"""Update a router
:param router: Either the id of a router or a
:class:`~openstack.network.v2.router.Router` instance.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the router represented
by ``router``.
:returns: The updated router
:rtype: :class:`~openstack.network.v2.router.Router`
"""
return self._update(
_router.Router, router, if_revision=if_revision, **attrs
)
def add_interface_to_router(self, router, subnet_id=None, port_id=None):
"""Add Interface to a router
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param subnet_id: ID of the subnet
:param port_id: ID of the port
:returns: Router with updated interface
:rtype: :class:`~openstack.network.v2.router.Router`
"""
body = {}
if port_id:
body = {'port_id': port_id}
else:
body = {'subnet_id': subnet_id}
router = self._get_resource(_router.Router, router)
return router.add_interface(self, **body)
def remove_interface_from_router(
self, router, subnet_id=None, port_id=None
):
"""Remove Interface from a router
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param subnet: ID of the subnet
:param port: ID of the port
:returns: Router with updated interface
:rtype: :class:`~openstack.network.v2.router.Router`
"""
body = {}
if port_id:
body = {'port_id': port_id}
else:
body = {'subnet_id': subnet_id}
router = self._get_resource(_router.Router, router)
return router.remove_interface(self, **body)
def add_extra_routes_to_router(self, router, body):
"""Add extra routes to a router
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: The request body as documented in the api-ref.
:returns: Router with updated extra routes
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.add_extra_routes(self, body=body)
def remove_extra_routes_from_router(self, router, body):
"""Remove extra routes from a router
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: The request body as documented in the api-ref.
:returns: Router with updated extra routes
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.remove_extra_routes(self, body=body)
def add_gateway_to_router(self, router, **body):
"""Add Gateway to a router
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: Body with the gateway information
:returns: Router with updated interface
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.add_gateway(self, **body)
def remove_gateway_from_router(self, router, **body):
"""Remove Gateway from a router
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: Body with the gateway information
:returns: Router with updated interface
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.remove_gateway(self, **body)
def add_external_gateways(self, router, body):
"""Add router external gateways
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: Body containing the external_gateways parameter.
:returns: Router with added gateways
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.add_external_gateways(self, body)
def update_external_gateways(self, router, body):
"""Update router external gateways
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: Body containing the external_gateways parameter.
:returns: Router with updated gateways
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.update_external_gateways(self, body)
def remove_external_gateways(self, router, body):
"""Remove router external gateways
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param body: Body containing the external_gateways parameter.
:returns: Router without the removed gateways
:rtype: :class:`~openstack.network.v2.router.Router`
"""
router = self._get_resource(_router.Router, router)
return router.remove_external_gateways(self, body)
def routers_hosting_l3_agents(self, router, **query):
"""Return a generator of L3 agent hosting a router
:param router: Either the router id or an instance of
:class:`~openstack.network.v2.router.Router`
:param kwargs query: Optional query parameters to be sent to limit
the resources returned
:returns: A generator of Router L3 Agents
:rtype: :class:`~openstack.network.v2.router.RouterL3Agents`
"""
router = self._get_resource(_router.Router, router)
return self._list(_agent.RouterL3Agent, router_id=router.id, **query)
def agent_hosted_routers(self, agent, **query):
"""Return a generator of routers hosted by a L3 agent
:param agent: Either the agent id of an instance of
:class:`~openstack.network.v2.network_agent.Agent`
:param kwargs query: Optional query parameters to be sent to limit
the resources returned
:returns: A generator of routers
:rtype: :class:`~openstack.network.v2.agent.L3AgentRouters`
"""
agent = self._get_resource(_agent.Agent, agent)
return self._list(_router.L3AgentRouter, agent_id=agent.id, **query)
def add_router_to_agent(self, agent, router):
"""Add router to L3 agent
:param agent: Either the id of an agent
:class:`~openstack.network.v2.agent.Agent` instance
:param router: A router instance
:returns: Agent with attached router
:rtype: :class:`~openstack.network.v2.agent.Agent`
"""
agent = self._get_resource(_agent.Agent, agent)
router = self._get_resource(_router.Router, router)
return agent.add_router_to_agent(self, router.id)
def remove_router_from_agent(self, agent, router):
"""Remove router from L3 agent
:param agent: Either the id of an agent or an
:class:`~openstack.network.v2.agent.Agent` instance
:param router: A router instance
:returns: Agent with removed router
:rtype: :class:`~openstack.network.v2.agent.Agent`
"""
agent = self._get_resource(_agent.Agent, agent)
router = self._get_resource(_router.Router, router)
return agent.remove_router_from_agent(self, router.id)
def create_ndp_proxy(self, **attrs):
"""Create a new ndp proxy from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.ndp_proxy.NDPProxxy`,
comprised of the properties on the NDPProxy class.
:returns: The results of ndp proxy creation
:rtype: :class:`~openstack.network.v2.ndp_proxy.NDPProxxy`
"""
return self._create(_ndp_proxy.NDPProxy, **attrs)
def get_ndp_proxy(self, ndp_proxy):
"""Get a single ndp proxy
:param ndp_proxy: The value can be the ID of a ndp proxy
or a :class:`~openstack.network.v2.ndp_proxy.NDPProxy`
instance.
:returns: One
:class:`~openstack.network.v2.ndp_proxy.NDPProxy`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_ndp_proxy.NDPProxy, ndp_proxy)
def find_ndp_proxy(self, ndp_proxy_id, ignore_missing=True, **query):
"""Find a single ndp proxy
:param ndp_proxy_id: The ID of a ndp proxy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the resource does not exist. When set to ``True``, None will be
returned when attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns:
One :class:`~openstack.network.v2.ndp_proxy.NDPProxy` or None
"""
return self._find(
_ndp_proxy.NDPProxy,
ndp_proxy_id,
ignore_missing=ignore_missing,
**query,
)
def delete_ndp_proxy(self, ndp_proxy, ignore_missing=True):
"""Delete a ndp proxy
:param ndp_proxy: The value can be the ID of a ndp proxy
or a :class:`~openstack.network.v2.ndp_proxy.NDPProxy`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the router does not exist. When set to ``True``, no exception will
be set when attempting to delete a nonexistent ndp proxy.
:returns: ``None``
"""
self._delete(
_ndp_proxy.NDPProxy, ndp_proxy, ignore_missing=ignore_missing
)
def ndp_proxies(self, **query):
"""Return a generator of ndp proxies
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``router_id``: The ID fo the router
* ``port_id``: The ID of internal port.
* ``ip_address``: The internal IP address
:returns: A generator of port forwarding objects
:rtype: :class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
return self._list(_ndp_proxy.NDPProxy, paginated=False, **query)
def update_ndp_proxy(self, ndp_proxy, **attrs):
"""Update a ndp proxy
:param ndp_proxy: The value can be the ID of a ndp proxy or a
:class:`~openstack.network.v2.ndp_proxy.NDPProxy` instance.
:param attrs: The attributes to update on the ip represented
by ``value``.
:returns: The updated ndp_proxy
:rtype: :class:`~openstack.network.v2.ndp_proxy.NDPProxy`
"""
return self._update(_ndp_proxy.NDPProxy, ndp_proxy, **attrs)
def create_firewall_group(self, **attrs):
"""Create a new firewall group from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.firewall_group.FirewallGroup`,
comprised of the properties on the FirewallGroup class.
:returns: The results of firewall group creation
:rtype: :class:`~openstack.network.v2.firewall_group.FirewallGroup`
"""
return self._create(_firewall_group.FirewallGroup, **attrs)
def delete_firewall_group(self, firewall_group, ignore_missing=True):
"""Delete a firewall group
:param firewall_group:
The value can be either the ID of a firewall group or a
:class:`~openstack.network.v2.firewall_group.FirewallGroup`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the firewall group does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent firewall group.
:returns: ``None``
"""
self._delete(
_firewall_group.FirewallGroup,
firewall_group,
ignore_missing=ignore_missing,
)
def find_firewall_group(self, name_or_id, ignore_missing=True, **query):
"""Find a single firewall group
:param name_or_id: The name or ID of a firewall group.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.firewall_group.FirewallGroup` or None
"""
return self._find(
_firewall_group.FirewallGroup,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_firewall_group(self, firewall_group):
"""Get a single firewall group
:param firewall_group: The value can be the ID of a firewall group or a
:class:`~openstack.network.v2.firewall_group.FirewallGroup`
instance.
:returns: One
:class:`~openstack.network.v2.firewall_group.FirewallGroup`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_firewall_group.FirewallGroup, firewall_group)
def firewall_groups(self, **query):
"""Return a generator of firewall_groups
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: Firewall group description
* ``egress_policy_id``: The ID of egress firewall policy
* ``ingress_policy_id``: The ID of ingress firewall policy
* ``name``: The name of a firewall group
* ``shared``: Indicates whether this firewall group is shared
across all projects.
* ``status``: The status of the firewall group. Valid values are
ACTIVE, INACTIVE, ERROR, PENDING_UPDATE, or
PENDING_DELETE.
* ``ports``: A list of the IDs of the ports associated with the
firewall group.
* ``project_id``: The ID of the project this firewall group is
associated with.
:returns: A generator of firewall group objects
"""
return self._list(_firewall_group.FirewallGroup, **query)
def update_firewall_group(self, firewall_group, **attrs):
"""Update a firewall group
:param firewall_group: Either the id of a firewall group or a
:class:`~openstack.network.v2.firewall_group.FirewallGroup`
instance.
:param attrs: The attributes to update on the firewall group
represented by ``firewall_group``.
:returns: The updated firewall group
:rtype: :class:`~openstack.network.v2.firewall_group.FirewallGroup`
"""
return self._update(
_firewall_group.FirewallGroup, firewall_group, **attrs
)
def create_firewall_policy(self, **attrs):
"""Create a new firewall policy from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.firewall_policy.FirewallPolicy`,
comprised of the properties on the FirewallPolicy class.
:returns: The results of firewall policy creation
:rtype: :class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
"""
return self._create(_firewall_policy.FirewallPolicy, **attrs)
def delete_firewall_policy(self, firewall_policy, ignore_missing=True):
"""Delete a firewall policy
:param firewall_policy:
The value can be either the ID of a firewall policy or a
:class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the firewall policy does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent firewall policy.
:returns: ``None``
"""
self._delete(
_firewall_policy.FirewallPolicy,
firewall_policy,
ignore_missing=ignore_missing,
)
def find_firewall_policy(self, name_or_id, ignore_missing=True, **query):
"""Find a single firewall policy
:param name_or_id: The name or ID of a firewall policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
or None
"""
return self._find(
_firewall_policy.FirewallPolicy,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_firewall_policy(self, firewall_policy):
"""Get a single firewall policy
:param firewall_policy: The value can be the ID of a firewall policy
or a
:class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
instance.
:returns: One
:class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_firewall_policy.FirewallPolicy, firewall_policy)
def firewall_policies(self, **query):
"""Return a generator of firewall_policies
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: Firewall policy description
* ``firewall_rule``: A list of the IDs of the firewall rules
associated with the firewall policy.
* ``name``: The name of a firewall policy
* ``shared``: Indicates whether this firewall policy is shared
across all projects.
* ``project_id``: The ID of the project that owns the resource.
:returns: A generator of firewall policy objects
"""
return self._list(_firewall_policy.FirewallPolicy, **query)
def update_firewall_policy(self, firewall_policy, **attrs):
"""Update a firewall policy
:param firewall_policy: Either the id of a firewall policy or a
:class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
instance.
:param attrs: The attributes to update on the firewall policy
represented by ``firewall_policy``.
:returns: The updated firewall policy
:rtype: :class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
"""
return self._update(
_firewall_policy.FirewallPolicy, firewall_policy, **attrs
)
def insert_rule_into_policy(
self,
firewall_policy_id,
firewall_rule_id,
insert_after=None,
insert_before=None,
):
"""Insert a firewall_rule into a firewall_policy in order
:param firewall_policy_id: The ID of the firewall policy.
:param firewall_rule_id: The ID of the firewall rule.
:param insert_after: The ID of the firewall rule to insert the new
rule after. It will be worked only when
insert_before is none.
:param insert_before: The ID of the firewall rule to insert the new
rule before.
:returns: The updated firewall policy
:rtype: :class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
"""
body = {
'firewall_rule_id': firewall_rule_id,
'insert_after': insert_after,
'insert_before': insert_before,
}
policy = self._get_resource(
_firewall_policy.FirewallPolicy, firewall_policy_id
)
return policy.insert_rule(self, **body)
def remove_rule_from_policy(self, firewall_policy_id, firewall_rule_id):
"""Remove a firewall_rule from a firewall_policy.
:param firewall_policy_id: The ID of the firewall policy.
:param firewall_rule_id: The ID of the firewall rule.
:returns: The updated firewall policy
:rtype: :class:`~openstack.network.v2.firewall_policy.FirewallPolicy`
"""
body = {'firewall_rule_id': firewall_rule_id}
policy = self._get_resource(
_firewall_policy.FirewallPolicy, firewall_policy_id
)
return policy.remove_rule(self, **body)
def create_firewall_rule(self, **attrs):
"""Create a new firewall rule from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.firewall_rule.FirewallRule`,
comprised of the properties on the FirewallRule class.
:returns: The results of firewall rule creation
:rtype: :class:`~openstack.network.v2.firewall_rule.FirewallRule`
"""
return self._create(_firewall_rule.FirewallRule, **attrs)
def delete_firewall_rule(self, firewall_rule, ignore_missing=True):
"""Delete a firewall rule
:param firewall_rule:
The value can be either the ID of a firewall rule or a
:class:`~openstack.network.v2.firewall_rule.FirewallRule`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the firewall rule does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent firewall rule.
:returns: ``None``
"""
self._delete(
_firewall_rule.FirewallRule,
firewall_rule,
ignore_missing=ignore_missing,
)
def find_firewall_rule(self, name_or_id, ignore_missing=True, **query):
"""Find a single firewall rule
:param name_or_id: The name or ID of a firewall rule.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.firewall_rule.FirewallRule`
or None
"""
return self._find(
_firewall_rule.FirewallRule,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_firewall_rule(self, firewall_rule):
"""Get a single firewall rule
:param firewall_rule: The value can be the ID of a firewall rule or a
:class:`~openstack.network.v2.firewall_rule.FirewallRule`
instance.
:returns: One
:class:`~openstack.network.v2.firewall_rule.FirewallRule`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_firewall_rule.FirewallRule, firewall_rule)
def firewall_rules(self, **query):
"""Return a generator of firewall_rules
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``action``: The action that the API performs on traffic that
matches the firewall rule.
* ``description``: Firewall rule description
* ``name``: The name of a firewall group
* ``destination_ip_address``: The destination IPv4 or IPv6 address
or CIDR for the firewall rule.
* ``destination_port``: The destination port or port range for
the firewall rule.
* ``enabled``: Facilitates selectively turning off rules.
* ``shared``: Indicates whether this firewall group is shared
across all projects.
* ``ip_version``: The IP protocol version for the firewall rule.
* ``protocol``: The IP protocol for the firewall rule.
* ``source_ip_address``: The source IPv4 or IPv6 address or CIDR
for the firewall rule.
* ``source_port``: The source port or port range for the firewall
rule.
* ``project_id``: The ID of the project this firewall group is
associated with.
:returns: A generator of firewall rule objects
"""
return self._list(_firewall_rule.FirewallRule, **query)
def update_firewall_rule(self, firewall_rule, **attrs):
"""Update a firewall rule
:param firewall_rule: Either the id of a firewall rule or a
:class:`~openstack.network.v2.firewall_rule.FirewallRule`
instance.
:param attrs: The attributes to update on the firewall rule
represented by ``firewall_rule``.
:returns: The updated firewall rule
:rtype: :class:`~openstack.network.v2.firewall_rule.FirewallRule`
"""
return self._update(
_firewall_rule.FirewallRule, firewall_rule, **attrs
)
def create_security_group(self, **attrs):
"""Create a new security group from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.security_group.SecurityGroup`,
comprised of the properties on the SecurityGroup class.
:returns: The results of security group creation
:rtype: :class:`~openstack.network.v2.security_group.SecurityGroup`
"""
return self._create(_security_group.SecurityGroup, **attrs)
def delete_security_group(
self, security_group, ignore_missing=True, if_revision=None
):
"""Delete a security group
:param security_group:
The value can be either the ID of a security group or a
:class:`~openstack.network.v2.security_group.SecurityGroup`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the security group does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent security group.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_security_group.SecurityGroup,
security_group,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_security_group(self, name_or_id, ignore_missing=True, **query):
"""Find a single security group
:param name_or_id: The name or ID of a security group.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.security_group.SecurityGroup`
or None
"""
return self._find(
_security_group.SecurityGroup,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_security_group(self, security_group):
"""Get a single security group
:param security_group: The value can be the ID of a security group or a
:class:`~openstack.network.v2.security_group.SecurityGroup`
instance.
:returns: One
:class:`~openstack.network.v2.security_group.SecurityGroup`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_security_group.SecurityGroup, security_group)
def security_groups(self, **query):
"""Return a generator of security groups
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Valid parameters are:
* ``description``: Security group description
* ``ìd``: The id of a security group, or list of security group ids
* ``name``: The name of a security group
* ``project_id``: The ID of the project this security group is
associated with.
:returns: A generator of security group objects
:rtype: :class:`~openstack.network.v2.security_group.SecurityGroup`
"""
return self._list(_security_group.SecurityGroup, **query)
def update_security_group(self, security_group, if_revision=None, **attrs):
"""Update a security group
:param security_group: Either the id of a security group or a
:class:`~openstack.network.v2.security_group.SecurityGroup`
instance.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the security group
represented by ``security_group``.
:returns: The updated security group
:rtype: :class:`~openstack.network.v2.security_group.SecurityGroup`
"""
return self._update(
_security_group.SecurityGroup,
security_group,
if_revision=if_revision,
**attrs,
)
def create_security_group_rule(self, **attrs):
"""Create a new security group rule from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`,
comprised of the properties on the
SecurityGroupRule class.
:returns: The results of security group rule creation
:rtype:
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
"""
return self._create(_security_group_rule.SecurityGroupRule, **attrs)
def create_security_group_rules(self, data):
"""Create new security group rules from the list of attributes
:param list data: List of dicts of attributes which will be used to
create a
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`,
comprised of the properties on the SecurityGroupRule
class.
:returns: A generator of security group rule objects
:rtype:
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
"""
return self._bulk_create(_security_group_rule.SecurityGroupRule, data)
def delete_security_group_rule(
self, security_group_rule, ignore_missing=True, if_revision=None
):
"""Delete a security group rule
:param security_group_rule:
The value can be either the ID of a security group rule
or a
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the security group rule does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent security group rule.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_security_group_rule.SecurityGroupRule,
security_group_rule,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_security_group_rule(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single security group rule
:param str name_or_id: The ID of a security group rule.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
or None
"""
return self._find(
_security_group_rule.SecurityGroupRule,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_security_group_rule(self, security_group_rule):
"""Get a single security group rule
:param security_group_rule:
The value can be the ID of a security group rule or a
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
instance.
:returns:
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_security_group_rule.SecurityGroupRule, security_group_rule
)
def security_group_rules(self, **query):
"""Return a generator of security group rules
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``description``: The security group rule description
* ``direction``: Security group rule direction
* ``ether_type``: Must be IPv4 or IPv6, and addresses represented
in CIDR must match the ingress or egress rule.
* ``project_id``: The ID of the project this security group rule
is associated with.
* ``protocol``: Security group rule protocol
* ``remote_group_id``: ID of a remote security group
* ``security_group_id``: ID of security group that owns the rules
:returns: A generator of security group rule objects
:rtype:
:class:`~openstack.network.v2.security_group_rule.SecurityGroupRule`
"""
return self._list(_security_group_rule.SecurityGroupRule, **query)
def create_default_security_group_rule(self, **attrs):
"""Create a new default security group rule from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule`,
comprised of the properties on the DefaultSecurityGroupRule class.
:returns: The results of default security group rule creation
:rtype:
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule`
"""
return self._create(
_default_security_group_rule.DefaultSecurityGroupRule, **attrs
)
def delete_default_security_group_rule(
self,
default_security_group_rule,
ignore_missing=True,
):
"""Delete a default security group rule
:param default_security_group_rule:
The value can be either the ID of a default security group rule
or a
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the defaul security group rule does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent default security group rule.
:returns: ``None``
"""
self._delete(
_default_security_group_rule.DefaultSecurityGroupRule,
default_security_group_rule,
ignore_missing=ignore_missing,
)
def find_default_security_group_rule(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single default security group rule
:param str name_or_id: The ID of a default security group rule.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule` or None
"""
return self._find(
_default_security_group_rule.DefaultSecurityGroupRule,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_default_security_group_rule(self, default_security_group_rule):
"""Get a single default security group rule
:param default_security_group_rule:
The value can be the ID of a default security group rule or a
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule` instance.
:returns:
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_default_security_group_rule.DefaultSecurityGroupRule,
default_security_group_rule,
)
def default_security_group_rules(self, **query):
"""Return a generator of default security group rules
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``description``: The default security group rule description
* ``direction``: Default security group rule direction
* ``ether_type``: Must be IPv4 or IPv6, and addresses represented
in CIDR must match the ingress or egress rule.
* ``protocol``: Default security group rule protocol
* ``remote_group_id``: ID of a remote security group
:returns: A generator of default security group rule objects
:rtype:
:class:`~openstack.network.v2.default_security_group_rule.
DefaultSecurityGroupRule`
"""
return self._list(
_default_security_group_rule.DefaultSecurityGroupRule, **query
)
def create_segment(self, **attrs):
"""Create a new segment from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.segment.Segment`,
comprised of the properties on the Segment class.
:returns: The results of segment creation
:rtype: :class:`~openstack.network.v2.segment.Segment`
"""
return self._create(_segment.Segment, **attrs)
def delete_segment(self, segment, ignore_missing=True):
"""Delete a segment
:param segment: The value can be either the ID of a segment or a
:class:`~openstack.network.v2.segment.Segment`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the segment does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent segment.
:returns: ``None``
"""
self._delete(_segment.Segment, segment, ignore_missing=ignore_missing)
def find_segment(self, name_or_id, ignore_missing=True, **query):
"""Find a single segment
:param name_or_id: The name or ID of a segment.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.segment.Segment` or None
"""
return self._find(
_segment.Segment,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_segment(self, segment):
"""Get a single segment
:param segment: The value can be the ID of a segment or a
:class:`~openstack.network.v2.segment.Segment`
instance.
:returns: One :class:`~openstack.network.v2.segment.Segment`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_segment.Segment, segment)
def segments(self, **query):
"""Return a generator of segments
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``description``: The segment description
* ``name``: Name of the segments
* ``network_id``: ID of the network that owns the segments
* ``network_type``: Network type for the segments
* ``physical_network``: Physical network name for the segments
* ``segmentation_id``: Segmentation ID for the segments
:returns: A generator of segment objects
:rtype: :class:`~openstack.network.v2.segment.Segment`
"""
return self._list(_segment.Segment, **query)
def update_segment(self, segment, **attrs):
"""Update a segment
:param segment: Either the id of a segment or a
:class:`~openstack.network.v2.segment.Segment` instance.
:param attrs: The attributes to update on the segment represented
by ``segment``.
:returns: The update segment
:rtype: :class:`~openstack.network.v2.segment.Segment`
"""
return self._update(_segment.Segment, segment, **attrs)
def service_providers(self, **query):
"""Return a generator of service providers
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of service provider objects
:rtype: :class:`~openstack.network.v2.service_provider.ServiceProvider`
"""
return self._list(_service_provider.ServiceProvider, **query)
def create_service_profile(self, **attrs):
"""Create a new network service flavor profile from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.service_profile.ServiceProfile`,
comprised of the properties on the ServiceProfile
class.
:returns: The results of service profile creation
:rtype: :class:`~openstack.network.v2.service_profile.ServiceProfile`
"""
return self._create(_service_profile.ServiceProfile, **attrs)
def delete_service_profile(self, service_profile, ignore_missing=True):
"""Delete a network service flavor profile
:param service_profile: The value can be either the ID of a service
profile or a
:class:`~openstack.network.v2.service_profile.ServiceProfile`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the service profile does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent service profile.
:returns: ``None``
"""
self._delete(
_service_profile.ServiceProfile,
service_profile,
ignore_missing=ignore_missing,
)
def find_service_profile(self, name_or_id, ignore_missing=True, **query):
"""Find a single network service flavor profile
:param name_or_id: The name or ID of a service profile.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.service_profile.ServiceProfile`
or None
"""
return self._find(
_service_profile.ServiceProfile,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_service_profile(self, service_profile):
"""Get a single network service flavor profile
:param service_profile: The value can be the ID of a service_profile or
a :class:`~openstack.network.v2.service_profile.ServiceProfile`
instance.
:returns: One
:class:`~openstack.network.v2.service_profile.ServiceProfile`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_service_profile.ServiceProfile, service_profile)
def service_profiles(self, **query):
"""Return a generator of network service flavor profiles
:param dict query: Optional query parameters to be sent to limit the
resources returned. Available parameters inclue:
* ``description``: The description of the service flavor profile
* ``driver``: Provider driver for the service flavor profile
* ``is_enabled``: Whether the profile is enabled
* ``project_id``: The owner project ID
:returns: A generator of service profile objects
:rtype: :class:`~openstack.network.v2.service_profile.ServiceProfile`
"""
return self._list(_service_profile.ServiceProfile, **query)
def update_service_profile(self, service_profile, **attrs):
"""Update a network flavor service profile
:param service_profile: Either the id of a service profile or a
:class:`~openstack.network.v2.service_profile.ServiceProfile`
instance.
:param attrs: The attributes to update on the service profile
represented by ``service_profile``.
:returns: The updated service profile
:rtype: :class:`~openstack.network.v2.service_profile.ServiceProfile`
"""
return self._update(
_service_profile.ServiceProfile, service_profile, **attrs
)
def create_subnet(self, **attrs):
"""Create a new subnet from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.subnet.Subnet`,
comprised of the properties on the Subnet class.
:returns: The results of subnet creation
:rtype: :class:`~openstack.network.v2.subnet.Subnet`
"""
return self._create(_subnet.Subnet, **attrs)
def delete_subnet(self, subnet, ignore_missing=True, if_revision=None):
"""Delete a subnet
:param subnet: The value can be either the ID of a subnet or a
:class:`~openstack.network.v2.subnet.Subnet` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the subnet does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent subnet.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:returns: ``None``
"""
self._delete(
_subnet.Subnet,
subnet,
ignore_missing=ignore_missing,
if_revision=if_revision,
)
def find_subnet(self, name_or_id, ignore_missing=True, **query):
"""Find a single subnet
:param name_or_id: The name or ID of a subnet.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.subnet.Subnet` or None
"""
return self._find(
_subnet.Subnet, name_or_id, ignore_missing=ignore_missing, **query
)
def get_subnet(self, subnet):
"""Get a single subnet
:param subnet: The value can be the ID of a subnet or a
:class:`~openstack.network.v2.subnet.Subnet` instance.
:returns: One :class:`~openstack.network.v2.subnet.Subnet`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_subnet.Subnet, subnet)
def subnets(self, **query):
"""Return a generator of subnets
:param dict query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``cidr``: Subnet CIDR
* ``description``: The subnet description
* ``gateway_ip``: Subnet gateway IP address
* ``ip_version``: Subnet IP address version
* ``ipv6_address_mode``: The IPv6 address mode
* ``ipv6_ra_mode``: The IPv6 router advertisement mode
* ``is_dhcp_enabled``: Subnet has DHCP enabled (boolean)
* ``name``: Subnet name
* ``network_id``: ID of network that owns the subnets
* ``project_id``: Owner tenant ID
* ``subnet_pool_id``: The subnet pool ID from which to obtain a
CIDR.
:returns: A generator of subnet objects
:rtype: :class:`~openstack.network.v2.subnet.Subnet`
"""
return self._list(_subnet.Subnet, **query)
def update_subnet(self, subnet, if_revision=None, **attrs):
"""Update a subnet
:param subnet: Either the id of a subnet or a
:class:`~openstack.network.v2.subnet.Subnet` instance.
:param int if_revision: Revision to put in If-Match header of update
request to perform compare-and-swap update.
:param attrs: The attributes to update on the subnet represented
by ``subnet``.
:returns: The updated subnet
:rtype: :class:`~openstack.network.v2.subnet.Subnet`
"""
return self._update(
_subnet.Subnet, subnet, if_revision=if_revision, **attrs
)
def create_subnet_pool(self, **attrs):
"""Create a new subnet pool from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.subnet_pool.SubnetPool`,
comprised of the properties on the SubnetPool class.
:returns: The results of subnet pool creation
:rtype: :class:`~openstack.network.v2.subnet_pool.SubnetPool`
"""
return self._create(_subnet_pool.SubnetPool, **attrs)
def delete_subnet_pool(self, subnet_pool, ignore_missing=True):
"""Delete a subnet pool
:param subnet_pool: The value can be either the ID of a subnet pool or
a :class:`~openstack.network.v2.subnet_pool.SubnetPool` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the subnet pool does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent subnet pool.
:returns: ``None``
"""
self._delete(
_subnet_pool.SubnetPool, subnet_pool, ignore_missing=ignore_missing
)
def find_subnet_pool(self, name_or_id, ignore_missing=True, **query):
"""Find a single subnet pool
:param name_or_id: The name or ID of a subnet pool.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.subnet_pool.SubnetPool`
or None
"""
return self._find(
_subnet_pool.SubnetPool,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_subnet_pool(self, subnet_pool):
"""Get a single subnet pool
:param subnet_pool: The value can be the ID of a subnet pool or a
:class:`~openstack.network.v2.subnet_pool.SubnetPool` instance.
:returns: One :class:`~openstack.network.v2.subnet_pool.SubnetPool`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_subnet_pool.SubnetPool, subnet_pool)
def subnet_pools(self, **query):
"""Return a generator of subnet pools
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``address_scope_id``: Subnet pool address scope ID
* ``description``: The subnet pool description
* ``ip_version``: The IP address family
* ``is_default``: Subnet pool is the default (boolean)
* ``is_shared``: Subnet pool is shared (boolean)
* ``name``: Subnet pool name
* ``project_id``: Owner tenant ID
:returns: A generator of subnet pool objects
:rtype: :class:`~openstack.network.v2.subnet_pool.SubnetPool`
"""
return self._list(_subnet_pool.SubnetPool, **query)
def update_subnet_pool(self, subnet_pool, **attrs):
"""Update a subnet pool
:param subnet_pool: Either the ID of a subnet pool or a
:class:`~openstack.network.v2.subnet_pool.SubnetPool` instance.
:param attrs: The attributes to update on the subnet pool
represented by ``subnet_pool``.
:returns: The updated subnet pool
:rtype: :class:`~openstack.network.v2.subnet_pool.SubnetPool`
"""
return self._update(_subnet_pool.SubnetPool, subnet_pool, **attrs)
@staticmethod
def _check_tag_support(resource):
try:
# Check 'tags' attribute exists
resource.tags
except AttributeError:
raise exceptions.InvalidRequest(
f'{resource.__class__.__name__} resource does not support tag'
)
def get_tags(self, resource):
"""Retrieve the tags of a specified resource
:param resource: :class:`~openstack.resource.Resource` instance.
:returns: The resource tags list
:rtype: "list"
"""
self._check_tag_support(resource)
return resource.fetch_tags(self).tags
def set_tags(self, resource, tags):
"""Replace tags of a specified resource with specified tags
:param resource:
:class:`~openstack.resource.Resource` instance.
:param tags: New tags to be set.
:type tags: "list"
:returns: The updated resource
:rtype: :class:`~openstack.resource.Resource`
"""
self._check_tag_support(resource)
return resource.set_tags(self, tags)
def add_tags(self, resource, tags):
"""Add tags to a specified resource
:param resource: :class:`~openstack.resource.Resource` instance.
:param tags: New tags to be set.
:type tags: "list"
:returns: The updated resource
:rtype: :class:`~openstack.resource.Resource`
"""
self._check_tag_support(resource)
return resource.add_tags(self, tags)
def add_tag(self, resource, tag):
"""Add one single tag to a specified resource
:param resource: :class:`~openstack.resource.Resource` instance.
:param tag: New tag to be set.
:type tag: "str"
:returns: The updated resource
:rtype: :class:`~openstack.resource.Resource`
"""
self._check_tag_support(resource)
return resource.add_tag(self, tag)
def remove_tag(self, resource, tag):
"""Remove one single tag of a specified resource
:param resource: :class:`~openstack.resource.Resource` instance.
:param tag: New tag to be set.
:type tag: "str"
:returns: The updated resource
:rtype: :class:`~openstack.resource.Resource`
"""
self._check_tag_support(resource)
return resource.remove_tag(self, tag)
def remove_all_tags(self, resource):
"""Remove all tags of a specified resource
:param resource: :class:`~openstack.resource.Resource` instance.
:returns: The updated resource
:rtype: :class:`~openstack.resource.Resource`
"""
self._check_tag_support(resource)
return resource.remove_all_tags(self)
def check_tag(self, resource, tag):
"""Checks if tag exists on the specified resource
:param resource: :class:`~openstack.resource.Resource` instance.
:param tag: Tag to be tested
:type tags: "string"
:returns: If the tag exists in the specified resource
:rtype: bool
"""
self._check_tag_support(resource)
return resource.check_tag(self, tag)
def create_trunk(self, **attrs):
"""Create a new trunk from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.trunk.Trunk`,
comprised of the properties on the Trunk class.
:returns: The results of trunk creation
:rtype: :class:`~openstack.network.v2.trunk.Trunk`
"""
return self._create(_trunk.Trunk, **attrs)
def delete_trunk(self, trunk, ignore_missing=True):
"""Delete a trunk
:param trunk: The value can be either the ID of trunk or a
:class:`openstack.network.v2.trunk.Trunk` instance
:returns: ``None``
"""
self._delete(_trunk.Trunk, trunk, ignore_missing=ignore_missing)
def find_trunk(self, name_or_id, ignore_missing=True, **query):
"""Find a single trunk
:param name_or_id: The name or ID of a trunk.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.trunk.Trunk`
or None
"""
return self._find(
_trunk.Trunk, name_or_id, ignore_missing=ignore_missing, **query
)
def get_trunk(self, trunk):
"""Get a single trunk
:param trunk: The value can be the ID of a trunk or a
:class:`~openstack.network.v2.trunk.Trunk` instance.
:returns: One
:class:`~openstack.network.v2.trunk.Trunk`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_trunk.Trunk, trunk)
def trunks(self, **query):
"""Return a generator of trunks
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of trunk objects
:rtype: :class:`~openstack.network.v2.trunk.trunk`
"""
return self._list(_trunk.Trunk, **query)
def update_trunk(self, trunk, **attrs):
"""Update a trunk
:param trunk: Either the id of a trunk or a
:class:`~openstack.network.v2.trunk.Trunk` instance.
:param attrs: The attributes to update on the trunk
represented by ``trunk``.
:returns: The updated trunk
:rtype: :class:`~openstack.network.v2.trunk.Trunk`
"""
return self._update(_trunk.Trunk, trunk, **attrs)
def add_trunk_subports(self, trunk, subports):
"""Set sub_ports on trunk
:param trunk: The value can be the ID of a trunk or a
:class:`~openstack.network.v2.trunk.Trunk` instance.
:param subports: New subports to be set.
:type subports: "list"
:returns: The updated trunk
:rtype: :class:`~openstack.network.v2.trunk.Trunk`
"""
trunk = self._get_resource(_trunk.Trunk, trunk)
return trunk.add_subports(self, subports)
def delete_trunk_subports(self, trunk, subports):
"""Remove sub_ports from trunk
:param trunk: The value can be the ID of a trunk or a
:class:`~openstack.network.v2.trunk.Trunk` instance.
:param subports: Subports to be removed.
:type subports: "list"
:returns: The updated trunk
:rtype: :class:`~openstack.network.v2.trunk.Trunk`
"""
trunk = self._get_resource(_trunk.Trunk, trunk)
return trunk.delete_subports(self, subports)
def get_trunk_subports(self, trunk):
"""Get sub_ports configured on trunk
:param trunk: The value can be the ID of a trunk or a
:class:`~openstack.network.v2.trunk.Trunk` instance.
:returns: Trunk sub_ports
:rtype: "list"
"""
trunk = self._get_resource(_trunk.Trunk, trunk)
return trunk.get_subports(self)
# ========== VPNaas ==========
# ========== VPN Endpoint group ==========
def create_vpn_endpoint_group(self, **attrs):
"""Create a new vpn endpoint group from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`,
comprised of the properties on the VpnEndpointGroup class.
:returns: The results of vpn endpoint group creation.
:rtype:
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
"""
return self._create(_vpn_endpoint_group.VpnEndpointGroup, **attrs)
def delete_vpn_endpoint_group(
self, vpn_endpoint_group, ignore_missing=True
):
"""Delete a vpn service
:param vpn_endpoint_group:
The value can be either the ID of a vpn service or a
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the vpn service does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent vpn service.
:returns: ``None``
"""
self._delete(
_vpn_endpoint_group.VpnEndpointGroup,
vpn_endpoint_group,
ignore_missing=ignore_missing,
)
def find_vpn_endpoint_group(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single vpn service
:param name_or_id: The name or ID of a vpn service.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
or None
"""
return self._find(
_vpn_endpoint_group.VpnEndpointGroup,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_vpn_endpoint_group(self, vpn_endpoint_group):
"""Get a single vpn service
:param vpn_endpoint_group: The value can be the ID of a vpn service
or a
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
instance.
:returns: One
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_vpn_endpoint_group.VpnEndpointGroup, vpn_endpoint_group
)
def vpn_endpoint_groups(self, **query):
"""Return a generator of vpn services
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of vpn service objects
:rtype:
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
"""
return self._list(_vpn_endpoint_group.VpnEndpointGroup, **query)
def update_vpn_endpoint_group(self, vpn_endpoint_group, **attrs):
"""Update a vpn service
:param vpn_endpoint_group: Either the id of a vpn service or a
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
instance.
:param attrs: The attributes to update on the VPN service
represented by ``vpn_endpoint_group``.
:returns: The updated vpnservice
:rtype:
:class:`~openstack.network.v2.vpn_endpoint_group.VpnEndpointGroup`
"""
return self._update(
_vpn_endpoint_group.VpnEndpointGroup, vpn_endpoint_group, **attrs
)
# ========== IPsec Site Connection ==========
def create_vpn_ipsec_site_connection(self, **attrs):
"""Create a new IPsec site connection from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`,
comprised of the properties on the IPSecSiteConnection class.
:returns: The results of IPsec site connection creation
:rtype:
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
"""
return self._create(
_ipsec_site_connection.VpnIPSecSiteConnection, **attrs
)
def find_vpn_ipsec_site_connection(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single IPsec site connection
:param name_or_id: The name or ID of an IPsec site connection.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException`
will be raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods such as query filters.
:returns: One
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
or None
"""
return self._find(
_ipsec_site_connection.VpnIPSecSiteConnection,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_vpn_ipsec_site_connection(self, ipsec_site_connection):
"""Get a single IPsec site connection
:param ipsec_site_connection: The value can be the ID of an IPsec site
connection or a
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
instance.
:returns: One
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_ipsec_site_connection.VpnIPSecSiteConnection,
ipsec_site_connection,
)
def vpn_ipsec_site_connections(self, **query):
"""Return a generator of IPsec site connections
:param dict query: Optional query parameters to be sent to limit the
resources being returned.
:returns: A generator of IPsec site connection objects
:rtype:
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
"""
return self._list(
_ipsec_site_connection.VpnIPSecSiteConnection, **query
)
def update_vpn_ipsec_site_connection(self, ipsec_site_connection, **attrs):
"""Update a IPsec site connection
:ipsec_site_connection: Either the id of an IPsec site connection or
a
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
instance.
:param attrs: The attributes to update on the IPsec site
connection represented by ``ipsec_site_connection``.
:returns: The updated IPsec site connection
:rtype:
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
"""
return self._update(
_ipsec_site_connection.VpnIPSecSiteConnection,
ipsec_site_connection,
**attrs,
)
def delete_vpn_ipsec_site_connection(
self, ipsec_site_connection, ignore_missing=True
):
"""Delete a IPsec site connection
:param ipsec_site_connection: The value can be either the ID of an
IPsec site connection, or a
:class:`~openstack.network.v2.vpn_ipsec_site_connection.VpnIPSecSiteConnection`
instance.
:param bool ignore_missing:
When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the IPsec site connection does not exist.
When set to ``True``, no exception will be set when attempting to
delete a nonexistent IPsec site connection.
:returns: ``None``
"""
self._delete(
_ipsec_site_connection.VpnIPSecSiteConnection,
ipsec_site_connection,
ignore_missing=ignore_missing,
)
# ========== IKEPolicy ==========
def create_vpn_ike_policy(self, **attrs):
"""Create a new ike policy from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`,
comprised of the properties on the VpnIkePolicy class.
:returns: The results of ike policy creation :rtype:
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
"""
return self._create(_ike_policy.VpnIkePolicy, **attrs)
def find_vpn_ike_policy(self, name_or_id, ignore_missing=True, **query):
"""Find a single ike policy
:param name_or_id: The name or ID of an IKE policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException`
will be raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods such as query filters.
:returns: One
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy` or None.
"""
return self._find(
_ike_policy.VpnIkePolicy,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_vpn_ike_policy(self, ike_policy):
"""Get a single ike policy
:param ike_policy: The value can be the ID of an IKE policy or a
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
instance.
:returns: One
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
:rtype: :class:`~openstack.network.v2.ike_policy.VpnIkePolicy`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
return self._get(_ike_policy.VpnIkePolicy, ike_policy)
def vpn_ike_policies(self, **query):
"""Return a generator of IKE policies
:param dict query: Optional query parameters to be sent to limit the
resources being returned.
:returns: A generator of ike policy objects
:rtype: :class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
"""
return self._list(_ike_policy.VpnIkePolicy, **query)
def update_vpn_ike_policy(self, ike_policy, **attrs):
"""Update an IKE policy
:ike_policy: Either the IK of an IKE policy or a
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
instance.
:param attrs: The attributes to update on the ike policy
represented by ``ike_policy``.
:returns: The updated ike policy
:rtype: :class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
"""
return self._update(_ike_policy.VpnIkePolicy, ike_policy, **attrs)
def delete_vpn_ike_policy(self, ike_policy, ignore_missing=True):
"""Delete an IKE policy
:param ike_policy: The value can be either the ID of an ike policy, or
a :class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
instance.
:param bool ignore_missing:
When set to ``False``
:class:`~openstack.exceptions.NotFoundException`
will be raised when the ike policy does not exist.
When set to ``True``, no exception will be set when attempting to
delete a nonexistent ike policy.
:returns: ``None``
"""
self._delete(
_ike_policy.VpnIkePolicy, ike_policy, ignore_missing=ignore_missing
)
# ========== IPSecPolicy ==========
def create_vpn_ipsec_policy(self, **attrs):
"""Create a new IPsec policy from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`,
comprised of the properties on the VpnIpsecPolicy class.
:returns: The results of IPsec policy creation :rtype:
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
"""
return self._create(_ipsec_policy.VpnIpsecPolicy, **attrs)
def find_vpn_ipsec_policy(self, name_or_id, ignore_missing=True, **query):
"""Find a single IPsec policy
:param name_or_id: The name or ID of an IPsec policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException`
will be raised when the resource does not exist. When set to
``True``, None will be returned when attempting to find a
nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods such as query filters.
:returns: One
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
or None.
"""
return self._find(
_ipsec_policy.VpnIpsecPolicy,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_vpn_ipsec_policy(self, ipsec_policy):
"""Get a single IPsec policy
:param ipsec_policy: The value can be the ID of an IPcec policy or a
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
instance.
:returns: One
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
:rtype: :class:`~openstack.network.v2.ipsec_policy.VpnIpsecPolicy`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
return self._get(_ipsec_policy.VpnIpsecPolicy, ipsec_policy)
def vpn_ipsec_policies(self, **query):
"""Return a generator of IPsec policies
:param dict query: Optional query parameters to be sent to limit the
resources being returned.
:returns: A generator of IPsec policy objects
:rtype: :class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
"""
return self._list(_ipsec_policy.VpnIpsecPolicy, **query)
def update_vpn_ipsec_policy(self, ipsec_policy, **attrs):
"""Update an IPsec policy
:ipsec_policy: Either the id of an IPsec policy or a
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
instance.
:param attrs: The attributes to update on the IPsec policy
represented by ``ipsec_policy``.
:returns: The updated IPsec policy
:rtype: :class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
"""
return self._update(
_ipsec_policy.VpnIpsecPolicy, ipsec_policy, **attrs
)
def delete_vpn_ipsec_policy(self, ipsec_policy, ignore_missing=True):
"""Delete an IPsec policy
:param ipsec_policy: The value can be either the ID of an IPsec policy,
or a
:class:`~openstack.network.v2.vpn_ipsec_policy.VpnIpsecPolicy`
instance.
:param bool ignore_missing:
When set to ``False``
:class:`~openstack.exceptions.NotFoundException`
will be raised when the IPsec policy does not exist. When set to
``True``, no exception will be set when attempting to delete a
nonexistent IPsec policy.
:returns: ``None``
"""
self._delete(
_ipsec_policy.VpnIpsecPolicy,
ipsec_policy,
ignore_missing=ignore_missing,
)
# ========== VPN Service ==========
def create_vpn_service(self, **attrs):
"""Create a new vpn service from attributes
:param attrs: Keyword arguments which will be used to create
a :class:`~openstack.network.v2.vpn_service.VpnService`,
comprised of the properties on the VpnService class.
:returns: The results of vpn service creation
:rtype: :class:`~openstack.network.v2.vpn_service.VpnService`
"""
return self._create(_vpn_service.VpnService, **attrs)
def delete_vpn_service(self, vpn_service, ignore_missing=True):
"""Delete a vpn service
:param vpn_service:
The value can be either the ID of a vpn service or a
:class:`~openstack.network.v2.vpn_service.VpnService` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the vpn service does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent vpn service.
:returns: ``None``
"""
self._delete(
_vpn_service.VpnService, vpn_service, ignore_missing=ignore_missing
)
def find_vpn_service(self, name_or_id, ignore_missing=True, **query):
"""Find a single vpn service
:param name_or_id: The name or ID of a vpn service.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One :class:`~openstack.network.v2.vpn_service.VpnService`
or None
"""
return self._find(
_vpn_service.VpnService,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_vpn_service(self, vpn_service):
"""Get a single vpn service
:param vpn_service: The value can be the ID of a vpn service or a
:class:`~openstack.network.v2.vpn_service.VpnService`
instance.
:returns: One
:class:`~openstack.network.v2.vpn_service.VpnService`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_vpn_service.VpnService, vpn_service)
def vpn_services(self, **query):
"""Return a generator of vpn services
:param dict query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of vpn service objects
:rtype: :class:`~openstack.network.v2.vpn_service.VpnService`
"""
return self._list(_vpn_service.VpnService, **query)
def update_vpn_service(self, vpn_service, **attrs):
"""Update a vpn service
:param vpn_service: Either the id of a vpn service or a
:class:`~openstack.network.v2.vpn_service.VpnService` instance.
:param attrs: The attributes to update on the VPN service
represented by ``vpn_service``.
:returns: The updated vpnservice
:rtype: :class:`~openstack.network.v2.vpn_service.VpnService`
"""
return self._update(_vpn_service.VpnService, vpn_service, **attrs)
def create_floating_ip_port_forwarding(self, floating_ip, **attrs):
"""Create a new floating ip port forwarding from attributes
:param floating_ip: The value can be either the ID of a floating ip
or a :class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param attrs:Keyword arguments which will be used to create
a:class:`~openstack.network.v2.port_forwarding.PortForwarding`,
comprised of the properties on the PortForwarding class.
:returns: The results of port forwarding creation
:rtype: :class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
floatingip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._create(
_port_forwarding.PortForwarding,
floatingip_id=floatingip.id,
**attrs,
)
def delete_floating_ip_port_forwarding(
self, floating_ip, port_forwarding, ignore_missing=True
):
"""Delete a floating IP port forwarding.
:param floating_ip: The value can be either the ID of a floating ip
or a :class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param port_forwarding: The value can be either the ID of a port
forwarding or a
:class:`~openstack.network.v2.port_forwarding.PortForwarding`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the floating ip does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent ip.
:returns: ``None``
"""
floatingip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
self._delete(
_port_forwarding.PortForwarding,
port_forwarding,
ignore_missing=ignore_missing,
floatingip_id=floatingip.id,
)
def find_floating_ip_port_forwarding(
self, floating_ip, port_forwarding_id, ignore_missing=True, **query
):
"""Find a floating ip port forwarding
:param floating_ip: The value can be the ID of the Floating IP that the
port forwarding belongs or a
:class:`~openstack.network.v2.floating_ip.FloatingIP` instance.
:param port_forwarding_id: The ID of a port forwarding.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.port_forwarding.PortForwarding`
or None
"""
floatingip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._find(
_port_forwarding.PortForwarding,
port_forwarding_id,
ignore_missing=ignore_missing,
floatingip_id=floatingip.id,
**query,
)
def get_floating_ip_port_forwarding(self, floating_ip, port_forwarding):
"""Get a floating ip port forwarding
:param floating_ip: The value can be the ID of the Floating IP that the
port forwarding belongs or a
:class:`~openstack.network.v2.floating_ip.FloatingIP` instance.
:param port_forwarding: The value can be the ID of a port forwarding
or a
:class:`~openstack.network.v2.port_forwarding.PortForwarding`
instance.
:returns: One
:class:`~openstack.network.v2.port_forwarding.PortForwarding`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
floatingip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._get(
_port_forwarding.PortForwarding,
port_forwarding,
floatingip_id=floatingip.id,
)
def floating_ip_port_forwardings(self, floating_ip, **query):
"""Return a generator of floating ip port forwarding
:param floating_ip: The value can be the ID of the Floating IP that the
port forwarding belongs or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param kwargs **query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of floating ip port forwarding objects
:rtype:
:class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
floatingip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._list(
_port_forwarding.PortForwarding,
floatingip_id=floatingip.id,
**query,
)
def update_floating_ip_port_forwarding(
self, floating_ip, port_forwarding, **attrs
):
"""Update a floating ip port forwarding
:param floating_ip: The value can be the ID of the Floating IP that the
port forwarding belongs or a
:class:`~openstack.network.v2.floating_ip.FloatingIP`
instance.
:param port_forwarding: Either the id of a floating ip port forwarding
or a
:class:`~openstack.network.v2.port_forwarding.PortForwarding`instance.
:param attrs: The attributes to update on the floating ip port
forwarding represented by ``floating_ip``.
:returns: The updated floating ip port forwarding
:rtype: :class:`~openstack.network.v2.port_forwarding.PortForwarding`
"""
floatingip = self._get_resource(_floating_ip.FloatingIP, floating_ip)
return self._update(
_port_forwarding.PortForwarding,
port_forwarding,
floatingip_id=floatingip.id,
**attrs,
)
def create_conntrack_helper(self, router, **attrs):
"""Create a new L3 conntrack helper from attributes
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`,
comprised of the properties on the ConntrackHelper class.
:returns: The results of conntrack helper creation
:rtype:
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`
"""
router = self._get_resource(_router.Router, router)
return self._create(
_l3_conntrack_helper.ConntrackHelper, router_id=router.id, **attrs
)
def conntrack_helpers(self, router, **query):
"""Return a generator of conntrack helpers
:param router: Either the router ID or an instance of
:class:`~openstack.network.v2.router.Router`
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of conntrack helper objects
:rtype:
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`
"""
router = self._get_resource(_router.Router, router)
return self._list(
_l3_conntrack_helper.ConntrackHelper, router_id=router.id, **query
)
def get_conntrack_helper(self, conntrack_helper, router):
"""Get a single L3 conntrack helper
:param conntrack_helper: The value can be the ID of a L3 conntrack
helper or a
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`,
instance.
:param router: The value can be the ID of a Router or a
:class:`~openstack.network.v2.router.Router` instance.
:returns: One
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
router = self._get_resource(_router.Router, router)
return self._get(
_l3_conntrack_helper.ConntrackHelper,
conntrack_helper,
router_id=router.id,
)
def update_conntrack_helper(self, conntrack_helper, router, **attrs):
"""Update a L3 conntrack_helper
:param conntrack_helper: The value can be the ID of a L3 conntrack
helper or a
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`,
instance.
:param router: The value can be the ID of a Router or a
:class:`~openstack.network.v2.router.Router` instance.
:param attrs: The attributes to update on the L3 conntrack helper
represented by ``conntrack_helper``.
:returns: The updated conntrack helper
:rtype:
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`
"""
router = self._get_resource(_router.Router, router)
return self._update(
_l3_conntrack_helper.ConntrackHelper,
conntrack_helper,
router_id=router.id,
**attrs,
)
def delete_conntrack_helper(
self, conntrack_helper, router, ignore_missing=True
):
"""Delete a L3 conntrack_helper
:param conntrack_helper: The value can be the ID of a L3 conntrack
helper or a
:class:`~openstack.network.v2.l3_conntrack_helper.ConntrackHelper`,
instance.
:param router: The value can be the ID of a Router or a
:class:`~openstack.network.v2.router.Router` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the floating ip does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent ip.
:returns: ``None``
"""
router = self._get_resource(_router.Router, router)
self._delete(
_l3_conntrack_helper.ConntrackHelper,
conntrack_helper,
router_id=router.id,
ignore_missing=ignore_missing,
)
def create_tap_flow(self, **attrs):
"""Create a new Tap Flow from attributes"""
return self._create(_tap_flow.TapFlow, **attrs)
def delete_tap_flow(self, tap_flow, ignore_missing=True):
"""Delete a Tap Flow"""
self._delete(
_tap_flow.TapFlow, tap_flow, ignore_missing=ignore_missing
)
def find_tap_flow(self, name_or_id, ignore_missing=True, **query):
"""Find a single Tap Service"""
return self._find(
_tap_flow.TapFlow,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_tap_flow(self, tap_flow):
"""Get a signle Tap Flow"""
return self._get(_tap_flow.TapFlow, tap_flow)
def update_tap_flow(self, tap_flow, **attrs):
"""Update a Tap Flow"""
return self._update(_tap_flow.TapFlow, tap_flow, **attrs)
def tap_flows(self, **query):
"""Return a generator of Tap Flows"""
return self._list(_tap_flow.TapFlow, **query)
def create_tap_mirror(self, **attrs):
"""Create a new Tap Mirror from attributes"""
return self._create(_tap_mirror.TapMirror, **attrs)
def delete_tap_mirror(self, tap_mirror, ignore_missing=True):
"""Delete a Tap Mirror"""
self._delete(
_tap_mirror.TapMirror, tap_mirror, ignore_missing=ignore_missing
)
def find_tap_mirror(self, name_or_id, ignore_missing=True, **query):
"""Find a single Tap Mirror"""
return self._find(
_tap_mirror.TapMirror,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_tap_mirror(self, tap_mirror):
"""Get a signle Tap Mirror"""
return self._get(_tap_mirror.TapMirror, tap_mirror)
def update_tap_mirror(self, tap_mirror, **attrs):
"""Update a Tap Mirror"""
return self._update(_tap_mirror.TapMirror, tap_mirror, **attrs)
def tap_mirrors(self, **query):
"""Return a generator of Tap Mirrors"""
return self._list(_tap_mirror.TapMirror, **query)
def create_tap_service(self, **attrs):
"""Create a new Tap Service from attributes"""
return self._create(_tap_service.TapService, **attrs)
def delete_tap_service(self, tap_service, ignore_missing=True):
"""Delete a Tap Service"""
self._delete(
_tap_service.TapService, tap_service, ignore_missing=ignore_missing
)
def find_tap_service(self, name_or_id, ignore_missing=True, **query):
"""Find a single Tap Service"""
return self._find(
_tap_service.TapService,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_tap_service(self, tap_service):
"""Get a signle Tap Service"""
return self._get(_tap_service.TapService, tap_service)
def update_tap_service(self, tap_service, **attrs):
"""Update a Tap Service"""
return self._update(_tap_service.TapService, tap_service, **attrs)
def tap_services(self, **query):
"""Return a generator of Tap Services"""
return self._list(_tap_service.TapService, **query)
def create_sfc_flow_classifier(self, **attrs):
"""Create a new Flow Classifier from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`,
comprised of the properties on the SfcFlowClassifier class.
:returns: The results of SFC Flow Classifier creation
:rtype:
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`
"""
return self._create(_sfc_flow_classifier.SfcFlowClassifier, **attrs)
def delete_sfc_flow_classifier(self, flow_classifier, ignore_missing=True):
"""Delete a Flow Classifier
:param flow_classifier:
The value can be either the ID of a flow classifier or a
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the flow classifier does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent flow classifier.
:returns: ``None``
"""
self._delete(
_sfc_flow_classifier.SfcFlowClassifier,
flow_classifier,
ignore_missing=ignore_missing,
)
def find_sfc_flow_classifier(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single Flow Classifier
:param str name_or_id: The name or ID of an SFC flow classifier.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.sfc_flow_classifier.
SfcFlowClassifier` or None
"""
return self._find(
_sfc_flow_classifier.SfcFlowClassifier,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_sfc_flow_classifier(self, flow_classifier):
"""Get a single Flow Classifier
:param flow_classifier:
The value can be the ID of an SFC flow classifier or a
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier` instance.
:returns:
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_sfc_flow_classifier.SfcFlowClassifier, flow_classifier
)
def update_sfc_flow_classifier(self, flow_classifier, **attrs):
"""Update a Flow Classifier
:param flow_classifier: The value can be the ID of a Flow Classifier
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`,
instance.
:param attrs: The attributes to update on the Flow Classifier
:returns: The updated Flow Classifier.
:rtype:
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`
"""
return self._update(
_sfc_flow_classifier.SfcFlowClassifier, flow_classifier, **attrs
)
def sfc_flow_classifiers(self, **query):
"""Return a generator of Flow Classifiers
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``name``: The name of the flow classifier.
* ``description``: The flow classifier description
* ``ethertype``: Must be IPv4 or IPv6.
* ``protocol``: Flow classifier protocol
:returns: A generator of SFC Flow classifier objects
:rtype:
:class:`~openstack.network.v2.sfc_flow_classifier.
SfcFlowClassifier`
"""
return self._list(_sfc_flow_classifier.SfcFlowClassifier, **query)
def create_sfc_port_chain(self, **attrs):
"""Create a new Port Chain from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.sfc_port_chain.SfcPortChain`,
comprised of the properties on the SfcPortchain class.
:returns: The results of SFC Port Chain creation
:rtype:
:class:`~openstack.network.v2.sfc_port_chain.SfcPortChain`
"""
return self._create(_sfc_port_chain.SfcPortChain, **attrs)
def delete_sfc_port_chain(self, port_chain, ignore_missing=True):
"""Delete a Port Chain
:param port_chain:
The value can be either the ID of a port chain or a
:class:`~openstack.network.v2.sfc_port_chain.SfcPortChain`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the port chain does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent port chain.
:returns: ``None``
"""
self._delete(
_sfc_port_chain.SfcPortChain,
port_chain,
ignore_missing=ignore_missing,
)
def find_sfc_port_chain(self, name_or_id, ignore_missing=True, **query):
"""Find a single Port Chain
:param str name_or_id: The name or ID of an SFC port chain.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.sfc_port_chain.
SfcPortChain` or None
"""
return self._find(
_sfc_port_chain.SfcPortChain,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_sfc_port_chain(self, port_chain):
"""Get a signle Port Chain
:param port_chain:
The value can be the ID of an SFC port chain or a
:class:`~openstack.network.v2.sfc_port_chain.SfcPortChain`
instance.
:returns:
:class:`~openstack.network.v2.sfc_port_chain.SfcPortchain`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_sfc_port_chain.SfcPortChain, port_chain)
def update_sfc_port_chain(self, port_chain, **attrs):
"""Update a Port Chain
:param flow_classifier: The value can be the ID of a Flow Classifier
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`,
instance.
:param attrs: The attributes to update on the Flow Classifier
:returns: The updated Flow Classifier.
:rtype:
:class:`~openstack.network.v2.sfc_flow_classifier.SfcFlowClassifier`
"""
return self._update(_sfc_port_chain.SfcPortChain, port_chain, **attrs)
def sfc_port_chains(self, **query):
"""Return a generator of Port Chains
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``name``: The name of the port chain
* ``description``: The port chain description
:returns: A generator of SFC port chain objects
:rtype:
:class:`~openstack.network.v2.sfc_port_chain.SfcPortChain`
"""
return self._list(_sfc_port_chain.SfcPortChain, **query)
def create_sfc_port_pair(self, **attrs):
"""Create a new Port Pair from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`,
comprised of the properties on the SfcPortPair class.
:returns: The results of SFC Port Pair creation
:rtype:
:class:`~openstack.network.v2.sfc_port_pair.SfPortPair`
"""
return self._create(_sfc_port_pair.SfcPortPair, **attrs)
def delete_sfc_port_pair(self, port_pair, ignore_missing=True):
"""Delete a Port Pair
:param port_pair:
The value can be either the ID of a port pair or a
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the port pair does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent port pair.
:returns: ``None``
"""
self._delete(
_sfc_port_pair.SfcPortPair,
port_pair,
ignore_missing=ignore_missing,
)
def find_sfc_port_pair(self, name_or_id, ignore_missing=True, **query):
"""Find a single Port Pair
:param str name_or_id: The name or ID of an SFC port pair.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair` or None
"""
return self._find(
_sfc_port_pair.SfcPortPair,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_sfc_port_pair(self, port_pair):
"""Get a signle Port Pair
:param port_pair:
The value can be the ID of an SFC port pair or a
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`
instance.
:returns:
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_sfc_port_pair.SfcPortPair, port_pair)
def update_sfc_port_pair(self, port_pair, **attrs):
"""Update a Port Pair
:param port_pair: The value can be the ID of a Port Pair
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`,
instance.
:param attrs: The attributes to update on the Port Pair
:returns: The updated Port Pair.
:rtype:
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`
"""
return self._update(_sfc_port_pair.SfcPortPair, port_pair, **attrs)
def sfc_port_pairs(self, **query):
"""Return a generator of Port Pairs
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``name``: The name of the port pair.
* ``description``: The port pair description.
:returns: A generator of SFC port pair objects
:rtype:
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPair`
"""
return self._list(_sfc_port_pair.SfcPortPair, **query)
def create_sfc_port_pair_group(self, **attrs):
"""Create a new Port Pair Group from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.sfc_port_pair_group.SfcPortPairGroup`,
comprised of the properties on the SfcPortPairGroup class.
:returns: The results of SFC Port Pair Group creation
:rtype:
:class:`~openstack.network.v2.sfc_port_pair_group.SfcPortPairGroup`
"""
return self._create(_sfc_port_pair_group.SfcPortPairGroup, **attrs)
def delete_sfc_port_pair_group(self, port_pair_group, ignore_missing=True):
"""Delete a Port Pair Group
:param port_pair_group:
The value can be either the ID of a port pair group or a
:class:`~openstack.network.v2.sfc_port_pair_group.
SfcPortPairGroup` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the port pair group does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent port pair group.
:returns: ``None``
"""
self._delete(
_sfc_port_pair_group.SfcPortPairGroup,
port_pair_group,
ignore_missing=ignore_missing,
)
def find_sfc_port_pair_group(
self, name_or_id, ignore_missing=True, **query
):
"""Find a single Port Pair Group
:param str name_or_id: The name or ID of an SFC port pair group.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.sfc_port_pair_group.
SfcPortPairGroup` or None
"""
return self._find(
_sfc_port_pair_group.SfcPortPairGroup,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_sfc_port_pair_group(self, port_pair_group):
"""Get a signle Port Pair Group
:param port_pair_group:
The value can be the ID of an SFC port pair group or a
:class:`~openstack.network.v2.sfc_port_pair_group.SfcPortPairGroup`
instance.
:returns:
:class:`~openstack.network.v2.sfc_port_pair_group.SfcPortPairGroup`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_sfc_port_pair_group.SfcPortPairGroup, port_pair_group
)
def update_sfc_port_pair_group(self, port_pair_group, **attrs):
"""Update a Port Pair Group
:param port_pair_group: The value can be the ID of a Port Pair Group
:class:`~openstack.network.v2.sfc_port_pair.SfcPortPairGroup`,
instance.
:param attrs: The attributes to update on the Port Pair Group
:returns: The updated Port Pair Group.
:rtype:
:class:`~openstack.network.v2.sfc_port_pair_group.SfcPortPairGroup`
"""
return self._update(
_sfc_port_pair_group.SfcPortPairGroup, port_pair_group, **attrs
)
def sfc_port_pair_groups(self, **query):
"""Return a generator of Port Pair Groups
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``name``: The name of the port pair.
* ``description``: The port pair description.
:returns: A generator of SFC port pair group objects
:rtype:
:class:`~openstack.network.v2.sfc_port_pair_group.
SfcPortPairGroup`
"""
return self._list(_sfc_port_pair_group.SfcPortPairGroup, **query)
def create_sfc_service_graph(self, **attrs):
"""Create a new Service Graph from attributes
:param attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`,
comprised of the properties on the SfcServiceGraph class.
:returns: The results of SFC Service Graph creation
:rtype:
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`
"""
return self._create(_sfc_sservice_graph.SfcServiceGraph, **attrs)
def delete_sfc_service_graph(self, service_graph, ignore_missing=True):
"""Delete a Service Graph
:param service_graph:
The value can be either the ID of a service graph or a
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the service graph does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent service graph.
:returns: ``None``
"""
self._delete(
_sfc_sservice_graph.SfcServiceGraph,
service_graph,
ignore_missing=ignore_missing,
)
def find_sfc_service_graph(self, name_or_id, ignore_missing=True, **query):
"""Find a single Service Graph
:param str name_or_id: The name or ID of an SFC service graph.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:param dict query: Any additional parameters to be passed into
underlying methods. such as query filters.
:returns: One
:class:`~openstack.network.v2.sfc_service_graph.
SfcServiceGraph` or None
"""
return self._find(
_sfc_sservice_graph.SfcServiceGraph,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_sfc_service_graph(self, service_graph):
"""Get a signle Service Graph
:param service_graph:
The value can be the ID of an SFC service graph or a
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`
instance.
:returns:
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_sfc_sservice_graph.SfcServiceGraph, service_graph)
def update_sfc_service_graph(self, service_graph, **attrs):
"""Update a Service Graph
:param service_graph: The value can be the ID of a Service Graph
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`,
instance.
:param attrs: The attributes to update on the Service Graph
:returns: The updated Service Graph.
:rtype:
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`
"""
return self._update(
_sfc_sservice_graph.SfcServiceGraph, service_graph, **attrs
)
def sfc_service_graphs(self, **query):
"""Return a generator of Service Graphs
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. Available parameters include:
* ``name``: The name of the port pair.
* ``description``: The port pair description.
:returns: A generator of SFC service graph objects
:rtype:
:class:`~openstack.network.v2.sfc_service_graph.SfcServiceGraph`
"""
return self._list(_sfc_sservice_graph.SfcServiceGraph, **query)
# ========== Utilities ==========
def wait_for_status(
self,
res: resource.ResourceT,
status: str,
failures: ty.Optional[list[str]] = None,
interval: ty.Union[int, float, None] = 2,
wait: ty.Optional[int] = None,
attribute: str = 'status',
callback: ty.Optional[ty.Callable[[int], None]] = None,
) -> resource.ResourceT:
"""Wait for the resource to be in a particular status.
:param session: The session to use for making this request.
:param resource: The resource to wait on to reach the status. The
resource must have a status attribute specified via ``attribute``.
:param status: Desired status of the resource.
:param failures: Statuses that would indicate the transition
failed such as 'ERROR'. Defaults to ['ERROR'].
:param interval: Number of seconds to wait between checks.
:param wait: Maximum number of seconds to wait for transition.
Set to ``None`` to wait forever.
:param attribute: Name of the resource attribute that contains the
status.
:param callback: A callback function. This will be called with a single
value, progress. This is API specific but is generally a percentage
value from 0-100.
:return: The updated resource.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if the
transition to status failed to occur in ``wait`` seconds.
:raises: :class:`~openstack.exceptions.ResourceFailure` if the resource
transitioned to one of the states in ``failures``.
:raises: :class:`~AttributeError` if the resource does not have a
``status`` attribute
"""
return resource.wait_for_status(
self, res, status, failures, interval, wait, attribute, callback
)
def wait_for_delete(
self,
res: resource.ResourceT,
interval: int = 2,
wait: int = 120,
callback: ty.Optional[ty.Callable[[int], None]] = None,
) -> resource.ResourceT:
"""Wait for a resource to be deleted.
:param res: The resource to wait on to be deleted.
:param interval: Number of seconds to wait before to consecutive
checks.
:param wait: Maximum number of seconds to wait before the change.
:param callback: A callback function. This will be called with a single
value, progress, which is a percentage value from 0-100.
:returns: The resource is returned on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if transition
to delete failed to occur in the specified seconds.
"""
return resource.wait_for_delete(self, res, interval, wait, callback)
def _get_cleanup_dependencies(self):
return {'network': {'before': ['identity']}}
def _service_cleanup(
self,
dry_run=True,
client_status_queue=None,
identified_resources=None,
filters=None,
resource_evaluation_fn=None,
skip_resources=None,
):
project_id = self.get_project_id()
# check if the VPN service plugin is configured
vpn_plugin = list(self.service_providers(service_type="VPN"))
if vpn_plugin:
if not self.should_skip_resource_cleanup(
"vpn_ipsec_site_connection", skip_resources
):
for obj in self.vpn_ipsec_site_connections():
self._service_cleanup_del_res(
self.delete_vpn_ipsec_site_connection,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not self.should_skip_resource_cleanup(
"vpn_service", skip_resources
):
for obj in self.vpn_services():
self._service_cleanup_del_res(
self.delete_vpn_service,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not self.should_skip_resource_cleanup(
"vpn_endpoint_group", skip_resources
):
for obj in self.vpn_endpoint_groups():
self._service_cleanup_del_res(
self.delete_vpn_endpoint_group,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not self.should_skip_resource_cleanup(
"vpn_ike_policy", skip_resources
):
for obj in self.vpn_ike_policies():
self._service_cleanup_del_res(
self.delete_vpn_ike_policy,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not self.should_skip_resource_cleanup(
"vpn_ipsec_policy", skip_resources
):
for obj in self.vpn_ipsec_policies():
self._service_cleanup_del_res(
self.delete_vpn_ipsec_policy,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not self.should_skip_resource_cleanup(
"floating_ip", skip_resources
):
# Delete floating_ips in the project if no filters defined OR all
# filters are matching and port_id is empty
for obj in self.ips(project_id=project_id):
self._service_cleanup_del_res(
self.delete_ip,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=fip_cleanup_evaluation,
)
if not self.should_skip_resource_cleanup(
"security_group", skip_resources
):
# Delete (try to delete) all security groups in the project
# Let's hope we can't drop SG in use
for obj in self.security_groups(project_id=project_id):
if obj.name != 'default':
self._service_cleanup_del_res(
self.delete_security_group,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not (
self.should_skip_resource_cleanup("network", skip_resources)
or self.should_skip_resource_cleanup("router", skip_resources)
or self.should_skip_resource_cleanup("port", skip_resources)
or self.should_skip_resource_cleanup("subnet", skip_resources)
):
# Networks are crazy, try to delete router+net+subnet
# if there are no "other" ports allocated on the net
for net in self.networks(project_id=project_id):
network_has_ports_allocated = False
router_if = list()
for port in self.ports(
project_id=project_id, network_id=net.id
):
self.log.debug(f'Looking at port {port}')
if port.device_owner in [
'network:router_interface',
'network:router_interface_distributed',
'network:ha_router_replicated_interface',
]:
router_if.append(port)
elif port.device_owner == 'network:dhcp':
# we don't treat DHCP as a real port
continue
elif port.device_owner is None or port.device_owner == '':
# Nobody owns the port - go with it
continue
elif (
identified_resources
and port.device_id not in identified_resources
):
# It seems some no other service identified this resource
# to be deleted. We can assume it doesn't count
network_has_ports_allocated = True
if network_has_ports_allocated:
# If some ports are on net - we cannot delete it
continue
self.log.debug(f'Network {net} should be deleted')
# __Check__ if we need to drop network according to filters
network_must_be_deleted = self._service_cleanup_del_res(
self.delete_network,
net,
dry_run=True,
client_status_queue=None,
identified_resources=None,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not network_must_be_deleted:
# If not - check another net
continue
# otherwise disconnect router, drop net, subnet, router
# Disconnect
for port in router_if:
if client_status_queue:
client_status_queue.put(port)
router = self.get_router(port.device_id)
if not dry_run:
# Router interfaces cannot be deleted when the router has
# static routes, so remove those first
if len(router.routes) > 0:
try:
self.remove_extra_routes_from_router(
router,
{"router": {"routes": router.routes}},
)
except exceptions.SDKException:
self.log.error(
f"Cannot delete routes {router.routes} from router {router}"
)
try:
self.remove_interface_from_router(
router=port.device_id, port_id=port.id
)
except exceptions.SDKException:
self.log.error(f'Cannot delete object {obj}')
# router disconnected, drop it
self._service_cleanup_del_res(
self.delete_router,
router,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
# Drop ports not belonging to anybody
for port in self.ports(
project_id=project_id, network_id=net.id
):
if port.device_owner is None or port.device_owner == '':
self._service_cleanup_del_res(
self.delete_port,
port,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
# Drop all subnets in the net (no further conditions)
for obj in self.subnets(
project_id=project_id, network_id=net.id
):
self._service_cleanup_del_res(
self.delete_subnet,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
# And now the network itself (we are here definitely only if we
# need that)
self._service_cleanup_del_res(
self.delete_network,
net,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
else:
self.log.debug(
"Skipping cleanup of networks, routers, ports and subnets "
"as those resources require all of them to be cleaned up"
"together, but at least one should be kept"
)
if not self.should_skip_resource_cleanup("router", skip_resources):
# It might happen, that we have routers not attached to anything
for obj in self.routers():
ports = list(self.ports(device_id=obj.id))
if len(ports) == 0:
self._service_cleanup_del_res(
self.delete_router,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
def fip_cleanup_evaluation(obj, identified_resources=None, filters=None):
"""Determine whether Floating IP should be deleted
:param Resource obj: Floating IP object
:param dict identified_resources: Optional dictionary with resources
identified by other services for deletion.
:param dict filters: dictionary with parameters
"""
if filters is not None and (
obj.port_id is not None
and identified_resources
and obj.port_id not in identified_resources
):
# If filters are set, but port is not empty and will not be empty -
# skip
return False
else:
return True
|