PrtgAPI.PowerShell.XML

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
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PrtgAPI.PowerShell</name>
    </assembly>
    <members>
        <member name="T:PrtgAPI.PowerShell.Base.AddObject`3">
            <summary>
            Base class for cmdlets that add new table objects.
            </summary>
            <typeparam name="TParams">The type of parameters to use to create this object.</typeparam>
            <typeparam name="TObject">The type of object to create.</typeparam>
            <typeparam name="TDestination">The type of object this object will be added under.</typeparam>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.AddObject`3.Destination">
            <summary>
            <para type="description">The parent object to create an object under.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.AddObject`3.Parameters">
            <summary>
            <para type="description">A set of parameters whose properties describe the type of object to add, with what settings.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.AddObject`3.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.AddObject`3.GetObjects(PrtgAPI.SearchFilter[])">
            <summary>
            Resolves the children of the <see cref="P:PrtgAPI.PowerShell.Base.AddObject`3.Destination"/> object that match the new object's name. </summary> <param name="filters">An array of search filters used to retrieve all children of the <see cref="P:PrtgAPI.PowerShell.Base.AddObject`3.Destination"/> with the specified name.</param> <returns>All objects under the parent object that match the new object's name.</returns>
        </member>
        <member name="T:PrtgAPI.PowerShell.Base.IPrtgMultiPassThruCmdlet">
            <summary>
            Represents a type capable of sending multiple pipeline inputs through as outputs all at once.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.IPrtgMultiPassThruCmdlet.PassThruObjects">
            <summary>
            The objects that should be output from the cmdlet.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.IPrtgMultiPassThruCmdlet.CurrentMultiPassThru">
            <summary>
            Stores the last object that was output from the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.IPrtgMultiPassThruCmdlet.WriteMultiPassThru">
            <summary>
            Writes all objects stored in <see cref="P:PrtgAPI.PowerShell.Base.IPrtgMultiPassThruCmdlet.PassThruObjects"/> if <see cref="P:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.PassThru"/> is specified.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet">
            <summary>
            Represents a cmdlet type capable of sending its pipeline inputs through as outputs.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.PassThru">
            <summary>
            Specifies whether to return the original <see cref="T:PrtgAPI.IObject"/> that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.PassThruObject">
            <summary>
            Returns the current object that should be passed through this cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.WritePassThru">
            <summary>
            Writes the current <see cref="P:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.PassThruObject"/> to the pipeline if <see cref="P:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.PassThru"/> is specified.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Base.NewObjectCmdlet">
            <summary>
            Base class for all cmdlets that create new objects.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.NewObjectCmdlet.Resolve">
            <summary>
            <para type="description">Indicates whether or not the new object should be resolved to a <see cref="T:PrtgAPI.PrtgObject"/>. By default this value is <see cref="P:System.Management.Automation.SwitchParameter.Present"/>.</para>
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Base.PrtgCmdlet">
            <summary>
            Base class for all cmdlets requiring authenticated access to a PRTG Server.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.PrtgCmdlet.client">
            <summary>
            Provides access to the <see cref="T:PrtgAPI.PrtgClient"/> stored in the current PowerShell Session State.
            </summary>
        </member>
        <member name="F:PrtgAPI.PowerShell.Base.PrtgCmdlet.TokenSource">
            <summary>
            A cancellation token source to use with long running tasks that may need to be interrupted by Ctrl+C.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.BeginProcessing">
            <summary>
            Provides a one-time, preprocessing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.BeginProcessingEx">
            <summary>
            Provides an enhanced one-time, preprocessing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.ProcessRecord">
            <summary>
            Performs record-by-record processing for the cmdlet. Do not override this method; override <see cref="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.ProcessRecordEx"/> instead. 
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.EndProcessing">
            <summary>
            Performs one-time, post-processing functionality for the cmdlet. This function is only run when the cmdlet successfully runs to completion.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.StopProcessing">
            <summary>
            Interrupts the currently running code to signal the cmdlet has been requested to stop.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgCmdlet.Dispose">
            <summary>
            Disposes of all managed and unmanaged resources used by the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet">
            <summary>
            Base class for all cmdlets that perform actions or manipulate multiple objects in a single request against PRTG.
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.Batch">
            <summary>
            <para type="description">Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single
            request against PRTG for processing all objects. By default this value is true.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PassThru">
            <summary>
            <para type="description">Specifies whether to return the original <see cref="T:PrtgAPI.PrtgObject"/> that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.ExecuteOrQueue(PrtgAPI.IObject)">
            <summary>
            If <see cref="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.Batch"/> is true, queues the object for processing after all items have been identified. Otherwise, executes this cmdlet's action immediately. </summary> <param name="obj">The object to process.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.ExecuteOrQueue(PrtgAPI.IObject,System.String)"> <summary> If <see cref="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.Batch"/> is true, queues the object for processing after all items have been identified. Otherwise, executes this cmdlet's action immediately. 
            </summary>
            <param name="obj">The object to process.</param>
            <param name="progressMessage">The progress message to display.</param>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.ExecuteQueueOperation(PrtgAPI.IObject,System.String)">
            <summary>
            Queues an object for execution after all objects have been identified.
            </summary>
            <param name="obj">The object to queue.</param>
            <param name="progressMessage">The progress message to display.</param>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.ExecuteMultiOperation(System.Action,System.String,System.Boolean)">
            <summary>
            Executes this cmdlet's action on all queued objects. </summary> <param name="action">The action to execute.</param> <param name="progressMessage">The progress message to display.</param> <param name="complete">Whether progress should be completed after calling this method.<para/> If the queued objects are to be split over several method calls, this value should only be true on the final call.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.EndProcessingEx"> <summary> Provides an enhanced one-time, postprocessing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PerformSingleOperation"> <summary> Invokes this cmdlet's action against the current object in the pipeline.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PerformMultiOperation(System.Int32[])">
            <summary>
            Invokes this cmdlet's action against all queued items from the pipeline. </summary> <param name="ids">The Object IDs of all queued items.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.WritePassThru"> <summary> Writes the current <see cref="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PassThruObject"/> to the pipeline if <see cref="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PassThru"/> is specified. </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PassThruObjects"> <summary> The objects that should be output from the cmdlet. </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.CurrentMultiPassThru"> <summary> Stores the last object that was output from the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.WriteMultiPassThru"> <summary> Writes all objects stored in <see cref="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PassThruObjects"/> if <see cref="P:PrtgAPI.PowerShell.Base.IPrtgPassThruCmdlet.PassThru"/> is specified. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.ShouldPostProcess"> <summary> Whether this cmdlet will execute its post processing operation. </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgMultiOperationCmdlet.PassThruObject"> <summary> Returns the current object that should be passed through this cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1"> <summary> Base class for all cmdlets that return a list of objects. </summary> <typeparam name="T">The type of objects that will be retrieved.</typeparam> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.GetRecords"> <summary> Retrieves all records of a specified type from a PRTG Server. Implementors can call different methods of a <see cref="T:PrtgAPI.PrtgClient"/> based on the type of object they wish to retrieve. </summary> <returns>A list of records relevant to the caller.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.GetResultsWithVariableProgress(System.Func{System.Collections.Generic.IEnumerable{`0}})"> <summary> Retrieve results from a PRTG server while displaying progress for objects that have been piped from a variable. </summary> <param name="getResults">The function to execute to retrieve this cmdlet's results.</param>
            <returns>A collection of objects returned from a PRTG Server. that match the specified search criteria.</returns>
        </member>
        <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.GetResultsWithProgress(System.Func{System.Collections.Generic.IEnumerable{`0}})">
            <summary>
            Retrieve results from a PRTG server while displaying progress for objects that have been piped between cmdlets.
            </summary>
            <param name="getResults">The function to execute to retrieve this cmdlet's results.</param> <returns>A collection of objects returned from a PRTG Server. that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.DisplayFirstInChainMessage"> <summary> Display the initial progress message for the first cmdlet in the chain.<para/> Returns an integer so that overridden instances of this method may support progress scenarios such as streaming (where a "detecting total number of items" message is displayed before requesting the object totals. </summary> <returns>-1. Override this method in a derived class to optionally return the total number of objects that will be retrieved.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.GetCount(System.Collections.Generic.IEnumerable{`0},System.Int32@)"> <summary> Retrieves the number of elements returned from a request. Generally the collection of records should internally be a <see cref="T:System.Collections.Generic.List`1"/>.<para/> For scenarios where this is not the case, this method can be overridden in derived classes. </summary> <param name="records">The collection of records to count.Should be a <see cref="T:System.Collections.Generic.List`1"/></param> <param name="count">The count of records to be returned from this method.</param> <returns></returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.FilterResponseRecords(System.Collections.Generic.IEnumerable{`0},System.String,System.Func{`0,System.String})"> <summary> Filter a response with a wildcard expression on a specified property. </summary> <param name="records">The records to filter.</param> <param name="pattern">The wildcard expression to filter with.</param> <param name="getProperty">A function that yields the property to filter by.</param> <returns>A list of records that match the specified filter.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgObjectCmdlet`1.FilterResponseRecordsByWildcardArray(System.String[],System.Func{`0,System.String},System.Collections.Generic.IEnumerable{`0})"> <summary> Filter records returned from PRTG by one or more wildcards. </summary> <param name="arr">The array of wildcards to filter against.</param> <param name="getProperty">A function that yields the property to filter by.</param> <param name="records">The records to filter.</param> <returns>A collection of filtered records.</returns> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgOperationCmdlet"> <summary> Base class for all cmdlets that perform actions or manipulate objects in PRTG. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgOperationCmdlet.ExecuteOperation(System.Action,System.String,System.Boolean)"> <summary> Executes an action and displays a progress message (if required). </summary> <param name="action">The action to be performed.</param> <param name="progressMessage">The body of the progress message to display.</param> <param name="complete">Whether to allow <see cref="T:PrtgAPI.PowerShell.Base.PrtgOperationCmdlet"/> to dynamically determine whether progress should be completed</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgOperationCmdlet.ParseValueIfRequired(System.Reflection.PropertyInfo,System.Object)"> <summary> Parse a value into its expected type. Requires the target <paramref name="property"/> contain a Parse method. </summary> <param name="property">The property the value applies to.</param> <param name="value">The value to apply to the property.</param> <returns>If the target property type contains a Parse method which did not throw upon being called, the parsed value. Otherwise, the original value.</returns> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgPassThruCmdlet"> <summary> Base class for generic operation cmdlets capable of passing their inputs out to the pipeline. </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgPassThruCmdlet.PassThru"> <summary> <para type="description">Specifies whether to return the original <see cref="T:PrtgAPI.IObject"/> that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPassThruCmdlet.WritePassThru"> <summary> Writes the current <see cref="P:PrtgAPI.PowerShell.Base.PrtgPassThruCmdlet.PassThruObject"/> to the pipeline if <see cref="P:PrtgAPI.PowerShell.Base.PrtgPassThruCmdlet.PassThru"/> is specified. </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgPassThruCmdlet.PassThruObject"> <summary> Returns the current object that should be passed through this cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet"> <summary> Base class for all cmdlets that perform operations after all pipeline elements have been processed. </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.PostProcess"> <summary> Whether this cmdlet will execute its post processing operation. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.ExecuteOperation(System.Action,System.String,System.Boolean)"> <summary> Executes an action and displays a progress message (if required). </summary> <param name="action">The action to be performed.</param> <param name="progressMessage">The body of the progress message to display.</param> <param name="complete">Whether to allow <see cref="T:PrtgAPI.PowerShell.Base.PrtgOperationCmdlet"/> to dynamically determine whether progress should be completed</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.DisplayPostProcessProgress(System.String,System.String,System.Int32,System.Nullable{System.Int32},System.String,System.Boolean)"> <summary> Display a progress message during an <see cref="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.EndProcessing"/> block. </summary> <param name="activity">The title of the progress message to display.</param> <param name="progressMessage">The body of the progress message to display.</param> <param name="completedPercent">The percentage this process has been completed.</param> <param name="secondsRemaining">The number of seconds remaining in this operation. If this value is null, seconds remaining will not be displayed.</param> <param name="currentOperation">The current operation that is being performed. If this value is null, the current operation will not be displayed.</param> <param name="complete">Whether or not the progress should be completed after displaying.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.CompletePostProcessProgress(System.Boolean)"> <summary> Completes a progress record created in the <see cref="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.EndProcessing"/> block. </summary> <param name="complete"></param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.ShouldPostProcess"> <summary> Implements the cmdlet specific algorithm for <see cref="P:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.PostProcess"/>. </summary> <returns>If this cmdlet should execute its post processing operation, true. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.EndProcessing"> <summary> Provides a one-time, postprocessing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgPostProcessCmdlet.EndProcessingEx"> <summary> Provides an enhanced one-time, postprocessing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet"> <summary> Base class for all cmdlets that display progress while reading and writing to the pipeline. </summary> </member> <member name="F:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.TypeDescription"> <summary> Description of the object type output by this cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet"/> class. </summary> <param name="typeDescription"></param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.WriteObjectWithProgress(System.Func{System.Object})"> <summary> Write a basic PSObject to the pipeline while displaying an appropriate progress message. </summary> <param name="obj">The object to write to the pipeline.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.UpdatePreviousAndCurrentVariableProgressOperations(System.Boolean,System.String)"> <summary> Updates the previous and current progress records for the current input object for scenarios in which a variable was piped into one or more cmdlets. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.PreUpdateProgress"> <summary> Updates progress before any of the objects in the current cmdlet are written to the pipeline. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.DuringUpdateProgress(System.Object)"> <summary> Updates progress as each object in the current cmdlet is written to the pipeline. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.PostUpdateProgress"> <summary> Updates progress after all objects in the current cmdlet have been written to the pipeline. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.SetObjectSearchProgress(PrtgAPI.PowerShell.Progress.ProcessingOperation)"> <summary> Set the progress activity, initial description and total number of records (where applicable) for the current cmdlet. </summary> <param name="operation">The type of processing that is being performed by this cmdlet.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.WriteList``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Writes a list to the output pipeline. </summary> <param name="sendToPipeline">The list that will be output to the pipeline.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgProgressCmdlet.First``1(System.Func{System.Collections.Generic.List{``0}},System.String,System.String)"> <summary> Create a sequence of progress tasks for executing a process containing two or more operations. </summary> <typeparam name="TResult">The type of object returned by the first operation.</typeparam> <param name="func">The first operation to execute.</param> <param name="typeDescription">The type description use for the progress.</param> <param name="operationDescription">The progress description to use for the first operation.</param> <returns></returns> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2"> <summary> Base class for all cmdlets that return advanced objects found in tables (sensors, devices, probes, logs, etc). </summary> <typeparam name="TObject">The type of objects that will be retrieved.</typeparam> <typeparam name="TParam">The type of parameters to use to retrieve objects</typeparam> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.Name"> <summary> <para type="description">Filter the response to objects with a certain name. Can include wildcards.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.Filter"> <summary> <para type="description">Filter the response to objects that match one or more criteria.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.Count"> <summary> <para type="description">Maximum number of results to return. Note: when this parameter is specified wildcard filters such as <see cref="P:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.Name"/> may behave unexpectedly when wildcard characters are not used and records are being filtered by an additional property other than <see cref="F:PrtgAPI.Property.ParentId"/>.</para> </summary> </member> <member name="F:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.content"> <summary> The type of content this cmdlet will retrieve. </summary> </member> <member name="F:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.dynamicParameters"> <summary> The search filters that were specified via dynamic parameters. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.#ctor(PrtgAPI.Content,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2"/> class. </summary> <param name="content">The type of content this cmdlet will retrieve.</param> <param name="shouldStream">Whether this cmdlet should have streaming enabled.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.BeginProcessingEx"> <summary> Provides an enhanced one-time, preprocessing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.GetRecords"> <summary> Retrieves all records of a specified type from a PRTG Server using the types default parameters. This method should never be executed. </summary> <returns></returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.GetAdditionalRecords(`1)"> <summary> Retrieves additional records not included in the initial request. </summary> <param name="parameters">The parameters that were used to perform the initial request.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.DisplayFirstInChainMessage"> <summary> Display the initial progress message for the first cmdlet in a chain.<para/> If the cmdlet is streaming results, will display "detecting total number of items" and return the total number of items that will be retrieved. </summary> <returns>If the cmdlet is streaming, the total number of objects that will be retrieved. Otherwise, -1.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.GetCount(System.Collections.Generic.IEnumerable{`0},System.Int32@)"> <summary> Retrieves the number of elements returned from a request that may or may not have been streamed. </summary> <param name="records">The records to count. This collection will only be enumerated if results were not retrieved via streaming (indicating the collection is not yet complete)</param> <param name="count">If results were streamed, the total number of objects initially reported by the server. Otherwise, will be-1.</param> <returns></returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.ProcessWildcardArrayFilter(PrtgAPI.Property,System.String[])"> <summary> Add an array of filter values that may contain wildcard values. </summary> <param name="property">The property to filter for.</param> <param name="arr">The array of wildcards.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.AddNameOrObjectFilter``1(PrtgAPI.Property,PrtgAPI.PowerShell.NameOrObject{``0},System.Func{``0,System.Object},System.Nullable{PrtgAPI.Property})"> <summary> Add a filter for the value contained in a <see cref="T:PrtgAPI.PowerShell.NameOrObject`1"/> object. </summary> <typeparam name="T">The type of <see cref="T:PrtgAPI.PrtgObject"/> possibly contained in <paramref name="obj"/>.</typeparam> <param name="objectProperty">The property to filter on if <paramref name="obj"/> contains an object.</param> <param name="obj">The object that either contains a <see cref="T:PrtgAPI.PrtgObject"/> or a wildcard expression specifying the object name to filter by.</param> <param name="getValue">A function that retrieves the property to filter by from the <see cref="T:PrtgAPI.PrtgObject"/> when <paramref name="obj"/> contains an object.</param> <param name="nameProperty">The property to filter by when <paramref name="obj"/> does not contain an object. If this value is null, <paramref name="objectProperty"/> will be used as the filter property.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.AddPipelineFilter(PrtgAPI.Property,System.Object,System.Boolean)"> <summary> Adds a filter for a concrete value that came in from the pipeline (such as an Id) </summary> <param name="property">The property to filter on.</param> <param name="value">The value to filter for.</param> <param name="invalidatesStream">Whether adding this filter precludes the current cmdlet from streaming.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.AddWildcardFilter(PrtgAPI.Property,System.String)"> <summary> Add a filter for a value that may contain wildcard characters. </summary> <param name="property">The property to filter on.</param> <param name="value">The value to filter for.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.CreateParameters"> <summary> Creates a new parameter object capable of being passed to <see cref="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.GetObjects(`1)"/> </summary> <returns>The default set of parameters.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{`0})"> <summary> Process any post retrieval filters specific to the current cmdlet. </summary> <param name="records">The records to filter.</param> <returns>The filtered records.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.FilterResponseRecordsByNameOrObjectName``1(PrtgAPI.PowerShell.NameOrObject{``0},System.Func{`0,System.String},System.Collections.Generic.IEnumerable{`0})"> <summary> Filter a response with a wildcard expression contained in a <see cref="T:PrtgAPI.PowerShell.NameOrObject`1"/> value. </summary> <typeparam name="T">The type of <see cref="T:PrtgAPI.PrtgObject"/> possibly contained in <paramref name="obj"/>.</typeparam> <param name="obj">The object that possibly contains a wildcard expression.</param> <param name="getProperty">A function that retrieves the property to filter by from each record.</param> <param name="records">The records to filter.</param> <returns>If <paramref name="obj"/> contains a wildcard expression, the filtered collection. Otherwise, the original collection.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableCmdlet`2.SortReturnedRecords(System.Collections.Generic.IEnumerable{`0})"> <summary> Specifies how the records returned from this cmdlet should be sorted. By default, no sorting is performed. </summary> <param name="records">The records to sort.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the sorted collection.</returns> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgTableFilterCmdlet`2"> <summary> Base class for all cmdlets that return advanced objects found in tables that support enhanced record filters (sensors, devices, probes, etc). </summary> <typeparam name="TObject">The type of objects that will be retrieved.</typeparam> <typeparam name="TParam">The type of parameters to use to retrieve objects</typeparam> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableFilterCmdlet`2.Id"> <summary> <para type="description">Retrieve an object with a specified ID.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableFilterCmdlet`2.#ctor(PrtgAPI.Content,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgTableFilterCmdlet`2"/> class. </summary> <param name="content">The type of content this cmdlet will retrieve.</param> <param name="shouldStream">Whether this cmdlet should have streaming enabled.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableFilterCmdlet`2.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgTableRecurseCmdlet`2"> <summary> Base class for all table cmdlets that require recursion to retrieve all records from a parent object. </summary> <typeparam name="TObject">The type of objects that will be retrieved.</typeparam> <typeparam name="TParam">The type of parameters to use to retrieve objects</typeparam> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableRecurseCmdlet`2.Recurse"> <summary> <para type="description">When piping from a <see cref="T:PrtgAPI.Group"/>, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableRecurseCmdlet`2.#ctor(PrtgAPI.Content,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgTableRecurseCmdlet`2"/> class. </summary> <param name="content">The type of content this cmdlet will retrieve.</param> <param name="shouldStream">Whether this cmdlet should have streaming enabled.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableRecurseCmdlet`2.GetAdditionalGroupRecords(PrtgAPI.Group,System.Func{PrtgAPI.Group,System.Int32},`1)"> <summary> Traverses the child groups of a specified parent group retrieving additional objects of a specified type until all objects of that type have been found. </summary> <param name="group">The parent group to traverse.</param> <param name="objsOfTypeInGroup">A function used to retrieve the total number of objects a group and its children contain.</param> <param name="parameters">The parameters that were used to execute the initial request on the parent.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableRecurseCmdlet`2.SortReturnedRecords(System.Collections.Generic.IEnumerable{`0})"> <summary> Specifies how the records returned from this cmdlet should be sorted. By default, sensors, devices and groups are sorted by their <see cref="P:PrtgAPI.ISensorOrDeviceOrGroup.Probe"/> property. </summary> <param name="records">The records to sort.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the sorted collection.</returns> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2"> <summary> Base class for all cmdlets that return advanced objects found in tables that support enhanced record filters and are capable of filtering by <see cref="P:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2.Status"/> (sensors, devices, probes, etc). </summary> <typeparam name="TObject">The type of objects that will be retrieved.</typeparam> <typeparam name="TParam">The type of parameters to use to retrieve objects</typeparam> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2.Status"> <summary> <para type="description">Only retrieve objects that match a specific status.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2.#ctor(PrtgAPI.Content,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2"/> class. </summary> <param name="content">The type of content this cmdlet will retrieve.</param> <param name="shouldStream">Whether this cmdlet should have streaming enabled.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{`0})"> <summary> Process any post retrieval filters specific to the current cmdlet. </summary> <param name="records">The records to filter.</param> <returns>The filtered records.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableStatusCmdlet`2.SortReturnedRecords(System.Collections.Generic.IEnumerable{`0})"> <summary> Specifies how the records returned from this cmdlet should be sorted. </summary> <param name="records">The records to sort.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the sorted collection.</returns> </member> <member name="T:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2"> <summary> Base class for all cmdlets that return advanced objects found in tables that support enhanced record filters and are capable of filtering by tags (sensors, devices, probes, etc). </summary> <typeparam name="TObject">The type of objects that will be retrieved.</typeparam> <typeparam name="TParam">The type of parameters to use to retrieve objects</typeparam> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2.Tags"> <summary> <para type="description">Filter the response to objects with all specified tags. Can include wildcards.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2.Tag"> <summary> <para type="description">Filter the response to objects with one of several tags. Can include wildcards.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2.#ctor(PrtgAPI.Content,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2"/> class. </summary> <param name="content">The type of content this cmdlet will retrieve.</param> <param name="shouldStream">Whether this cmdlet should have streaming enabled.</param> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{`0})"> <summary> Process any post retrieval filters specific to the current cmdlet. </summary> <param name="records">The records to filter.</param> <returns>The filtered records.</returns> </member> <member name="M:PrtgAPI.PowerShell.Base.PrtgTableTagCmdlet`2.GetDynamicParameters"> <summary> Retrieves an object that defines the dynamic parameters of this cmdlet. </summary> <returns>An object that defines the dynamic parameters of this cmdlet.</returns> </member> <member name="P:PrtgAPI.PowerShell.Base.StreamableCmdletProvider`3.ForceStream"> <summary> Indicates that current cmdlet should stream, regardless of whether it determines this is required. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GoPrtgCmdlet"> <summary> Base class for all cmdlets that provide GoPrtg functionality. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetChannel"> <summary> <para type="synopsis">Retrieves all channels of a sensor.</para> <para type="description">The Get-Channel cmdlet retrieves all channels beloninging to a PRTG Sensor.</para> <para type="description">Get-Channel uses APIs unsupported by Paessler to retrieve advanced channel settings (limits, thresholds, etc). For each channel a separate request must be made in order to retrieve advanced channel details, in addition to a separate single request that retrieves general information for all channels. As such, in order to retrieve information on n channels, n+1 requests must be made. Keep this in mind when piping sensors with a large number of channels, or piping a large number of sensors.</para> <para type="description">If a name is specified, Get-Channel filters the results to those that match the name expression. Due to limitations of the PRTG API, Get-Channel filters its results post-request. If the specified sensor is read only for the active PRTG user, certain channel properties will not be displayed.</para> <para type="description">Get-Channel does not include the Downtime channel present on all sensors (Channel ID -4) as this sensor does not contain a value in table view. In addition, due to limitations of the PRTG API any channels configured with the setting "Hide from Tables" will not be returned by Get-Channel</para> <example> <code>C:\> Get-Sensor -Tags wmicpuloadsensor | Get-Channel</code> <para>Get all channels from all Windows CPU Load sensors.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Tags wmimemorysensor | Get-Channel Avail*</code> <para>Get all channels whose names start with "Avail" from all Windows Memory sensors.</para> <para/> </example> <example> <code>C:\> Get-Channel -SensorId 2001</code> <para>Get all channels from the sensor with ID 2001</para> </example> <para type="link">Get-Sensor</para> <para type="link">Set-ChannelProperty</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetChannel.Sensor"> <summary> <para type="description">The Sensor to retrieve channels for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetChannel.SensorId"> <summary> <para type="description">The ID of the Sensor to retrieve channels for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetChannel.Name"> <summary> <para type="description">Filter the channels retrieved to only those that match a specific name.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetChannel.Id"> <summary> <para type="description">Filter the channels retrieved to only those that match a specific ID.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetChannel.GetRecords"> <summary> Retrieves a list of channels from a PRTG Server. </summary> <returns>A list of channels.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetDevice"> <summary> <para type="synopsis">Retrieves devices from a PRTG Server.</para> <para type="description">The Get-Device cmdlet retrieves devices from a PRTG Server. Devices hold sensors used to monitor a particular system. Get-Device provides a variety of methods of filtering the devices requested from PRTG, including by device name, ID and tags, as well as parent probe/group. Multiple filters can be used in conjunction to futher limit the number of results returned. Device properties that do not contain explicitly defined parameters on Get-Device can be specified as dynamic parameters, allowing one or more values to be specified of the specified type. All string parameters support the use of wildcards.</para> <para type="description">For scenarios in which you wish to exert finer grained control over search filters, a custom <see cref="T:PrtgAPI.SearchFilter"/> object can be created by specifying the field name, condition and value to filter upon. For information on properties that can be filtered upon, see New-SearchFilter.</para> <para type="description">Get-Device provides two parameter sets for filtering objects by tags. When filtering for devices that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for devices containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</para> <para type="description">When requesting devices belonging to a specified group, PRTG will not return any objects that may be present under further child groups of the parent group. To work around this, by default Get-Device will automatically recurse child groups if it detects the initial device request did not return all items (as evidenced by the parent group's TotalDevices property.
            If you do not wish Get-Device to recurse child groups, this behavior can be overridden by specifying -Recurse:$false.</para>
            
            <para type="description">The <see cref="T:PrtgAPI.Device"/> objects returned from Get-Device can be piped to a variety of other cmdlets for further processing, including Get-Sensor,
            wherein the ID of each device will be used to filter for its parent sensors.</para>
            
            <example>
                <code>C:\> Get-Device dc-1</code>
                <para>Get all devices named "dc-1" (case insensitive)</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Device *exch*</code>
                <para>Get all devices whose name contains "exch" (case insensitive)</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Device -Id 2000</code>
                <para>Get the device with ID 2000</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe contoso | Get-Device</code>
                <para>Get all devices from the probe named "contoso"</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Device -Tag C_OS_Win,exch</code>
                <para>Get all devices that have the tag "C_OS_Win" or "exch"</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Device -Tags ny,C_OS_Win</code>
                <para>Get all Windows servers in New York</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Device -Count 1</code>
                <para>Get only 1 device from PRTG.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Device -Location "*new york*"</code>
                <para>Get all devices whose location contains "new york" using a dynamic parameter.</para>
                <para/>
            </example>
            <example>
                <code>C:\> flt location contains "new york" | Get-Device</code>
                <para>Get all devices whose location contains "new york" using a SearchFilter.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Group -Id 2001 | Get-Device -Recurse:$false</code>
                <para>Get all devices directly under the specified group, ignoring all child groups.</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Get-Group</para>
            <para type="link">Get-Probe</para>
            <para type="link">New-SearchFilter</para>
            <para type="link">Add-Device</para> 
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetDevice.Group">
            <summary>
            <para type="description">The group to retrieve devices for.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetDevice.Probe">
            <summary>
            <para type="description">The probe to retrieve devices for.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetDevice.Host">
            <summary>
            <para type="description">Filter the response to devices with a certain HostName/IP Address. Can include wildcards.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDevice.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetDevice"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDevice.GetAdditionalRecords(PrtgAPI.Parameters.DeviceParameters)">
            <summary>
            Retrieves additional records not included in the initial request.
            </summary>
            <param name="parameters">The parameters that were used to perform the initial request.</param>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDevice.ProcessAdditionalParameters">
            <summary>
            Processes additional parameters specific to the current cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDevice.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{PrtgAPI.Device})">
            <summary>
            Process any post retrieval filters specific to the current cmdlet.
            </summary>
            <param name="records">The records to filter.</param>
            <returns>The filtered records.</returns>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDevice.CreateParameters">
            <summary>
            Creates a new parameter object to be used for retrieving devices from a PRTG Server.
            </summary>
            <returns>The default set of parameters.</returns>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate">
            <summary>
            <para type="synopsis">Retrieves all auto-discovery templates supported by a PRTG Server.</para>
            
            <para type="description">The Get-DeviceTemplate cmdlet retrieves all device templates supported by a specified object, allowing
            you to limit the scope of an auto-discovery operation when creating a new device to a specified set of device types. If no
            -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate.Device"/> is specified, by default Get-DeviceTemplate will retrieve device templates supported by the Core Probe Device
            (Object ID: 40). Practically speaking, all devices should support all device templates; as such, there should generally be no need
            to specify an object.</para>
            
            <para type="description">Results returned by Get-DeviceTemplate can be filtered by specifying one or more expressions to the
            -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate.Name"/> parameter. Device template results will be filtered to those that contain a specified expression anywhere
            in their Name or Value properties.</para>
            
            <example>
                <code>C:\> $params = New-DeviceParameters dc-1</code>
                <para>C:\> $params.AutoDiscoveryMode = "AutomaticTemplate"</para>
                <para>C:\> $params.DeviceTemplates = Get-DeviceTemplate *wmi*</para>
                <para>C:\> Get-Probe contoso | Add-Device $params</para>
                <para>Create a new device named "dc-1" that performs an auto-discovery for WMI sensors only.</para>
            </example>
            
            <para type="link">New-SensorParameters</para>
            <para type="link">Add-Device</para>
            
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate.Device">
            <summary>
            <para type="description">The object to retrieve device templates from. If no object is specified, PrtgAPI will retrieve all templates supported by the Core Probe Device (ID 40)</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate.Name">
            <summary>
            <para type="description">Filters results to those whose name contains the specified expression.</para> 
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetDeviceTemplate.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetGroup">
            <summary>
            <para type="synopsis">Retrieves groups from a PRTG Server.</para>
            
            <para type="description">The Get-Group cmdlet retrieves groups from a PRTG Server. Groups allow you to organize devices and other groups together.
            In addition, the root node of PRTG containing all probes in the system is marked as a group. Get-Group provides a variety of methods of
            filtering the groups requested from PRTG, including by group name, ID and tags, as well as by parent probe/group. Multiple filters can be
            used in conjunction to further limit the number of results returned. Group properties that do not contain explicitly defined
            parameters on Get-Group can be specified as dynamic parameters, allowing one or more values to be specified of the specified type. All string parameters
            support the use of wildcards.</para>
            
            <para type="description">For scenarios in which you wish to exert finer grained control over search filters,
            a custom <see cref="T:PrtgAPI.SearchFilter"/> object can be created by specifying the field name, condition and value to filter upon.
            For more information on properties that can be filtered upon, see New-SearchFilter.</para>
            
            <para type="description">Get-Group provides two parameter sets for filtering objects by tags. When filtering for groups
            that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands.
            For scenarios in which you wish to filter for groups containing ALL specified tags, the -Tags
            parameter can be used, performing a logical AND between all specified operands.</para>
            
            <para type="description">When requesting groups belonging to a specified group, PRTG will not return any objects that may
            be present under further child groups of the parent group (i.e. grandchildren). To work around this, by default Get-Groups will automatically recurse
            child groups if it detects the initial group request did not return all items (as evidenced by the group's TotalGroups property. If you do not wish Get-Group to recurse child groups, this behavior can be overridden by specifying -Recurse:$false.</para> <para type="description">The <see cref="P:PrtgAPI.PowerShell.Cmdlets.GetGroup.Group"/> objects returned from Get-Group can be piped to a variety of other cmdlets for further processing, including Get-Group, Get-Device and Get-Sensor, where the ID or name of the group will be used to filter for child objects of the specified type.</para> <example> <code>C:\> Get-Group Servers</code> <para>Get all groups named "Servers" (case insensitive)</para> <para/> </example> <example> <code>C:\> Get-Group *windows*</code> <para>Get all groups whose name contains "windows" (case insensitive)</para> <para/> </example> <example> <code>C:\> Get-Group -Id 2005</code> <para>Get the group with ID 2005</para> <para/> </example> <example> <code>C:\> Get-Probe contoso | Get-Group</code> <para>Get all groups under the probe named "contoso"</para> <para/> </example> <example> <code>C:\> Get-Group -Tag ny,ca</code> <para>Get all devices that have the tag "ny" or "ca"</para> <para/> </example> <example> <code>C:\> Get-Group -Tags ny,south</code> <para>Get all groups in South New York</para> <para/> </example> <example> <code>C:\> Get-Group -ParentId 3045</code> <para>Get all groups directly under the object with ID 3045 using a dynamic parameter.</para> <para/> </example> <example> <code>C:\> flt parentid eq 3045 | Get-Group</code> <para>Get all groups directly under the object with ID 3045 using a SearchFilter.</para> <para/> </example> <example> <code>C:\> Get-Group -Count 1</code> <para>Get only 1 group from PRTG.</para> <para/> </example> <example> <code>C:\> Get-Group -Id 2001 | Get-Group -Recurse:$false</code> <para>Get all groups directly under the group with ID 2001, ignoring all grandchildren.</para> </example> <para type="link">Get-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-Probe</para> <para type="link">New-SearchFilter</para> <para type="link">Add-Group</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetGroup.Group"> <summary> <para type="description">The parent group to retrieve groups for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetGroup.Probe"> <summary> <para type="description">The probe to retrieve groups for.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetGroup.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetGroup"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetGroup.GetAdditionalRecords(PrtgAPI.Parameters.GroupParameters)"> <summary> Retrieves additional records not included in the initial request. </summary> <param name="parameters">The parameters that were used to perform the initial request.</param> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetGroup.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetGroup.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{PrtgAPI.Group})"> <summary> Process any post retrieval filters specific to the current cmdlet. </summary> <param name="records">The records to filter.</param> <returns>The filtered records.</returns> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetGroup.CreateParameters"> <summary> Creates a new parameter object to be used for retrieving groups from a PRTG Server. </summary> <returns>The default set of parameters.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetModificationHistory"> <summary> <para type="synopsis">Retrieves the setting/state modification history of a PRTG Object.</para> <para type="description">The Get-ModificationHistory cmdlet retrieves all setting/state modifications of an object. The Get-ModificationHistory cmdlet corresponds with the "History" tab of objects in the PRTG UI.</para> <example> <code>C:\> Get-Sensor -Id 1001 | Get-ModificationHistory</code> <para>Retrieve all modification events for the sensor with ID 1001</para> </example> <para type="link">Get-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-Group</para> <para type="link">Get-Probe</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetModificationHistory.Object"> <summary> <para type="description">The object to retrieve historical data for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetModificationHistory.Id"> <summary> <para type="description">The ID of the object to retrieve historical data for.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetModificationHistory.GetRecords"> <summary> Retrieves a list of modification events from a PRTG Server. </summary> <returns>A list of all modification events for the specified object.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetNotificationAction"> <summary> <para type="synopsis">Retrieves all Notification Actions from a PRTG Server.</para> <para type="description">The Get-NotificationAction retrieves notification actions present on a PRTG Server. Notification actions can be triggered under various circumstances via notification triggers. For more information on notification triggers, see Get-NotificationTrigger.</para> <para type="synopsis">Get-NotificationAction supports filtering returned actions by a number of parameters, including by -Name, -Id, -Tags or a custom SearchFilter. When filtering by tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for notification actions containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</para> <para type="description">Get-NotificationAction provides two parameter sets for filtering objects by tags. When filtering for notification actions that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for notification actions containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</para> <para type="description">If you are currently signed in as a read only user, you may not be able to see all notification actions or notification action properties.</para> <example> <code>C:\> Get-NotificationTrigger</code> <para>Get all notification actions.</para> <para/> </example> <example> <code>C:\> Get-NotificationTrigger *pager*</code> <para>Get all notification actions whose name contains "pager"</para> <para/> </example> <example> <code>C:\> Get-NotificationTrigger -Id 301,302</code> <para>Get the notification actions with IDs 301 and 302.</para> <para/> </example> <example> <code>C:\> Get-NotificationTrigger -Tags PagerDuty</code> <para>Get all notification actions tagged with "PagerDuty"</para> <para/> </example> <para type="link">Get-NotificationTrigger</para> <para type="link">New-TriggerParameters</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetNotificationAction.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetNotificationAction"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetNotificationAction.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetNotificationAction.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{PrtgAPI.NotificationAction})"> <summary> Process any post retrieval filters specific to the current cmdlet. </summary> <param name="records">The records to filter.</param> <returns>The filtered records.</returns> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetNotificationAction.CreateParameters"> <summary> Creates a new parameter object to be used for retrieving notification actions from a PRTG Server. </summary> <returns>The default set of parameters.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger"> <summary> <para type="synopsis">Retrieves notification triggers from a PRTG Server.</para> <para type="description">The Get-NotificationTrigger cmdlet retrieves notification triggers that are defined on a PRTG Object as well as the types of triggers an object supports. Notification triggers define conditions that when met by a sensor or one of its channels, should result in the firing of a notification action. When notification triggers are defined on a device, group, or probe, the triggers are inherited by all nodes under the object. Individual objects can choose to block inheritance of notification triggers, preventing those triggers from trickling down.</para> <para type="description">When looking at notification triggers defined on a single object, Get-NotificationTrigger can be invoked with no arguments. When looking at notification triggers across multiple objects, it is often useful to filter out notification triggers inherited from a parent object via the -Inherited parameter.</para> <para type="description"><see cref="T:PrtgAPI.NotificationTrigger"/> objects returned from Get-NotificationTrigger can be passed to Edit-NotificationTriggerProperty or New-NotificationTriggerParameters, to allow cloning or editing the trigger's properties.</para>
            <para type="description">Notification trigger types that are supported by a specified object can be determined using the -Types parameter.
            While there is no restriction on the types of triggers assignable to container-like objects (including devices, groups and probes)
            each sensor can only be assigned specific types based on the types of channels it contains. When adding a new trigger,
            Add-NotificationTrigger will automatically validate whether the specified TriggerParameters are assignable to the target object.
            If the new trigger's type is incompatible with the target object, PrtgAPI will throw an exception alerting you to this error.</para> <example> <code>C:\> Get-Probe | Get-NotificationTrigger</code> <para>Get all notification triggers defined on all probes</para> <para/> </example> <example> <code>C:\> Get-Device | Get-NotificationTrigger *pager* -Inherited $false</code> <para>Get all notification triggers from all devices whose OnNotificationAction action name contains "pager" in the name and are not inherited from any parent objects.</para> <para/> </example> <example> <code>C:\> Get-Probe -Id 2001 | Get-NotificationTrigger -Type State</code> <para>Get all State notification triggers from the sensor with ID 2001</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 1001 | Get-NotificationTrigger -Types</code> <para>Get all notification trigger types supported by the object with ID 1001.</para> </example> <para type="link">Get-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-Group</para> <para type="link">Get-Probe</para> <para type="link">Add-NotificationTrigger</para> <para type="link">New-NotificationTriggerParameters</para> <para type="link">Set-NotificationTrigger</para> <para type="link">Edit-NotificationTriggerProperty</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.Object"> <summary> <para type="description">The object to retrieve notification triggers for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.OnNotificationAction"> <summary> <para type="description">Filter the response to objects with a certain OnNotificationAction. Can include wildcards.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.Type"> <summary> <para type="description">Filter the response to objects of a certain type.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.Types"> <summary> <para type="description">List all notification trigger types compatible with the specified object.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.Inherited"> <summary> <para type="description">Indicates whether to include inherited triggers in the response.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetNotificationTrigger.GetRecords"> <summary> Retrieves all notification triggers from a PRTG Server. </summary> <returns>A list of all notification triggers.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetObject"> <summary> <para type="synopsis">Retrieves objects from a PRTG Server.</para> <para type="description">The Get-Object cmdlet retrieves objects from a PRTG Server. Get-Object is capable of retrieving any object with a unique identifier within the PRTG object hierarchy, including internal system nodes.</para> <para type="description">By default, any objects returned by the Get-Object cmdlet are returned in their raw <see cref="T:PrtgAPI.PrtgObject"/> state. For objects that are natively supported by PrtgAPI's type system, these objects can be transformed into their "true" forms by specifying
            the -Resolve parameter. When specified, Get-Object will group objects of a similar type up together to re-retrieve them via as few
            API calls as possible. As objects must effectively be retrieved twice, care should be taken when attempting to resolve a large number of objects.</para>
            
            <para type="description">Objects returned by Get-Object can be limited those of a particular <see cref="T:PrtgAPI.ObjectType"/> by specifying the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObject.Type"/>
            parameter. When filtering by sensors, the underlying raw type name must be specified (e.g. "ping", "wmivolume"). If the generic
            object type <see cref="F:PrtgAPI.ObjectType.Sensor"/> is specified, Get-Object will refrain from filtering by type server side,
            such that the complete type of each object may be inspected client side.</para>
            
            <example>
                <code>C:\> Get-Object</code>
                <para>Retrieve all uniquely identifiable objects.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Object -Id 810</code>
                <para>Retrieve the object with ID 810 (Web Server Options).</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Object *report*</code>
                <para>Retrieve all objects whose name contains "report".</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Object -Type Device,System</code>
                <para>Retrieve all Device and System objects.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Object -Type wmivolume -Resolve</code>
                <para>Get all WMI Volume sensor objects and resolve them to objects of type <see cref="T:PrtgAPI.Sensor"/>.</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Get-Device</para>
            <para type="link">Get-Group</para>
            <para type="link">Get-Probe</para>
            <para type="link">Get-NotificationAction</para>
            <para type="link">Get-PrtgSchedule</para>
            <para type="link">Get-ObjectProperty</para>
            <para type="link">Set-ObjectProperty</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObject.Resolve">
            <summary>
            <para type="description">Specifies that returned objects should be resolved to their most derived object types (<see cref="T:PrtgAPI.Sensor"/>, <see cref="T:PrtgAPI.Device"/>, <see cref="T:PrtgAPI.Probe"/>, etc.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObject.Type">
            <summary>
            <para type="description">Filter results to those of a specified <see cref="T:PrtgAPI.ObjectType"/>.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObject.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetObject"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObject.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{PrtgAPI.PrtgObject})">
            <summary>
            Process any post retrieval filters specific to the current cmdlet.
            </summary>
            <param name="records">The records to filter.</param>
            <returns>The filtered records.</returns>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObject.ProcessAdditionalParameters">
            <summary>
            Processes additional parameters specific to the current cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObject.CreateParameters">
            <summary>
            Creates a new parameter object to be used for retrieving generic objects from a PRTG Server.
            </summary>
            <returns>The default set of parameters.</returns>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetObjectLog">
            <summary>
            <para type="synopsis">Retrieves object logs from a PRTG Server.</para>
            
            <para type="description">The Get-ObjectLog cmdlet retrieves event logs from a PRTG Server. If no object is specified,
            Get-ObjectLog will retrieve results from the Root PRTG Group (ID: 0). Logs are ordered from newest to oldest. When retrieving logs
            from an object, all logs on child objects are also included. By default, PRTG only stores 30 days worth of logs.</para> 
            
            <para type="description">If no date range or count is specified, by default Get-ObjectLog will retrieve all logs defined on
            the specified object for the last 7 days unless the specified object is the root group (ID: 0) or a probe, in which cause
            only logs that have occurred today will be retrieved.</para>
            
            <para type="description">When specifying a date range, well known constants as well as manual start and end
            times can be specified. When specifying a date and time, the meaning of -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/> and -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/>
            are dependent upon the order with which the logs are being output. When logs are ordered from newest to oldest
            -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/> refers to the time closest to now, while -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/> represents the time furthest
            away from now. When logs are ordered from oldest to newest (i.e. when -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/> is specified) -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/>
            represents the point in time logs furthest away from now logs should be retrieved from going into the future.</para>
            
            <para type="descrption">If a -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/> is specified without specifying an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/>,
            Get-ObjectLog will default to retrieving logs for the past 7 days prior to the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/>, unless the
            specified object is the root group (ID: 0) or a probe, in which case Get-ObjectLog will default to retrieving logs
            for the past 24 hours from the start time. When specifying well known constants, logs are retrieved from the specified
            point in time until the current time.</para>
            
            <para type="description">Logs can be streamed continuously from a PRTG Object by specifying the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/> parameter.
            When -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/> is specified (also aliased as -Tail) PrtgAPI will continuously poll PRTG for new logs according
            to a specified -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Interval"/>, outputting them to the console as they arrive in order from oldest to newest. If
            no -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Interval"/> is specified, by default Get-ObjectLog will poll once per second. A -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/>
            can optionally be specified, specifying the initial point in time PrtgAPI should retrieve logs from. When -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/>
            is specified -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/> will have no effect. Specifying an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/> in conjunction with -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/>
            will cause a warning to be emitted to the warning stream specifying that the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/> parameter will be ignored.
            </para>
            
            <para type="description">Logs can be filtered to those of one or more event types by specifying the -Status parameter.
            Logs can also be filtered according to their event name, however note that name based filtering of Get-ObjectLog is
            performed client side, not server side. As such, specifying a -Name in conjunction with -Count will not work. This can be
            cirvumvented using Select-Object with the -First parameter instead.</para>
            
            <para type="description">Note that while Get-ObjectLog considers the "start time" as being the point in time closest to now
            and the "end time" as the point in time furthest away from now when logs are ordered from newest to oldest, PRTG's underlying API actually defines these in the opposite way. Since logs are ordered from newest to oldest however, PrtgAPI flips these definitions as to prevent any confusion. Keep this in mind in the event the -Verbose parameter is specified, as the start and end times will appear to be switched. When -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/> is specified the meaning of -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/> and -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"/> are flipped to match their meaningings in the underlying API so that logs can continuously be retrieved.</para> <example> <code>C:\> Get-ObjectLog</code> <para>Retrieve all logs from the root group (ID: 0) from today.</para> <para/> </example> <example> <code>C:\> Get-ObjectLog -Count 4000</code> <para>Retrieve the last 4000 logs from the root group.</para> <para/> </example> <example> <code>C:\> Get-Device dc-1 | Get-ObjectLog</code> <para>Retrieve all logs on device "dc-1" for the last week.</para> <para/> </example> <example> <code>C:\> Get-ObjectLog -Start (Get-Date).AddDays(-3)</code> <para>Retrieve all logs from the root node from 3 and 4 days ago.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 2460 | Get-ObjectLog -EndDate (Get-Date).AddDays(-4)</code> <para>Retrieve all logs from the sensor with ID 2460 between now and 4 days ago.</para> <para/> </example> <example> <code>C:\> Get-Probe *contoso* | Get-ObjectLog -Since LastWeek</code> <para>Retrieve all logs from all probes whose name contains "contoso" between now and last week.</para> <para/> </example> <example> <code>C:\> Get-ObjectLog -Status Disconnected -Count 3</code> <para>Retrieve the last 3 times a probe disconnected.</para> <para/> </example> <example> <code>C:\> Get-Device exch-1 | Get-ObjectLog ping | select -First 4</code> <para>Retrieve the last 4 events that occurred to the sensor named "ping" on the device named "exch-1".</para> <para/> </example> <example> <code>C:\> Get-ObjectLog -Id 1001 -EndDate $null</code> <para>Retrieve all logs from the object with ID 1001.</para> <para/> </example> <example> <code>C:\> Get-ObjectLog -Status Connected -Wait</code> <para>Continuously poll PRTG for new Probe Connected events, requesting once every second.</para> </example> <para type="link">Get-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-Group</para> <para type="link">Get-Probe</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Object"> <summary> <para type="description">Object to retrieve logs for. If no object is specified, defaults to the root object (group ID: 0)</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Id"> <summary> <para type="description">ID of the object to retrieve logs for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"> <summary> <para type="description">Start time to retrieve logs from. If no value is specified, defaults to the current date and time.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.EndDate"> <summary> <para type="description">End time to retrieve logs until. If no value is specified, defaults to 7 prior from the <see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.StartDate"/>.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Period"> <summary> <para type="description">Time period to retrieve logs from. If no value is specified, retrieves logs from 7 days ago to the current date and time.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Status"> <summary> <para type="description">Only retrieve objects that match a specific status.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"> <summary> <para type="description">Indicates Get-ObjectLog should continuously retrieve new records from PRTG according to a specified polling -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Interval"/>.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Interval"> <summary> <para type="description">Interval with which Get-ObjectLog should poll for new records when using -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.Wait"/>.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetObjectLog"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObjectLog.CreateParameters"> <summary> Creates a new parameter object to be used for retrieving logs from a PRTG Server. </summary> <returns>The default set of parameters.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty"> <summary> <para type="synopsis">Retrieves properties and settings of a PRTG Object.</para> <para type="description">The Get-ObjectProperty cmdlet retrieves properties and settings of a PRTG Object, as found on the "Settings" tab within the PRTG UI. Properties retrieved by Get-ObjectProperty may not necessarily be active depending on the value of their dependent property (e.g. the Interval will not take effect if InheritInterval is $true).</para> <para type="description">Get-ObjectProperty supports retrieving type safe and raw values. These values can be retrieved as part of larger property collections (by specifying no parameters or -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Raw"/>) or as individual values (-<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Property"/> or -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.RawProperty"/>). When retrieving property collections Get-ObjectProperty will fail to retrieve the expected properties if the current user has read only access to the specified object. To retrieve properties from read only objects a specific -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Property"/> or -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.RawProperty"/> must be specified.</para> <para type="description">Properties that are not currently supported by Get-ObjectProperty can be retrieved by specifying the -RawProperty parameter. Raw property names can be found by inspecting the "name" attribute of the &lt;input/&gt; tag under the object's Settings page in the PRTG UI. Unlike Set-ObjectProperty, raw property names do not need to include
            their trailing underscores when used with Get-ObjectProperty. If a trailing underscore is used, PrtgAPI will automatically truncate it.
            When retrieving raw properties please note that PRTG does not support the retrieval of Inheritance related properties via raw lookups.</para>
            
            <para type="description">By default raw properties will display their values in their "raw" format, i.e. their literal string
            value or numeric representation (such as 0 or 1 for an "option" setting). If -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Text"/> is specified when retrieving an
            "option" property, the property's "label" in the PRTG UI will be returned instead of its numeric representation.</para> <para type="description">Properties can be retrieved by piping in a <see cref="T:PrtgAPI.PrtgObject"/> or by specifying a single object ID. When retrieving by -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Id"/> individual properties of sub objects (such as Channels and Notification Triggers) can be retrieved by specifying a -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.SubId"/> as well as -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.RawSubType"/>. As sub objects typically include all properties known to them on their regular objects, retrieval of individual sub object properties is generally not necessary.</para> <para type="descrption">When retrieving individual properties, Get-ObjectProperty will throw a <see cref="T:PrtgAPI.PrtgRequestException"/> if the specified property is not present on the target object. If the PRTG Server is not in English however, Get-ObjectProperty will return "(Property not found)" in the PRTG Server's language when a property cannot be found.</para>
            
            <para type="description">In order to provide type safety when modifying properties, all properties supported by Set-ObjectProperty
            perform a lookup against their corresponding property in Get-ObjectProperty. If the type of value passed to Set-ObjectProperty
            does not match the property's expected type, PrtgAPI will attempt to parse the value into the expected type. For more information, see Set-ObjectProperty.</para> <example> <code>C:\> Get-Device -Id 1001 | Get-ObjectProperty</code> <para>Retrieve all properties and settings of the device with ID 1001</para> <para/> </example> <example> <code>C:\> Get-Device -Id 1001 | Get-ObjectProperty -RawProperty name_</code> <para>Retrieve the value of raw property "name"</para> <para/> </example> <example> <code>C:\> Get-Device -Id 1001 | Get-ObjectProperty -RawProperty query_ -Text</code> <para>Retrieve the "query" field of a REST Custom sensor.</para> <para/> </example> <example> <code>C:\> Get-ObjectProperty -Id 1001 -Raw</code> <para>Retrieve all raw properties of the object with ID 1001</para> <para/> </example> <example> <code>C:\> Get-ObjectProperty -Id 1001 -SubId 1 -RawSubType channel -RawProperty limitmaxerror</code> <para>Retrieve the upper error limit property of the channel with ID 1 on the object with ID 1001</para> </example> <para type="link">Set-ObjectProperty</para> <para type="link">Get-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-Group</para> <para type="link">Get-Probe</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Object"> <summary> <para type="description">The object to retrieve properties for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Id"> <summary> <para type="description">The ID of the object to retrieve properties for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.SubId"> <summary> <para type="description">The sub ID of the object to retrieve properties for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.RawSubType"> <summary> <para type="description">The type of the sub object to retrieve properties for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Property"> <summary> <para type="description">The name of one or more properties to retrieve. Note: PRTG does not support retrieving inheritance settings in via direct API calls.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.RawProperty"> <summary> <para type="description">The raw name of one or more properties to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' &lt;input/&gt; tag on the Settings page of PRTG.<para/>
            Note: PRTG does not support retrieving raw section inheritance settings.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Raw">
            <summary>
            <para type="description">Retrieve all raw properties from the target object.</para>
            <para type="description">Note: objects may have additional properties that cannot be retrieved via this method.
            For more information, see Get-Help about_ObjectProperty</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.Text">
            <summary>
            <para type="description">Specifies whether to display option properties using their label names instead their internal numeric values.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetObjectProperty.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetProbe">
            <summary>
            <para type="synopsis">Retrieves probes from a PRTG Server.</para>
            </summary>
            
            <para type="description">The Get-Probe cmdlet retrieves probes from a PRTG Server. Probes represent sites where the 
            PRTG Probe Service has been installed. Each PRTG Server has a single Core Probe. Additional probes may be installed
            with the PRTG Remote Probe installer for monitoring of remote sites.</para>
            
            <para type="description">Get-Probe provides a variety of methods of filtering the probes requested from PRTG,
            including by probe name, probe status (Connected / Disconnected), ID and tags.
            Multiple filters can be used in conjunction to further limit the number of results returned. Probe properties that do
            not contain explicitly defined parameters on Get-Group can be specified as dynamic parameters, allowing one or more
            values to be specified of the specified type. All string parameters support the use of wildcards.</para>
            
            <para type="description">For scenarios in which you wish to exert finer grained control over search filters,
            a custom <see cref="T:PrtgAPI.SearchFilter"/> object can be created by specifying the field name, condition and value
            to filter upon. For information on properties that can be filtered upon, see New-SearchFilter</para>
            
            <para type="description">Get-Probe provides two parameter sets for filtering objects by tags. When filtering for probes
            that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands.
            For scenarios in which you wish to filter for probes containing ALL specified tags, the -Tags
            parameter can be used, performing a logical AND between all specified operands.</para>
            
            <para type="description">The <see cref="T:PrtgAPI.Probe"/> objects returned from Get-Probe can be piped to a variety of other cmdlets for
            further processing, including Get-Group, Get-Device and Get-Sensor, where the ID or name of the probe will be used to filter
            for child objects of the specified type.</para>
            
            <example>
                <code>C:\> Get-Probe contoso</code>
                <para>Get all probes named "contoso" (case insensitive)</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe *office*</code>
                <para>Get all probes whose name contains "office" (case insensitive)</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe -Id 1</code>
                <para>Get the probe with ID 1</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe -TotalGroups 10</code>
                <para>Get all probes that contain exactly 10 child groups using dynamic parameters.</para>
                <para/>
            </example>
            <example>
                <code>C:\> flt totalgroups eq 10 | Get-Probe</code>
                <para>Get all probes that contain exactly 10 child groups using a SearchFilter.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe -Count 1</code>
                <para>Get only 1 probe from PRTG.</para>
                <para/>
            </example>
            <example>
                <code>C:\> flt totalsens greaterthan 100 | Get-Probe</code>
                <para>Get all probes that contain more than 100 sensors.</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Get-Device</para>
            <para type="link">Get-Group</para>
            <para type="link">New-SearchFilter</para>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetProbe.ProbeStatus">
            <summary>
            <para type="description">Only retrieve probes that match a specified connection state.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetProbe.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetProbe"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetProbe.ProcessAdditionalParameters">
            <summary>
            Processes additional parameters specific to the current cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetProbe.CreateParameters">
            <summary>
            Creates a new parameter object to be used for retrieving probes from a PRTG Server.
            </summary>
            <returns>The default set of parameters.</returns>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetPrtgSchedule">
            <summary>
            <para type="synopsis">Retrieves all Monitoring Schedules from a PRTG Server.</para>
            
            <para type="description">The Get-PrtgSchedule cmdlet retrieves all monitoring schedules present on a PRTG Server.
            Schedules define the timeframes during which monitoring on sensors can be active. When sensors are deactivated
            due to schedules, their statuses will automatically be set to <see cref="F:PrtgAPI.Status.PausedBySchedule"/>.</para>
            
            <example>
                <code>C:\> Get-PrtgSchedule</code>
                <para>Get all monitoring schedules.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-PrtgSchedule *night*</code>
                <para>Get all monitoring schedules whose name contains "night"</para>
                <para/>
            </example>
            <example>
                <code>C:\> $schedule = Get-PrtgSchedule -Id 621</code>
                <para>C:\> Get-Sensor -Id 2024 | Set-ObjectProperty -RawParameters @{</para>
                <para>C:\>     scheduledependency = 0</para>
                <para>C:\>     schedule_ = $schedule</para>
                <para>C:\> }</para>
                <para>Apply the schedule with ID 621 to the sensor with ID 2024</para>
            </example>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetPrtgSchedule.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetPrtgSchedule"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetPrtgSchedule.CreateParameters">
            <summary>
            Creates a new parameter object to be used for retrieving schedules from a PRTG Server.
            </summary>
            <returns>The default set of parameters.</returns>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetPrtgStatus">
            <summary>
            <para type="synopsis">Retrieves configuration, status and version details from a PRTG Server.</para>
            
            <para type="description">The Get-PrtgStatus cmdlet retrieves status details from a PRTG Server, including
            details regarding sensor types, license and version details, cluster config and user access rights.</para>
            
            <example>
                <code>C:\> Get-PrtgStatus</code>
                <para>Retrieve the current system status.</para>
            </example>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetPrtgStatus.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSensor">
            <summary>
            <para type="synopsis">Retrieves sensors from a PRTG Server.</para>
            
            <para type="description">The Get-Sensor cmdlet retrieves sensors from a PRTG Server. Sensors are the fundamental unit of monitoring
            in PRTG, and the most populous type of object in the system by far. Get-Sensor provides a variety of methods of filtering the sensors
            requested from PRTG, including by sensor name, ID, status and tags as well as parent probe/group/device. Multiple filters
            can be used in conjunction to further limit the number of results returned. Sensor properties that do not contain explicitly defined
            parameters on Get-Sensor can be specified as dynamic parameters, allowing one or more values to be specified of the specified type. All string parameters
            support the use of wildcards.</para>
            
            <para type="description">For scenarios in which you wish to exert finer grained control over search filters,
            a custom <see cref="T:PrtgAPI.SearchFilter"/> object can be created specifying the field name, condition and value to filter upon. For information
            on properties that can be filtered on, see New-SearchFilter. When searching for Sensor Factory objects, please note that these
            objects do not respond to server side filters by "type". To filter for Sensor Factory sensors, filter by the tag "factorysensor".</para>
            
            <para type="description">When invoked with no arguments, Get-Sensor will query the number of sensors present on your PRTG Server.
            If PrtgAPI detects the number is about a specified threshold, PrtgAPI will split the request up into several smaller requests
            which will each be invoked one after the other. Results will then be "streamed" to the pipeline as each smaller request completes. A progress
            bar will also be visible up the top indicating the total number of sensors retrieved/remaining.</para>
            
            <para type="description">Get-Sensor provides two parameter sets for filtering objects by tags. When filtering for sensors
            that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands.
            For scenarios in which you wish to filter for sensors containing ALL specified tags, the -Tags
            parameter can be used, performing a logical AND between all specified operands.</para>
            
            <para type="description">When requesting sensors belonging to a specified group, PRTG will not return any objects that may
            be present under further child groups of the parent group. To work around this, by default Get-Sensor will automatically recurse
            child groups if it detects the initial sensor request did not return all items (as evidenced by the parent group's TotalSensors property. If you do not wish Get-Sensor to recurse child groups, this behavior can be overridden by specifying -Recurse:$false.</para> <para type="description">The <see cref="T:PrtgAPI.Sensor"/> objects returned from Get-Sensor can be piped to a variety of other cmdlets for further processing, including Get-Channel, wherein the ID of the sensor will be used to acquire its underlying channels.</para> <example> <code>C:\> Get-Sensor Ping</code> <para>Get all sensors named "Ping" (case insensitive)</para> <para/> </example> <example> <code>C:\> Get-Sensor *cpu*</code> <para>Get all sensors whose name contains "cpu" (case insensitive)</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 2001</code> <para>Get the sensor with ID 2001</para> <para/> </example> <example> <code>C:\> Get-Sensor -Status Down</code> <para>Get all sensors in a "Down" status.</para> <para/> </example> <example> <code>C:\> Get-Device *fw* | Get-Sensor Ping</code> <para>Get all sensors named "Ping" (case insensitive) from all devices whose name contains "fw"</para> <para/> </example> <example> <code>C:\> Get-Sensor -Count 1</code> <para>Get only 1 sensor from PRTG.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Tag wmicpu*,wmimem*</code> <para>Get all WMI CPU Load and WMI Memory sensors.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Tags ny,wmicpu*</code> <para>Get all WMI CPU Load sensors from all New York devices.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Type *snmp*</code> <para>Get all SNMP sensors using a dynamic parameter.</para> <para/> </example> <example> <code>C:\> flt type contains snmp | Get-Sensor</code> <para>Get all SNMP sensors using a SearchFilter.</para> <para/> </example> <example> <code>C:\> Get-Group -Id 2001 | Get-Sensor -Recurse:$false</code> <para>Get all sensors from devices directly under the specified group, ignoring all child groups.</para> </example> <para type="link">Get-Device</para> <para type="link">Get-Group</para> <para type="link">Get-Probe</para> <para type="link">Get-Channel</para> <para type="link">New-SearchFilter</para> <para type="link">Add-Sensor</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensor.Device"> <summary> <para type="description">The parent <see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensor.Device"/> to retrieve sensors for, or a wildcard expression specifying the names of the devices to retrieve sensors for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensor.Probe"> <summary> <para type="description">The <see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensor.Probe"/> to retrieve sensors for, or a wildcard expression specifying the names of the probes to retrieve sensors for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensor.Group"> <summary> <para type="description">The group to retrieve sensors for.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensor.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetSensor"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensor.GetAdditionalRecords(PrtgAPI.Parameters.SensorParameters)"> <summary> Retrieves additional records not included in the initial request. </summary> <param name="parameters">The parameters that were used to perform the initial request.</param> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensor.ProcessAdditionalParameters"> <summary> Processes additional parameters specific to the current cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensor.PostProcessAdditionalFilters(System.Collections.Generic.IEnumerable{PrtgAPI.Sensor})"> <summary> Process any post retrieval filters specific to the current cmdlet. </summary> <param name="records">The records to filter.</param> <returns>The filtered records.</returns> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensor.CreateParameters"> <summary> Creates a new parameter object to be used for retrieving sensors from a PRTG Server. </summary> <returns>The default set of parameters.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSensorFactorySource"> <summary> <para type="synopsis">Retrieves source sensors and channels from a PRTG Sensor Factory.</para> <para type="description">The Get-SensorFactorySource cmdlet retrieves the source sensors and channels of PRTG Sensor Factory objects. By default Get-SensorFactorySource retrieves the sensors of the channel definition. If the -Channels parameter is specified, the cmdlet will retrieve the source channels instead. If a sensor is passed to Get-SensorFactorySource that isn't a Sensor Factory, an ParameterBindingException will be thrown.</para>
            
            <example>
                <code>C:\> flt type eq "sensor factory" | Get-Sensor -Count 1 | Get-SensorFactorySource</code>
                <para>Retrieve all source sensors of a single sensor factory sensor</para>
                <para/>
            </example>
            <example>
                <code>C:\> flt type eq "sensor factory" | Get-Sensor -Count 1 | Get-SensorFactorySource -Channels</code>
                <para>Retrieve all source channels of a single sensor factory sensor</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">New-SearchFilter</para>
            
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorFactorySource.Sensor">
            <summary>
            <para type="description">The sensor factory sensor to retrieve source sensors or channels of.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorFactorySource.Channels">
            <summary>
            <para type="description">Whether to retrieve the source <see cref="T:PrtgAPI.Channel"/> objects of a sensor factory, instead of the source sensors.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorFactorySource.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetSensorFactorySource"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorFactorySource.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory">
            <summary>
            <para type="synopsis">Retrieves historic data values for a PRTG Sensor.</para>
            
            <para type="description">The Get-SensorHistory cmdlet retrieves historic data values for all channels of a PRTG Sensor within a specified time period.
            By default, values are returned according to the scanning interval defined on the sensor (e.g. values every 60 seconds). Using the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average"/> parameter,
            values can be averaged together to provide a higher level view of a larger time span. Any number of seconds can be specified as the <see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average"/>,
            however note that depending on the interval of the sensor, certain time spans may result in blank values within the sensor results.</para>
            
            <para type="description">Historic data values can be retrieved over any time period via the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.StartDate"/>  and -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.EndDate"/>
            parameters. If these values are not specified, records will be returned from between now and 60 minutes ago.
            If PRTG finds it does not have enough monitoring data to return for the specified time span, an exception will be thrown. To work around this,
            you can request date for a larger time frame and then potentially filter the data with the Where-Object and Select-Object cmdlets.</para>
            
            <para type="description">When an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.EndDate"/> is specified, Get-SensorHistory will split the sensor history query into a series of smaller
            requests, emitting results to the pipeline as they arrive. If the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Count"/> parameter is speciifed, and -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.EndDate"/> is not
            specified, Get-SensorHistory will automatically adjust the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.EndDate"/> such that the specified number of records can be retrieved, based
            on the sensor's Interval or the specified -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average" />. If an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.EndDate"/> has been specified, the number of records returned may be limited by the number of records available in the specified time period.</para> <para type="description">Due to limitations of the PRTG API, Get-SensorHistory cannot display both downtime and channel value lookups at the same time. Value lookups can only be displayed when an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average"/> of 0 is specified, while downtime can only be displayed when a specific average has been specified. By default, if no average is specified Get-SensorHistory will use an average of 0 to enable the display of value lookups. If the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Downtime"/> parameter is specified and no -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average"/> is specified, Get-SensorHistory will use the Interval property of the sensor to specify the true average.</para> <para type="description">PrtgAPI will automatically display all numeric channel values as numbers, with the unit of the channel displayed in brackets next to the channel header (e.g. "Total(%)"). These units are for display purposes only, and so can be ignored when attempting to extract certain columns from the sensor history result.</para> <para type="description">Note that while Get-SensorHistory considers the "start time" as being the point in time closest to now and the "end time" as the point in time furthest away from now, PRTG's underlying API actually defines these in the opposite way.
            Since records are ordered from newest to oldest however, PrtgAPI flips these definitions as to prevent any confusion. Keep this
            in mind in the event the -Verbose parameter is specified, as the start and end times will appear to be switched.</para>
            
            <example>
                <code>C:\> Get-Sensor -Id 1001 | Get-SensorHistory</code>
                <para>Get historical values for all channels on the sensor with ID 1001 over the past 24 hours, using the sensor's default interval.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 1001 | Get-SensorHistory -Average 300</code> <para>Get historical values for all channels on the sensor with ID 1001 over the past 24 hours, averaging values in 5 minute intervals.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 1001 | Get-SensorHistory -StartDate (Get-Date).AddDays(-1) -EndDate (Get-Date).AddDays(-3)</code> <para>Get historical values for all channels on the sensor with ID 1001 starting three days ago and ending yesterday.</para> <para/> </example> <example> <code>C:\> Get-Sensor -Tags wmicpu* -count 1 | Get-SensorHistory | select Total</code> <para>Get historical values for all channels on a single WMI CPU Load sensor, selecting the "Total" channel (visually displayed as "Total(%)"</para> <para/> </example> <example> <code>C:\> Get-Sensor -Tags wmicpu* -count 1 | where Total -gt 90</code> <para>Get historical values for all channels on a single WMI CPU Load sensor where the Total channel's value was greater than 90.</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Select-Object</para>
            <para type="link">Where-Object</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Sensor">
            <summary>
            <para type="description">Sensor to retrieve historic data for.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Id">
            <summary>
            <para type="description">ID of the sensor to retrieve historic data for.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.StartDate">
            <summary>
            <para type="description">Start time to retrieve history from. If no value is specified, defaults to 24 hours ago.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.EndDate">
            <summary>
            <para type="description">End time to retrieve history to. If no value is specified, defaults to the current date and time.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average">
            <summary>
            <para type="description">Time span (in seconds) to average results over. For example, a value of 300 will show the average value every 5 minutes.
            If a value of 0 is used, PRTG will include value lookup labels in historical results. If a value other than 0 is used, PRTG will include the Downtime
            channel in results.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Downtime">
            <summary>
            <para type="description">Specifies that the Downtime channel should be included in query results in lieu of value lookup labels.
            If this parameter is specified and <see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Average"/> is not specified, the Interval of the sensor will be used to determine the average.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.Count">
            <summary>
            <para type="description">Limits results to the specified number of items within the specified time period.</para> 
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorHistory.GetRecords">
            <summary>
            Retrieves all records of a specified type from a PRTG Server. Implementors can call different methods of a <see cref="T:PrtgAPI.PrtgClient"/> based on the type they wish to retrieve.
            </summary>
            <returns>A list of records relevant to the caller.</returns>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget">
            <summary>
            <para type="synopsis">Retrieves system resources that capable of being monitored or used for monitoring by a new PRTG Sensor.</para>
            
            <para type="description">Get-SensorTarget cmdlet identifies resources that are capable of being used as the target of a new PRTG Sensor.
            The resources identified by Get-SensorTarget are dynamic in nature. When Get-SensorTarget is executed, the PRTG will interrogate
            the PRTG Probe of the specified device in order to identify the resources that are compatible with the target system. For example,
            for creating a new WMI Service sensor, PRTG will request the probe enumerate all of the system services that are installed
            on the target device.</para>
            
            <para type="description">For convenience, Get-SensorTarget allows specifying a -Name used to filter the returned results.
            Typically, items returned by Get-SensorTarget should be sent straight to a call to New-SensorParameters, however if you do
            not wish to perform any other processing on the results returned by this cmdlet you may automatically generate a set of
            parameters for the specified sensor type by specifying the -Parameters (alias: -Params) parameter. When creating sensor parameters
            with the -Params parameter, the default sensor name of the specified sensor type will be used.</para>
            
            <para type="description">Sensor types not supported by PrtgAPI can still be interrogated by Get-SensorTarget via the -RawType parameter.
            Raw sensor type names can be found by inspecting the Id column of items output from the Get-SensorType cmdlet. When operating on raw types,
            by default Get-SensorTarget will attempt to guess the name of the data table within PRTG the sensor targets are stored in. If PRTG detects
            more than one data table exists, an <see cref="T:System.ArgumentException"/> will be thrown listing the names of all of the available tables. The name
            of the table to use can then be specified to the -Table parameter.</para>
            
            <para type="description">Sensor targets identified for raw types are represented as a "generic" sensor target type. Generic sensor targets
            allow accessing both their Name and Value as named properties. Any other properties of the sensor target can be obtained by accessing the
            Properties array of the object. Generic sensor targets capable of being used with any <see cref="T:PrtgAPI.Parameters.NewSensorParameters"/> type, including
            <see cref="T:PrtgAPI.Parameters.RawSensorParameters"/> and <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/>.</para>
            
            <para type="description">While resources returned by Get-SensorTarget are guaranteed to be compatible with the target device,
            there is no restriction preventing such resources from being used on other devices as well. Attempting to create a sensor
            on an incompatible device may succeed, however the sensor will likely enter a <see cref="F:PrtgAPI.Status.Down"/> state upon refreshing,
            similar to what would happen if the sensor were created normally and then the sensor's target was deleted.</para> <example> <code>C:\> $device = Get-Device -Id 1001</code> <para>C:\> $services = $device | Get-SensorTarget WmiService *exchange*</para> <para>C:\> $params = New-SensorParameters WmiService $services</para> <para>C:\> $device | Add-Sensor $params</para> <para>Add all WMI Services whose name contains "Exchange" to the Device with ID 1001</para> <para/> </example> <example> <code>C:\> $device = Get-Device -Id 1001</code> <para>C:\> $params = $device | Get-SensorTarget WmiService *exchange* -Params</para> <para>C:\> $device | Add-Sensor $params</para> <para>Add all WMI Services whose name contains "Exchange" to the Device with ID 1001, creating sensor parameters immediately.</para> <para/> </example> <example> <code>C:\> $targets = Get-Device -Id 1001 | Get-SensorTarget -RawType vmwaredatastoreextern</code> <para>Get all VMware Datastores from the device with ID 1001.</para> <para/> </example> <example> <code>C:\> $targets = Get-Device -Id 1001 | Get-SensorTarget -RawType wmivolume</code> <para>C:\> $targets | foreach { $_.Properties[3] }</para> <para>List the disk type (Local Disk, Compact Disk etc) of all WMI Volume targets.</para> </example> <para type="link">New-SensorParameters</para> <para type="link">Add-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-SensorType</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.Device"> <summary> <para type="description">The device to retrieve sensor targets from. While results returned by Get-SensorTarget are guaranteed to be compatible with the specified device, returned objects may also be compatible with other devices in PRTG.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.Type"> <summary> <para type="description">The type of sensor target to query for. Not all sensor types may require or support target resolution.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.Name"> <summary> <para type="description">An expression used to filter returned results to those with a specified name.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.Parameters"> <summary> <para type="description">When present, specifies that Get-SensorTarget should automatically wrap the returned items up in a set of sensor parameters applicable to the specified sensor type.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.RawType"> <summary> <para type="description">The raw type of sensor target to query for. Types that require additional information before querying (such as Oracle Tablespace) cannot be queried.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.Table"> <summary> <para type="description">The name of the Dropdown List or Checkbox Group the sensor targets belong to. If this value is null, PrtgAPI will attempt to guess the name of the table. If this value cannot be guessed or is not valid, an <see cref="T:System.ArgumentException"/> will be thrown listing all possible values.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.Timeout"> <summary> <para type="description">Duration (in seconds) to wait for sensor targets to resolve.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorTarget.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSensorTotals"> <summary> <para type="synopsis">Retrieves the total number of each type of sensor in the system.</para> <para type="description">The Get-SensorTotals cmdlet retrieves the total number of each type of sensor in a PRTG Server.</para> <example> <code>C:\> Get-SensorTotals</code> <para>Count the number of sensors in the system.</para> </example> <para type="link">Get-Sensor</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorTotals.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSensorType"> <summary> <para type="synopsis">Retrieves all sensor types supported by a PRTG Server.</para> <para type="description">The Get-SensorType cmdlet retrieves all sensor types from PRTG that are supported by a specified object, allowing you to identify the Type Id to be used with other cmdlets (such as Get-SensorTarget and New-SensorParameters). If no -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSensorType.Object"/> is specified, by default Get-SensorType will retrieve sensor types supported by the Core Probe (Object ID: 1). Practically speaking, all objects appear to support all sensor types; as such, there should generally be no need to specify an object.</para> <para type="description">Results returned by Get-SensorType can be filtered by specifying an expression to the -Name parameter. Sensor type results will be filtered to those that contain the specified expression anywhere in either the Id, Name or Description.</para> <example> <code>C:\> Get-SensorType</code> <para>List all sensor types supported by PRTG.</para> <para/> </example> <example> <code>C:\> Get-SensorType *exchange*</code> <para>List all sensor types that contain "exchange" in the Id, Name or Description.</para> <para/> </example> <example> <code>C:\> Get-Device -Id 1001 | Get-SensorType</code> <para>List all sensor types supported by the Device with Id 1001</para> </example> <para type="link">Get-SensorTarget</para> <para type="link">New-SensorParameters</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorType.Object"> <summary> <para type="description">The object to retrieve sensor types from. If no object is specified, PrtgAPI will retrieve all types supported by the Core Probe (ID 1)</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSensorType.Name"> <summary> <para type="description">Filters results to those that contain the specified expression in any field.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSensorType.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo"> <summary> <para type="synopsis">Retrieves system information for a PRTG Device.</para> <para type="description">The Get-SystemInfo cmdlet retrieves system information for a specified device. By default, PRTG will probe devices once every 24 hours for enhanced system information, including hardware, software, process, service and user info. Not all devices may support retrieving system information or may only support specific system information types.</para> <para type="description">Specific system information types can be retrieved by specifying one or more values to the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo.Type"/> parameter. If more than one type is specified, results will be bundled up in a <see cref="T:System.Management.Automation.PSObject"/> containing a property for each information type. If no types are specified, Get-SystemInfo will automatically retrieve information for all known information types.</para> <example> <code>C:\> Get-SystemInfo -Id 1001</code> <para>Retrieve system information from the device with ID 1001.</para> <para/> </example> <example> <code>C:\> Get-Device -Id 1001 | Get-SystemInfo</code> <para>Retrieve system information from a piped in device.</para> <para/> </example> <example> <code>C:\> Get-SystemInfo -ID 1001 hardware,software</code> <para>Retrieve hardware and software information for the device with ID 1001.</para> </example> <para type="link">Get-Device</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo.Device"> <summary> <para type="description">Device to retrieve system information for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo.Id"> <summary> <para type="description">ID of the device to retrieve system information for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo.Type"> <summary> <para type="description">One or more system information types to retrieve. If no types are specified, all System Information types will be retrieved.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.GetSystemInfo.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter"> <summary> <para type="synopsis">Filters results on the PRTG Server to improve performance.</para> <para type="description">The New-SearchFilter cmdlet allows you to filter the results returned by a cmdlet by a custom property. Each object returned from New-SearchFilter defines a single filter rule. Multiple filters can often be passed to compatible cmdlets to filter on multiple values.</para> <para type="description">To view all properties that can be filtered on for on objects, see the SYNTAX or PARAMETERS section of this cmdlet's help page.</para> 
            
            <example>
                <code>C:\> flt parentid eq 1001 | Get-Sensor</code>
                <para>Get all sensors under the object with ID 1001</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Get-Device</para>
            <para type="link">Get-Group</para>
            <para type="link">Get-Probe</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter.Property">
            <summary>
            <para type="description">Object property to filter on.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter.Operator">
            <summary>
            <para type="description">Operator to filter with.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter.Value">
            <summary>
            <para type="description">Value to filter for.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter.Illegal">
            <summary>
            <para type="description">Permits constructing search expressions believed to be incompatible
            with all versions of PRTG.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter.Raw">
            <summary>
            <para type="description">Specifies to avoid performing formatting the serialized filter value based on
            the required format of the specified filter property.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSearchFilter.ProcessRecord">
            <summary>
            Performs record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition">
            <summary>
            <para type="synopsis">Creates a channel definition for use in a PRTG Sensor Factory.</para>
            
            <para type="description">The New-SensorFactoryDefinition cmdlet automatically defines a series of channel defitions for use in a Sensor Factory sensor.</para>
            
            <para type="description">New-SensorFactoryDefinition can be used to create both individual channel definitions for a collection of sensors, as well as
            aggregation sensors, using a complex formula that operates on all of the sensors in a set.</para>
            
            <para type="description">When specifying an Expression, the default expression and current sensor can be accessed via the $expr and $_ automatic variables.
            Unless you wish to modify the sensor ID or channel ID to be used for a specific sensor, it is generally recommended to avoid recalculating
            the base channel definition and use the automatic $expr variable, which is defined as "channel(sensorId, channelID)" where sensorID is the ID of the current
            sensor, and channelID is the value passed to -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.ChannelId"/>.</para>
            
            <para type="description">When specifying an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Aggregator"/>, the running accumulator, default expression and current sensor can be accessed via the $acc, $expr and $_
            automatic variables respectively. Based on whether not the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Expression"/> parameter is specified, $expr will either contain the custom or the
            default expression.</para>
            
            <para type="description">While it is possible to override the expression evaluated in $expr in the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Aggregator"/> by recalculating the channel definition
            (via the $_ automatic variable), if the channel ID specified in the new definition is different from the channel ID specified in the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.ChannelId"/> parameter,
            the first channel definition in the resulting output will have a different channel ID than all the rest. This is due to the fact when the Aggregator runs,
            it initially sets the accumulator ($acc) to the expression of the first sensor. As such, if in the Aggregator you change the channel ID, you
            will also need to replace the channel ID of the initial value in the accumulator. Due to the complexity involved in managing this, it is
            recommended to avoid modifying the channel ID in the aggregator, and either set the channel ID in an -Expression or in the -ChannelID.</para>
            
            <para type="description">Both -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Expression"/> and -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Aggregator"/> support the use of Sensor Factory formula functions (channel(), min(), max(), avg() and percent()),
            as well as all boolean and math operators. For more information, see the Sensor Factory documentation in the PRTG Manual.</para>
            
            <para type="description">Horizontal lines can be generated by specifying the position the line should appear at to the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Value"/> parameter. When
            specifying a horizontal line the channel unit the line should apply to should be specified in square brackets at the end of the channel name. It
            does not matter what the ID of any horizontal lines are, as long as they do not conflict with any other channel definitions.</para> 
            
            <para type="description">To automatically copy the output of New-SensorFactoryDefinition to the clipboard, you can pipe the cmdlet to clip.exe.</para>
            
            <example>
                <code>C:\> Get-Sensor -Tags wmicpuloadsensor | New-SensorFactoryDefinition { $_.Device } 0</code>
                <para>Create a channel definition for the "Total" channel (ID: 0) of each WMI CPU Load sensor in the system</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Sensor -Tags wmimemorysensor | New-SensorFactoryDefinition { $_.Device } -Expr { "100 - $expr" } 0</code>
                <para>Create a channel definition for the "Percent Available Memory" channel (ID: 0) of each WMI Memory Free sensor, modifying each channel to show the percent of memory "used" instead of free</para>
                <para/>
            </example>
            <example>
                <code>C:\> $sensors = Get-Sensor -Tags wmicpuloadsensor</code>
                <para>C:\> $sensors | New-SensorFactoryDefinition "Max CPU Load" -Aggregator { "max($expr,$acc)" }</para>
                <para>C:\> $sensors | New-SensorFactoryDefinition { $_.Device } -StartId 2</para>
                <para>Create a channel definition for showing the highest CPU Load of all sensors as well as channel definitions for each individual sensor</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Sensor -Tags wmicpuloadsensor | New-SensorFactoryDefinition { "$($_.Device) [bananas]" } 0</code>
                <para>Create a channel definition for the "Total" channel (ID: 0) displaying all channels with the custom unit "bananas"</para>
                <para/>
            </example>
            <example>
                <code>C:\> New-SensorFactoryDefinition "Line at 40.2 [msec]" -Value 40.2 -StartId 3</code>
                <para>Create a channel definition for a horizontal line against channels that use the "msec" unit using a channel ID of 3.</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Get-Channel</para> 
            <para type="link">https://www.paessler.com/manuals/prtg/sensor_factory_sensor</para> 
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Sensor">
            <summary>
            <para type="description">The sensor to create a channel definition for.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Name">
            <summary>
            <para type="description">An string or an expression that resolves the name to use for a channel definition.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.ChannelId">
            <summary>
            <para type="description">The channel ID to use. If a custom expression is provided, this value can be optionally overridden.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Expression">
            <summary>
            <para type="description">A custom expression to use for defining a channel definition.</para>
            <para type="description">Provides the following automatic variables</para>
            <para type="description">    '$expr' (for the default expression)</para>
            <para type="description">    '$_'    (for the current sensor)</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.StartId">
            <summary>
            <para type="description">The starting channel ID to use for each channel definition. The default value is 1.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Aggregator">
            <summary>
            <para type="description">An aggregator to use for creating a single aggregation channel.</para>
            <para type="description">Provides the fllowing automatic variables:</para>
            <para type="description">    '$acc'  (the running accumulator)</para>
            <para type="description">    '$expr' (for the default expression)</para>
            <para type="description">    '$_'    (the current sensor</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Finalizer">
            <summary>
            <para type="description">A post-processing action to perform on an aggregated expresion before emititing to the pipeline.
            If -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Aggregator"/> is not specified this parameter does nothing.</para>
            <para type="description">Provides the following automatic variables:</para>
            <para type="description">    '$acc' (the accumulated result)</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Value">
            <summary>
            <para type="description">A static value to use for the channel value in place of an -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.Expression"/>.</para> 
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.BeginProcessing">
            <summary>
            Provides a one-time, preprocessing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.ProcessRecord">
            <summary>
            Performs record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSensorFactoryDefinition.EndProcessing">
            <summary>
            Provides a one-time, postprocessing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor">
            <summary>
            <para type="synopsis">Marks a <see cref="F:PrtgAPI.Status.Down"/> sensor as <see cref="F:PrtgAPI.Status.DownAcknowledged"/>.</para>
            
            <para type="description">The Acknowledge-Sensor cmdlet acknowledges a sensor that is currently in a 'Down' state. When a sensor
            is acknowledged, it no longer generates notification triggers and is moved from the 'Down' sensors page to the 'Down (Acknowledged)'
            sensors page.</para> 
            <para type="description">When acknowledging a sensor, you must specify how long to acknowledge the sensor for. If the sensor is still in a down
            state when the acknowledgement period expires, the sensor will return to a Down state. While in a Down (Acknowledged) state
            PRTG will continue refreshing the sensor according to its scanning interval. If at any time the requisite conditions are met
            for the sensor to enter an 'Up' state, the sensor will turn 'Up' and no further action will be required. If an acknowledged
            sensor that has gone Up fails and returns to a Down state, the sensor will need to be re-acknowledged.</para>
            <para type="description">If a sensor is continually flapping, it may be better to pause the sensor rather than acknowledge it.
            For more information on pausing objects, see Pause-Object.</para>
            
            <para type="description">By default, Acknowledge-Sensor will operate in Batch Mode. In Batch Mode, Acknowledge-Sensor
            will not execute a request for each individual object, but will rather store each item in a queue to acknowledge
            all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations
            against a large number of objects.</para>
            
            <para type="description">If the pipeline is cancelled (either due to a cmdlet throwing an exception
            or the user pressing Ctrl-C) before fully completing, Acknowledge-Sensor will not generate a request against PRTG.
            If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved
            by specifying -Batch:$false.</para>
            
            <example>
                <code>C:\> Get-Sensor -Status Down | Acknowledge-Sensor -Duration 60</code>
                <para>Acknowledge all down sensors for the next 60 minutes</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Sensor -Status Down | Acknowledge-Sensor -Until (Get-Date).AddDays(30) -Message "Honestly, CBF"</code>
                <para>Acknowledge all down sensors for the next 30 days with a message explaining the reason the sensor was acknowledged</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Sensor Ping -Status Down | Acknowledge-Sensor -Forever</code>
                <para>Acknowledge all down ping sensors forever (or until they comes back up by themselves)</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Pause-Object</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.Sensor">
            <summary>
            <para type="description">The sensor to acknowledge.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.Message">
            <summary>
            <para type="description">A message to display on the object indicating the reason it is acknowledged.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.Duration">
            <summary>
            <para type="description">The duration to acknowledge the sensor for, in minutes.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.Until">
            <summary>
            <para type="description">The datetime at which the object should become unacknowledged.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.Forever">
            <summary>
            <para type="description">Indicates the object should be acknowledged indefinitely.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.BeginProcessing">
            <summary>
            Provides a one-time, preprocessing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.PerformSingleOperation">
            <summary>
            Invokes this cmdlet's action against the current object in the pipeline. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.PerformMultiOperation(System.Int32[])"> <summary> Invokes this cmdlet's action against all queued items from the pipeline.
            </summary>
            <param name="ids">The Object IDs of all queued items.</param>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.AcknowledgeSensor.PassThruObject">
            <summary>
            Returns the current object that should be passed through this cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.AddDevice">
            <summary>
            <para type="synopsis">Adds a new device to a PRTG Group or Probe.</para>
            
            <para type="description">The Add-Device cmdlet adds a new device to a PRTG Group or Probe. When adding a new
            device, Add-Device supports two methods of specifying the parameters required to create the object. For basic scenarios
            where you wish to inherit all settings from the parent object, the <see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Name"/>, <see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Host"/> and auto-discovery method
            can all be specified as arguments directly to Add-Device. If a -<see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Host"/> is not specified, Add-Device will automatically
            use the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Name"/> as the device's hostname. If -<see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.AutoDiscover"/> is specified, Add-Device will perform an <see cref="F:PrtgAPI.AutoDiscoveryMode.Automatic"/> auto-discovery.</para> <para type="description">For more advanced scenarios where you wish to specify more advanced parameters (such as the Internet Protocol version used to communicate with the device) a <see cref="T:PrtgAPI.Parameters.NewDeviceParameters"/> object can instead be created with the New-DeviceParameters cmdlet. When the parameters object is passed to Add-Device, PrtgAPI will validate that all mandatory parameter fields contain values. If a mandatory field is missing a value, Add-Sensor will throw an <see cref="T:System.InvalidOperationException"/>, listing the field whose value was missing.</para> <para type="description">By default, Add-Device will attempt to resolve the created device to a <see cref="T:PrtgAPI.Device"/> object. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created device by comparing the devices under the parent object before and after the new device is created. While this is generally very reliable, in the event something or someone else creates another new device directly under the target object with the same Name, that object will also be returned in the objects resolved by Add-Device. If you do not wish to resolve the created device, this behavior can be disabled by specifying -Resolve:$false.</para> <example> <code>C:\> Get-Probe contoso | Add-Device dc-1</code> <para>Add a new device named "dc-1" to the Contoso probe, using "dc-1" as its hostname, without performing an automatic auto-discovery.</para> <para/> </example> <example> <code>C:\> Get-Group -Id 2305 | Add-Device exch-1 192.168.0.2 -AutoDiscover</code> <para>Add a device named "exch-1" to the group with ID 2305, using 192.168.0.2 as its IP Address and performing an automatic auto-discovery after the device is created.</para> <para/> </example> <example> <code>C:\> $params = New-DeviceParameters sql-1 "2001:db8::ff00:42:8329"</code> <para>C:\> $params.IPVersion = "IPv6"</para> <para>C:\> Get-Probe contoso | Add-Device $params</para> <para>Add a device named sql-1 using an IPv6 Address to the probe Contoso probe.</para> </example> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Destination"> <summary> <para type="description">The parent object to create an object under.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Name"> <summary> <para type="description">The name to use for the device. If a <see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Host"/> is not specified, this value will be used as the hostname as well.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Host"> <summary> <para type="description">The IPv4 Address/HostName to use for monitoring this device. If this value is not specified, the <see cref="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Name"/> will be used as the hostname.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.AutoDiscover"> <summary> <para type="description">Whether to perform an <see cref="F:PrtgAPI.AutoDiscoveryMode.Automatic"/> auto-discovery on the newly created device.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddDevice.Template"> <summary> <para type="description">One or more wildcards specifying the device templates to used when performing the auto-discovery. If no templates are specified, all templates will be used.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddDevice.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.AddDevice"/> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddDevice.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddDevice.GetObjects(PrtgAPI.SearchFilter[])"> <summary> Resolves the children of the destination object that match the new object's name.
            </summary>
            <param name="filters">An array of search filters used to retrieve all children of the destination with the specified name.</param>
            <returns>All objects under the parent object that match the new object's name.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.AddGroup"> <summary> <para type="synopsis">Adds a new group to a PRTG Group or Probe.</para> <para type="description">The Add-Group cmdlet adds a new group to a a PRTG Group or Probe. When adding a new group, Add-Group supports two methods of specifying the parameters required to create the object. For basic scenarios where you inherit all settings from the parent object, a group can created by passing nothing more than a <see cref="P:PrtgAPI.PowerShell.Cmdlets.AddGroup.Name"/> to Add-Group.</para> <para type="description">For more advanced scenarios where you wish to specify more advanced parameters (such as Tags that will apply to the group) a <see cref="T:PrtgAPI.Parameters.NewGroupParameters"/> object can be instead created with the New-GroupParameters cmdlet. When the parameters object is passed to Add-Device, PrtgAPI will validate that all mandatory parameter fields contain values. If a mandatory field is missing a value, Add-Sensor will throw an <see cref="T:System.InvalidOperationException"/>, listing the field whose value was missing.</para> <para type="description">By default, Add-Group will attempt to resolve the created group to a <see cref="T:PrtgAPI.Group"/> object. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created group by comparing the groups under the parent object before and after the new group is created. While this is generally very reliable, in the event something or someone else creates another new group directly under the target object with the same Name, that object will also be returned in the objects resolved by Add-Group. If you do not wish to resolve the created group, this behavior can be disabled by specifying -Resolve:$false.</para> <example> <code>C:\> Get-Probe contoso | Add-Group Servers</code> <para>Add a new group called "Servers" to the Contoso probe.</para> <para/> </example> <example> <code>C:\> $params = New-GroupParameters Servers</code> <para>C:\> $params.Tags = "awesomeGroup"</para> <para>C:\> Get-Probe contoso | Add-Device $params</para> <para>Add a new group called "Servers" with custom tags to the Contoso probe.</para> </example> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddGroup.Destination"> <summary> <para type="description">The parent object to create an object under.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddGroup.Name"> <summary> <para type="description">The name to use for the group.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddGroup.#ctor"> <summary> <para type="description">Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.AddGroup"/> class.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddGroup.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddGroup.GetObjects(PrtgAPI.SearchFilter[])"> <summary> Resolves the children of the destination object that match the new object's name.
            </summary>
            <param name="filters">An array of search filters used to retrieve all children of the destination with the specified name.</param>
            <returns>All objects under the parent object that match the new object's name.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.AddNotificationTrigger"> <summary> <para type="synopsis">Adds a notification trigger to a PRTG Server.</para> <para type="description">The Add-NotificationTrigger cmdlet adds a new notification trigger to an object in PRTG. When adding a notification trigger, you must first create a <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> object that defines the settings to use in the trigger. <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> can be defined from existing notification triggers or created from scratch. Certain objects do support certain types of notification triggers (e.g. different types of sensors).</para> <para type="description">Attempting to add a notification trigger to an object that does not supported that trigger type will generate an <see cref="T:PrtgAPI.InvalidTriggerTypeException"/>. Notification triggers applied to parent objects that are not supported by their children are simply ignored within PRTG, and do not generate exceptions. For information on viewing the trigger types supported by an object, see Get-NotificationTriggerTypes</para> <para type="description">By default, Add-NotificationTrigger will attempt to resolve the created trigger to a <see cref="T:PrtgAPI.NotificationTrigger"/> object. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created trigger by comparing the triggers on the parent object before and after the new trigger is created. While this is generally very reliable, in the event something or someone else creates another new trigger directly under the target object with the same OnNotificationAction, that object will also be returned in the objects resolved by Add-NotificationTrigger. If you do not wish to resolve the created trigger, this behavior can be disabled by specifying -Resolve:$false.</para> <para type="description">For more information on creating <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> , see New-NotificationTriggerParameters.</para> <example> <code>C:\> Get-Probe | Get-NotificationTrigger | New-TriggerParameters 2001 | Add-Trigger</code> <para>Add all triggers on all probes directly to the object with ID 2001.</para> </example> <para type="link">New-NotificationTriggerParameters</para> <para type="link">Set-NotificationTrigger</para> <para type="link">Edit-NotificationTriggerProperty</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddNotificationTrigger.Parameters"> <summary> <para type="description">The parameters to use to add a <see cref="T:PrtgAPI.NotificationTrigger"/>.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddNotificationTrigger.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.SetNotificationTrigger"> <summary> <para type="synopsis">Modifies a notification trigger on a PRTG Server.</para> <para type="description">The Set-NotificationTrigger cmdlet updates an existing notification trigger defined on an object in PRTG. When editing a notification trigger, you must first create a <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> object that defines the settings you wish to modify. <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> can be created from an existing notification trigger or created from scratch.</para> <para type="description">For more information on creating <see cref="T:PrtgAPI.Parameters.TriggerParameters"/>, see New-NotificationTriggerParameters</para> <para type="description">For information on how to quickly edit a single trigger property, see Edit-NotificationTriggerProperty.</para> <example> <para>C:\> $triggerParams = Get-Probe | Get-Trigger -Type State | New-TriggerParameters</para> <para>C:\> $triggerParams.RepeatInterval = 20</para> <para>C:\> $triggerParams.OffNotificationAction = $null</para> <para>C:\> $triggerParams | Set-NotificationTrigger</para> <code/> <para>Set the repeat interval of the notification to trigger to every 20 minutes, and remove the off notification action. This example assumes there is exactly one probe in the system with exactly one state notification trigger defined on it.</para> </example> <para type="link">New-NotificationTriggerParameters</para> <para type="link">Edit-NotificationTriggerProperty</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.SetNotificationTrigger.Parameters"> <summary> <para type="description">The parameters to use to modify a <see cref="T:PrtgAPI.NotificationTrigger"/>.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.SetNotificationTrigger.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.AddSensor"> <summary> <para type="synopsis">Adds a new sensor to a PRTG Device.</para> <para type="description">The Add-Sensor cmdlet adds a new sensor to a PRTG Device. When adding a new sensor, you must first create a <see cref="T:PrtgAPI.Parameters.NewSensorParameters"/> object that defines the type of sensor to create and the settings to use in the new object.</para> <para type="description">When adding sensor types that are natively supported by PrtgAPI, Add-Sensor will validate that all mandatory parameter fields contain values. If a mandatory field is missing a value, Add-Sensor will throw an <see cref="T:System.InvalidOperationException"/>, listing the field whose value was missing. When adding unsupported sensor types defined in <see cref="T:PrtgAPI.Parameters.RawSensorParameters"/>, Add-Sensor does not perform any parameter validation. As such, it is critical to ensure that all parameter names and values are valid before passing the parameters to the Add-Sensor cmdlet.</para> <para type="description">For parameter types that support specifying multiple SensorTarget objects (such as <see cref="T:PrtgAPI.Parameters.WmiServiceSensorParameters"/>) PRTG can fail to add all sensors properly if the size of a single request is too large (generally 60 items or greater). To prevent this issue from happening, PrtgAPI automatically splits your request into a series of smaller requests, however if you find yourself experiencing issues, this is something to be aware of.</para> <para type="description">By default, Add-Sensor will attempt to resolve the created sensor(s) to one or more <see cref="T:PrtgAPI.Sensor"/> objects. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created group by comparing the sensors under the parent object before and after the new sensor(s) are created. While this is generally very reliable, in the event something or someone else creates another new sensor directly under the target object with the same Name, that object will also be returned in the objects resolved by Add-Sensor. If you do not wish to resolve the created sensor, this behavior can be disabled by specifying -Resolve:$false.</para> <example> <code>C:\> $params = New-SensorParameters ExeXml "Monitor Traffic" "TrafficMonitor.ps1"</code> <para>C:\> Get-Device *fw* | Add-Sensor $params</para> <para>Add an EXE/Script Advanced sensor to all firewall devices, using the script "TrafficMonitor.ps1"</para> <para/> </example> <example> <code>C:\> $raw = @{</code> <para>>> name_ = "my raw sensor"</para> <para>>> tags_ = "xmlexesensor"</para> <para>>> priority_ = 4</para> <para>>> exefile_ = "CustomScript.ps1|CustomScript.ps1||</para> <para>>> exeparams_ = "arg1 arg2 arg3"</para> <para>>> environment_ = 1</para> <para>>> usewindowsauthentication_ = 1</para> <para>>> mutexname_ = "testMutex"</para> <para>>> timeout_ = 70</para> <para>>> writeresult_ = 1</para> <para>>> intervalgroup = 0</para> <para>>> interval_ = "30|30 seconds"</para> <para>>> errorintervalsdown_ = 2</para> <para>>> sensortype = "exexml"</para> <para>>> }</para> <para>C:\> $params = New-SensorParameters $raw</para> <para>C:\> Get-Device dc-1 | Add-Sensor $params</para> <para>Add a new EXE/Script Advanced sensor to the device named dc-1 using its raw parameters</para> </example> <para type="link">Get-Device</para> <para type="link">New-SensorParameters</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.AddSensor.Parameters"> <summary> <para type="description">A set of parameters whose properties describe the type of object to add, with what settings.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddSensor.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.AddSensor"/> class. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddSensor.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.AddSensor.GetObjects(PrtgAPI.SearchFilter[])"> <summary> Resolves the children of the destination object that match the new object's name.
            </summary>
            <param name="filters">An array of search filters used to retrieve all children of the destination with the specified name.</param>
            <returns>All objects under the parent object that match the new object's name.</returns> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.ApproveProbe"> <summary> <para type="synopsis">Approves or denies a new probe for use within PRTG.</para> <para type="description">The Approve-Probe cmdlet approves or denies a newly installed probe for use within PRTG. The Approve-Probe cmdlet can only be used on probes that have not yet been approved for use within PRTG. If Approve-Probe is executed on a probe that has already been approved, a warning will be emitted and the probe will be ignored.</para> <para type="description">When a probe is approved, PRTG will automatically create the "Probe Device" object under the probe containing the default probe sensors. If the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.AutoDiscover"/> parameter is specified, PRTG will additionally attempt to perform an auto-discovery to add any devices present in the probe's network.</para>
            
            <para type="description">If -<see cref="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.Deny"/> is specified, the probe will be removed from PRTG and its GID will be blacklisted.
            If a probe GID is blacklisted, it will not be able to communicate with PRTG unless its GID is changed or the GID is removed
            from the blacklist under Setup -> System Administration -> Core &amp; Probes</para>
            
            <example>
                <code>C:\> Get-Probe | Approve-Probe</code>
                <para>Approve all PRTG probes. Any probes that have already been approved will be skipped.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe | where { ($_ | Get-ObjectProperty).ProbeApproved -eq $false } | Approve-Probe</code>
                <para>Approve all probes that have not been approved.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Approve-Probe -Id 1001 -Deny</code>
                <para>Deny the probe with ID 1001.</para>
                <para/>
            </example>
            <example>
                <code>C:\> Get-Probe | Approve-Probe -AutoDiscover</code>
                <para>Approve all probes and immediately perform an auto-discovery. Any probes that have already been approved will be skipped.</para>
            </example>
            
            <para type="link">Get-Probe</para> 
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.Probe">
            <summary>
            <para type="description">Probe to set the approval status of.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.Id">
            <summary>
            <para type="description">ID of the probe to set the approval status of.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.Deny">
            <summary>
            <para type="description">Deny the probe from communicating with PRTG. This will also blacklist the probe's GID.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.AutoDiscover"> <summary> <para type="description">Approve the probe and automatically perform an auto-discovery.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.PassThru"> <summary> <para type="description">Specifies whether to return the original <see cref="T:PrtgAPI.IObject"/> that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.ApproveProbe.PassThruObject"> <summary> Returns the current object that should be passed through this cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.BackupPrtgConfig"> <summary> <para type="synopsis">Requests a PRTG Network Monitor server create a backup of its configuration database.</para> <para type="description">The Backup-PrtgConfig cmdlet requests a PRTG Network Monitor server create a backup of its configuration database after first writing the current running configuration to disk. Configuration backups are stored under the Configuration Auto-Backups folder, by default located at C:\ProgramData\Paessler\PRTG Network Monitor\Configuration Auto-Backups</para> <para type="description">When this cmdlet is executed, PRTG will asynchronously start creating a configuration backup. As such, this cmdlet will return before the backup has completed. Depending on the size of your configuration database, this may take several seconds to complete. In order to guarantee a backup has been successfully completed, it is recommended to probe the contents of the Configuration Auto-Backups folder before and after running this script, to identify the backup file that was created as a result of running this cmdlet. The created backup can also be identified by parsing the DateTime timestamp in the created filename, typically "PRTG Configuration (Snapshot yyyy-MM-dd HH-mm-ss)"</para> <example> <code>C:\> Backup-PrtgConfig</code> <para>Trigger a backup of the PRTG Configuration Database.</para> </example> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.BackupPrtgConfig.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.ClearPrtgCache"> <summary> <para type="synopsis">Clears cached data used by a PRTG Network Monitor server.</para> <para type="description">The Clear-PrtgCache cmdlet clears Geo Map, Active Directory authentication and Graph Data details from a PRTG server. Geo Map and Active Directory authentication caches are grouped together under the <see cref="F:PrtgAPI.SystemCacheType.General"/> cache type. Graph Data is cleared separately, under the <see cref="F:PrtgAPI.SystemCacheType.GraphData"/> cache type.</para> <para type="description">When Graph Data is cleared, the PRTG Core Service will automatically restart. To prevent this happening accidentally, Clear-PrtgCache will prompt you to confirm you are sure you wish to proceed. This can be overridden by specifying the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.ClearPrtgCache.Force"/> parameter.</para> <example> <code>C:\> Clear-PrtgCache General</code> <para>Clear Geo Map and Active Directory authentication caches.</para> <para/> </example> <example> <code>C:\> Clear-PrtgCache GraphData -Force</code> <para>Clear PRTG's graph data cache without displaying a confirmation prompt that this will restart the PRTG Core Service.</para>
            </example>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.ClearPrtgCache.Type">
            <summary>
            <para type="description">The type of cache to clear.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.ClearPrtgCache.Force">
            <summary>
            <para type="description">Forces PRTG to clear caches that may cause a reboot of the PRTG Server without displaying a confirmation prompt.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.ClearPrtgCache.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.CloneObject">
            <summary>
            <para type="synopsis">Clones a sensor, device, group or notification trigger within PRTG.</para>
            
            <para type="description">The Clone-Object cmdlet duplicates a PRTG Sensor, Device, Group or Notification Trigger, including
            all objects defined under it (such as all sensors of a device, or all devices and sensors of a group).</para>
            <para type="description">Clone-Object can operate in two modes: Clone From and Clone To. In Clone From mode (the default) objects
            you wish to clone are piped into Clone-Object, requiring you to specify the Object ID of the parent the cloned object will sit under.
            In Clone To mode, objects you wish to clone a single object to are piped to Clone-Object, requiring you to specify the ID of the object you
            wish to clone.</para>
            
            <para type="description">Sensors can only be cloned to <see cref="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Device"/> objects, whereas devices and groups can both cloned to other groups
            or directly under a probe.</para>
            
            <para type="description">When cloning sensors, devices and groups objects (in Clone From mode), a name can optionally be specified. When cloning sensors and groups,
            if a name is not specified the name of the original sensor or group will be used. When cloning devices, if a name is not
            specified PrtgAPI will automatically name the device as "Clone of &lt;device&gt;, where &lt;device&gt;
            is the name of the original device. When cloning devices, a Hostname/IP Address can optionally be specified. If a Hostname/IP Address
            is ommitted, PrtgAPI will use the name of the device as the hostname. Cloning a notification trigger with Clone-Object is equivalent
            to passing a trigger to the New-TriggerParameters cmdlet, followed by Add-NotificationTrigger.</para>
             
            <para type="
description">To clone a single child object to multiple destination objects, the -SourceId parameter can be specified. When operating in Clone To mode, Clone-Object will automatically assign the newly created object the same name as the source object. When Clone-Object executes, it will automatically attempt to resolve the target object specified by the -SourceId parameter. If -SourceId cannot be resolved to a valid sensor, device or group, Clone-Object will throw an exception specifying that the specified object ID is not valid.</para> <para type="description">When an object has been cloned, by default Clone-Object will attempt to automatically resolve the object into its resultant <see cref="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Sensor"/>, <see cref="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Device"/>, <see cref="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Group"/> or <see cref="T:PrtgAPI.NotificationTrigger"/> object. Based on the speed of your PRTG Server, this can sometimes result in a delay of 5-10 seconds due to the delay with which PRTG clones the object. If Clone-Object cannot resolve the resultant object on the first attempt, PrtgAPI will make a further 4 retries, pausing for a successively greater duration between each try. After each failed attempt a warning will be displayed indicating the number of attempts remaining. Object resolution can be aborted at any time by pressing an escape sequence such as Ctrl-C.</para> <para type="description">If you do not wish to resolve the resultant object, you can specify -Resolve:$false, which will cause Clone-Object to output a clone summary, including the object ID, name and hostname (for devices) of the new object. When cloning triggers, is -Resolve:$false is specified, no summary will be returned (as PRTG does not automatically return any information regarding cloned triggers). As PRTG pauses all cloned sensors, devices and groups by default, it is generally recommended to resolve the new object so that you may unpause the object with Resume-Object.</para> <example> <code>C:\> Get-Sensor -Id 1234 | Clone-Object -DestinationId 5678</code> <para>Clone the sensor with ID 1234 to the device with ID 5678</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 1234 | Clone-Object -DestinationId 5678 MyNewSensor</code> <para>Clone the sensor with ID 1234 to the device with ID 5678 renamed as "MyNewSensor"</para> <para/> </example> <example> <code>C:\> Get-Device *exch* | Clone-Object -SourceId 2002</code> <para>Clone the object with ID 2002 to all devices whose name contains "exch"</para> <para/> </example> <example> <code>C:\> Get-Sensor -Id 1234 | Clone-Object -DestinationId 5678 -Resolve:$false</code> <para>Clone the sensor with ID 1234 into the device with ID 5678 without resolving the resultant PrtgObject</para> <para/> </example> <example> <code>C:\> Get-Device -Id 1234 | Clone-Object -DestinationId 5678 MyNewDevice 192.168.1.1</code> <para>Clone the device with ID 1234 into the group or probe with ID 5678 renamed as "MyNewDevice" with IP Address 192.168.1.1</para> <para/> </example> <example> <code>C:\> Get-Probe -Id 1234 | Get-Trigger | Clone-Object -DestinationId 5678</code> <para>Clone all notification triggers (both inherited and explicitly defined) on the probe with ID 1234 to the object with ID 5678</para> </example> <para type="link">Get-Sensor</para> <para type="link">Get-Device</para> <para type="link">Get-Group</para> <para type="link">Get-Trigger</para> <para type="link">Get-NotificationTriggerParameters</para> <para type="link">Add-NotificationTrigger</para> <para type="link">Resume-Object</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.DestinationId"> <summary> <para type="description">The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Name"> <summary> <para type="description">The name to rename the cloned object to.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Host"> <summary> <para type="description">The hostname or IP Address to set on the cloned device.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Sensor"> <summary> <para type="description">The sensor to clone.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Device"> <summary> <para type="description">The device to clone.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Group"> <summary> <para type="description">The group to clone.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Trigger"> <summary> <para type="description">The notification trigger to clone.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.SourceId"> <summary> <para type="description">The ID of the object to clone.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.Destination"> <summary> <para type="description">The object to clone the object specified by the <see cref="P:PrtgAPI.PowerShell.Cmdlets.CloneObject.SourceId"/> to.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.CloneObject.BeginProcessingEx"> <summary> Provides an enhanced one-time, preprocessing functionality for the cmdlet. </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.CloneObject.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.EditNotificationTriggerProperty"> <summary> <para type="synopsis">Edits a notification trigger on a PRTG Server.</para> <para type="description">The Edit-NotificationTriggerProperty cmdlet allows a single notification trigger property to be modified. Typically when you wish to modify the properties of an existing notification trigger, a TriggerParameters object must be constructed and then passed to the Set-NotificationTrigger cmdlet. Edit-NotificationTriggerProperty simplifies the common case of only wanting to modify a single property of the trigger.</para> <example> <code>C:\> Get-Sensor -Id 1044 | Get-Trigger | Edit-TriggerProperty OnNotificationAction $null</code> <para>Remove the OnNotificationAction of all triggers defined on the object with ID 1044</para> </example> <para type="link">Get-NotificationTrigger</para> <para type="link">Set-NotificationTrigger</para> <para type="link">New-NotificationTriggerParameters</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.EditNotificationTriggerProperty.Trigger"> <summary> <para type="description">Notification Trigger to edit.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.EditNotificationTriggerProperty.Property"> <summary> <para type="description">The property to modify.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.EditNotificationTriggerProperty.Value"> <summary> <para type="description">Value to set the property to.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.EditNotificationTriggerProperty.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.EditNotificationTriggerProperty.PassThruObject"> <summary> Returns the current object that should be passed through this cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.LoadPrtgConfigFile"> <summary> <para type="synopsis">Reloads config files including sensor lookups and device icons used by PRTG Network Monitor.</para> <para type="description">The Load-PrtgConfigFile cmdlet reloads miscellaneous config files used by PRTG Network Monitor, including lookup definitions used for customizing how sensor values are displayed, as well as other miscellaneous config files including device icons, report templates and language files.</para> <para type="description">Config files used by PRTG are automatically reloaded whenever the PRTG Core Service is restarted. To prevent having to completely restart PRTG whenever a config file is installed or modified, Load-PrtgConfigFile can instead be used.</para> <para type="description">Device icons, report templates and language files are refreshed together by a single request, categorised by PrtgAPI as the <see cref="F:PrtgAPI.ConfigFileType.General"/> config file type. Sensor lookups are reloaded separately, under the <see cref="F:PrtgAPI.ConfigFileType.Lookups"/> file type.</para> <example> <code>C:\> Load-PrtgConfigFile General</code> <para>Reload any device icons, report templates or language files that may have been installed or modified since PRTG started.</para> <para/> </example> <example> <code>C:\> Load-PrtgConfigFile Lookups</code> <para>Loads or reloads any sensor lookups that may have been changed or installed since PRTG was started.</para> </example> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.LoadPrtgConfigFile.Type"> <summary> <para type="description">The type of config files to reload.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.LoadPrtgConfigFile.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.MoveObject"> <summary> <para type="synopsis">Moves a device or group within the PRTG Object Tree.</para> <para type="description">The Move-Object cmdlet allows you to move a device or group to another group or probe within PRTG. Any device or group can be moved to any other group or probe, with the exception of special objects such as the "Probe Device" object under each probe, as well as the Root group (ID: 0).</para> <example> <code>C:\> Get-Device dc-1 | Move-Object 5678</code> <para>Move all devices named dc-1 to under the object with ID 5678</para> </example> <para type="link">Get-Device</para> <para type="link">Get-Group</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.MoveObject.Device"> <summary> <para type="description">The device to move to another group or probe.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.MoveObject.Group"> <summary> <para type="description">The group to move to another group or probe.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.MoveObject.DestinationId"> <summary> <para type="description">The group or probe to move the object to. This cannot be the Root PRTG Group.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.MoveObject.ProcessRecordEx"> <summary> Performs enhanced record-by-record processing functionality for the cmdlet. </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.MoveObject.PassThruObject"> <summary> Returns the current object that should be passed through this cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand"> <summary> <para type="synopsis">Creates a new set of device parameters for creating a brand new device under a group or probe.</para> <para type="description">The New-DeviceParameters cmdlet creates a set of parameters for adding a brand new device to PRTG. Device parameter objects returned from New-DeviceParameters allow specifying a variety of device specific configuration details including Internet Protocol version and auto-discovery settings at the time of object creation.</para> <para type="description">All devices must have a <see cref="P:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.Name"/> and <see cref="P:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.Host"/> property specified. If a <see cref="P:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.Host"/> (IP Address/HostName) is not specified in the call to New-DeviceParameters, PrtgAPI will automatically use the <see cref="P:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.Name"/> </para> as the hostname/IP Address. <para type="description">Note that not all device parameters (such as settings that can be inherited from the parent group) can be specified with PrtgAPI at the time of object creation. If you wish to modify such properties, this can be achieved after the device has been created via the Set-ObjectProperty cmdlet.</para> <example> <code>C:\> $params = New-DeviceParameters dc-1</code> <para>C:\> Get-Probe contoso | Add-Device $params</para> <para>Create a new device named "dc-1" with hostname "dc-1" under the Contoso probe.</para> <para/> </example> <example> <code>C:\> $params = New-DeviceParameters exch-1 "2001:db8::ff00:42:8329"</code> <para>C:\> $params.IPVersion = "IPv6"</para> <para>C:\> Get-Probe contoso | Add-Device $params</para> <para>Create a new device named "dc-2" with an IPv6 address, specifying the Internet Protocol as IPv6.</para> <para/> </example> <example> <code>C:\> $params = New-DeviceParameters dc-1</code> <para>C:\> $params.AutoDiscoveryMode = "AutomaticTemplate"</para> <para>C:\> $params.DeviceTemplates = Get-DeviceTemplate *wmi*</para> <para>C:\> Get-Probe contoso | Add-Device $params</para> <para>Create a new device named "dc-1" that performs an auto-discovery for WMI sensors only.</para> <para/> </example> <example> <code>C:\> $params = New-DeviceParameters dc-1</code> <para>C:\> Get-Probe contoso | Add-Device $params -PassThru | Set-ObjectProperty Location "23 Fleet Street"</para> <para>Create a new device named "dc-1" and then set its location.</para> </example> <para type="link">Add-Device</para> <para type="link">Get-DeviceTemplate</para> <para type="link">Set-ObjectProperty</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.Name"> <summary> <para type="description">The name to give the new device.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.Host"> <summary> <para type="description">The hostname or IP Address to use for the new device. If no value is specified, the name will be used.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.NewDeviceParametersCommand.ProcessRecord"> <summary> Performs record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.NewGroupParametersCommand"> <summary> <para type="synopsis">Creates a new set of group parameters for creating a brand new group under a group or probe.</para> /// <para type="description">The New-GroupParameters cmdlet creates a set of parameters for adding a brand new group to PRTG. Group parameter objects returned from New-GroupParameters allow specifying a variety of group specific configuration details including auto-discovery settings at the time of object creation.</para> <para type="description">Note that not all group parameters (such as settings that can be inherited from the parent group or probe) can be specified with PrtgAPI at the time of object creation. If you wish to modify such properties, this can be achieved after the group has been created via the Set-ObjectProperty cmdlet.</para> <example> <code>C:\> $params = New-GroupParameters Servers</code> <para>C:\> Get-Probe contoso | Add-Group $params</para> <para>Add a new group called "Servers" to the Contoso probe.</para> <para/> </example> <example> <code>C:\> $params = New-GroupParameters Servers</code> <para>C:\> $params.Tags = "awesomeGroup"</para> <para>C:\> Get-Probe Contoso | Add-Group $params</para> <para>Add a new group called "Servers" to the Contoso probe with a custom tag "awesomeGroup".</para> </example> <para type="link">Add-Group</para> <para type="link">Set-ObjectProperty</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewGroupParametersCommand.Name"> <summary> <para type="description">The name to give the new group.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.NewGroupParametersCommand.ProcessRecord"> <summary> Performs record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters"> <summary> <para type="synopsis">Creates a new set of notification trigger parameters for adding or editing a notification trigger.</para> <para type="description">The New-NotificationTriggerParameters cmdlet creates a set of trigger parameters for creating or editing a notification trigger. When editing notification triggers, New-NotificationTriggerParameters should only be used when multiple values require updating. For updating a single notification trigger property Edit-NotificationTriggerProperty should be used instead.</para> <para type="description">When creating a new notification trigger, the trigger's parameters can either be imported from an existing notification trigger's properties and then further modified, or defined manually from scratch.</para> <para type="description">Based on the type of notification trigger specified, New-NotificationTriggerParameters will create one of several TriggerParameter type objects, exposing only the parameters relevant to that trigger type.</para> <para type="description">When working with TriggerParameters objects, all parameter properties support nullable values, allowing you to clear any properties you wish to remove or undo. The exception to this however is Notification Action related properties. When a Notification Action is set to null, it will set the property to the "empty" notification action. This allows you to easily clear unwanted notification actions within the PRTG Interface.</para> <para type="description">When editing existing notification triggers, all properties on the TriggerParameters object will be initially set to null. Specifying a value for a property will highlight to PrtgAPI that that property should be updated when the trigger request is executed. While holding a value of null by default, Notification Actions will not set themselves with the "empty" notification action unless this value is explicitly specified. Note that if you wish to undo modifying a notification action property you have set to null, you will be unable to do so without creating a brand new TriggerParameters object.</para> <para type="description">For trigger types where the Channel property is supported (Speed, Threshold and Volume) when defining the trigger on a Probe, Group or Device, enum values "Primary", "Total", "TrafficIn" and "TrafficOut" must be used. When applied directly to a Sensor, a specific Channel or Channel ID must be used. To safely resolve all channels supported by the sensor the Get-Channel cmdlet can be used. Once a Channel or Channel ID has been assigned to a trigger parameter's Channel property, it is wrapped as a TriggerChannel object and the underlying type cannot be retrieved. As such, if you wish to refer to your original type, you must keep a copy of the value assigned to the Channel property for further use in your code.</para> <example> <code>C:\> $params = New-TriggerParameters 1234 State</code> <para>C:\> $params | Add-Trigger</para> <para>Add a new state notification trigger with default values to object with ID 1234</para> <para/> </example> <example> <code>C:\> $params = New-TriggerParameters 1234 3 State</code> <para>C:\> $params.Latency = 40</para> <para>C:\> $params | Set-Trigger</para> <para>Edit the state notification trigger with sub ID 3 on the object with ID 1234, setting the Latency to 40 seconds</para> <para/> </example> <example> <code>C:\> $params = Get-Sensor -Id 1001 | Get-Trigger -Type State -Inherited $false | New-TriggerParameters 1234</code> <para>C:\> $params.OffNotificationAction = $null</para> <para>C:\> $params | Add-Trigger</para> <para>Create a new notification trigger on the object with ID 1234 from the state trigger on the sensor with ID 1001, setting the OffNotificationAction to "None"</para> <para/> </example> <example> <code>C:\> $params = Get-Sensor -Id 1001 | Get-Trigger -Type State -Inherited $false | New-TriggerParameters</code> <para>C:\> $params.Latency = 30</para> <para>C:\> $params | Set-Trigger</para> <para>Edit the notification trigger on the sensor with ID 1001, setting the latency to 30 seconds</para> <para/> </example> <example> <code>C:\> $sensor = Get-Sensor -Id 1001</code> <para>C:\> $channel = $sensor | Get-Channel "Available Memory"</para> <para>C:\> $params = $sensor | New-TriggerParameters Threshold</para> <para>C:\> $params.Channel = $channel</para> <para>C:\> $params | Add-Trigger</para> <para>Create a new notification trigger on the sensor with ID 1001 that alerts based on the value of its "Available Memory" channel.</para> <para/> </example> <example> <code>C:\> $params = New-TriggerParameters 1001 Threshold</code> <para>C:\> $params.Channel = 1</para> <para>C:\> $params | Add-Trigger</para> <para>Create a new threshold notification trigger on the sensor with ID 1001 that alerts based on the value of the channel with ID 1.</para> </example> <para type="link">Edit-NotificationTriggerProperty</para> <para type="link">Add-NotificationTrigger</para> <para type="link">Set-NotificationTrigger</para> <para type="link">Get-Channel</para> //todo: i dont think requirevalueattribute is working? when should it work? how do we test creating some corrupt triggers? //todo: have examples for the various ways of setting the channel for a threshold trigger, plus some examples for setting the various properties of volume/speed/threshold triggers </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters.Object"> <summary> <para type="description">The object a trigger should be created for.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters.Id"> <summary> <para type="description">The ID of the object the notification trigger will be created for or the ID of the object whose triggers should be modified.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters.Source"> <summary> <para type="description">The notification trigger import trigger parameters from.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters.TriggerId"> <summary> <para type="description">The Sub ID of the trigger to manipulate.</para> </summary> </member> <member name="P:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters.Type"> <summary> <para type="description">The type of notification trigger to manipulate.</para> </summary> </member> <member name="M:PrtgAPI.PowerShell.Cmdlets.NewNotificationTriggerParameters.ProcessRecord"> <summary> Performs record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand"> <summary> <para type="synopsis">Creates a new set of sensor parameters for creating a brand new sensor under a device.</para> <para type="description">The New-SensorParameters cmdlet creates a set of parameters for adding a brand new sensor to PRTG. All sensor types supported by PRTG can be added with New-SensorParameters, however certain types are "natively" supported. For types that are not are natively supported, New-SensorParameters is capable of either dynamically generating the required set of parameters, or creating a completely custom set of parameters from a collection of values manually crafted by hand.</para> <para type="description">Natively supported sensor types allow interfacing with strongly typed properties of a well known object deriving from NewSensorParameters. When a supported type is created, the name to give the sensor can be optionally specified. If a name is not specified, New-SensorParameters will automatically assign the sensor the default name PRTG would assign a sensor of the specified type (e.g. EXE/Script Advanced sensors by default are named "XML Custom EXE/Script Sensor").</para> <para type="description">In addition to the sensor name, certain sensor types contain additional mandatory fields that must be populated before attempting to add the sensor (such as the ExeFile of an EXE/Script Advanced sensor). New-SensorParameters optionally allows you to specify the value of the primary mandatory field of the specified type using the -Value parameter. Fields that require values contain a value of $null by default, however not all fields that are $null are necessarily mandatory. If you attempt to add a natively supported type with missing mandatory fields, PrtgAPI will catch this and alert you that the value that was missing.</para> <para type="description">Beyond type safety, PrtgAPI does not perform any validation that the values you specify to fields are "correct" (e.g. for an EXE/Script Advanced sensor, that the specified file exists). In the event invalid values are specified, PRTG will usually handle the error gracefully, however you are responsible for confirming that any values that are used to create a new sensor as are as correct as possible.</para> <para type="description">For sensor types that are not natively supported, PrtgAPI provides the ability to dynamically generate the set of parameters required to add the specified sensor type. Dynamically generated sensor parameters operate as a hybrid of a both a Dictionary and a PSObject, allowing you to interface with these types as if they are a native object. For sensor types that require Sensor Targets, a dictionary of all identified sensor targets can be found under the dynamic sensor parameter's Targets property. Parameters that appear to contain sensor targets will automatically be wrapped as a <see cref="T:PrtgAPI.Targets.GenericSensorTarget"/>, and by default will contain the first target from the list of available candidates.</para> <para type="description">By default, dynamically sensor parameters are "locked", as to prevent additional parameters from being added to the object in the event a typo is made. If you do wish to add additional parameters however, this can be performed by calling the Unlock method on the specified <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/> and then setting the value via the parameter's indexer or via the dynamic property name. Note that <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/> dynamic properties will always show parameters as not containing a trailing underscore as to provide a "cleaner" interface. The raw <see cref="T:PrtgAPI.Parameters.CustomParameter"/> objects of the parameters can be viewed however by specifying <see cref="F:PrtgAPI.Parameter.Custom"/> to the object's indexer.</para> <para type="description">If you wish to create your parameters yourself, this can either be done by creating an -Empty set of parameters for you to manually populate, or by defining a hashtable listing all the parameters that are required to create the specified sensor along with their raw associated values. The parameters for creating a specific type of sensor can be discovered via a web debugger such as Fiddler or by inspecting the underlying parameters generated by a set of <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/>.</para> <para type="description">When accessing <see cref="T:PrtgAPI.Parameters.RawSensorParameters"/> and <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/> via their indexers, by default PowerShell will suppress any exceptions thrown when trying to access non-existent properties, instead simply returning $null. This is due to the default Strict Mode the PowerShell engine runs under. To enable exceptions on accessing invalid paramters, the strict mode must be set to version 3 or higher. For more information, see Get-Help Set-StrictMode.</para> <para type="description">Great care should be taken when adding sensors using raw parameters. As there is no type safety, the possibility of making errors is high. As most raw parameter names end in an underscore, it is critical to ensure these parameters have been named properly. In the event a sensor is added improperly, it can easily be corrected or deleted in the PRTG UI. When specifying a hashtable parameter set to New-SensorParameters, PrtgAPI will validate that at a minimum the 'name_' and 'sensortype' parameters are specified. If either of these two are missing, New-SensorParameters will generate an exception.</para> <para type="description">When sensor parameters are created via the Add-Sensor cmdlet, if the -Resolve parameter is specified PrtgAPI will attempt to resolve the resultant sensors based on the sensor type specified in the sensor parameters. If the resulting sensor type is capable of changing based on the specified parameters, you can instruct PrtgAPI to broaden its sensor resolution search by specifying the -<see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.DynamicType"/> parameter when creating your parameters object. <see cref="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.DynamicType"/> property can also be modified on the resulting <see cref="T:PrtgAPI.Parameters.NewSensorParameters"/> object that is returned from the New-SensorParameters cmdlet. </para> <para type="description">All sensor parameter types support specifying common sensor parameters (Inherit Triggers, Interval, Priority, etc) via well typed properties. If these properties are not set, PRTG will automatically use the default values for these fields based on the type of sensor being created.</para> <example> <code>C:\> $params = New-SensorParameters ExeXml "Custom Script" "CustomScript.ps1"</code> <para>C:\> Get-Device dc-1 | Add-Sensor $params</para> <para>Create a new EXE/Script Advanced sensor on the device dc-1 using the name "Custom Script", that executes the file "CustomScript.ps1", specifying the script name in the optional -Value parameter</para> <para/> </example> <example> <code>C:\> $params = New-SensorParameters ExeXml "Custom Script"</code> <para>C:\> $params.ExeFile = "CustomScript.ps1"</para> <para>C:\> Get-Device dc-1 | Add-Sensor $params</para> <para>Create a new EXE/Script Advanced sensor on the device dc-1 using the name "Custom Script", that executes the file "CustomScript.ps1", specifying the script name after the object has been created</para> <para/> </example> <example> <code>C:\> $params = New-SensorParameters ExeXml</code> <para>C:\> $params.ExeFile = "CheckStatus.ps1"</para> <para>C:\> Get-Device -Id 1001 | Add-Sensor $params</para> <para>Create a new EXE/Script Advanced sensor on the device with ID 1001 using the name "XML Custom EXE/Script Sensor" that executes the file "CheckStatus.ps1"</para> <para/> </example> <example> <code>C:\> $params = Get-Device esxi-1 | New-SensorParameters -RawType vmwaredatastoreextern</code> <para>C:\> $params.datafieldlist__check = $params.Targets["datafieldlist__check"]</para> <para>C:\> $params | Add-Sensor</para> <para>Dynamically create a new set of VMware Datastore credentials for the device named esxi-1 targeting all datastores that exist on the device.</para> <para/> </example> <example> <code>C:\ $params = Get-Device esxi-1 | New-SensorParameters -RawType vmwaredatastoreextern</code> <para>C:\> $params[[PrtgAPI.Parameter]::Custom]</para> <para>View the raw set of CustomParameters defined on an object.</para> <para/> </example> <example> <code>C:\> $params = Get-Device esxi-1 | New-SensorParameters -RawType exchangepsdatabase</code> <para>C:\> $params.Unlock()</para> <para>C:\> $params.customparam_ = "some value"</para> <para>Create a new parameter named "customparam" on a set of Exchange Database sensor parameters.</para> <para/> </example> <example> <code>C:\> $params = New-SensorParameters -Empty</code> <para>C:\> $params["name_"] = "My Sensor"</para> <para>C:\> $params["sensortype"] = "exexml"</para> <para>Create an empty set of sensor parameters to manually insert all raw parameters.</para> <para/> </example> <example> <code>C:\> $raw = @{</code> <para>>> name_ = "my raw sensor"</para> <para>>> tags_ = "xmlexesensor"</para> <para>>> priority_ = 4</para> <para>>> exefile_ = "CustomScript.ps1|CustomScript.ps1||</para>
                <para>>>     exeparams_ = "arg1 arg2 arg3"</para>
                <para>>>     environment_ = 1</para>
                <para>>>     usewindowsauthentication_ = 1</para>
                <para>>>     mutexname_ = "testMutex"</para>
                <para>>>     timeout_ = 70</para>
                <para>>>     writeresult_ = 1</para>
                <para>>>     intervalgroup = 0</para>
                <para>>>     interval_ = "30|30 seconds"</para>
                <para>>>     errorintervalsdown_ = 2</para>
                <para>>>     sensortype = "exexml"</para>
                <para>>> }</para>
                <para>C:\> $params = New-SensorParameters $raw</para>
                <para>C:\> Get-Device dc-1 | Add-Sensor $params</para>
                <para>Add a new EXE/Script Advanced sensor to the device named dc-1 using a hashtable containing its raw parameters.</para>
                <para/>
            </example>
            <example>
                <code>C:\> $params = New-SensorParameters $raw -DynamicType</code>
                <para>Create a set of parameters for creating a sensor with a dynamic type (such as snmplibrary).</para>
                <para/>
            </example>
            <example>
                <code>C:\> Set-StrictMode -Version 3</code>
                <para>Set the Strict Mode to version 3 for the current PowerShell session.</para>
            </example>
            
            <para type="link">Get-Help SensorParameters</para>
            <para type="link">Add-Sensor</para>
            <para type="link">Get-Device</para>
            <para type="link">Set-StrictMode</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.Type">
            <summary>
            <para type="description">The type of sensor to create.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.First">
            <summary>
            <para type="description">The name to give the new sensor. If no value is specified, the default name of the specified sensor type will be used.
            If the specified sensor type does not support specifying a name, this field is used for any mandatory values required by the sensor type.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.Second">
            <summary>
            <para type="description">A mandatory value required by the specified sensor type.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.RawParameters">
            <summary>
            <para type="description">A collection of raw parameters for adding an unsupported sensor type.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.Device">
            <summary>
            <para type="description">The device to create a set of <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/> from.</para> 
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.RawType">
            <summary>
            <para type="description">The raw name of the sensor type to create.</para> 
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.Target">
            <summary>
            <para type="description">Wildcard used to specify the sensor targets to assign to a set of <see cref="T:PrtgAPI.Parameters.DynamicSensorParameters"/>.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.Timeout">
            <summary>
            <para type="description">Duration (in seconds) to wait for dynamic sensor parameters to resolve.</para> 
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.Empty">
            <summary>
            <para type="description">Specifies that an empty set of <see cref="T:PrtgAPI.Parameters.RawSensorParameters"/> should be returned to allow constructing
            a parameter set manually.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.DynamicType">
            <summary>
            <para type="description">Specifies whether the resulting sensor type is dynamically determined by the parameters included in the request.
            If this property is true, PrtgAPI will relax its sensor resolution mechanism to ensure the resultant object is retrieved.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand"/> class.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.BeginProcessing">
            <summary>
            Provides a one-time, preprocessing functionality for the cmdlet.
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.NewSensorParametersCommand.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member name="T:PrtgAPI.PowerShell.Cmdlets.OpenPrtgObject">
            <summary>
            <para type="synopsis">Opens the URL of a PRTG Object in the PRTG Web Interface.</para>
            
            <para type="description">The Open-PrtgObject cmdlet opens the web page of a PRTG Object in your default browser.
            Care should be taken with Open-PrtgObject, as your system may experience performance issues if too many URLs are opened at one time.</para>
            
            <para type="description">Open-PrtgObject is only compatible with objects that contain a URL field; namely Probes, Devices, Groups Sensors,
            Notification Actions and Schedules.</para>
            
            <example>
                <code>C:\> Get-Device dc-1 | Get-Sensor ping | Open-PrtgObject</code>
                <para>Open all sensors named "ping" under devices named "dc-1" in the default web browser.</para>
            </example>
            
            <para type="link">Get-Sensor</para>
            <para type="link">Get-Device</para>
            <para type="link">Get-Group</para>
            <para type="link">Get-Probe</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.OpenPrtgObject.Object">
            <summary>
            <para type="description">The sensor, device, group or probe to open.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.OpenPrtgObject.Notification">
            <summary>
            <para type="description">The notification action to open.</para>
            </summary>
        </member>
        <member name="P:PrtgAPI.PowerShell.Cmdlets.OpenPrtgObject.Schedule">
            <summary>
            <para type="description">The schedule to open.</para>
            </summary>
        </member>
        <member name="M:PrtgAPI.PowerShell.Cmdlets.OpenPrtgObject.ProcessRecordEx">
            <summary>
            Performs enhanced record-by-record processing functionality for the cmdlet.
            </summary>
        </member>
        <member