PowervRNI.psm1
|
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 |
# VMware vRealize Network Insight PowerShell module # Martijn Smit (@smitmartijn) # msmit@vmware.com # Version 2.0 # Keep a list handy of all data source types and the different URIs that is supposed to be called for that datasource $Script:DatasourceURLs = @{ } $Script:DatasourceURLs.Add("vcenter", @("/data-sources/vcenters")) $Script:DatasourceURLs.Add("nsxv", @("/data-sources/nsxv-managers")) $Script:DatasourceURLs.Add("nsxt", @("/data-sources/nsxt-managers")) $Script:DatasourceURLs.Add("ciscoswitch", @("/data-sources/cisco-switches")) $Script:DatasourceURLs.Add("aristaswitch", @("/data-sources/arista-switches")) $Script:DatasourceURLs.Add("dellswitch", @("/data-sources/dell-switches")) $Script:DatasourceURLs.Add("dellos10switch", @("/data-sources/dell-os10-switches")) $Script:DatasourceURLs.Add("brocadeswitch", @("/data-sources/brocade-switches")) $Script:DatasourceURLs.Add("juniperswitch", @("/data-sources/juniper-switches")) $Script:DatasourceURLs.Add("ciscoucs", @("/data-sources/ucs-managers")) $Script:DatasourceURLs.Add("hpeswitch", @("/data-sources/hpe-switches")) $Script:DatasourceURLs.Add("hponeview", @("/data-sources/hpov-managers")) $Script:DatasourceURLs.Add("hpvcmanager", @("/data-sources/hpvc-managers")) $Script:DatasourceURLs.Add("checkpointfirewall", @("/data-sources/checkpoint-firewalls")) $Script:DatasourceURLs.Add("panfirewall", @("/data-sources/panorama-firewalls")) $Script:DatasourceURLs.Add("infoblox", @("/data-sources/infoblox-managers")) $Script:DatasourceURLs.Add("vmc-nsxmanager", @("/data-sources/vmc-nsxmanagers")) $Script:DatasourceURLs.Add("f5-bigip", @("/data-sources/f5-bigip")) $Script:DatasourceURLs.Add("huawei", @("/data-sources/huawei")) $Script:DatasourceURLs.Add("ciscoaci", @("/data-sources/cisco-aci")) $Script:DatasourceURLs.Add("pks", @("/data-sources/pks")) $Script:DatasourceURLs.Add("kubernetes", @("/data-sources/kubernetes-clusters")) $Script:DatasourceURLs.Add("openshift", @("/data-sources/openshift-clusters")) $Script:DatasourceURLs.Add("servicenow", @("/data-sources/servicenow-instances")) $Script:DatasourceURLs.Add("velocloud", @("/data-sources/velocloud")) $Script:DatasourceURLs.Add("azure", @("/data-sources/azure-subscriptions")) $Script:DatasourceURLs.Add("fortimanager", @("/data-sources/fortinet-firewalls")) $Script:DatasourceURLs.Add("generic-device", @("/data-sources/generic-switches")) $Script:DatasourceURLs.Add("mellanoxswitch", @("/data-sources/mellanox-switches")) $Script:DatasourceURLs.Add("ciscoasrxrswitch", @("/data-sources/cisco-asrxr-switches")) $Script:DatasourceURLs.Add("hcxconnector", @("/data-sources/hcx-connectors")) $Script:DatasourceURLs.Add("aws", @("/data-sources/aws-accounts")) # Collect a list of all data source URLs to be used to retrieve "all" data sources $allURLs = New-Object System.Collections.Generic.List[System.Object] foreach ($h in $Script:DatasourceURLs.GetEnumerator()) { $allURLs += $h.Value } $Script:DatasourceURLs.Add("all", $allURLs) # Keep another list handy which translates the internal vRNI Names for datasources to their relative URLs $Script:DatasourceInternalURLs = @{ } $Script:DatasourceInternalURLs.Add("VCenterDataSource", "/data-sources/vcenters") $Script:DatasourceInternalURLs.Add("NSXVManagerDataSource", "/data-sources/nsxv-managers") $Script:DatasourceInternalURLs.Add("NSXTManagerDataSource", "/data-sources/nsxt-managers") $Script:DatasourceInternalURLs.Add("CiscoSwitchDataSource", "/data-sources/cisco-switches") $Script:DatasourceInternalURLs.Add("AristaSwitchDataSource", "/data-sources/arista-switches") $Script:DatasourceInternalURLs.Add("DellSwitchDataSource", "/data-sources/dell-switches") $Script:DatasourceInternalURLs.Add("BrocadeSwitchDataSource", "/data-sources/brocade-switches") $Script:DatasourceInternalURLs.Add("JuniperSwitchDataSource", "/data-sources/juniper-switches") $Script:DatasourceInternalURLs.Add("UCSManagerDataSource", "/data-sources/ucs-managers") $Script:DatasourceInternalURLs.Add("HPESwitchDataSource", "/data-sources/hpe-switches") $Script:DatasourceInternalURLs.Add("HPOneViewManagerDataSource", "/data-sources/hpov-managers") $Script:DatasourceInternalURLs.Add("HPVCManagerDataSource", "/data-sources/hpvc-managers") $Script:DatasourceInternalURLs.Add("CheckpointFirewallDataSource", "/data-sources/checkpoint-firewalls") $Script:DatasourceInternalURLs.Add("PanFirewallDataSource", "/data-sources/panorama-firewalls") $Script:DatasourceInternalURLs.Add("InfobloxManagerDataSource", "/data-sources/infoblox-managers") $Script:DatasourceInternalURLs.Add("PolicyManagerDataSource", "/data-sources/vmc-nsxmanagers") $Script:DatasourceInternalURLs.Add("F5BIGIPDataSource", "/data-sources/f5-bigip") $Script:DatasourceInternalURLs.Add("HuaweiSwitchDataSource", "/data-sources/huawei") $Script:DatasourceInternalURLs.Add("CiscoACIDataSource", "/data-sources/cisco-aci") $Script:DatasourceInternalURLs.Add("PKSDataSource", "/data-sources/pks") $Script:DatasourceInternalURLs.Add("KubernetesDataSource", "/data-sources/kubernetes-clusters") $Script:DatasourceInternalURLs.Add("ServiceNowDataSource", "/data-sources/servicenow-instances") $Script:DatasourceInternalURLs.Add("VeloCloudDataSource", "/data-sources/velocloud") $Script:DatasourceInternalURLs.Add("AzureDataSource", "/data-sources/azure-subscriptions") $Script:DatasourceInternalURLs.Add("FortinetFirewallDataSource", "/data-sources/fortinet-firewalls") $Script:DatasourceInternalURLs.Add("GenericSwitchDataSource", "/data-sources/generic-switches") $Script:DatasourceInternalURLs.Add("MellanoxSwitchDataSource", "/data-sources/mellanox-switches") $Script:DatasourceInternalURLs.Add("CiscoASRXRSwitchDataSource", "/data-sources/cisco-asrxr-switches") $Script:DatasourceInternalURLs.Add("HcxDataSource", "/data-sources/hcx-connectors") $Script:DatasourceInternalURLs.Add("AWSDataSource", "/data-sources/aws-accounts") # This list will be used in Get-vRNIEntity to map entity URLs to their IDs so we can use those IDs in /entities/fetch $Script:EntityURLtoIdMapping = @{ } $Script:EntityURLtoIdMapping.Add("problems", "ProblemEvent") $Script:EntityURLtoIdMapping.Add("vms", "VirtualMachine") $Script:EntityURLtoIdMapping.Add("vnics", "Vnic") $Script:EntityURLtoIdMapping.Add("hosts", "Host") $Script:EntityURLtoIdMapping.Add("clusters", "Cluster") $Script:EntityURLtoIdMapping.Add("vc-datacenters", "VCDatacenter") $Script:EntityURLtoIdMapping.Add("datastores", "Datastore") $Script:EntityURLtoIdMapping.Add("vmknics", "Vmknic") $Script:EntityURLtoIdMapping.Add("layer2-networks", "VxlanLayer2Network") $Script:EntityURLtoIdMapping.Add("ip-sets", "NSXIPSet") $Script:EntityURLtoIdMapping.Add("flows", "Flow") $Script:EntityURLtoIdMapping.Add("security-groups", "NSXSecurityGroup") $Script:EntityURLtoIdMapping.Add("security-tags", "SecurityTag") $Script:EntityURLtoIdMapping.Add("firewall-rules", "NSXFirewallRule") $Script:EntityURLtoIdMapping.Add("firewalls", "NSXDistributedFirewall") $Script:EntityURLtoIdMapping.Add("services", "NSXService") $Script:EntityURLtoIdMapping.Add("service-groups", "NSXServiceGroup") $Script:EntityURLtoIdMapping.Add("vcenter-managers", "VCenterManager") $Script:EntityURLtoIdMapping.Add("nsx-managers", "NSXVManager") $Script:EntityURLtoIdMapping.Add("distributed-virtual-switches", "DistributedVirtualSwitch") $Script:EntityURLtoIdMapping.Add("distributed-virtual-portgroups", "DistributedVirtualPortgroup") $Script:EntityURLtoIdMapping.Add("firewall-managers", "CheckpointManager") $Script:EntityURLtoIdMapping.Add("kubernetes-services", "KubernetesService") $Script:vRNICloudLocationUrlMapping = @{ } $Script:vRNICloudLocationUrlMapping.Add("default", "api.mgmt.cloud.vmware.com") $Script:vRNICloudLocationUrlMapping.Add("US", "api.mgmt.cloud.vmware.com") $Script:vRNICloudLocationUrlMapping.Add("UK", "uk.api.mgmt.cloud.vmware.com") $Script:vRNICloudLocationUrlMapping.Add("JP", "jp.api.mgmt.cloud.vmware.com") $Script:vRNICloudLocationUrlMapping.Add("AU", "au.api.mgmt.cloud.vmware.com") $Script:vRNICloudLocationUrlMapping.Add("CA", "ca.api.mgmt.cloud.vmware.com") $Script:vRNICloudLocationUrlMapping.Add("DE", "de.api.mgmt.cloud.vmware.com") # Thanks to PowerNSX (http://github.com/vmware/powernsx) for providing some of the base functions & # principles on which this module is built on. # Run at module load time to determine a few things about the platform this module is running on. function _PvRNI_init { # $PSVersionTable.PSEdition property does not exist pre v5. We need to do a few things in # exported functions to workaround some limitations of core edition, so we export # the global PNSXPSTarget var to reference if required. if (($PSVersionTable.PSVersion.Major -ge 6) -or (($PSVersionTable.PSVersion.Major -eq 5) -And ($PSVersionTable.PSVersion.Minor -ge 1))) { $script:PvRNI_PlatformType = $PSVersionTable.PSEdition } else { $script:PvRNI_PlatformType = "Desktop" } # Define class required for certificate validation override. Version dependant. # For whatever reason, this does not work when contained within a function? $TrustAllCertsPolicy = @" using System.Net; using System.Security.Cryptography.X509Certificates; public class TrustAllCertsPolicy : ICertificatePolicy { public bool CheckValidationResult( ServicePoint srvPoint, X509Certificate certificate, WebRequest request, int certificateProblem) { return true; } } "@ if ($script:PvRNI_PlatformType -eq "Desktop") { if (-not ("TrustAllCertsPolicy" -as [type])) { Add-Type $TrustAllCertsPolicy } } } function Invoke-vRNIRestMethod { <# .SYNOPSIS Forms and executes a REST API call to a vRealize Network Insight Platform VM. .DESCRIPTION Invoke-vRNIRestMethod uses either a specified connection object as returned by Connect-vRNIServer, or the $defaultvRNIConnection global variable if defined to construct a REST api call to the vRNI API. Invoke-vRNIRestMethod constructs the appropriate request headers required by the vRNI API, including the authentication token (built from the connection object) and the content type, before making the rest call and returning the appropriate JSON object to the caller cmdlet. .EXAMPLE PS C:\> Invoke-vRNIRestMethod -Method GET -Uri "/api/ni/data-sources/vcenters" Performs a 'GET' against the URI /api/ni/data-sources/vcenters and returns the JSON object which contains the vRNI response. This call requires the $defaultvRNIConnection variable to exist and be populated with server and authentiation details as created by Connect-vRNIServer, or it fails with a message to first use Connect-vRNIServer .EXAMPLE PS C:\> $MyConnection = Connect-vRNIServer -Server vrni-platform.lab.local PS C:\> Invoke-vRNIRestMethod -Method GET -Uri "/api/ni/data-sources/vcenters" -Connection $MyConnection Connects to a vRNI Platform VM and stores the connection details in a variable, which in turn is used for the following cmdlet to retrieve all vCenter datasources. The JSON object containing the vRNI response is returned. #> [CmdletBinding(DefaultParameterSetName = "ConnectionObj")] param ( [Parameter (Mandatory = $true, ParameterSetName = "Parameter")] # vRNI Platform server [string]$Server, [Parameter (Mandatory = $true, ParameterSetName = "Parameter")] [Parameter (ParameterSetName = "ConnectionObj")] # REST Method (GET, POST, DELETE, UPDATE) [string]$Method, [Parameter (Mandatory = $true, ParameterSetName = "Parameter")] [Parameter (ParameterSetName = "ConnectionObj")] # URI of API endpoint (/api/ni/endpoint) [string]$URI, [Parameter (Mandatory = $false, ParameterSetName = "Parameter")] [Parameter (ParameterSetName = "ConnectionObj")] # Content to be sent to server when method is PUT/POST/PATCH [string]$Body = "", [Parameter (Mandatory = $false, ParameterSetName = "Parameter")] [Parameter (ParameterSetName = "ConnectionObj")] # Save content to file [string]$OutFile = "", [Parameter (Mandatory = $false, ParameterSetName = "Parameter")] [Parameter (ParameterSetName = "ConnectionObj")] # Override Content-Type [string]$ContentType = "application/json", [Parameter (Mandatory = $false, ParameterSetName = "ConnectionObj")] # Pre-populated connection object as returned by Connect-vRNIServer [psObject]$Connection ) if ($pscmdlet.ParameterSetName -eq "ConnectionObj") { # Ensure we were either called with a connection or there is a defaultConnection (user has called Connect-vRNIServer) if ($null -eq $connection) { # Now we need to assume that defaultvRNIConnection does not exist... if ( -not (test-path variable:global:defaultvRNIConnection) ) { throw "Not connected. Connect to vRNI with Connect-vRNIServer first." } else { Write-Host "$($MyInvocation.MyCommand.Name) : Using default connection" $connection = $defaultvRNIConnection } } $authtoken = $connection.AuthToken $server = $connection.Server # Check if the authentication token hasn't expired yet if ((Get-Date) -gt $connection.AuthTokenExpiry) { throw "The vRNI Authentication token has expired (expired at '$($connection.AuthTokenExpiry.DateTime)'). Please login again using Connect-vRNIServer." } } # Sleep a tiny bit so we don't overload the vRNI API when using consecutive commands Start-Sleep -m 100 # Create a header option dictionary, to be used for authentication (if we have an existing session) and other RESTy stuff $headerDict = @{ } $headerDict.add("Content-Type", $ContentType) # Add the auth token to the headers, if the CSPToken is not filled out if ($authtoken -ne "") { $headerDict.add("Authorization", "NetworkInsight $authtoken") } # Add the Cloud Services Platform token if available (means we're using Network Insight as a Service) if ($null -ne $connection) { if ($null -ne $connection.CSPToken) { $headerDict.remove("Authorization") $headerDict.add("csp-auth-token", $connection.CSPToken) } } # Form the URL to call and write in our journal about this call $URL = "https://$($Server)$($URI)" Write-Debug "$(Get-Date -format s) REST Call via Invoke-RestMethod: $Method $URL " Write-Debug "Headers: $headerDict" Write-Debug "Body: $Body" # Build up Invoke-RestMethod parameters, can differ per platform $invokeRestMethodParams = @{ "Method" = $Method; "Headers" = $headerDict; "ContentType" = $ContentType; "Uri" = $URL; } # If a body for a POST request has been specified, add it to the parameters for Invoke-RestMethod if ($Body -ne "") { $invokeRestMethodParams.Add("Body", $body) } # If we want to save the output to a file (Get-vRNIRecommendedRulesNsxBundle uses this), specify -OutFile if ($OutFile -ne "") { $invokeRestMethodParams.Add("OutFile", $OutFile) } # Add a trigger to ignore SSL certificate checks, if we're not using Network Insight as a Service (self-hosted usually have self-signed certificates) $SkipSSLCheck = $True if ($null -ne $connection) { if ($connection.CSPToken -eq "") { $SkipSSLCheck = $False } } if ($SkipSSLCheck -eq $True) { if (($script:PvRNI_PlatformType -eq "Desktop")) { # Allow untrusted certificate presented by the remote system to be accepted if ([System.Net.ServicePointManager]::CertificatePolicy.tostring() -ne 'TrustAllCertsPolicy') { [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy } } # Core (for now) uses a different mechanism to manipulating [System.Net.ServicePointManager]::CertificatePolicy if (($script:PvRNI_PlatformType -eq "Core")) { $invokeRestMethodParams.Add("SkipCertificateCheck", $true) } } # Only use TLS as SSL connection to vRNI [Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls" # Energize! try { $response = Invoke-RestMethod @invokeRestMethodParams } # If its a webexception, we may have got a response from the server with more information... # Even if this happens on PoSH Core though, the ex is not a webexception and we cant get this info :( catch [System.Net.WebException] { #Check if there is a response populated in the response prop as we can return better detail. $response = $_.exception.response if ( $response ) { $responseStream = $response.GetResponseStream() $reader = New-Object system.io.streamreader($responseStream) $responseBody = $reader.readtoend() ## include ErrorDetails content in case therein lies juicy info $ErrorString = "$($MyInvocation.MyCommand.Name) : The API response received indicates a failure. $($response.StatusCode.value__) : $($response.StatusDescription) : Response Body: $($responseBody)`nErrorDetails: '$($_.ErrorDetails)'" # Log the error with response detail. Write-Warning -Message $ErrorString ## throw the actual error, so that the consumer can debug via the actuall ErrorRecord Throw $_ } else { # No response, log and throw the underlying ex $ErrorString = "$($MyInvocation.MyCommand.Name) : Exception occured calling invoke-restmethod. $($_.exception.tostring())" Write-Warning -Message $_.exception.tostring() ## throw the actual error, so that the consumer can debug via the actuall ErrorRecord Throw $_ } } catch { # Not a webexception (may be on PoSH core), log and throw the underlying ex string $ErrorString = "$($MyInvocation.MyCommand.Name) : Exception occured calling invoke-restmethod. $($_.exception.tostring())" Write-Warning -Message $ErrorString ## throw the actual error, so that the consumer can debug via the actuall ErrorRecord Throw $_ } Write-Debug "$(Get-Date -format s) Invoke-RestMethod Result: $response" Write-Debug "$(Get-Date -format s) Invoke-RestMethod Results: $($response.results)" # Workaround for bug in invoke-restmethod where it doesnt complete the tcp session close to our server after certain calls. # We end up with connectionlimit number of tcp sessions in close_wait and future calls die with a timeout failure. # So, we are getting and killing active sessions after each call. Not sure of performance impact as yet - to test # and probably rewrite over time to use invoke-webrequest for all calls... PiTA!!!! :| #$ServicePoint = [System.Net.ServicePointManager]::FindServicePoint($FullURI) #$ServicePoint.CloseConnectionGroup("") | out-null # Return result if ($response) { $response } } ##################################################################################################################### ##################################################################################################################### ######################################## Connection Management ##################################################### ##################################################################################################################### ##################################################################################################################### function Connect-vRNIServer { <# .SYNOPSIS Connects to the specified vRealize Network Insight Platform VM and constructs a connection object. .DESCRIPTION The Connect-vRNIServer cmdlet returns a connection object that contains an authentication token which the rest of the cmdlets in this module use to perform authenticated REST API calls. The connection object contains the authentication token, the expiry datetime that the token expires and the vRNI server address. .EXAMPLE PS C:\> Connect-vRNIServer -Server vrni-platform.lab.local Connect to vRNI Platform VM with the hostname vrni-platform.lab.local, the cmdlet will prompt for credentials. Returns the connection object, if successful. .EXAMPLE PS C:\> $mysecpassword = ConvertTo-SecureString secret -AsPlainText -Force PS C:\> Connect-vRNIServer -Server vrni-platform.lab.local -Username admin@local -SecurePassword $mysecpassword Connect to vRNI Platform VM with the hostname vrni-platform.lab.local with the given local credentials. Returns the connection object, if successful. .EXAMPLE PS C:\> $mysecpassword = ConvertTo-SecureString secret -AsPlainText -Force PS C:\> Connect-vRNIServer -Server vrni-platform.lab.local -Username martijn@ld.local -SecurePassword $mysecpassword Connect to vRNI Platform VM with the hostname vrni-platform.lab.local with the given LDAP credentials. Returns the connection object, if successful. .EXAMPLE PS C:\> $mysecpassword = ConvertTo-SecureString secret -AsPlainText -Force PS C:\> Connect-vRNIServer -Server vrni-platform.lab.local -Username martijn@ld.local -SecurePassword $mysecpassword -UseLocalAuth Connect to vRNI Platform VM with the hostname vrni-platform.lab.local with the given LOCAL credentials. Returns the connection object, if successful. .EXAMPLE PS C:\> $mysecpassword = ConvertTo-SecureString secret -AsPlainText -Force PS C:\> $MyConnection = Connect-vRNIServer -Server vrni-platform.lab.local -Username admin@local -SecurePassword $mysecpassword PS C:\> Get-vRNIDataSource -Connection $MyConnection Connects to vRNI with the given credentials and then uses the returned connection object in the next cmdlet to retrieve all datasources from that specific vRNI instance. #> param ( [Parameter (Mandatory = $true)] # vRNI Platform hostname or IP address [ValidateNotNullOrEmpty()] [string]$Server, [Parameter (Mandatory = $false)] # Username to use to login to vRNI [ValidateNotNullOrEmpty()] [string]$Username, [Parameter (Mandatory = $false)] # Password to use to login to vRNI [ValidateNotNullOrEmpty()] [securestring]$Password, [Parameter (Mandatory = $false)] #PSCredential object containing NSX API authentication credentials [PSCredential]$Credential, [Parameter (Mandatory = $false)] # Domain to use to login to vRNI - Deprecated, use the full username (something@anything.com) for LDAP auth, and the UseLocalAuth parameter to force local user auth [ValidateNotNullOrEmpty()] [string]$Domain = "", [Parameter (Mandatory = $false)] # Are we doing local authentication? [ValidateNotNullOrEmpty()] [switch]$UseLocalAuth ) # Make sure either -Credential is set, or both -Username and -Password if (($PsBoundParameters.ContainsKey("Credential") -And $PsBoundParameters.ContainsKey("Username")) -Or ($PsBoundParameters.ContainsKey("Credential") -And $PsBoundParameters.ContainsKey("SecurePassword"))) { throw "Specify either -Credential or -Username to authenticate (if using -Username and omitting -SecurePassword, a prompt will be given)" } # Build cred object for default auth if user specified username/pass $connection_credentials = "" if ($PsBoundParameters.ContainsKey("Username")) { # Is the -Password omitted? Prompt securely if (!($PsBoundParameters.ContainsKey("Password"))) { $connection_credentials = Get-Credential -UserName $Username -Message "vRealize Network Insight Platform Authentication" } # If the password has been given in cleartext, else { $connection_credentials = New-Object System.Management.Automation.PSCredential($Username, $Password) } } # If a credential object was given as a parameter, use that elseif ($PSBoundParameters.ContainsKey("Credential")) { $connection_credentials = $Credential } # If no -Username or -Credential was given, prompt for credentials elseif (!$PSBoundParameters.ContainsKey("Credential")) { $connection_credentials = Get-Credential -Message "vRealize Network Insight Platform Authentication" } # Start building the hash table containing the login call we need to do $requestFormat = @{ "username" = $connection_credentials.Username "password" = $connection_credentials.GetNetworkCredential().Password } # Figure out if the username is a local or remote username $parts = $requestFormat.username.split("@") # If no domain param is given, use the default LOCAL domain and populate the "domain" field if ($parts[1] -eq "local" -Or $UseLocalAuth -eq $True -Or $Domain -eq "LOCAL") { $requestFormat.domain = @{ "domain_type" = "LOCAL" "value" = "local" } } # Otherwise there a LDAP domain requested for credentials else { $requestFormat.domain = @{ "domain_type" = "LDAP" "value" = $parts[1] } } # Only use TLS as SSL connection to vRNI [Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls" # Convert the hash to JSON and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat Write-Debug "Request: $($requestBody)" $response = Invoke-vRNIRestMethod -Server $Server -Method POST -URI "/api/ni/auth/token" -Body $requestBody Write-Debug "Response: $($response)" if ($response) { # Setup a custom object to contain the parameters of the connection $connection = [pscustomObject] @{ "Server" = $Server "AuthToken" = $response.token ## the expiration of the token; currently (vRNI API v1.0), tokens are valid for five (5) hours "AuthTokenExpiry" = (Get-Date "01 Jan 1970").AddMilliseconds($response.expiry).ToLocalTime() } # Remember this as the default connection Set-Variable -name defaultvRNIConnection -value $connection -scope Global # Retrieve the API version so we can use that in determining if we can use newer API endpoints $Script:vRNI_API_Version = [System.Version]((Get-vRNIAPIVersion).api_version) # Return the connection $connection } } function Disconnect-vRNIServer { <# .SYNOPSIS Destroys the Connection object if provided, otherwise this destroys the $defaultvRNIConnection global variable if it exists. .DESCRIPTION Although REST is not connection-orientated, vRNI does remember the authentication token which is used throughout the session. This cmdlet also invalidates the authentication token from vRNI, so it can no longer be used. .EXAMPLE PS C:\> Disconnect-vRNIServer Invalidates and removes the global default connection variable. .EXAMPLE PS C:\> Disconnect-vRNIServer -Connection $MyConnection Invalidates the authentication token of a specific connection object #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Invalidate auth token from vRNI $result = Invoke-vRNIRestMethod -Connection $Connection -Method DELETE -URI "/api/ni/auth/token" # Remove the global default connection variable, if the -Connection parameter is the same as the default if ($Connection -eq $defaultvRNIConnection) { if (Get-Variable -Name defaultvRNIConnection -scope global) { Remove-Variable -name defaultvRNIConnection -scope global } } $result } function Connect-NIServer { <# .SYNOPSIS Connects to the Network Insight Service on the VMware Cloud Services Platform and constructs a connection object. .DESCRIPTION The Connect-NIServer cmdlet returns a connection object that contains an authentication token which the rest of the cmdlets in this module use to perform authenticated REST API calls. The connection object contains the Cloud Services Platform token, the expiry datetime that the token expires and the NI server address. The RefreshToken can be found in your profile, here: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens .EXAMPLE PS C:\> Connect-NIServer -RefreshToken xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Connect to the VMware Cloud Services Portal with your specified Refresh Token. The cmdlet will connect to the CSP, validate the token and will return an access token. Returns the connection object, if successful. .EXAMPLE PS C:\> Connect-NIServer -RefreshToken xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Location UK Connect to the vRealize Network Insight Cloud service in the UK. #> param ( [Parameter (Mandatory = $true)] # The Refresh Token from your VMware Cloud Services Portal [ValidateNotNullOrEmpty()] [string]$RefreshToken, [Parameter (Mandatory = $false)] # The Refresh Token from your VMware Cloud Services Portal [ValidateNotNullOrEmpty()] [ValidateSet ("default", "US", "UK", "JP", "AU", "CA", "DE")] [string]$Location = "default" ) # Only use TLS as SSL connection to vRNI [Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls" $vrni_cloud_url = $Script:vRNICloudLocationUrlMapping.$Location $URL = "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token=$($RefreshToken)" $response = Invoke-WebRequest -URI $URL -ContentType "application/json" -Method POST -UseBasicParsing -Headers @{"csp-auth-token" = "$($RefreshToken)" } Write-Debug "Response: $($response)" if ($response) { $response = ($response | ConvertFrom-Json) # Setup a custom object to contain the parameters of the connection, including the URL to the CSP API & Access token $connection = [pscustomObject] @{ "Server" = "$($vrni_cloud_url)/ni" "CSPToken" = $response.access_token ## the expiration of the token; currently (vRNI API v1.0), tokens are valid for five (5) hours "AuthTokenExpiry" = (Get-Date).AddSeconds($response.expires_in).ToLocalTime() } # Remember this as the default connection Set-Variable -name defaultvRNIConnection -value $connection -scope Global # Retrieve the API version so we can use that in determining if we can use newer API endpoints $Script:vRNI_API_Version = [System.Version]((Get-vRNIAPIVersion).api_version) # Return the connection $connection } } function Connect-NIBetaServer { <# .SYNOPSIS Connects to a beta instance of Network Insight Service on the VMware Cloud Services Platform and constructs a connection object. .DESCRIPTION This is only to be used for the beta instances of vRNI Cloud. These instances do not have the full CSP integration, so refresh tokens cannot be used. The AuthToken parameter needs to come from the browswer developer tools, after you've logged in manually. Look for the POST call to /login-csp and copy the extreme long string that's in the response header Set-Cookie; you're looking for the value of csp-auth-token. .EXAMPLE PS C:\> Connect-NIBetaServer -AuthToken 'eyJ0...extremelylongstring..u5hyuA' -BetaURL ndnibeta7.us.api.main.vrni-symphony.com #> param ( [Parameter (Mandatory = $true)] # The AuthToken value after logging in [ValidateNotNullOrEmpty()] [string]$AuthToken, [Parameter (Mandatory = $true)] # The hostname/URL of the beta instance [ValidateNotNullOrEmpty()] [string]$BetaURL ) # Setup a custom object to contain the parameters of the connection, including the URL to the CSP API & Access token $connection = [pscustomObject] @{ "Server" = "$($BetaURL)/ni" "CSPToken" = $AuthToken ## the expiration of the token; currently (vRNI API v1.0), tokens are valid for five (5) hours "AuthTokenExpiry" = (Get-Date).AddSeconds(5 * 60 * 60).ToLocalTime() } # Remember this as the default connection Set-Variable -name defaultvRNIConnection -value $connection -scope Global # Retrieve the API version so we can use that in determining if we can use newer API endpoints $Script:vRNI_API_Version = [System.Version]((Get-vRNIAPIVersion).api_version) # Return the connection $connection } ##################################################################################################################### ##################################################################################################################### ################################################ Search ########################################################### ##################################################################################################################### ##################################################################################################################### function Invoke-vRNISearch { <# .SYNOPSIS Run a search against vRNI. The syntax for these search query is the same as in the web interface. .DESCRIPTION There are 3 possible return fields, based on the type of search query you're doing: - entity_list_response - aggregation_response - groupby_response .EXAMPLE PS C:\> Invoke-vRNISearch -Query "VMs where vCPU Count > 2" Returns a list of all VMs with more than 2 vCPUs #> param ( [Parameter (Mandatory = $True)] # Search query to run against vRNI [ValidateNotNullOrEmpty()] [String]$Query, [Parameter (Mandatory = $False)] # Limit the results with this number [ValidateNotNullOrEmpty()] [int]$Limit = 500, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = @{ "query" = $Query "size" = $Limit } $requestBody = ConvertTo-Json $requestFormat $results = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/search/ql" -Body $requestBody $results } ##################################################################################################################### ##################################################################################################################### ####################################### Infrastructure Management ################################################## ##################################################################################################################### ##################################################################################################################### function Get-vRNINodes { <# .SYNOPSIS Retrieve details of the vRealize Network Insight nodes. .DESCRIPTION Nodes within a vRealize Network Insight typically consist of two node types; collector VMs (or previously know as proxy VMs) and platform VMs. You can have multiple of each type to support your deployment and cluster them. .EXAMPLE PS C:\> Get-vRNINodes Retrieves information about all available nodes. .EXAMPLE PS C:\> Get-vRNINodes | Where {$_.node_type -eq "PROXY_VM"} Retrieves information about all available nodes, but filter on the collector VMs. #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Get a list of available nodes first, this call returns a list of node IDs, which we can use # to retrieve more details on the specific node $nodes = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/infra/nodes" # Use this as a result container $nodes_details = [System.Collections.ArrayList]@() foreach ($node_record in $nodes.results) { # Retrieve the node details and store those $node_info = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/infra/nodes/$($node_record.id)" $nodes_details.Add($node_info) | Out-Null } $nodes_details } function Get-vRNIAPIVersion { <# .SYNOPSIS Retrieve the version number of the vRealize Network Insight API. .DESCRIPTION The API of vRealize Network Insight is versioned and this retrieves that version number. .EXAMPLE PS C:\> Get-vRNIAPIVersion Returns the version number of the vRNI API. #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $version = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/info/version" $version } function Get-vRNILicensing { <# .SYNOPSIS Retrieve the installed licenses and their usage of vRealize Network Insight. .DESCRIPTION vRealize Network Insight requires licensing to function. This will get the activated licenses and their usage .EXAMPLE PS C:\> Get-vRNILicensing Returns the installed licenses and their usage. #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $licensing = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/settings/licensing" $licensing.result } function Test-vRNILicensing { <# .SYNOPSIS Validates a given license against vRealize Network Insight. .DESCRIPTION vRealize Network Insight requires licensing to function. This will validate whether a given license can be activated. If successful, the result will be details of the license. If not successful, the function will throw an exception with the API error .EXAMPLE PS C:\> Test-vRNILicensing -License xxx-yyyy-dddd Validates the given license #> param ( [Parameter (Mandatory = $true)] # The license key we want to validate [ValidateNotNullOrEmpty()] [string]$License, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = @{ "licenseKey" = $License } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $validate = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/settings/licensing/validate" -Body $requestBody $validate.result } function Install-vRNILicensing { <# .SYNOPSIS Installs a given license on vRealize Network Insight. .DESCRIPTION vRealize Network Insight requires licensing to function. This will install a given license. Use Test-vRNILicensing on the license first. If successful, the result will be details of the license. If not successful, the function will throw an exception with the API error. .EXAMPLE PS C:\> Install-vRNILicensing -License xxx-yyyy-dddd Installs the given license #> param ( [Parameter (Mandatory = $true)] # The license key we want to validate [ValidateNotNullOrEmpty()] [string]$License, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = @{ "licenseKey" = $License } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $validate = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/settings/licensing/activate" -Body $requestBody $validate.result } function Remove-vRNILicensing { <# .SYNOPSIS Removes a given license from vRealize Network Insight. .DESCRIPTION vRealize Network Insight requires licensing to function. This will remove a given license. If successful, the result will empty. If not successful, the function will throw an exception with the API error. .EXAMPLE PS C:\> Remove-vRNILicensing -License xxx-yyyy-dddd Removes the given license #> param ( [Parameter (Mandatory = $true)] # The license key we want to validate [ValidateNotNullOrEmpty()] [string]$License, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = @{ "licenseKey" = $License } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $validate = Invoke-vRNIRestMethod -Connection $Connection -Method DELETE -URI "/api/ni/settings/licensing/deactivate" -Body $requestBody $validate.result } ##################################################################################################################### ##################################################################################################################### ####################################### Backup Management ################################################## ##################################################################################################################### ##################################################################################################################### function Get-vRNIBackup { <# .SYNOPSIS Retrieve the settings of the backup of the vRealize Network Insight Platform configuration. .DESCRIPTION You can create scheduled backups of the vRealize Network Insight Platform configuration, this cmdlet retrieves the settings of the backup. If the invocation returns a 404 error; the backup is not configured. .EXAMPLE PS C:\> Get-vRNIBackup Returns the current settings of the backup #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $conf = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/settings/backup" $conf } function Get-vRNIBackupStatus { <# .SYNOPSIS Retrieve the status of the backup of the vRealize Network Insight Platform configuration. .DESCRIPTION You can create scheduled backups of the vRealize Network Insight Platform configuration, this cmdlet retrieves the status of the backup. .EXAMPLE PS C:\> Get-vRNIBackupStatus Returns the current status of the backup #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $status = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/settings/backup/status" $status } function Remove-vRNIBackup { <# .SYNOPSIS Removes the backup configuration of the vRealize Network Insight Platform configuration. .DESCRIPTION You can create scheduled backups of the vRealize Network Insight Platform configuration, this cmdlet removes the current configuration of the backup. If the invocation returns a 404 error; the backup is not configured. .EXAMPLE PS C:\> Remove-vRNIBackup Removes the current configuration of the backup #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $status = Invoke-vRNIRestMethod -Connection $Connection -Method DELETE -URI "/api/ni/settings/backup" $status } function Enable-vRNIBackup { <# .SYNOPSIS Enables the backup configuration of the vRealize Network Insight Platform configuration. .DESCRIPTION You can create scheduled backups of the vRealize Network Insight Platform configuration, this cmdlet enables the current configuration of the backup. If the invocation returns a 404 error; the backup is not configured. .EXAMPLE PS C:\> Enable-vRNIBackup Enables the current configuration of the backup #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $status = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/settings/backup/enable" $status } function Disable-vRNIBackup { <# .SYNOPSIS Disables the backup configuration of the vRealize Network Insight Platform configuration. .DESCRIPTION You can create scheduled backups of the vRealize Network Insight Platform configuration, this cmdlet disables the current configuration of the backup. If the invocation returns a 404 error; the backup is not configured. .EXAMPLE PS C:\> Disable-vRNIBackup Disables the current configuration of the backup #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $status = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/settings/backup/disable" $status } function Set-vRNIBackup { <# .SYNOPSIS Configures the backup configuration of the vRealize Network Insight Platform configuration. .DESCRIPTION You can create scheduled backups of the vRealize Network Insight Platform configuration, this cmdlet configures the backup. .EXAMPLE PS C:\> $backupSchedule = @{ "enable" = $true; "schedule_period" = "DAILY"; "minute" = 30; "hour" = 12; "day_of_week" = 1 } PS C:\> $sshServer = @{ "server_address" = "10.0.0.10"; "port" = 22; "username" = "backups"; "password" = "VMware1!"; "backup_directory" = "/home/backups/"; "backup_file_name" = "vrni-backup.tar" } PS C:\> Set-vRNIBackup -RunNow $true -BackupSchedule $backupSchedule -SSHServer $sshServer Configure scheduled backups of once a day at 12:30 to a SSH server, and create a backup now. .EXAMPLE PS C:\> $backupSchedule = @{ "enable" = $true; "schedule_period" = "WEEKLY"; "minute" = 30; "hour" = 12; "day_of_week" = 0 } PS C:\> $ftpServer = @{ "server_address" = "10.0.0.10"; "port" = 21; "username" = "backups"; "password" = "VMware1!"; "backup_directory" = "/home/backups/"; "backup_file_name" = "vrni-backup.tar" } PS C:\> Set-vRNIBackup -RunNow $true -BackupSchedule $backupSchedule -FTPServer $ftpServer Configure scheduled backups of once a week on Sunday (day_of_week follows cron syntax) at 12:30 to a FTP server, and create a backup now. .EXAMPLE PS C:\> $backupSchedule = @{ "enable" = $true; "schedule_period" = "DAILY"; "minute" = 30; "hour" = 11; "day_of_week" = 0 } PS C:\> $localServer = @{ "backup_directory" = "/home/support/backups/"; "backup_file_name" = "vrni-backup.tar" } PS C:\> Set-vRNIBackup -RunNow $true -BackupSchedule $backupSchedule -LocalServer $localServer Configure scheduled backups daily at 11:30 to the local Platform filesystem, and don't create a backup now. #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection, [Parameter (Mandatory = $true)] # Whether or not we want to run the backup right away [ValidateNotNullOrEmpty()] [bool]$RunNow = $True, [Parameter (Mandatory = $true)] # Whether or not we want to run the backup right away [ValidateNotNullOrEmpty()] [hashtable]$BackupSchedule, [Parameter (Mandatory = $false, ParameterSetName = "SSH")] # The details of the [ValidateNotNullOrEmpty()] [hashtable]$SSHServer, [Parameter (Mandatory = $false, ParameterSetName = "FTP")] # Whether or not we want to run the backup right away [ValidateNotNullOrEmpty()] [hashtable]$FTPServer, [Parameter (Mandatory = $false, ParameterSetName = "LOCAL")] # Whether or not we want to run the backup right away [ValidateNotNullOrEmpty()] [hashtable]$LocalServer, [Parameter(Mandatory = $false)] [ValidateSet("applications", "snmp", "smtp", "data_sources", "analytics_thresholds", "analytics_outliers", "events", "syslog", "pinboards", "ldap", "vidm", "user_data", "user_preferences", "physical_subnet_vlan", "saved_searches", "physical_ip_dns_mapping", "east_west_ip", "north_south_ip")] [String[]]$FilterSections ) # Allow only 1 backup method $methods = 0 if ($SSHServer.Keys.Count -gt 0) { $methods += 1 } if ($FTPServer.Keys.Count -gt 0) { $methods += 1 } if ($LocalServer.Keys.Count -gt 0) { $methods += 1 } if ($methods -gt 1) { throw "Only 1 backup method may be enabled" } if ($methods -eq 0) { throw "Please enable a backup method using -SSHServer, -FTPServer, or -LocalServer" } # Warning for local storage if ($PSCmdlet.ParameterSetName -eq "LOCAL") { Write-Host -ForegroundColor "yellow" "You've indicated to store the backup on the local vRNI appliance. Make sure you know what you're doing!" } # Format request with all given data $requestFormat = @{ "schedule_now" = $RunNow "backup_schedule" = $BackupSchedule } # Add backup method if ($PSCmdlet.ParameterSetName -eq "SSH") { $requestFormat.backup_file_server_type = "SSH" $requestFormat.ssh_file_server = $SSHServer } if ($PSCmdlet.ParameterSetName -eq "FTP") { $requestFormat.backup_file_server_type = "FTP" $requestFormat.ftp_file_server = $FTPServer } if ($PSCmdlet.ParameterSetName -eq "LOCAL") { $requestFormat.backup_file_server_type = "LOCAL" $requestFormat.local_file_server = $LocalServer } # Figure out which config sections we want to backup # Default to enable the section and only disable the section when they appear in -FilterSections $config_filter = @{} $config_filter.applications = $true $config_filter.snmp = $true $config_filter.smtp = $true $config_filter.data_sources = $true $config_filter.analytics_thresholds = $true $config_filter.analytics_outliers = $true $config_filter.events = $true $config_filter.syslog = $true $config_filter.pinboards = $true $config_filter.ldap = $true $config_filter.vidm = $true $config_filter.user_data = $true $config_filter.user_preferences = $true $config_filter.physical_subnet_vlan = $true $config_filter.saved_searches = $true $config_filter.physical_ip_dns_mapping = $true $config_filter.east_west_ip = $true $config_filter.north_south_ip = $true if ($FilterSections.Length) { if ($FilterSections.Contains('applications')) { $config_filter.applications = $false } if ($FilterSections.Contains('snmp')) { $config_filter.snmp = $false } if ($FilterSections.Contains('smtp')) { $config_filter.smtp = $false } if ($FilterSections.Contains('data_sources')) { $config_filter.data_sources = $false } if ($FilterSections.Contains('analytics_thresholds')) { $config_filter.analytics_thresholds = $false } if ($FilterSections.Contains('analytics_outliers')) { $config_filter.analytics_outliers = $false } if ($FilterSections.Contains('events')) { $config_filter.events = $false } if ($FilterSections.Contains('syslog')) { $config_filter.syslog = $false } if ($FilterSections.Contains('pinboards')) { $config_filter.pinboards = $false } if ($FilterSections.Contains('ldap')) { $config_filter.ldap = $false } if ($FilterSections.Contains('vidm')) { $config_filter.vidm = $false } if ($FilterSections.Contains('user_data')) { $config_filter.user_data = $false } if ($FilterSections.Contains('user_preferences')) { $config_filter.user_preferences = $false } if ($FilterSections.Contains('physical_subnet_vlan')) { $config_filter.physical_subnet_vlan = $false } if ($FilterSections.Contains('saved_searches')) { $config_filter.saved_searches = $false } if ($FilterSections.Contains('physical_ip_dns_mapping')) { $config_filter.physical_ip_dns_mapping = $false } if ($FilterSections.Contains('east_west_ip')) { $config_filter.east_west_ip = $false } if ($FilterSections.Contains('north_south_ip')) { $config_filter.north_south_ip = $false } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat # Configure backup! $status = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/settings/backup" -Body $requestBody $status } ##################################################################################################################### ##################################################################################################################### ######################################## Datasource Management ##################################################### ##################################################################################################################### ##################################################################################################################### function Get-vRNIDataSource { <# .SYNOPSIS Retrieve datasource information .DESCRIPTION Datasources within vRealize Network Insight provide the data shown in the UI. The vRNI Collectors periodically polls the datasources as the source of truth. Typically you have a vCenter, NSX Manager and physical switches as the datasource. .EXAMPLE PS C:\> Get-vRNIDataSource Retrieves the details of all datasource types. .EXAMPLE PS C:\> Get-vRNIDataSource -DataSourceType nsxv Retrieves the defaults of all NSX Managers added to vRNI as a datasource. #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) DynamicParam { # Use a dynamic parameter to get a list of all data source names from $Script:DatasourceURLs $ParameterName = 'DataSourceType' # Form attribute parameters $RuntimeParameterDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary $AttributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] # Create and set the parameters' attributes $ParameterAttribute = New-Object System.Management.Automation.ParameterAttribute $ParameterAttribute.Mandatory = $false $AttributeCollection.Add($ParameterAttribute) # Generate and set the ValidateSet # Collect a list of all data source names $allDS = New-Object System.Collections.Generic.List[System.Object] foreach ($h in $Script:DatasourceURLs.GetEnumerator()) { $allDS += $h.Name } $ValidateSetAttribute = New-Object System.Management.Automation.ValidateSetAttribute($allDS) # Add the ValidateSet to the attributes collection $AttributeCollection.Add($ValidateSetAttribute) # Create and return the dynamic parameter $RuntimeParameter = New-Object System.Management.Automation.RuntimeDefinedParameter($ParameterName, [string], $AttributeCollection) $RuntimeParameterDictionary.Add($ParameterName, $RuntimeParameter) return $RuntimeParameterDictionary } Process { # Bind the parameter to a friendly variable if ($PSBoundParameters.ContainsKey("DataSourceType")) { New-DynamicParameter -CreateVariables -BoundParameters $PSBoundParameters } if (!$DataSourceType) { $DataSourceType = "all" } # Use this as a return container $datasources = [System.Collections.ArrayList]@() # Because each datasource type has its unique URL (/api/ni/data-sources/vcenter, /data-sources/ucs-manager, etc), # and we want all the datasource information, loop through the URLs of the types we want to retrieve and $datasource_types_to_get = $Script:DatasourceURLs.$DataSourceType # Since vRNI 6.3 (API v1.2.0), we can GET /api/ni/data-sources. Override the URL if we're asking all data sources and are on v1.2.0 if ($DataSourceType -eq "all" -And $Script:vRNI_API_Version -ge [System.Version]"1.2.0") { $datasource_types_to_get = @("/data-sources?size=500") # 500 = random crazy big number } foreach ($datasource_uri in $datasource_types_to_get) { # Energize! $response = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni$($datasource_uri)" # Process results, if there are datasources of this type. The results of the /api/ni/data-sources/$TYPE call is a # list of datasource IDs and not much more. We take that ID and do a call for details on that datasource if ($response.results -ne "") { foreach ($datasource in $response.results) { # Retrieve datasource details and store it $URI = "/api/ni$($Script:DatasourceInternalURLs.$($datasource.entity_type))/$($datasource.entity_id)" $datasource_detail = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI $URI $datasources.Add($datasource_detail) | Out-Null } } } # Return all found data sources $datasources } } function New-vRNIDataSource { <# .SYNOPSIS Create new datasources within vRealize Network Insight to retrieve data from. .DESCRIPTION Datasources within vRealize Network Insight provide the data shown in the UI. The vRNI Collectors periodically polls the datasources as the source of truth. Typically you have a vCenter, NSX Manager and physical switches as the datasource. This cmdlet adds new datasources to vRNI, so it can retrieve data from it and correlate and display this data in the interfce. .EXAMPLE PS C:\> $mysecpassword = ConvertTo- secret -AsPlainText -Force PS C:\> $collectorId = (Get-vRNINodes | Where {$_.node_type -eq "PROXY_VM"} | Select -ExpandProperty id) PS C:\> New-vRNIDataSource -DataSourceType vcenter -FDQN vc.nsx.local -Username administrator@vsphere.local -Password $mysecpassword -CollectorVMId $collectorId -Nickname vc.nsx.local First, get the node ID of the collector VM (assuming there's only one), then add a vCenter located at vc.nsx.local to vRNI. .EXAMPLE PS C:\> $mysecpassword = ConvertTo-SecureString secret -AsPlainText -Force PS C:\> $collectorId = (Get-vRNINodes | Where {$_.node_type -eq "PROXY_VM"} | Select -ExpandProperty id) PS C:\> $vcId = (Get-vRNIDataSource | Where {$_.nickname -eq "vc.nsx.local"} | Select -ExpandProperty entity_id) PS C:\> New-vRNIDataSource -DataSourceType nsxv -FDQN mgr.nsx.local -Username admin -Password $mysecpassword -Nickname mgr.nsx.local -CollectorVMId $collectorId -Enabled $True -NSXEnableCentralCLI $True -NSXEnableIPFIX $True -NSXvCenterID $vcId Adds a new NSX Manager as a data source, auto select the collector ID (if you only have one), enable the NSX Central CLI for collecting data, also enable NSX IPFIX for network datastream insight from the point of view of NSX. .EXAMPLE PS C:\> $collectorId = (Get-vRNINodes | Where {$_.ip_address -eq "10.0.0.11"} | Select -ExpandProperty id) PS C:\> New-vRNIDataSource -DataSourceType azure -CollectorVMId $collectorId -Nickname Azure-1 -TenantID xxx-xxx-xxx-xxx-xxx -ApplicationID xxx-xxx-xxx-xxx-xxx -SecretKey secret -SubscriptionID xxx-xxx-xxx-xxx-xxx Adds a new Azure subscription; first gets a specific collector appliance based on IP, and continues to add the Azure subscription based on the application registration information. More info on requirements can be found here: https://docs.vmware.com/en/VMware-vRealize-Network-Insight/5.0/com.vmware.vrni.using.doc/GUID-12272E1A-055F-47E9-9EA6-8693FE86AA02.html .EXAMPLE PS C:\> $nsxtId = (Get-vRNIDataSource -DatasourceType nsxt | Where {$_.nickname -eq "my-nsxt-manager"} | Select -ExpandProperty id) PS C:\> $collectorId = (Get-vRNINodes | Where {$_.ip_address -eq "10.0.0.11"} | Select -ExpandProperty id) PS C:\> $kubeconfig = (Get-Content ~/.kube/config | Out-String) PS C:\> New-vRNIDataSource -DataSourceType kubernetes -Nickname k8s-cluster-1 -CollectorVMId $collectorId -NSXTManagerID $nsxtId -KubeConfig $kubeconfig Add a Kubernetes cluster as a data source. First gets the entity ID of the NSX-T Manager supporting the container network, then vRNI Collector ID, then puts the kubeconfig file into a string, and finally adds the Kubernetes cluster to vRNI. #> [CmdletBinding(DefaultParameterSetName = "__AllParameterSets")] param ( [Parameter (Mandatory = $false)] # Username to use to login to the datasource [ValidateNotNullOrEmpty()] [string]$Username = "", [Parameter (Mandatory = $false)] # Password to use to login to the datasource [ValidateNotNullOrEmpty()] [securestring]$Password = "", [Parameter (Mandatory = $false)] # The IP address of the datasource [ValidateNotNullOrEmpty()] [string]$IP, [Parameter (Mandatory = $false)] # The FDQN address of the datasource [ValidateNotNullOrEmpty()] [string]$FDQN, [Parameter (Mandatory = $true)] # Collector (Proxy) Node ID [ValidateNotNullOrEmpty()] [string]$CollectorVMId, [Parameter (Mandatory = $true)] # Nickname for the datasource [ValidateNotNullOrEmpty()] [string]$Nickname = "", [Parameter (Mandatory = $false)] # Whether we want to enable the datasource [ValidateNotNullOrEmpty()] [bool]$Enabled = $True, [Parameter (Mandatory = $false)] # Optional notes for the datasource [ValidateNotNullOrEmpty()] [string]$Notes = "", [Parameter (Mandatory = $false)] # Optional polling interval in minutes. Not applicable to all data sources (mostly network devices) [ValidateNotNullOrEmpty()] [int]$PollingIntervalMinutes = 10, [Parameter (Mandatory = $false)] # Enable vCenter IPFIX only on these Distributed Switches. Format: "dvs-12" for a single VDS or "dvs-1,dvs-2" for a list of VDSs [ValidateNotNullOrEmpty()] [string]$EnableIPFIXonVDS = "", # These params are only required when adding a NSX Manager as datasource [Parameter (Mandatory = $False, ParameterSetName = "NSXDS")] # Enable the central CLI collection [ValidateNotNullOrEmpty()] [bool]$NSXEnableCentralCLI = $True, [Parameter (Mandatory = $False, ParameterSetName = "NSXDS")] # Enable NSX IPFIX as a source [ValidateNotNullOrEmpty()] [bool]$NSXEnableIPFIX = $True, [Parameter (Mandatory = $false, ParameterSetName = "NSXDS")] # Enable Virtual Latency (VTEP, VNIC, & PNIC) streaming from NSX to vRNI [ValidateNotNullOrEmpty()] [bool]$NSXEnableLatency = $False, [Parameter (Mandatory = $False, ParameterSetName = "NSXDS")] # vCenter ID that this NSX Manager will be linked too [ValidateNotNullOrEmpty()] [string]$NSXvCenterID = "", # This params is only required when adding a cisco switch [Parameter (Mandatory = $true, ParameterSetName = "CISCOSWITCH")] # Set the switch type [ValidateSet ("CATALYST_3000", "CATALYST_4500", "CATALYST_6500", "NEXUS_5K", "NEXUS_7K", "NEXUS_9K", "CISCOASRISR", "CISCOASR1000", "CISCOISR4000")] [string]$CiscoSwitchType, # This params is only required when adding a dell switch [Parameter (Mandatory = $true, ParameterSetName = "DELLSWITCH")] # Set the switch type [ValidateSet ("FORCE_10_MXL_10", "POWERCONNECT_8024", "S4048", "Z9100", "S6000")] [string]$DellSwitchType, # These params are only required when adding an Azure subscription as datasource [Parameter (Mandatory = $true, ParameterSetName = "AZURE")] # Azure Tenant ID [ValidateNotNullOrEmpty()] [string]$TenantID, [Parameter (Mandatory = $true, ParameterSetName = "AZURE")] # Azure Application ID [ValidateNotNullOrEmpty()] [string]$ApplicationID, [Parameter (Mandatory = $true, ParameterSetName = "AZURE")] [Parameter (ParameterSetName = "AWS")] # Azure or AWS Secret Key [ValidateNotNullOrEmpty()] [string]$SecretKey, [Parameter (Mandatory = $true, ParameterSetName = "AZURE")] # Azure Subscription ID [ValidateNotNullOrEmpty()] [string]$SubscriptionID, [Parameter (Mandatory = $false, ParameterSetName = "AZURE")] [Parameter (ParameterSetName = "AWS")] # Retrieve Flows? [ValidateNotNullOrEmpty()] [bool]$FlowsEnabled = $True, # These params are only required when adding an AWS account as data source [Parameter (Mandatory = $true, ParameterSetName = "AWS")] # AWS Access Key [ValidateNotNullOrEmpty()] [string]$AccessKey, [Parameter (Mandatory = $false, ParameterSetName = "AWS")] # Provide this switch when giving account is a master account and we want to index all linked accounts [ValidateNotNullOrEmpty()] [switch]$AddLinkedAccounts, [Parameter (Mandatory = $false, ParameterSetName = "AWS")] # Restrict collection from specific regions [ValidateNotNullOrEmpty()] [string]$RestrictToRegions = "", [Parameter (Mandatory = $false, ParameterSetName = "AWS")] # AWS Role ARN Suffix [ValidateNotNullOrEmpty()] [string]$RoleARNSuffix, [Parameter (Mandatory = $False, ParameterSetName = "KUBERNETES")] # KubeConfig as a string [ValidateNotNullOrEmpty()] [string]$KubeConfig, [Parameter (Mandatory = $True, ParameterSetName = "KUBERNETES")] # NSX-T Manager entity ID [ValidateNotNullOrEmpty()] [string]$NSXTManagerID, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) DynamicParam { # Use a dynamic parameter to get a list of all data source names from $Script:DatasourceURLs $ParameterName = 'DataSourceType' # Form attribute parameters $RuntimeParameterDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary $AttributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] # Create and set the parameters' attributes $ParameterAttribute = New-Object System.Management.Automation.ParameterAttribute $ParameterAttribute.Mandatory = $true $AttributeCollection.Add($ParameterAttribute) # Generate and set the ValidateSet # Collect a list of all data source names $allDS = New-Object System.Collections.Generic.List[System.Object] foreach ($h in $Script:DatasourceURLs.GetEnumerator()) { $allDS += $h.Name } $ValidateSetAttribute = New-Object System.Management.Automation.ValidateSetAttribute($allDS) # Add the ValidateSet to the attributes collection $AttributeCollection.Add($ValidateSetAttribute) # Create and return the dynamic parameter $RuntimeParameter = New-Object System.Management.Automation.RuntimeDefinedParameter($ParameterName, [string], $AttributeCollection) $RuntimeParameterDictionary.Add($ParameterName, $RuntimeParameter) return $RuntimeParameterDictionary } Process { # Bind the parameter to a friendly variable New-DynamicParameter -CreateVariables -BoundParameters $PSBoundParameters if ($IP -ne "" -And $FDQN -ne "") { throw "Please only provide the FDQN or the IP address for the datasource, not both." } # Require username and password for everything except Azure, K8s, and OpenShift if (($DataSourceType -ne "aws" -And $DataSourceType -ne "azure" -And $DataSourceType -ne "kubernetes" -And $DataSourceType -ne "openshift" -And $DataSourceType -ne "generic-device") -And ($Username -eq "" -Or $Password -eq "")) { throw "Please provide the Username and Password parameters as the credentials to connect to the data source." } # Check if the NSXDS parameter set is used when adding a NSX Manager as datasource if ($DataSourceType -eq "nsxv" -And $PSCmdlet.ParameterSetName -ne "NSXDS") { throw "Please provide the NSX parameters when adding a NSX Manager." } if ($DataSourceType -eq "nsxv" -And $NSXvCenterID -eq "") { throw "Please provide the NSXvCenterID parameter when adding a NSX-v Manager." } # Check if the KUBERNETES parameter set is used when adding K8s or OpenShift as datasource if (($DataSourceType -eq "kubernetes" -Or $DataSourceType -eq "openshift" -Or $DataSourceType -eq "pks") -And $PSCmdlet.ParameterSetName -ne "KUBERNETES") { throw "Please provide the KubeConfig and NSXTManagerID parameters when adding an OpenShift or Kubernetes data source. PKS only needs the NSXTManagerID" } # Check if the switch type is provided, when adding a Cisco of Dell switch if ($DataSourceType -eq "ciscoswitch" -And $PSCmdlet.ParameterSetName -ne "CISCOSWITCH") { throw "Please provide the -CiscoSwitchType parameter when adding a Cisco switch." } if ($DataSourceType -eq "dellswitch" -And $PSCmdlet.ParameterSetName -ne "DELLSWITCH") { throw "Please provide the -DellSwitchType parameter when adding a Dell switch." } if ($DataSourceType -eq "azure" -And $PSCmdlet.ParameterSetName -ne "AZURE") { throw "Please provide the TenantID, ApplicationID, SecretKey, and SubscriptionID parameters when adding an Azure subscription." } if ($DataSourceType -eq "aws" -And $PSCmdlet.ParameterSetName -ne "AWS") { throw "Please provide the AccessKey and SecretKey parameters when adding an AWS account. Optionally, provide the AddLinkedAccounts with RoleARNSuffix, RestrictToRegions, and FlowsEnabled parameters." } if ($PSBoundParameters.ContainsKey('PollingIntervalMinutes') -And $Script:vRNI_API_Version -lt [System.Version]"1.2.0") { throw "Custom polling intervals only work with vRNI 6.3+" } # Format request with all given data $requestFormat = @{ "proxy_id" = $CollectorVMId "nickname" = $Nickname "notes" = $Notes "enabled" = $Enabled } # Add IP or hostname to everything but SaaS accounts if ($DataSourceType -ne "servicenow" -And $DataSourceType -ne "azure" -And $DataSourceType -ne "aws") { $requestFormat.ip = $IP $requestFormat.fqdn = $FDQN } # ServiceNow uses instance_id as the FQDN if ($DataSourceType -eq "servicenow") { $requestFormat.instance_id = $FDQN $requestFormat.is_graph_config_customized = "false" # TODO: support customised relation graphs } # For any other data source than a generic (UANI) switch, K8s or OpenShift, use regular credentials if ($DataSourceType -ne "kubernetes" -And $DataSourceType -ne "openshift" -And $DataSourceType -ne "generic-device") { $cred = New-Object System.Management.Automation.PSCredential("", $Password) $requestFormat.credentials = @{ "username" = $Username "password" = $cred.GetNetworkCredential().Password } } else { if ($DataSourceType -eq "kubernetes" -Or $DataSourceType -ne "openshift") { # Add KubeConfig and NSX-T Manager entity ID for OpenShift or K8s $requestFormat.manager_id = $NSXTManagerID $requestFormat.credentials = @{ "kubeconfig" = $KubeConfig } } } if ($DataSourceType -eq "pks") { # Add NSX-T Manager entity ID for PKS $requestFormat.manager_id = $NSXTManagerID } # If we're adding a NSX Manager, also add the NSX parameters to the body if ($DataSourceType -eq "nsxv") { $requestFormat.vcenter_id = $NSXvCenterID $requestFormat.ipfix_enabled = $NSXEnableIPFIX $requestFormat.central_cli_enabled = $NSXEnableCentralCLI $requestFormat.latency_enabled = $NSXEnableLatency } if ($DataSourceType -eq "nsxt") { $requestFormat.ipfix_enabled = $NSXEnableIPFIX $requestFormat.latency_enabled = $NSXEnableLatency } # When adding a Cisco or Dell switch, provide the switch_type key in the body if ($DataSourceType -eq "ciscoswitch") { $requestFormat.switch_type = $CiscoSwitchType } if ($DataSourceType -eq "dellswitch") { $requestFormat.switch_type = $DellSwitchType } # Add the application registration details for Azure subscriptions if ($DataSourceType -eq "azure") { $requestFormat.flows_enabled = $FlowsEnabled $requestFormat.credentials = @{ "azure_client" = $ApplicationID "azure_key" = $SecretKey "azure_tenant" = $TenantID "azure_subscription" = $SubscriptionID } } # Add the account details for AWS if ($DataSourceType -eq "aws") { $requestFormat.flows_enabled = $FlowsEnabled $requestFormat.credentials = @{ "access_key" = $AccessKey "secret_key" = $SecretKey } if ($AddLinkedAccounts.IsPresent) { $requestFormat.add_linked_accounts = $True $requestFormat.role_arn_suffix = $RoleARNSuffix } else { $requestFormat.add_linked_accounts = $False } if ($RestrictToRegions -ne "") { $requestFormat.enable_aws_geo_restrictions = $True $requestFormat.selected_regions = $RestrictToRegions } else { $requestFormat.enable_aws_geo_restrictions = $False } } # Check if polling interval is giving between 10 and 10080 (7 days) if ($PollingIntervalMinutes -lt 10) { throw "PollingIntervalMinutes needs to be at least 10 minutes" } if ($PollingIntervalMinutes -gt (7 * 24 * 60)) { throw "PollingIntervalMinutes can be at maximum 7 days, or 10080 minutes" } # Only provide custom polling interval when it's different than 10 (default) if ($PollingIntervalMinutes -ne 10) { $requestFormat.config_polling_interval_in_min = $PollingIntervalMinutes $requestFormat.config_polling_interval_type = "CUSTOM" } # Check if the EnableIPFIXonVDS parameter has been given and adjust the body accordingly # todo: maybe add support for disable_for_dvs? if ($EnableIPFIXonVDS -ne "") { if ($Script:vRNI_API_Version -lt [System.Version]"1.2.0") { throw "The EnableIPFIXonVDS only works for vRNI 6.3+" } # feed the DVS list into the enable_for_dvs param $requestFormat.ipfix_request = @{ "enable_for_dvs" = $EnableIPFIXonVDS } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $URI = "/api/ni$($Script:DatasourceURLs.$DataSourceType[0])" $response = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri $URI -Body $requestBody $response } } function Remove-vRNIDataSource { <# .SYNOPSIS Removes a datasource from vRealize Network Insight .DESCRIPTION Datasources within vRealize Network Insight provide the data shown in the UI. The vRNI Collectors periodically polls the datasources as the source of truth. Typically you have a vCenter, NSX Manager and physical switches as the datasource. This cmdlet removes a datasources from vRNI. .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "vc.nsx.local"} | Remove-vRNIDataSource Removes a vCenter datasource with the nickname "vc.nsx.local" .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "manager.nsx.local"} | Remove-vRNIDataSource Removes a NSX Manager datasource with the nickname "manager.nsx.local" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ # All we have to do is to send a DELETE request to URI /api/ni/$DataSourceType/$DatasourceId, so # form the URI and send the DELETE request to vRNI $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)" Invoke-vRNIRestMethod -Connection $Connection -Method DELETE -Uri $URI } ## end Foreach-Object } ## end process } function Update-vRNIDataSource { <# .SYNOPSIS Updates the configuration of a datasource from vRealize Network Insight .DESCRIPTION Datasources within vRealize Network Insight provide the data shown in the UI. The vRNI Collectors periodically polls the datasources as the source of truth. Typically you have a vCenter, NSX Manager and physical switches as the datasource. This cmdlet updates a datasources in vRNI. .EXAMPLE PS C:\> $mysecpassword = ConvertTo-SecureString VMware1! -AsPlainText -Force PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "vc.nsx.local"} | Update-vRNIDataSource -Username admin -Password $mysecpassword Updates the credentials of a vCenter datasource with the nickname "vc.nsx.local" .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "manager.nsx.local"} | Update-vRNIDataSource -Nickname "newnickname" Updates the nickname of a NSX Manager datasource with the nickname "manager.nsx.local" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $false)] # Nickname for the datasource [ValidateNotNullOrEmpty()] [string]$Nickname = "", [Parameter (Mandatory = $true)] # Credentials to use to login to the datasource [ValidateNotNullOrEmpty()] [pscredential]$Credentials, [Parameter (Mandatory = $false)] # Optional notes for the datasource [ValidateNotNullOrEmpty()] [string]$Notes = "", [Parameter (Mandatory = $false)] # Optional polling interval in minutes. Not applicable to all data sources (mostly network devices) [ValidateNotNullOrEmpty()] [int]$PollingIntervalMinutes = 10, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { # Check if polling interval is giving between 10 and 10080 (7 days) if ($PollingIntervalMinutes -lt 10) { throw "PollingIntervalMinutes needs to be at least 10 minutes" } if ($PollingIntervalMinutes -gt (7 * 24 * 60)) { throw "PollingIntervalMinutes can be at maximum 7 days, or 10080 minutes" } if ($PSBoundParameters.ContainsKey('PollingIntervalMinutes') -And $Script:vRNI_API_Version -lt [System.Version]"1.2.0") { throw "Custom polling intervals only work with vRNI 6.3+" } $DataSource | Foreach-Object { $oThisDatasource = $_ # All we have to do is to send a PUT request to URI /api/ni/$DataSourceType/$DatasourceId, # with the modified options $oThisDatasource.credentials = @{} $oThisDatasource.credentials.Add('username', $Credentials.Username) $oThisDatasource.credentials.Add('password', $Credentials.GetNetworkCredential().Password) if ($Nickname -ne "") { $oThisDatasource.nickname = $Nickname } if ($Notes -ne "") { # notes might not be in the returned object, if that's the case, add it as an object member if (!($oThisDatasource.PSobject.Properties.Name -contains "notes")) { $oThisDatasource | Add-Member -MemberType NoteProperty -Name 'notes' -Value $Notes } else { $oThisDatasource.notes = $Notes } } # Provide custom polling interval only for vRNI 6.3+ if ($PSBoundParameters.ContainsKey('PollingIntervalMinutes') -And $Script:vRNI_API_Version -ge [System.Version]"1.2.0") { # config_polling_interval_in_min might not be in the returned object, if that's the case, add it as an object member if (!($oThisDatasource.PSobject.Properties.Name -contains "config_polling_interval_in_min")) { $oThisDatasource | Add-Member -MemberType NoteProperty -Name 'config_polling_interval_in_min' -Value $PollingIntervalMinutes } else { $requestFormat.config_polling_interval_in_min = $PollingIntervalMinutes } if (!($oThisDatasource.PSobject.Properties.Name -contains "config_polling_interval_type")) { $oThisDatasource | Add-Member -MemberType NoteProperty -Name 'config_polling_interval_type' -Value "CUSTOM" } else { $requestFormat.config_polling_interval_type = "CUSTOM" } } $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)" $requestBody = ConvertTo-Json $oThisDatasource Invoke-vRNIRestMethod -Connection $Connection -Method PUT -Uri $URI -Body $requestBody } ## end Foreach-Object } ## end process } function Update-vRNINSXvControllerClusterPassword { <# .SYNOPSIS Updates the NSX-v Controller Cluster password and enabled data collection. Needed for routing information on NSX-v. .DESCRIPTION The NSX for vSphere Controller Cluster contains the routing information of the virtual network. These controllers have separate passwords, and vRNI needs that password in order to collect data. .EXAMPLE PS C:\> Get-vRNIDataSource -DatasourceType nsxv | Update-vRNINSXvControllerClusterPassword -Password 'secret' Gets all NSX-v data sources and sets the controller cluster password for each of them. .EXAMPLE PS C:\> Get-vRNIDataSource -DatasourceType nsxv | Update-vRNINSXvControllerClusterPassword -Password 'secret' -Enabled $False Gets all NSX-v data sources and disables controller cluster data collection. #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $True)] # Controller Cluster Password [ValidateNotNullOrEmpty()] [string]$Password, [Parameter (Mandatory = $False)] # Enable data collection from [ValidateNotNullOrEmpty()] [bool]$Enabled = $True, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ if ($oThisDatasource.entity_type -ne "NSXVManagerDataSource") { throw "Given data source is not a NSX-v data source! $($oThisDatasource)" } $requestFormat = @{ "enabled" = $Enabled "controller_password" = $Password } $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)/controller-cluster" $requestBody = ConvertTo-Json $requestFormat Invoke-vRNIRestMethod -Connection $Connection -Method PUT -Uri $URI -Body $requestBody } ## end Foreach-Object } ## end process } function Update-vRNIDataSourceData { <# .SYNOPSIS Updates the user-assisted-networking-information data (zip file) of a generic switch or router datasource .DESCRIPTION Generic switch or router devices backed by UANI, take a zipfile with with a set of CSV files containing the information of the device. This cmdlet updates the data source inside vRNI and uploads the zipfile to do so. More info: https://github.com/vmware/network-insight-sdk-generic-datasources .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "generic-switch"} | Update-vRNIDataSourceData -Zipfile 'c:\uani-zipfile-17-11-2019.zip' Updates the generic data source information with the info from the zipfile #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $True)] # The zipfile with the contents for UANI [ValidateNotNullOrEmpty()] [string]$Zipfile, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)/data" $fileName = Split-Path $Zipfile -leaf $zipContents = [IO.File]::ReadAllBytes($Zipfile) $usedEncoding = [System.Text.Encoding]::GetEncoding("ISO-8859-1") $fileEncoding = $usedEncoding.GetString($zipContents) $boundary = [System.Guid]::NewGuid().ToString(); $LF = "`r`n"; $requestBody = ( "--$boundary", "Content-Disposition: form-data; name=`"file`"; filename=`"$($fileName)`"", "Content-Type: application/octet-stream$LF", $fileEncoding, "--$boundary--$LF" ) -join $LF Invoke-vRNIRestMethod -Connection $Connection -Method PUT -Uri $URI -Body $requestBody -ContentType "multipart/form-data; boundary=`"$boundary`"" } ## end Foreach-Object } ## end process } function Enable-vRNIDataSource { <# .SYNOPSIS Enables an existing datasources within vRealize Network Insight .DESCRIPTION Datasources within vRealize Network Insight provide the data shown in the UI. The vRNI Collectors periodically polls the datasources as the source of truth. Typically you have a vCenter, NSX Manager and physical switches as the datasource. This cmdlet enables an existing datasources within vRNI. .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "vc.nsx.local"} | Enable-vRNIDataSource Enables a vCenter datasource with the nickname "vc.nsx.local" .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "manager.nsx.local"} | Enable-vRNIDataSource Enables a NSX Manager datasource with the nickname "manager.nsx.local" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ # All we have to do is to send a POST request to URI /api/ni/$DataSourceType/$DatasourceId/enable, so # form the URI and send the request to vRNI $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)/enable" Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri $URI } ## end Foreach-Object } ## end Process } function Disable-vRNIDataSource { <# .SYNOPSIS Disables an existing datasources within vRealize Network Insight .DESCRIPTION Datasources within vRealize Network Insight provide the data shown in the UI. The vRNI Collectors periodically polls the datasources as the source of truth. Typically you have a vCenter, NSX Manager and physical switches as the datasource. This cmdlet disables an existing datasources within vRNI. .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "vc.nsx.local"} | Disable-vRNIDataSource Disables a vCenter datasource with the nickname "vc.nsx.local" .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "manager.nsx.local"} | Disable-vRNIDataSource Disables a NSX Manager datasource with the nickname "manager.nsx.local" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ # All we have to do is to send a POST request to URI /api/ni/$DataSourceType/$DatasourceId/disable, so # form the URI and send the request to vRNI $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)/disable" Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri $URI } ## end Foreach-Object } ## end process } function Get-vRNIDataSourceSNMPConfig { <# .SYNOPSIS Retrieves the SNMP configuration of a switch datasource from vRealize Network Insight .DESCRIPTION Physical devices like switches and UCS systems have SNMP options, which vRNI can read out to provide interface bandwidth graphs. This cmdlet allows you to retrieve the SNMP configuration of a specific data source. .EXAMPLE PS C:\> Get-vRNIDataSource | Where {$_.entity_type -eq "CiscoSwitchDataSource"} | Get-vRNIDataSourceSNMPConfig Gets the SNMP configuration for all Cisco switch data sources #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ # Sanity check on the data source type: only Cisco, Dell, Brocade, Juniper, Arista switches & UCS have SNMP config if ($oThisDatasource.entity_type -ne "CiscoSwitchDataSource" -And $oThisDatasource.entity_type -ne "DellSwitchDataSource" -And $oThisDatasource.entity_type -ne "BrocadeSwitchDataSource" -And $oThisDatasource.entity_type -ne "JuniperSwitchDataSource" -And $oThisDatasource.entity_type -ne "AristaSwitchDataSource" -And $oThisDatasource.entity_type -ne "UCSManagerDataSource" -And $oThisDatasource.entity_type -ne "CiscoACIDataSource" -And $oThisDatasource.entity_type -ne "HuaweiSwitchDataSource" -And $oThisDatasource.entity_type -ne "F5BIGIPDataSource") { throw "Invalid Data Source Type ($($oThisDatasource.entity_type)) for SNMP. Only Cisco, Dell, Brocade, Juniper, Arista, F5, Huawei & UCS have SNMP configuration." } # All we have to do is to send a GET request to URI /api/ni/$DataSourceType/$DatasourceId/snmp-config $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)/snmp-config" $result = Invoke-vRNIRestMethod -Connection $Connection -Method GET -Uri $URI $result } ## end Foreach-Object } ## end process } function Set-vRNIDataSourceSNMPConfig { <# .SYNOPSIS Updates the SNMP configuration of a switch or UCS datasource within vRealize Network Insight .DESCRIPTION Physical devices like switches and UCS systems have SNMP options, which vRNI can read out to provide interface bandwidth graphs. This cmdlet allows you to set the SNMP configuration of a specific data source. .EXAMPLE PS C:\> $AuthenticationPassword = ConvertTo-SecureString ult1m4t3p4ss -AsPlainText -Force PS C:\> $PrivacyPassword = ConvertTo-SecureString s0pr1v4t3 -AsPlainText -Force PS C:\> $snmpOptions = @{ "Enabled" = $true; "Username" = "snmpv3user"; "ContextName" = " "; "AuthenticationType" = "MD5"; "AuthenticationPassword" = $AuthenticationPassword; "PrivacyType" = "AES128"; "PrivacyPassword" = $PrivacyPassword; } PS C:\> Get-vRNIDataSource | Where {$_.nickname -eq "Core01"} | Set-vRNIDataSourceSNMPConfig @snmpOptions Configures SNMPv3 for a data source named 'Core01' .EXAMPLE PS C:\> Get-vRNIDataSource -DataSourceType ciscoswitch | Set-vRNIDataSourceSNMPConfig -Enabled $true -Community "qwerty1234" Configured SNMPv2 on all Cisco switch datasources. #> [CmdletBinding(DefaultParameterSetName = "__AllParameterSets")] param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNIDataSource [ValidateNotNullOrEmpty()] [PSObject]$DataSource, [Parameter (Mandatory = $false)] # Enable SNMP? [ValidateNotNullOrEmpty()] [bool]$Enabled = $true, # This param is only required when configuring SNMP v2c [Parameter (Mandatory = $true, ParameterSetName = "SNMPv2c")] # SNMP v2c Community string [ValidateNotNullOrEmpty()] [string]$Community, # These params are only required when configuring SNMP v3 [Parameter (Mandatory = $true, ParameterSetName = "SNMPv3")] # SNMP v3 Username [ValidateNotNullOrEmpty()] [string]$Username, [Parameter (Mandatory = $true, ParameterSetName = "SNMPv3")] # SNMP v3 Context name [ValidateNotNullOrEmpty()] [string]$ContextName, [Parameter (Mandatory = $true, ParameterSetName = "SNMPv3")] # SNMP v3 Context name [ValidateSet ("MD5", "SHA", "NO_AUTH")] [string]$AuthenticationType, [Parameter (Mandatory = $true, ParameterSetName = "SNMPv3")] # SNMP v3 Authentication Password [ValidateNotNullOrEmpty()] [securestring]$AuthenticationPassword, [Parameter (Mandatory = $true, ParameterSetName = "SNMPv3")] # SNMP v3 Privacy Type [ValidateSet ("AES", "DES", "AES128", "AES192", "AES256", "3DES", "NO_PRIV")] [string]$PrivacyType, [Parameter (Mandatory = $true, ParameterSetName = "SNMPv3")] # SNMP v3 Privacy Password [ValidateNotNullOrEmpty()] [securestring]$PrivacyPassword, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $DataSource | Foreach-Object { $oThisDatasource = $_ # Sanity check on the data source type: only Cisco, Dell, Brocade, Juniper, Arista switches & UCS have SNMP config if ($oThisDatasource.entity_type -ne "CiscoSwitchDataSource" -And $oThisDatasource.entity_type -ne "DellSwitchDataSource" -And $oThisDatasource.entity_type -ne "BrocadeSwitchDataSource" -And $oThisDatasource.entity_type -ne "JuniperSwitchDataSource" -And $oThisDatasource.entity_type -ne "AristaSwitchDataSource" -And $oThisDatasource.entity_type -ne "UCSManagerDataSource" -And $oThisDatasource.entity_type -ne "F5BIGIPDataSource" -And $oThisDatasource.entity_type -ne "HuaweiSwitchDataSource") { throw "Invalid Data Source Type ($($oThisDatasource.entity_type)) for SNMP. Only Cisco, Dell, Brocade, Juniper, F5, Arista switches & UCS have SNMP configuration." } # Format request with all given data $requestFormat = @{ "snmp_enabled" = $Enabled } # if SNMPv2 parameters are given, build the snmp_2c var if ($pscmdlet.ParameterSetName -eq "SNMPv2c") { $requestFormat.snmp_version = "v2c" $requestFormat.config_snmp_2c = @{ "community_string" = $Community } } # if SNMPv3 parameters are given, build the snmp_3 var if ($pscmdlet.ParameterSetName -eq "SNMPv3") { $requestFormat.snmp_version = "v3" $Authentication = New-Object System.Management.Automation.PSCredential("", $AuthenticationPassword) $Privacy = New-Object System.Management.Automation.PSCredential("", $PrivacyPassword) $requestFormat.config_snmp_3 = @{ "username" = $Username "context_name" = $ContextName "authentication_type" = $AuthenticationType "authentication_password" = $Authentication.GetNetworkCredential().Password "privacy_type" = $PrivacyType "privacy_password" = $Privacy.GetNetworkCredential().Password } } # All we have to do now is to send a PUT request to URI /api/ni/$DataSourceType/$DatasourceId/snmp-config with the right body $requestBody = ConvertTo-Json $requestFormat $URI = "/api/ni$($Script:DatasourceInternalURLs.$($oThisDatasource.entity_type))/$($oThisDatasource.entity_id)/snmp-config" Invoke-vRNIRestMethod -Connection $Connection -Method PUT -Uri $URI -Body $requestBody } ## end Foreach-Object } ## end process } ##################################################################################################################### ##################################################################################################################### ####################################### Application Management ##################################################### ##################################################################################################################### ##################################################################################################################### function Get-vRNIApplication { <# .SYNOPSIS Get Application information from vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .PARAMETER Name Limit the amount of records returned to a specific name .PARAMETER Connection vRNI Connection object .EXAMPLE PS C:\> Get-vRNIApplication Show all existing applications and their details. .EXAMPLE PS C:\> Get-vRNIApplication -Name '3 Tier App' Get only the application details of the application named "3 Tier App" #> param ( [Parameter(Mandatory = $false, Position = 1, ParameterSetName = 'Filter')] [string[]] $Name, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [PSCustomObject] $Connection = $defaultvRNIConnection ) $applications = [System.Collections.ArrayList]@() $size = 50 $listParams = @{ Connection = $Connection Method = 'GET' Uri = "/api/ni/groups/applications?size=$size" } # If a filter has been given, use the search endpoint to more efficiently find the right applications if ($PSCmdlet.ParameterSetName -eq 'Filter') { $listParams['Method'] = 'POST' $listParams['Uri'] = '/api/ni/search' $body = @{ entity_type = 'Application' } # Build the search filter $filter = @() # If there's an application name specified, figure out if it's a single name or an array of names # and format the search filter appropriately if ($Name) { # Multiple application names if ($Name.Count -gt 1) { $nameArray = @() foreach ($nameItem in $Name) { $nameArray += "'$nameItem'" } $nameSearchString = " in (" + ($nameArray -join ',') + ")" } # Single application name else { $nameSearchString = " = '$Name'" } $filter += "(Name $nameSearchString)" } ## end if ($Name) $body['filter'] = $filter -join ' and ' $listParams['Body'] = $body | ConvertTo-Json Write-Verbose ('Body: ' + $listParams['Body']) } ## end if ($PSCmdlet.ParameterSetName -eq 'Filter') else { # With version 1.1.0 of the API - there's a single endpoint to retrieve all if ($Script:vRNI_API_Version -ge [System.Version]"1.1.0") { $listParams['Uri'] = '/api/ni/groups/applications/fetch?size=2500' $applications = Invoke-vRNIRestMethod @listParams $applications.results return } } $hasMoreData = $true $counter = 0 while ($hasMoreData) { $applicationResponse = Invoke-vRNIRestMethod @listParams Write-Verbose ("$($applicationResponse.total_count) applications to process") if ($applicationResponse.total_count -gt $size) { $listParams['Uri'] += "&cursor=$($applicationResponse.cursor)" } foreach ($app in $applicationResponse.results) { # Retrieve application details and store them $app_info = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/groups/applications/$($app.entity_id)" $applications.Add($app_info) | Out-Null $counter++ } $remaining = $applicationResponse.total_count - $counter if ($remaining -gt 0) { Write-Verbose "$remaining more applications to process" $hasMoreData = $true } else { $hasMoreData = $false } } $applications } function Get-vRNIApplicationMemberVM { <# .SYNOPSIS Get a list of VMs in an application from vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .EXAMPLE PS C:\> Get-vRNIApplication My3TierApp | Get-vRNIApplicationMemberVM Show the member VMs for the application called "My3TierApp" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true)] # Application object, gotten from Get-vRNIApplication [ValidateNotNullOrEmpty()] [PSObject]$Application, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { ## do Foreach-Object, so as to enable user to pass multiple Application objects for value of -Application parameter $Application | Foreach-Object { $oThisApplication = $_ # Get a list of all VMs for this application $vm_list = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/groups/applications/$($oThisApplication.entity_id)/members/vms" $vm_list.results } ## end Foreach-Object } ## end process } function Get-vRNIApplicationTier { <# .SYNOPSIS Get Application Tier information from vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .EXAMPLE PS C:\> Get-vRNIApplication My3TierApp | Get-vRNIApplicationTier Show the tiers for the application container called "My3TierApp" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true)] # Application object, gotten from Get-vRNIApplication [ValidateNotNullOrEmpty()] [PSObject]$Application, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned to a specific name [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { ## do Foreach-Object, so as to enable user to pass multiple Application objects for value of -Application parameter $Application | Foreach-Object { $oThisApplication = $_ # First, get a list of all tier. This returns a list with application IDs which we can use # to retrieve the details of the applications $tier_list = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/groups/applications/$($oThisApplication.entity_id)/tiers" # Use this as a results container $tiers = [System.Collections.ArrayList]@() foreach ($tier in $tier_list.results) { # Retrieve application details and store them $tier_info = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/groups/applications/$($oThisApplication.entity_id)/tiers/$($tier.entity_id)" $tiers.Add($tier_info) | Out-Null # Don't go on if we've already found the one the user wants specifically if ($Name -eq $tier_info.name) { break } } # Filter out other application tiers if the user wants one specifically if ($Name) { $tiers | Where-Object { $_.name -eq $Name } } else { $tiers } } ## end Foreach-Object } ## end process } function New-vRNIApplicationTier { <# .SYNOPSIS Create a Tier in an Application container in vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .EXAMPLE PS C:\> Get-vRNIApplication My3TierApp | New-vRNIApplicationTier -Name web-tier -VMFilters ("name = '3TA-Web01' or name = '3TA-Web02'") Create a new tier in the application 'My3TierApp' called 'web-tier' and assign the VMs named '3TA-Web01' and '3TA-Web02' to this tier. .EXAMPLE PS C:\> $security_group_id = (Get-vRNISecurityGroup SG-3Tier-App).entity_id PS C:\> Get-vRNIApplication My3TierApp | New-vRNIApplicationTier -Name app-tier -VMFilters ("name = '3TA-App01'", "security_groups.entity_id = '$security_group_id'") Create a new tier in the application 'My3TierApp' called 'web-tier' and assign the VMs named '3TA-Web01' and '3TA-Web02' to this tier. .EXAMPLE PS C:\> Get-vRNIApplication IP-Network | New-vRNIApplicationTier -Name IP-Set-1 -IPFilters 100.194.0.0/24, 192.168.1.1, 192.168.10.0/27 This retrieves the existing application called 'IP-Network' and creates a new tier inside it called 'IP-Set-1' with a /24 subnet, a single host and a /27 subnet. .EXAMPLE PS C:\> Get-vRNIApplication IP-Network | New-vRNIApplicationTier -Name IP-Host-2 -IPFilters 172.16.0.10 This retrieves the existing application called 'IP-Network' and creates a new tier inside it called 'IP-Host-2' with a single host on the IP 172.16.0.10. .PARAMETER Filters The filters within an application tier determine what VMs will be placed in that application. Currently, only these options are supported: Single VM: "name = '3TA-App01'" Multiple VMs: "name = '3TA-App01' or name = '3TA-App02'" VMs with a NSX Security Tag: "security_groups.entity_id = '18230:82:604573173'" #> # To keep backwards compatibility with 1.0 [CmdletBinding(DefaultParameterSetName = "VMFilter")] param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true)] # Application object, gotten from Get-vRNIApplication [ValidateNotNullOrEmpty()] [PSObject]$Application, [Parameter (Mandatory = $true)] # The name of the new tier [string]$Name, [Parameter (Mandatory = $false, ParameterSetName = "VMFilter")] # The VM filters in the new tier [string[]]$Filters, [Parameter (Mandatory = $false, ParameterSetName = "MultipleFilters")] # The VM filters in the new tier [string[]]$VMFilters, [Parameter (Mandatory = $false, ParameterSetName = "IPFilters")] # The IP set filters in the new tier [string[]]$IPFilters, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) begin { if (!$Filters -And !$VMFilters -And !$IPFilters) { throw "Please provide at least one filter." } # Format request with all given data $requestFormat = @{ "name" = $Name "group_membership_criteria" = @() } # Backwards compatibility with 1.0 - if the old -Filters are given, transfer it to $VMFilters if ($pscmdlet.ParameterSetName -eq "VMFilter") { $VMFilters = $Filters } # If supplied, go through the VM filters and build the call if ($VMFilters) { foreach ($filter in $VMFilters) { $criteria_record = @{ } $criteria_record.membership_type = "SearchMembershipCriteria" $criteria_record.search_membership_criteria = @{ "entity_type" = "BaseVirtualMachine" "filter" = $filter } $requestFormat.group_membership_criteria += $criteria_record } } # If supplied, go through the IP filters and build the call if ($IPFilters) { $criteria_record = @{ } $criteria_record.membership_type = "IPAddressMembershipCriteria" $criteria_record.ip_address_membership_criteria = @{ } $criteria_record.ip_address_membership_criteria.ip_addresses = @() foreach ($ipset in $IPFilters) { $criteria_record.ip_address_membership_criteria.ip_addresses += $ipset } $requestFormat.group_membership_criteria += $criteria_record } Write-Debug $requestFormat # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat -Depth 5 } ## end begin process { $Application | Foreach-Object { $oThisApplication = $_ Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/groups/applications/$($oThisApplication.entity_id)/tiers" -Body $requestBody } ## end Foreach-Object } ## end process } function Remove-vRNIApplicationTier { <# .SYNOPSIS Remove a tier from an application container from vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .EXAMPLE PS C:\> Get-vRNIApplication My3TierApp | Get-vRNIApplicationTier web-tier | Remove-vRNIApplicationTier Remove the tier 'web-tier' from the application container called "My3TierApp" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Application Tier object, gotten from Get-vRNIApplicationTier [ValidateNotNullOrEmpty()] [PSObject]$ApplicationTier, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $ApplicationTier | Foreach-Object { $oThisApplicationTier = $_ # Send the DELETE request and show the result Invoke-vRNIRestMethod -Connection $Connection -Method DELETE -URI "/api/ni/groups/applications/$($oThisApplicationTier.application.entity_id)/tiers/$($oThisApplicationTier.entity_id)" } ## end Foreach-Object } ## end process } function New-vRNIApplication { <# .SYNOPSIS Create a new Application container inside vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .EXAMPLE PS C:\> New-vRNIApplication -Name My3TierApp Create a new application container with the name My3TierApp. #> param ( [Parameter (Mandatory = $false, Position = 1)] # Give the application a name [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = @{ "name" = $Name } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $response = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/groups/applications" -Body $requestBody $response } function Remove-vRNIApplication { <# .SYNOPSIS Remove an Application container from vRealize Network Insight. .DESCRIPTION Within vRNI there are applications, which can be viewed as groups of VMs. These groups can be used to group the VMs of a certain application together, and filter on searches within vRNI. For instance, you can generate recommended firewall rules based on an application group. .EXAMPLE PS C:\> Get-vRNIApplication My3TierApp | Remove-vRNIApplication Remove the application container called "My3TierApp" #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Application object, gotten from Get-vRNIApplication [ValidateNotNullOrEmpty()] [PSObject]$Application, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $Application | Foreach-Object { $oThisApplication = $_ # Send the DELETE request and show the result Invoke-vRNIRestMethod -Connection $Connection -Method DELETE -URI "/api/ni/groups/applications/$($oThisApplication.entity_id)" } ## end Foreach-Object } ## end process } ##################################################################################################################### ##################################################################################################################### ######################################### Entity Management ######################################################## ##################################################################################################################### ##################################################################################################################### function Get-vRNIEntity { <# .SYNOPSIS Get available entities from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all kinds of entities inside the monitored infrastructure. This is a catch-all function to retrieve any entity and the objects related to that entity. .EXAMPLE PS C:\> Get-vRNIEntity -Entity_URI security-groups Get all security groups in the vRNI environment. .EXAMPLE PS C:\> Get-vRNIEntity -Entity_URI "hosts" -Name "esxi01.lab" Get the entity object for the hypervisor host called "esxi01.lab" #> param ( [Parameter (Mandatory = $true)] # Limit the amount of records returned [string]$Entity_URI, [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to start looking up records [int]$StartTime = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to stop looking up records [int]$EndTime = 0, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Use this as a results container $entities = [System.Collections.ArrayList]@() # vRNI uses a paging system with (by default) 10 items per page. These vars are to keep track of the pages and retrieve what's left $size = 10 $total_count = 0 $current_count = 0 $cursor = "" $finished = $false while (!$finished) { $using_params = 0 # This is the base URI for the problems $URI = "/api/ni/entities/$($Entity_URI)" if ($size -gt 0 -And $cursor -ne "") { $URI += "?size=$($size)&cursor=$($cursor)" $using_params++ } # Check if we want to limit the results to a time window if ($PSCmdlet.ParameterSetName -eq "TIMELIMIT" -And ($StartTime -gt 0 -And $EndTime -gt 0)) { if ($using_params -gt 0) { $URI += "&start_time=$($StartTime)&end_time=$($EndTime)" $using_params++ } else { $URI += "?start_time=$($StartTime)&end_time=$($EndTime)" $using_params++ } } Write-Debug "Using URI: $($URI)" $listParams = @{ Connection = $Connection Method = 'GET' URI = $URI } # support filtering by a VM by using search instead of returning all entities if ($PSBoundParameters.ContainsKey('Name') -and $Name -ne '') { $listParams['URI'] = '/api/ni/search' $listParams['Body'] = @{ entity_type = $Script:EntityURLtoIdMapping.$Entity_URI filter = "Name = '$Name'" } | ConvertTo-Json $listParams['Method'] = 'POST' } # Get a list of all entities $entity_list = Invoke-vRNIRestMethod @listParams # If we're not finished, store information about the run for next use if ($finished -eq $false) { $total_count = $entity_list.total_count $cursor = $entity_list.cursor } # If the size is smaller than 10 (decreased by previous run), or the size is greater than the total records, finish up if ($size -lt 10 -Or ($total_count -gt 0 -And $size -gt $total_count)) { $finished = $true } # If we're using version 1.1.0 or greater of the vRNI API - we can use the /entities/fetch bulk method of getting entity details. Much more efficient. if ($Script:vRNI_API_Version -ge [System.Version]"1.1.0") { $requestFormat = @{ "entity_ids" = $entity_list.results } $requestBody = ConvertTo-Json $requestFormat $entity_info = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/entities/fetch" -Body $requestBody foreach ($entity in $entity_info.results) { # If we're retrieving flows, add the time of the main flow to this specific flow record if ($Entity_URI -eq "flows") { $entity.entity | Add-Member -Name "time" -value $entity.time -MemberType NoteProperty } $entity = $entity.entity $entities.Add($entity) | Out-Null $current_count++ # If we are limiting the output, break from the loops and return results if ($Limit -ne 0 -And ($Limit -lt $current_count -Or $Limit -eq $current_count)) { $finished = $true break } } # Check remaining items, if it's less than the default size, reduce the next page size if ($size -gt ($total_count - $current_count)) { $size = ($total_count - $current_count) } # continue the while(!$finished) loop continue } # Go through the entities individually and store them in the results array foreach ($sg in $entity_list.results) { # Retrieve entity details and store them $entity_info = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/entities/$($Entity_URI)/$($sg.entity_id)?time=$($sg.time)" # If we're retrieving flows, add the time of the main flow to this specific flow record if ($Entity_URI -eq "flows") { $entity_info | Add-Member -Name "time" -value $sg.time -MemberType NoteProperty } $entities.Add($entity_info) | Out-Null $current_count++ # If we are limiting the output, break from the loops and return results if ($Limit -ne 0 -And ($Limit -lt $current_count -Or $Limit -eq $current_count)) { $finished = $true break } } ## end foreach($sg in $entity_list.results) # Check remaining items, if it's less than the default size, reduce the next page size if ($size -gt ($total_count - $current_count)) { $size = ($total_count - $current_count) } } # if a single entity name was requested, filter on name if ($Name) { $entities | Where-Object { $_.name -eq $Name } } else { $entities } } function Get-vRNIEntityName { <# .SYNOPSIS Translate an entity id to a name in vRealize Network Insight. .DESCRIPTION The internal database of vRealize Network Insight uses entity IDs to keep track of entities. This function translates an ID to an actual useable name. .EXAMPLE PS C:\> Get-vRNIEntityName -EntityID 14307:562:1274720802 Get the name of the entity with ID 14307:562:1274720802 #> param ( [Parameter (Mandatory = $true, Position = 1)] # The entity ID to resolve to a name [string]$EntityID, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Invoke-vRNIRestMethod with the proper URI to get the entity results $result = Invoke-vRNIRestMethod -Connection $Connection -Method GET -URI "/api/ni/entities/names/$($EntityID)" $result } function Get-vRNIEntityNames { <# .SYNOPSIS Translate an array of entity ids to names in vRealize Network Insight. .DESCRIPTION The internal database of vRealize Network Insight uses entity IDs to keep track of entities. This function translates an ID to an actual useable name. .EXAMPLE PS C:\> Get-vRNIEntityNames -EntityID 14307:562:1274720802,14307:562:1274720803 -EntityType VirtualMachine Get the name of the entity with ID 14307:562:1274720802 and 14307:562:1274720803 #> param ( [Parameter (Mandatory = $true, Position = 1)] # The entity IDs to resolve to a name [string[]]$EntityIDs, [Parameter (Mandatory = $true, Position = 2)] # The entity type to resolve to a name [string[]]$EntityType, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $requestFormat = @{ "entity_ids" = @() } foreach ($entityID in $EntityIDs) { $record = @{ "entity_id" = $entityID "entity_type" = $EntityType } $requestFormat.entity_ids += $record } $requestBody = ConvertTo-Json $requestFormat $entity_info = Invoke-vRNIRestMethod -Connection $Connection -Method POST -URI "/api/ni/entities/fetch" -Body $requestBody $entity_info.results } function Get-vRNIProblem { <# .SYNOPSIS Get open problems from vRealize Network Insight. .DESCRIPTION vRNI checks for problems in your environment and displays or alerts you about these problems. These problems can have multiple causes; for example latency issues with NSX Controllers, a configuration issue on the VDS, etc. In the end you're supposed to solve these problems and have no open ones. .EXAMPLE PS C:\> Get-vRNIProblem Get a list of all open problems .EXAMPLE PS C:\> Get-vRNIProblem | Where {$_.severity -eq "CRITICAL"} Get a list of all open problems which have the CRITICAL severity (and are probably important to solve quickly) .EXAMPLE PS C:\> Get-vRNIProblem -StartTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()-600) -EndTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()) Get all problems that have been open in the last 10 minutes. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to start looking up records [int]$StartTime = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to stop looking up records [int]$EndTime = 0, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "problems" -Limit $Limit -StartTime $StartTime -EndTime $EndTime $results } function Get-vRNIFlow { <# .SYNOPSIS Get network flows from vRealize Network Insight. .DESCRIPTION vRNI can consume NetFlow and IPFIX data from the vSphere Distributed Switch and physical switches which support NetFlow v5, v7, v9 or IPFIX. This cmdlet will let you export these flows .EXAMPLE PS C:\> Get-vRNIFlow Get the last 100 flows (100 = default) .EXAMPLE PS C:\> Get-vRNIFlow -Limit 10 Get the last 10 flows .EXAMPLE PS C:\> Get-vRNIFlow -StartTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()-600) -EndTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()) Get all flows that occurred in the last 10 minutes. .EXAMPLE PS C:\> Get-vRNIFlow -StartTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()-600) -EndTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()) | Where {$_.protocol -eq "TCP"} Get all flows that occurred in the last 10 minutes and ignore all flows that are not TCP based. .EXAMPLE PS C:\> Get-vRNIFlow -StartTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()-600) -EndTime ([DateTimeOffset]::Now.ToUnixTimeSeconds()) | Where {$_.traffic_type -eq "INTERNET_TRAFFIC"} Get only internet-based (in or out) flows that occurred in the last 10 minutes. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 100, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to start looking up records [int]$StartTime = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to stop looking up records [int]$EndTime = 0, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # If we want to select flows in a time slot, make sure the end time is later then the start time if ($PSCmdlet.ParameterSetName -eq "TIMELIMIT") { if ($StartTime -gt $EndTime) { throw "Param StartTime cannot be greater than EndTime" } } # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "flows" -Limit $Limit -StartTime $StartTime -EndTime $EndTime $results } function Get-vRNIKubernetesServices { <# .SYNOPSIS Get Kubernetes Services from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all Kubernetes Services in your environment and this cmdlet will help you discover these services. .EXAMPLE PS C:\> Get-vRNIKubernetesServices List all Kubernetes Services in your vRNI environment (note: this may take a while if you have a lot of services) .EXAMPLE PS C:\> Get-vRNIKubernetesServices -Name my-k8s-service Retrieve only the Kubernetes Service object called "my-k8s-service" #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "kubernetes-services" -Name $Name -Limit $Limit $results } function Get-vRNISDDC { <# .SYNOPSIS Get SDDC objects from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all SDDC constructs in your environment and this cmdlet will help you discover these services. .EXAMPLE PS C:\> Get-vRNISDDC List all SDDCs in your vRNI environment (note: this may take a while if you have a lot of SDDCs) .EXAMPLE PS C:\> Get-vRNISDDC -Name my-sddc Retrieve only the SDDC object called my-sddc" #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "vmc-sddc" -Name $Name -Limit $Limit $results } #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------- VM Entities ---------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# function Get-vRNIVM { <# .SYNOPSIS Get virtual machines from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all VMs in your environment and this cmdlet will help you discover these VMs. .EXAMPLE PS C:\> Get-vRNIVM List all VMs in your vRNI environment (note: this may take a while if you have a lot of VMs) .EXAMPLE PS C:\> Get-vRNIVM -Name my-vm-name Retrieve only the VM object called "my-vm-name" .EXAMPLE PS C:\> $vcenter_entity_id = (Get-vRNIvCenter | Where {$_.name -eq "vcenter.lab"}).entity_id PS C:\> Get-vRNIVM | Where {$_.vcenter_manager.entity_id -eq $vcenter_entity_id} Get all VMs that are attached to the vCenter named "vcenter.lab" #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "vms" -Name $Name -Limit $Limit $results } function Get-vRNIVMvNIC { <# .SYNOPSIS Get virtual machine vnics from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all VM vNICs in your environment and this cmdlet will help you discover these VM vNICs. .EXAMPLE PS C:\> Get-vRNIVMvNIC List all VM vNICs in your vRNI environment (note: this may take a while if you have a lot of VMs) #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "vnics" -Name $Name -Limit $Limit $results } #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #--------------------------------------- vCenter Entities -------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# function Get-vRNIvCenter { <# .SYNOPSIS Get configured vCenter instances from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all vCenters in your environment and this cmdlet will help you discover these vCenters. .EXAMPLE PS C:\> Get-vRNIvCenter Get all vCenters in the vRNI environment. .EXAMPLE PS C:\> Get-vRNIvCenter vcenter.lab Retrieve the vCenter object for the one called "vcenter.lab" #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "vcenter-managers" -Name $Name -Limit $Limit $results } function Get-vRNIvCenterFolder { <# .SYNOPSIS Get available vCenter folders from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all vCenter folders in your environment and this cmdlet will help you discover these folders. .EXAMPLE PS C:\> Get-vRNIvCenterFolder Get all vCenter folders in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "folders" -Name $Name -Limit $Limit $results } function Get-vRNIvCenterDatacenter { <# .SYNOPSIS Get available vCenter Datacenters from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all vCenter Datacenters in your environment and this cmdlet will help you discover these Datacenters. .EXAMPLE PS C:\> Get-vRNIvCenterDatacenter Get all vCenter Datacenters in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "vc-datacenters" -Name $Name -Limit $Limit $results } function Get-vRNIvCenterCluster { <# .SYNOPSIS Get available vCenter Clusters from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all vCenter Clusters in your environment and this cmdlet will help you discover these Clusters. .EXAMPLE PS C:\> Get-vRNIvCenterCluster Get all vCenter Clusters in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "clusters" -Name $Name -Limit $Limit $results } #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #-------------------------------------- ESXi host Entities ------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# function Get-vRNIHost { <# .SYNOPSIS Get available hypervisor hosts from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all hosts in your environment and this cmdlet will help you discover these hosts. .EXAMPLE PS C:\> Get-vRNIHost Get all hypervisor hosts in the vRNI environment. .EXAMPLE PS C:\> Get-vRNIHost esxi01.lab Retrieve the ESXi host object for the one called "esxi01.lab" .EXAMPLE PS C:\> Get-vRNIHost | Select name, service_tag Get a list of all hosts with their hardware service tag. .EXAMPLE PS C:\> Get-vRNIHost | Where {$_.nsx_manager -ne ""} Get all hosts that are managed by a NSX Manager. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "hosts" -Name $Name -Limit $Limit $results } function Get-vRNIHostVMKNic { <# .SYNOPSIS Get available host vmknics from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all host vmknics in your environment and this cmdlet will help you discover these vmknids. .EXAMPLE PS C:\> Get-vRNIHostVMKNic Get all host vmknics in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "vmknics" -Name $Name -Limit $Limit $results } #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #------------------------------------------- NSX Entities -------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# function Get-vRNISecurityGroup { <# .SYNOPSIS Get available security groups (SG) from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all SGs in your environment and this cmdlet will help you discover these SGs. .EXAMPLE PS C:\> Get-vRNISecurityGroup Get all security groups in the vRNI environment. .EXAMPLE PS C:\> Get-vRNISecurityGroup 3TA-Management-Access Retrieve the security group object for the one called "3TA-Management-Access" #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "security-groups" -Name $Name -Limit $Limit $results } function Get-vRNISecurityTag { <# .SYNOPSIS Get available security tags (ST) from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all STs in your environment and this cmdlet will help you discover these STs. .EXAMPLE PS C:\> Get-vRNISecurityTag Get all security tags in the vRNI environment. .EXAMPLE PS C:\> Get-vRNISecurityTag ST-3TA-Management Retrieve the security tag object for the one called "ST-3TA-Management" #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "security-tags" -Name $Name -Limit $Limit $results } function Get-vRNIIPSet { <# .SYNOPSIS Get available NSX IP Sets from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all NSX IP Sets in your environment and this cmdlet will help you discover these IP sets. .EXAMPLE PS C:\> Get-vRNIIPSet Get all IP Sets in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "ip-sets" -Name $Name -Limit $Limit $results } function Get-vRNIService { <# .SYNOPSIS Get available NSX Services from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all NSX Services in your environment and this cmdlet will help you discover these Services. .EXAMPLE PS C:\> Get-vRNIService Get all NSX Services in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "services" -Name $Name -Limit $Limit $results } function Get-vRNIServiceGroup { <# .SYNOPSIS Get available NSX Service Groups from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all NSX Service Groups in your environment and this cmdlet will help you discover these groups. .EXAMPLE PS C:\> Get-vRNIServiceGroup Get all NSX Service Groups in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "service-groups" -Name $Name -Limit $Limit $results } function Get-vRNINSXManager { <# .SYNOPSIS Get available NSX Managers from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all NSX Managers in your environment and this cmdlet will help you discover these NSX Managers. .EXAMPLE PS C:\> Get-vRNINSXManager Get all NSX Managers in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "nsx-managers" -Name $Name -Limit $Limit $results } #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #---------------------------------------- Networking Entities ---------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# function Get-vRNIFirewallRule { <# .SYNOPSIS Get available firewall rules from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all firewall rules in your environment and this cmdlet will help you discover these rules. .EXAMPLE PS C:\> Get-vRNIFirewallRule Get all firewall rules in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "firewall-rules" -Name $Name -Limit $Limit $results } function Get-vRNIL2Network { <# .SYNOPSIS Get available layer 2 networks from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all networks in your environment and this cmdlet will help you discover these layer 2 networks. .EXAMPLE PS C:\> Get-vRNIL2Network Get all layer 2 networks in the vRNI environment. .EXAMPLE PS C:\> Get-vRNIL2Network | Where {$_.entity_type -eq "VxlanLayer2Network"} Only show all VXLAN layer 2 networks. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "layer2-networks" -Name $Name -Limit $Limit $results } function Get-vRNIDistributedSwitch { <# .SYNOPSIS Get available vSphere Distributed Switches from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all VDSes in your environment and this cmdlet will help you discover these VDSes. .EXAMPLE PS C:\> Get-vRNIDistributedSwitch Get all vSphere Distributed Switches in the vRNI environment. .EXAMPLE PS C:\> Get-vRNIDistributedSwitch LabSwitch Get only the VDS called 'LabSwitch' #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "distributed-virtual-switches" -Name $Name -Limit $Limit $results } function Get-vRNIDistributedSwitchPortGroup { <# .SYNOPSIS Get available VDS Portgroups from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all VDS Portgroups in your environment and this cmdlet will help you discover these portgroups. .EXAMPLE PS C:\> Get-vRNIDistributedSwitchPortGroup Get all VDS Portgroups in the vRNI environment. .EXAMPLE PS C:\> Get-vRNIDistributedSwitchPortGroup Web-Tier Get only the portgroup called 'Web-Tier' #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "distributed-virtual-portgroups" -Name $Name -Limit $Limit $results } function Get-vRNICheckPointManagers { <# .SYNOPSIS Get available CheckPoint Firewall Managers from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all CheckPoint Firewall Managers in your environment and this cmdlet will help you discover these managers. .EXAMPLE PS C:\> Get-vRNICheckPointManagers Get all CheckPoint Firewall Managers in the vRNI environment. .EXAMPLE PS C:\> Get-vRNICheckPointManagers CP01 Get only the CheckPoint Firewall Managers called 'CP01' #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "firewall-managers" -Name $Name -Limit $Limit $results } #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------- Storage Entities -----------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# #----------------------------------------------------------------------------------------------------------------# function Get-vRNIDatastore { <# .SYNOPSIS Get available datastores from vRealize Network Insight. .DESCRIPTION vRealize Network Insight has a database of all datastores in your environment and this cmdlet will help you discover these datastores. .EXAMPLE PS C:\> Get-vRNIDatastore Get all datastores in the vRNI environment. #> param ( [Parameter (Mandatory = $false)] # Limit the amount of records returned [int]$Limit = 0, [Parameter (Mandatory = $false, Position = 1)] # Limit the amount of records returned [string]$Name = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Call Get-vRNIEntity with the proper URI to get the entity results $results = Get-vRNIEntity -Entity_URI "datastores" -Name $Name -Limit $Limit $results } ##################################################################################################################### ##################################################################################################################### ##################################### Recommended Firewall Rules ################################################## ##################################################################################################################### ##################################################################################################################### function Get-vRNIRecommendedRules { <# .SYNOPSIS Retrieve the recommended firewall rules of a specific application. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the required firewall rules to implement micro-segmentation. This means you have a starting point when it comes to micro-segmentation and implementing the needed firewall rules. This function retrieves the recommended firewall rules for an application. Per default this function uses a 14 day analysis period. .EXAMPLE PS C:\> Get-vRNIRecommendedRules -ApplicationID (Get-vRNIApplication vRNI).entity_id This will return the recommended firewall rules for the application called 'vRNI' .EXAMPLE PS C:\> $sevenDaysAgo = (Get-Date).AddDays(-7) PS C:\> $start = [int][double]::Parse((Get-Date -Date $sevenDaysAgo -UFormat %s)) PS C:\> $end = [int][double]::Parse((Get-Date -UFormat %s)) PS C:\> Get-vRNIRecommendedRules -ApplicationID (Get-vRNIApplication vRNI).entity_id -StartTime $start -EndTime $end This will return the recommended firewall rules for the application called 'vRNI' from analysis on the last 7 days. #> param ( [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to start looking up records [int]$StartTime = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to stop looking up records [int]$EndTime = 0, [Parameter (Mandatory = $false)] # The application entity ID for which to retrieve the recommended rules [string]$ApplicationID = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) if ($PSCmdlet.ParameterSetName -eq "TIMELIMIT" -And ($StartTime -gt 0 -And $EndTime -gt 0)) { if ($StartTime -gt $EndTime) { throw "StartTime cannot be greated than EndTime" } } else { # Use a timeframe of 14 days by default $twoWeeksAgo = (Get-Date).AddDays(-14) $StartTime = [int][double]::Parse((Get-Date -Date $twoWeeksAgo -UFormat %s)) $EndTime = [int][double]::Parse((Get-Date -UFormat %s)) } # TODO: also allow lookups between 2 application tiers # Format request with all given data $requestFormat = @{ "group_1" = @{ "entity" = @{ "entity_type" = "Application" "entity_id" = $ApplicationID } } "time_range" = @{ "start_time" = $StartTime "end_time" = $EndTime } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $response = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/micro-seg/recommended-rules" -Body $requestBody $response.results } function Get-vRNIRecommendedRulesNsxBundle { <# .SYNOPSIS Retrieve the recommended firewall rules of a specific application bundled in the NSX-v format for processing with the Rules Importer Tool (more on that at a later date) .DESCRIPTION vRealize Network Insight collects netflow data and analyses the required firewall rules to implement micro-segmentation. This means you have a starting point when it comes to micro-segmentation and implementing the needed firewall rules. This function retrieves the recommended firewall rules for an application. Per default this function uses a 14 day analysis period. .EXAMPLE PS C:\> Get-vRNIRecommendedRulesNsxBundle -ApplicationID (Get-vRNIApplication vRNI).entity_id This will return the recommended firewall rules for the application called 'vRNI' .EXAMPLE PS C:\> $sevenDaysAgo = (Get-Date).AddDays(-7) PS C:\> $start = [int][double]::Parse((Get-Date -Date $sevenDaysAgo -UFormat %s)) PS C:\> $end = [int][double]::Parse((Get-Date -UFormat %s)) PS C:\> Get-vRNIRecommendedRulesNsxBundle -ApplicationID (Get-vRNIApplication vRNI).entity_id -StartTime $start -EndTime $end This will return the recommended firewall rules for the application called 'vRNI' from analysis on the last 7 days. #> param ( [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to start looking up records [int]$StartTime = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to stop looking up records [int]$EndTime = 0, [Parameter (Mandatory = $false)] # The application entity ID for which to retrieve the recommended rules [string]$ApplicationID = "", [Parameter (Mandatory = $true)] # This cmdlet outputs a zip file specified by the filename here [string]$OutFile, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) if ($PSCmdlet.ParameterSetName -eq "TIMELIMIT" -And ($StartTime -gt 0 -And $EndTime -gt 0)) { if ($StartTime -gt $EndTime) { throw "StartTime cannot be greated than EndTime" } } else { # Use a timeframe of 14 days by default $twoWeeksAgo = (Get-Date).AddDays(-14) $StartTime = [int][double]::Parse((Get-Date -Date $twoWeeksAgo -UFormat %s)) $EndTime = [int][double]::Parse((Get-Date -UFormat %s)) } # TODO: also allow lookups between 2 application tiers # Format request with all given data $requestFormat = @{ "group_1" = @{ "entity" = @{ "entity_type" = "Application" "entity_id" = $ApplicationID } } "time_range" = @{ "start_time" = $StartTime "end_time" = $EndTime } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/micro-seg/recommended-rules/nsx" -Body $requestBody -OutFile $OutFile } ##################################################################################################################### ##################################################################################################################### ######################################### Settings Management ###################################################### ##################################################################################################################### ##################################################################################################################### function New-vRNISubnetMapping { <# .SYNOPSIS Create a new IP Subnet to VLAN ID mapping within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. When vRNI does not have full visibility on the physical network and can't discover the mappings between VLANs and subnets, you can use subnet mappings to manually determine which subnets belong to which VLANs. .EXAMPLE PS C:\> New-vRNISubnetMapping -VLANID 10 -CIDR 192.168.0.0/24 .EXAMPLE PS C:\> New-vRNISubnetMapping -VLANID 11 -CIDR 192.168.0.0/16 #> param ( [Parameter (Mandatory = $true)] # The VLAN ID for this mapping [int]$VLANID, [Parameter (Mandatory = $true)] # The CIDR mapped to the given VLAN ID [string]$CIDR, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = @{ "cidr" = $CIDR "vlan_id" = $VLANID } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/settings/subnet-mappings" -Body $requestBody } function Get-vRNISubnetMapping { <# .SYNOPSIS Retrieve all IP Subnet to VLAN ID mappings within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. When vRNI does not have full visibility on the physical network and can't discover the mappings between VLANs and subnets, you can use subnet mappings to manually determine which subnets belong to which VLANs. .EXAMPLE PS C:\> Get-vRNISubnetMapping #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $results = Invoke-vRNIRestMethod -Connection $Connection -Method GET -Uri "/api/ni/settings/subnet-mappings" return $results.results } function Get-vRNIEastWestIP { <# .SYNOPSIS Retrieve all East-West IP mappings within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. If you are using public IPs for workloads inside the datacenter, you should add them to the East-West IP mappings. .EXAMPLE PS C:\> Get-vRNIEastWestIP #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $results = Invoke-vRNIRestMethod -Connection $Connection -Method GET -Uri "/api/ni/settings/ip-tags/EAST_WEST" return $results } function Add-vRNIEastWestIP { <# .SYNOPSIS Adds a new East-West IP mapping within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. If you are using public IPs for workloads inside the datacenter, you should add them to the East-West IP mappings. .EXAMPLE PS C:\> Add-vRNIEastWestIP -Subnet 80.182.12.0/24 .EXAMPLE PS C:\> Add-vRNIEastWestIP -IP_Range_Start 90.23.12.1 -IP_Range_End 90.23.12.100 #> param ( [Parameter (Mandatory = $true, ParameterSetName = "PS_Subnet")] # The subnet to add to the IP mappings [string]$Subnet, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range start to add to the IP mappings [string]$IP_Range_Start, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range end to add to the IP mappings [string]$IP_Range_End, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = "" if ($PSCmdlet.ParameterSetName -eq "PS_Subnet") { $requestFormat = @{ "tag_id" = "EAST_WEST" "subnets" = @($Subnet) } } if ($PSCmdlet.ParameterSetName -eq "PS_IP_Range") { $requestFormat = @{ "tag_id" = "EAST_WEST" "ip_address_ranges" = @( @{ "start_ip" = $IP_Range_Start "end_ip" = $IP_Range_End } ) } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $results = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/settings/ip-tags/EAST_WEST/add" -Body $requestBody return $results } function Remove-vRNIEastWestIP { <# .SYNOPSIS Removes a East-West IP mapping within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. If you are using public IPs for workloads inside the datacenter, you should add them to the East-West IP mappings. .EXAMPLE PS C:\> Remove-vRNIEastWestIP -Subnet 80.182.12.0/24 .EXAMPLE PS C:\> Remove-vRNIEastWestIP -IP_Range_Start 90.23.12.1 -IP_Range_End 90.23.12.100 #> param ( [Parameter (Mandatory = $true, ParameterSetName = "PS_Subnet")] # The subnet to remove from the IP mappings [string]$Subnet, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range start to remove from the IP mappings [string]$IP_Range_Start, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range end to remove from the IP mappings [string]$IP_Range_End, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = "" if ($PSCmdlet.ParameterSetName -eq "PS_Subnet") { $requestFormat = @{ "tag_id" = "EAST_WEST" "subnets" = @($Subnet) } } if ($PSCmdlet.ParameterSetName -eq "PS_IP_Range") { $requestFormat = @{ "tag_id" = "EAST_WEST" "ip_address_ranges" = @( @{ "start_ip" = $IP_Range_Start "end_ip" = $IP_Range_End } ) } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $results = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/settings/ip-tags/EAST_WEST/remove" -Body $requestBody return $results } function Get-vRNINorthSouthIP { <# .SYNOPSIS Retrieve all North-South IP mappings within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. If you are using internal IPs outside the datacenter, you should add them to the North-South IP mappings. .EXAMPLE PS C:\> Get-vRNINorthSouthIP #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $results = Invoke-vRNIRestMethod -Connection $Connection -Method GET -Uri "/api/ni/settings/ip-tags/INTERNET" return $results } function Add-vRNINorthSouthIP { <# .SYNOPSIS Add a new North-South IP mapping within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. If you are using internal IPs outside the datacenter, you should add them to the North-South IP mappings. .EXAMPLE PS C:\> Add-vRNINorthSouthIP -Subnet 80.182.12.0/24 .EXAMPLE PS C:\> Add-vRNINorthSouthIP -IP_Range_Start 90.23.12.1 -IP_Range_End 90.23.12.100 #> param ( [Parameter (Mandatory = $true, ParameterSetName = "PS_Subnet")] # The subnet to add to the IP mappings [string]$Subnet, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range start to add to the IP mappings [string]$IP_Range_Start, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range end to add to the IP mappings [string]$IP_Range_End, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = "" if ($PSCmdlet.ParameterSetName -eq "PS_Subnet") { $requestFormat = @{ "tag_id" = "INTERNET" "subnets" = @($Subnet) } } if ($PSCmdlet.ParameterSetName -eq "PS_IP_Range") { $requestFormat = @{ "tag_id" = "INTERNET" "ip_address_ranges" = @( @{ "start_ip" = $IP_Range_Start "end_ip" = $IP_Range_End } ) } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $results = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/settings/ip-tags/INTERNET/add" -Body $requestBody return $results } function Remove-vRNINorthSouthIP { <# .SYNOPSIS Remove a North-South IP mapping within vRealize Network Insight. .DESCRIPTION vRealize Network Insight collects netflow data and analyses the network flows. If you are using internal IPs outside the datacenter, you should add them to the North-South IP mappings. .EXAMPLE PS C:\> Remove-vRNINorthSouthIP -Subnet 80.182.12.0/24 .EXAMPLE PS C:\> Remove-vRNINorthSouthIP -IP_Range_Start 90.23.12.1 -IP_Range_End 90.23.12.100 #> param ( [Parameter (Mandatory = $true, ParameterSetName = "PS_Subnet")] # The subnet to remove from the IP mappings [string]$Subnet, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range start to remove from the IP mappings [string]$IP_Range_Start, [Parameter (Mandatory = $true, ParameterSetName = "PS_IP_Range")] # The IP range end to remove from the IP mappings [string]$IP_Range_End, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Format request with all given data $requestFormat = "" if ($PSCmdlet.ParameterSetName -eq "PS_Subnet") { $requestFormat = @{ "tag_id" = "INTERNET" "subnets" = @($Subnet) } } if ($PSCmdlet.ParameterSetName -eq "PS_IP_Range") { $requestFormat = @{ "tag_id" = "INTERNET" "ip_address_ranges" = @( @{ "start_ip" = $IP_Range_Start "end_ip" = $IP_Range_End } ) } } # Convert the hash to JSON, form the URI and send the request to vRNI $requestBody = ConvertTo-Json $requestFormat $results = Invoke-vRNIRestMethod -Connection $Connection -Method POST -Uri "/api/ni/settings/ip-tags/INTERNET/remove" -Body $requestBody return $results } function Get-vRNIAuditLogs { <# .SYNOPSIS Retrieve audit logs from Network Insight .DESCRIPTION Network Insight logs the actions that are being executed on its interface, and this endpoint is a way to retrieve the audit log .EXAMPLE PS C:\> Get-vRNIAuditLogs .EXAMPLE PS C:\> Get-vRNIAuditLogs -Username "admin@local" .EXAMPLE PS C:\> Get-vRNIAuditLogs -Operation "LOGIN" #> param ( [Parameter (Mandatory = $false)] # Filter on username [string]$Username = "", [Parameter (Mandatory = $false)] # Filter on a specific operation (like LOGIN, UPDATE) [string]$Operation = "", [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to start looking up records [int]$StartTime = 0, [Parameter (Mandatory = $false, ParameterSetName = "TIMELIMIT")] # The epoch timestamp of when to stop looking up records [int]$EndTime = 0, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # A list to collect the log records in $logs = [System.Collections.ArrayList]@() # Initialise the body $body = @{ size = 50 } # Filter on specific details, if given via params if ($Username -ne "") { $body['username'] = $Username } if ($Operation -ne "") { $body['operation'] = $Operation } # Add a time range, if specified in the params if ($PSCmdlet.ParameterSetName -eq "TIMELIMIT" -And ($StartTime -gt 0 -And $EndTime -gt 0)) { $body['time_range'] = @{ start_time = $StartTime end_time = $EndTime } } # Initialise the RestMethod params $listParams = @{ Connection = $Connection Method = 'POST' Uri = "/api/ni/logs/audit" Body = $body | ConvertTo-Json } # Loop through the log pages, as it uses pagination to return only a restrict set $hasMoreData = $true $counter = 0 while ($hasMoreData) { $logsResponse = Invoke-vRNIRestMethod @listParams Write-Verbose ("$($logsResponse.total_count) logs to process") if ($logsResponse.total_count -gt $size) { $body['cursor'] = $logsResponse.cursor $listParams['Body'] = $body | ConvertTo-Json } # Save results foreach ($log_record in $logsResponse.results) { $logs.Add($log_record) | Out-Null $counter++ } $remaining = $logsResponse.total_count - $counter if ($remaining -gt 0) { Write-Verbose "$remaining more logs to process" $hasMoreData = $true } else { $hasMoreData = $false } } $logs } ##################################################################################################################### ##################################################################################################################### ####################################### vIDM Settings Management ################################################### ##################################################################################################################### ##################################################################################################################### function Get-vRNISettingsVIDM { <# .SYNOPSIS Retrieve vIDM settings from Network Insight .DESCRIPTION VMware Identity Manager (vIDM) can be used for authentication within vRNI. vIDM offers more authentication & authorization options like multi-factor, location dependent, etc. This cmdlet retrieves the vIDM settings. .EXAMPLE PS C:\> Get-vRNISettingsVIDM #> param ( [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $result = Invoke-vRNIRestMethod -Connection $Connection -Method "GET" -Uri "/api/ni/settings/vidm" $result } function Set-vRNISettingsVIDM { <# .SYNOPSIS Retrieve vIDM settings from Network Insight .DESCRIPTION VMware Identity Manager (vIDM) can be used for authentication within vRNI. vIDM offers more authentication & authorization options like multi-factor, location dependent, etc. This cmdlet configures the vIDM settings. .EXAMPLE PS C:\> Get-vRNISettingsVIDM -Appliance my-vidm-appliance -ClientID vRNI -ClientSecret longstring #> param ( [Parameter (Mandatory = $true)] # vIDM Appliance hostname [string]$Appliance, [Parameter (Mandatory = $true)] # vIDM OAuth2 Client ID [string]$ClientID, [Parameter (Mandatory = $true)] # vIDM OAuth2 Client Secret [string]$ClientSecret, [Parameter (Mandatory = $false)] # Optional vIDM OAuth2 SHA Thumbprint [string]$SHA_Thumbprint = "", [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Initialise the body $body = @{ vidm_appliance = $Appliance client_id = $ClientID client_secret = $ClientSecret sha_thumbprint = $SHA_Thumbprint enable = $true } # Initialise the RestMethod params $listParams = @{ Connection = $Connection Method = 'POST' Uri = "/api/ni/settings/vidm" Body = $body | ConvertTo-Json } $result = Invoke-vRNIRestMethod @listParams $result } function Get-vRNISettingsUserGroup { <# .SYNOPSIS Retrieve user groups settings from Network Insight .DESCRIPTION User groups from AD, VIDM or LOCAL can be mapped to vRNI member roles (ADMIN or MEMBER) and this cmdlet gets the current mappings. The public API currently only supports the VIDM type. .EXAMPLE PS C:\> Get-vRNISettingsUserGroups -Type VIDM #> param ( [Parameter (Mandatory = $true)] [ValidateSet ("LDAP", "LOCAL", "VIDM")] # Group type; where is the group from? [string]$Type, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) $result = Invoke-vRNIRestMethod -Connection $Connection -Method "GET" -Uri "/api/ni/settings/user-groups?type=$($Type)" $result.results } function Set-vRNISettingsUserGroup { <# .SYNOPSIS Configure user group role mappings. .DESCRIPTION User groups from AD, VIDM or LOCAL can be mapped to vRNI member roles (ADMIN or MEMBER) and this cmdlet configures a group to role mapping. .EXAMPLE PS C:\> Set-vRNISettingsVIDMUserGroup -Type VIDM -Group vrni-admins -Domain mylab.local -Role ADMIN Map group 'vrni-admins' in vIDM to the vRNI ADMIN role .EXAMPLE PS C:\> Set-vRNISettingsVIDMUserGroup -Type VIDM -Group vrni-members -Domain mylab.local -Role MEMBER Map group 'vrni-members' in vIDM to the vRNI MEMBER role #> param ( [Parameter (Mandatory = $true)] # Type user group (only VIDM supported for now) [ValidateSet ("VIDM")] [string]$Type, [Parameter (Mandatory = $true)] # Name of the group in vIDM [string]$Group, [Parameter (Mandatory = $true)] # Domain in vIDM that this group belongs to [string]$Domain, [Parameter (Mandatory = $true)] # Role that this group will get in vRNI [ValidateSet ("ADMIN", "MEMBER")] [string]$Role, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) # Initialise the body $body = @{ group_name = $Group domain = $Domain role = $Role } # Initialise the RestMethod params $listParams = @{ Connection = $Connection Method = 'POST' Uri = "/api/ni/settings/user-groups/vidm" Body = $body | ConvertTo-Json } $result = Invoke-vRNIRestMethod @listParams $result } function Remove-vRNISettingsUserGroup { <# .SYNOPSIS Removes a user group mapping from vRealize Network Insight .DESCRIPTION User groups from AD, VIDM or LOCAL can be mapped to vRNI member roles (ADMIN or MEMBER) and this cmdlet removes a group to role mapping. .EXAMPLE PS C:\> Get-vRNISettingsUserGroup | Where {$_.group_name -eq "mygroup"} | Remove-vRNISettingsUserGroup #> param ( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] # Datasource object, gotten from Get-vRNISettingsUserGroup [ValidateNotNullOrEmpty()] [PSObject]$Group, [Parameter (Mandatory = $False)] # vRNI Connection object [ValidateNotNullOrEmpty()] [PSCustomObject]$Connection = $defaultvRNIConnection ) process { $Group | Foreach-Object { $oThisGroup = $_ |