en-us/dbatools-help.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
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml"><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Select-DbaObject</command:name><command:noun>DbaObject</command:noun><command:verb>Select</command:verb><maml:description><maml:para>Wrapper around Select-Object, extends property parameter.</maml:para></maml:description></command:details><maml:description><maml:para>Wrapper around Select-Object, extends property parameter.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Select-DbaObject</maml:name><command:parameter required="false" position="named" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>The object(s) to select from.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Psobject</command:parameterValue><dev:type><maml:name>Psobject</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Property</maml:name><maml:description><maml:para>The properties to select. - Supports hashtables, which will be passed through to Select-Object.
</maml:para><maml:para>- Supports renaming as it is possible in SQL: "Length AS Size" will select the Length property but rename it to size.
</maml:para><maml:para>- Supports casting to a specified type: "Address to IPAddress" or "Length to int".
</maml:para><maml:para>Uses PowerShell type-conversion. - Supports parsing numbers to sizes: "Length size GB:2" Converts numeric input (presumed to be bytes) to gigabyte with two decimals.   Also supports toggling on Unit descriptors by adding another element: "Length size GB:2:1" - Supports selecting properties from objects in other variables: "ComputerName from VarName" (Will insert the property 'ComputerName' from variable $VarName)
</maml:para><maml:para>- Supports filtering when selecting from outside objects: "ComputerName from VarName where ObjectId = Id" (Will insert the property 'ComputerName' from the object in variable $VarName, whose ObjectId property is equal to the inputs Id property)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaSelectParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaSelectParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeProperty</maml:name><maml:description><maml:para>Properties to not list.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExpandProperty</maml:name><maml:description><maml:para>Properties to expand.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Alias</maml:name><maml:description><maml:para>Create an alias property. This can be in simple SQL notation, such as "Length as Size" or a hashtable with the alias name being the key and the referenced property being the value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectAliasParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectAliasParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ScriptProperty</maml:name><maml:description><maml:para>Add script properties to the object. This parameter takes a hashtable that can be either simply Name --&gt; Scriptblock binding (for readonly properties) or Name --&gt; Hashtable binding, with the inner hashtable containing two keys: get &amp; set. Each pointing at their respective scriptblock.
</maml:para><maml:para>-ScriptProperty @{
</maml:para><maml:para>DoubleSize = { $this.Length * 2}
</maml:para><maml:para>MegaSize = @{
</maml:para><maml:para>get = { $this.Length * 10 }
</maml:para><maml:para>set = { $this.Length = $_ / 10 }
</maml:para><maml:para>}
</maml:para><maml:para>}</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectScriptPropertyParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectScriptPropertyParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ScriptMethod</maml:name><maml:description><maml:para>Add script methods to the object. This can be done using either:
</maml:para><maml:para>- String syntax 'GetDouble =&gt; $this.Length * 2'
</maml:para><maml:para>- Hashtable defining any number of methods, with the name being the key and the scriptblock being the value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectScriptMethodParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectScriptMethodParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Unique</maml:name><maml:description><maml:para>Do not list multiples of the same value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Last</maml:name><maml:description><maml:para>Select the last n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>First</maml:name><maml:description><maml:para>Select the first n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Skip</maml:name><maml:description><maml:para>Skip the first (or last if used with -Last) n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Wait</maml:name><maml:description><maml:para>Indicates that the cmdlet turns off optimization. Windows PowerShell runs commands in the order that they appear in the command pipeline and lets them generate all objects. By default, if you include a Select-DbaObject command with the First or Index parameters in a command pipeline, Windows PowerShell stops the command that generates the objects as soon as the selected number of objects is generated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowProperty</maml:name><maml:description><maml:para>Only the specified properties will be shown by default. Supersedes ShowExcludeProperty</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowExcludeProperty</maml:name><maml:description><maml:para>Hides the specified properties from the default display style of the output object. Is ignored if used together with ShowProperty.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TypeName</maml:name><maml:description><maml:para>Adds a typename to the selected object. Will automatically prefix the module.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>KeepInputObject</maml:name><maml:description><maml:para>Keeps the original input object, adding new properties the select added without removing any. This allows you to use this command to add properties without losing the input object's type.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Select-DbaObject</maml:name><command:parameter required="false" position="named" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>The object(s) to select from.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Psobject</command:parameterValue><dev:type><maml:name>Psobject</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Property</maml:name><maml:description><maml:para>The properties to select. - Supports hashtables, which will be passed through to Select-Object. </maml:para><maml:para>- Supports renaming as it is possible in SQL: "Length AS Size" will select the Length property but rename it to size. </maml:para><maml:para>- Supports casting to a specified type: "Address to IPAddress" or "Length to int". </maml:para><maml:para>Uses PowerShell type-conversion. - Supports parsing numbers to sizes: "Length size GB:2" Converts numeric input (presumed to be bytes) to gigabyte with two decimals. Also supports toggling on Unit descriptors by adding another element: "Length size GB:2:1" - Supports selecting properties from objects in other variables: "ComputerName from VarName" (Will insert the property 'ComputerName' from variable $VarName) </maml:para><maml:para>- Supports filtering when selecting from outside objects: "ComputerName from VarName where ObjectId = Id" (Will insert the property 'ComputerName' from the object in variable $VarName, whose ObjectId property is equal to the inputs Id property)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaSelectParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaSelectParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeProperty</maml:name><maml:description><maml:para>Properties to not list.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExpandProperty</maml:name><maml:description><maml:para>Properties to expand.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Alias</maml:name><maml:description><maml:para>Create an alias property. This can be in simple SQL notation, such as "Length as Size" or a hashtable with the alias name being the key and the referenced property being the value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectAliasParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectAliasParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ScriptProperty</maml:name><maml:description><maml:para>Add script properties to the object. This parameter takes a hashtable that can be either simply Name --&gt; Scriptblock binding (for readonly properties) or Name --&gt; Hashtable binding, with the inner hashtable containing two keys: get &amp; set. Each pointing at their respective scriptblock. </maml:para><maml:para>-ScriptProperty @{ </maml:para><maml:para>DoubleSize = { $this.Length * 2} </maml:para><maml:para>MegaSize = @{ </maml:para><maml:para>get = { $this.Length * 10 } </maml:para><maml:para>set = { $this.Length = $_ / 10 } </maml:para><maml:para>} </maml:para><maml:para>}</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectScriptPropertyParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectScriptPropertyParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ScriptMethod</maml:name><maml:description><maml:para>Add script methods to the object. This can be done using either: </maml:para><maml:para>- String syntax 'GetDouble =&gt; $this.Length * 2' </maml:para><maml:para>- Hashtable defining any number of methods, with the name being the key and the scriptblock being the value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectScriptMethodParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectScriptMethodParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Unique</maml:name><maml:description><maml:para>Do not list multiples of the same value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SkipLast</maml:name><maml:description><maml:para>Skip the last n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowProperty</maml:name><maml:description><maml:para>Only the specified properties will be shown by default. Supersedes ShowExcludeProperty</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowExcludeProperty</maml:name><maml:description><maml:para>Hides the specified properties from the default display style of the output object. Is ignored if used together with ShowProperty.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TypeName</maml:name><maml:description><maml:para>Adds a typename to the selected object. Will automatically prefix the module.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>KeepInputObject</maml:name><maml:description><maml:para>Keeps the original input object, adding new properties the select added without removing any. This allows you to use this command to add properties without losing the input object's type.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Select-DbaObject</maml:name><command:parameter required="false" position="named" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>The object(s) to select from.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Psobject</command:parameterValue><dev:type><maml:name>Psobject</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Unique</maml:name><maml:description><maml:para>Do not list multiples of the same value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Wait</maml:name><maml:description><maml:para>Indicates that the cmdlet turns off optimization. Windows PowerShell runs commands in the order that they appear in the command pipeline and lets them generate all objects. By default, if you include a Select-DbaObject command with the First or Index parameters in a command pipeline, Windows PowerShell stops the command that generates the objects as soon as the selected number of objects is generated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Index</maml:name><maml:description><maml:para>Specifies an array of objects based on their index values. Enter the indexes in a comma-separated list.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Int32[]</command:parameterValue><dev:type><maml:name>System.Int32[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowProperty</maml:name><maml:description><maml:para>Only the specified properties will be shown by default. Supersedes ShowExcludeProperty</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowExcludeProperty</maml:name><maml:description><maml:para>Hides the specified properties from the default display style of the output object. Is ignored if used together with ShowProperty.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TypeName</maml:name><maml:description><maml:para>Adds a typename to the selected object. Will automatically prefix the module.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>KeepInputObject</maml:name><maml:description><maml:para>Keeps the original input object, adding new properties the select added without removing any. This allows you to use this command to add properties without losing the input object's type.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Alias</maml:name><maml:description><maml:para>Create an alias property. This can be in simple SQL notation, such as "Length as Size" or a hashtable with the alias name being the key and the referenced property being the value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectAliasParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectAliasParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeProperty</maml:name><maml:description><maml:para>Properties to not list.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExpandProperty</maml:name><maml:description><maml:para>Properties to expand.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>First</maml:name><maml:description><maml:para>Select the first n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Index</maml:name><maml:description><maml:para>Specifies an array of objects based on their index values. Enter the indexes in a comma-separated list.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Int32[]</command:parameterValue><dev:type><maml:name>System.Int32[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>The object(s) to select from.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Psobject</command:parameterValue><dev:type><maml:name>Psobject</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>KeepInputObject</maml:name><maml:description><maml:para>Keeps the original input object, adding new properties the select added without removing any. This allows you to use this command to add properties without losing the input object's type.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Last</maml:name><maml:description><maml:para>Select the last n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Property</maml:name><maml:description><maml:para>The properties to select. - Supports hashtables, which will be passed through to Select-Object.
</maml:para><maml:para>- Supports renaming as it is possible in SQL: "Length AS Size" will select the Length property but rename it to size.
</maml:para><maml:para>- Supports casting to a specified type: "Address to IPAddress" or "Length to int".
</maml:para><maml:para>Uses PowerShell type-conversion. - Supports parsing numbers to sizes: "Length size GB:2" Converts numeric input (presumed to be bytes) to gigabyte with two decimals.   Also supports toggling on Unit descriptors by adding another element: "Length size GB:2:1" - Supports selecting properties from objects in other variables: "ComputerName from VarName" (Will insert the property 'ComputerName' from variable $VarName)
</maml:para><maml:para>- Supports filtering when selecting from outside objects: "ComputerName from VarName where ObjectId = Id" (Will insert the property 'ComputerName' from the object in variable $VarName, whose ObjectId property is equal to the inputs Id property)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaSelectParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaSelectParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ScriptMethod</maml:name><maml:description><maml:para>Add script methods to the object. This can be done using either:
</maml:para><maml:para>- String syntax 'GetDouble =&gt; $this.Length * 2'
</maml:para><maml:para>- Hashtable defining any number of methods, with the name being the key and the scriptblock being the value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectScriptMethodParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectScriptMethodParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ScriptProperty</maml:name><maml:description><maml:para>Add script properties to the object. This parameter takes a hashtable that can be either simply Name --&gt; Scriptblock binding (for readonly properties) or Name --&gt; Hashtable binding, with the inner hashtable containing two keys: get &amp; set. Each pointing at their respective scriptblock.
</maml:para><maml:para>-ScriptProperty @{
</maml:para><maml:para>DoubleSize = { $this.Length * 2}
</maml:para><maml:para>MegaSize = @{
</maml:para><maml:para>get = { $this.Length * 10 }
</maml:para><maml:para>set = { $this.Length = $_ / 10 }
</maml:para><maml:para>}
</maml:para><maml:para>}</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.SelectScriptPropertyParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.SelectScriptPropertyParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowExcludeProperty</maml:name><maml:description><maml:para>Hides the specified properties from the default display style of the output object. Is ignored if used together with ShowProperty.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ShowProperty</maml:name><maml:description><maml:para>Only the specified properties will be shown by default. Supersedes ShowExcludeProperty</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Skip</maml:name><maml:description><maml:para>Skip the first (or last if used with -Last) n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SkipLast</maml:name><maml:description><maml:para>Skip the last n items.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TypeName</maml:name><maml:description><maml:para>Adds a typename to the selected object. Will automatically prefix the module.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Unique</maml:name><maml:description><maml:para>Do not list multiples of the same value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Wait</maml:name><maml:description><maml:para>Indicates that the cmdlet turns off optimization. Windows PowerShell runs commands in the order that they appear in the command pipeline and lets them generate all objects. By default, if you include a Select-DbaObject command with the First or Index parameters in a command pipeline, Windows PowerShell stops the command that generates the objects as soon as the selected number of objects is generated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> ---------------- Example 1: Renaming a property ---------------- </maml:title><maml:introduction></maml:introduction><dev:code> Get-ChildItem | Select-DbaObject Name, "Length as Size" </dev:code><dev:remarks><maml:para> Selects the properties Name and Length, renaming Length to Size in the process.
 </maml:para><maml:para> _ </maml:para></dev:remarks></command:example><command:example><maml:title> ------------------ Example 2: Converting type ------------------ </maml:title><maml:introduction></maml:introduction><dev:code> Import-Csv .\file.csv | Select-DbaObject Name, "Length as Size to DbaSize" </dev:code><dev:remarks><maml:para> Selects the properties Name and Length, renaming Length to Size and converting it to [DbaSize] (a userfriendly representation of size numbers contained in the dbatools module)
 </maml:para><maml:para> _ </maml:para></dev:remarks></command:example><command:example><maml:title> ---------- Example 3: Selecting from another object 1 ---------- </maml:title><maml:introduction></maml:introduction><dev:code> $obj = [PSCustomObject]@{ Name = "Foo" }
Get-ChildItem | Select-DbaObject FullName, Length, "Name from obj" </dev:code><dev:remarks><maml:para> Selects the properties FullName and Length from the input and the Name property from the object stored in $obj
 </maml:para><maml:para> _ </maml:para></dev:remarks></command:example><command:example><maml:title> ---------- Example 4: Selecting from another object 2 ---------- </maml:title><maml:introduction></maml:introduction><dev:code> $list = @()
$list += [PSCustomObject]@{ Type = "Foo"; ID = 1 }
$list += [PSCustomObject]@{ Type = "Bar"; ID = 2 }
$obj | Select-DbaObject Name, "ID from list WHERE Type = Name" </dev:code><dev:remarks><maml:para> This allows you to LEFT JOIN contents of another variable. Note that it can only do simple property-matching at this point.
 </maml:para><maml:para> It will select Name from the objects stored in $obj, and for each of those the ID Property on any object in $list that has a Type property of equal value as Name on the input.
 </maml:para><maml:para> _ </maml:para></dev:remarks></command:example><command:example><maml:title> ---------------- Example 5: Naming and styling ---------------- </maml:title><maml:introduction></maml:introduction><dev:code> Get-ChildItem | Select-DbaObject Name, Length, FullName, Used, LastWriteTime, Mode -TypeName MyType -ShowExcludeProperty Mode, Used </dev:code><dev:remarks><maml:para> Lists all items in the current path, selects the properties specified (whether they exist or not) , then ...
 </maml:para><maml:para> - Sets the name to "MyType"
 </maml:para><maml:para> - Hides the properties "Mode" and "Used" from the default display set, causing them to be hidden from default view </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Documentation</maml:linkText><maml:uri>https://dbatools.io/Select-DbaObject</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Set-DbatoolsConfig</command:name><command:noun>DbatoolsConfig</command:noun><command:verb>Set</command:verb><maml:description><maml:para>Sets configuration entries.</maml:para></maml:description></command:details><maml:description><maml:para>This function creates or changes configuration values. These can be used to provide dynamic configuration information outside the PowerShell variable system.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-DbatoolsConfig</maml:name><command:parameter required="true" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FullName</maml:name><maml:description><maml:para>The full name of a configuration element. Must be namespaced &lt;dbatools&gt;.&lt;Name&gt;. The name can have any number of sub-segments, in order to better group configurations thematically.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Value</maml:name><maml:description><maml:para>The value to assign to the named configuration element.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object</command:parameterValue><dev:type><maml:name>System.Object</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>Using this, the configuration setting is given a description, making it easier for a user to comprehend, what a specific setting is for.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Validation</maml:name><maml:description><maml:para>The name of the validation script used for input validation. These can be used to validate make sure that input is of the proper data type. New validation scripts can be registered using Register-DbatoolsConfigValidation</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Handler</maml:name><maml:description><maml:para>A scriptblock that is executed when a value is being set. Is only executed if the validation was successful (assuming there was a validation, of course)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Scriptblock</command:parameterValue><dev:type><maml:name>Scriptblock</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Hidden</maml:name><maml:description><maml:para>Setting this parameter hides the configuration from casual discovery. Configurations with this set will only be returned by Get-Config, if the parameter "-Force" is used. This should be set for all system settings a user should have no business changing (e.g. for Infrastructure related settings such as mail server).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Default</maml:name><maml:description><maml:para>Setting this parameter causes the system to treat this configuration as a default setting. If the configuration already exists, no changes will be performed. Useful in scenarios where for some reason it is not practical to automatically set defaults before loading userprofiles.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Use this when setting configurations as part of module import. When initializing a configuration, it will only do a thing if the configuration hasn't already been initialized (So if you load the module multiple times or in multiple runspaces, it won't make a difference) Also, if there already was a non-initialized setting set for a given configuration, it will then try to set the old value again. This value will be processed by handlers, if any are set.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SimpleExport</maml:name><maml:description><maml:para>Enabling this will cause the module to use friendly json notation on export to file. This may result in loss of data precision, but makes it easier to edit settings in file.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ModuleExport</maml:name><maml:description><maml:para>Using 'Export-DbatoolsConfig -ModuleName &lt;dbatools&gt;' settings flagged with this switch will be exported to a default path if they have been changed from the initial default value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableValidation</maml:name><maml:description><maml:para>This parameters disables the input validation - if any - when processing a setting. Normally this shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableHandler</maml:name><maml:description><maml:para>This parameter disables the configuration handlers. Configuration handlers are designed to automatically process input set to a config value, in addition to writing the value. In many cases, this is used to improve performance, by forking the value location also to a static C#-field, which is then used, rather than searching a Hashtable. Normally these shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PassThru</maml:name><maml:description><maml:para>Return the changed configuration setting object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Register</maml:name><maml:description></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-DbatoolsConfig</maml:name><command:parameter required="true" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FullName</maml:name><maml:description><maml:para>The full name of a configuration element. Must be namespaced &lt;dbatools&gt;.&lt;Name&gt;. The name can have any number of sub-segments, in order to better group configurations thematically.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PersistedValue</maml:name><maml:description><maml:para>In most circumstances an internal parameter. Applies the serialized value to a setting. Used for restoring data from configuration files that should only be deserialized when the module consuming it is already imported.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PersistedType</maml:name><maml:description><maml:para>In most circumstances an internal parameter. Paired with PersistedValue, used to specify the data type of the serialized object set in its serialized state.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Configuration.ConfigurationValueType</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Configuration.ConfigurationValueType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>Using this, the configuration setting is given a description, making it easier for a user to comprehend, what a specific setting is for.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Validation</maml:name><maml:description><maml:para>The name of the validation script used for input validation. These can be used to validate make sure that input is of the proper data type. New validation scripts can be registered using Register-DbatoolsConfigValidation</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Handler</maml:name><maml:description><maml:para>A scriptblock that is executed when a value is being set. Is only executed if the validation was successful (assuming there was a validation, of course)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Scriptblock</command:parameterValue><dev:type><maml:name>Scriptblock</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Hidden</maml:name><maml:description><maml:para>Setting this parameter hides the configuration from casual discovery. Configurations with this set will only be returned by Get-Config, if the parameter "-Force" is used. This should be set for all system settings a user should have no business changing (e.g. for Infrastructure related settings such as mail server).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Default</maml:name><maml:description><maml:para>Setting this parameter causes the system to treat this configuration as a default setting. If the configuration already exists, no changes will be performed. Useful in scenarios where for some reason it is not practical to automatically set defaults before loading userprofiles.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Use this when setting configurations as part of module import. When initializing a configuration, it will only do a thing if the configuration hasn't already been initialized (So if you load the module multiple times or in multiple runspaces, it won't make a difference) Also, if there already was a non-initialized setting set for a given configuration, it will then try to set the old value again. This value will be processed by handlers, if any are set.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SimpleExport</maml:name><maml:description><maml:para>Enabling this will cause the module to use friendly json notation on export to file. This may result in loss of data precision, but makes it easier to edit settings in file.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ModuleExport</maml:name><maml:description><maml:para>Using 'Export-DbatoolsConfig -ModuleName &lt;dbatools&gt;' settings flagged with this switch will be exported to a default path if they have been changed from the initial default value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableValidation</maml:name><maml:description><maml:para>This parameters disables the input validation - if any - when processing a setting. Normally this shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableHandler</maml:name><maml:description><maml:para>This parameter disables the configuration handlers. Configuration handlers are designed to automatically process input set to a config value, in addition to writing the value. In many cases, this is used to improve performance, by forking the value location also to a static C#-field, which is then used, rather than searching a Hashtable. Normally these shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PassThru</maml:name><maml:description><maml:para>Return the changed configuration setting object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Register</maml:name><maml:description></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-DbatoolsConfig</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Module</maml:name><maml:description><maml:para>This allows grouping configuration elements into groups based on the module/component they serve. If this parameter is not set, the configuration element must have a module name in the name parameter (the first segment will be taken, irrespective of whether that makes sense).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>Name of the configuration entry. If an entry of exactly this non-casesensitive name already exists, its value will be overwritten. Duplicate names across different modules are possible and will be treated separately. If a name contains namespace notation and no module is set, the first namespace element will be used as module instead of name. Example: -Name "Nordwind.Server" Is Equivalent to -Name "Server" -Module "Nordwind"</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Value</maml:name><maml:description><maml:para>The value to assign to the named configuration element.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object</command:parameterValue><dev:type><maml:name>System.Object</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>Using this, the configuration setting is given a description, making it easier for a user to comprehend, what a specific setting is for.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Validation</maml:name><maml:description><maml:para>The name of the validation script used for input validation. These can be used to validate make sure that input is of the proper data type. New validation scripts can be registered using Register-DbatoolsConfigValidation</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Handler</maml:name><maml:description><maml:para>A scriptblock that is executed when a value is being set. Is only executed if the validation was successful (assuming there was a validation, of course)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Scriptblock</command:parameterValue><dev:type><maml:name>Scriptblock</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Hidden</maml:name><maml:description><maml:para>Setting this parameter hides the configuration from casual discovery. Configurations with this set will only be returned by Get-Config, if the parameter "-Force" is used. This should be set for all system settings a user should have no business changing (e.g. for Infrastructure related settings such as mail server).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Default</maml:name><maml:description><maml:para>Setting this parameter causes the system to treat this configuration as a default setting. If the configuration already exists, no changes will be performed. Useful in scenarios where for some reason it is not practical to automatically set defaults before loading userprofiles.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Use this when setting configurations as part of module import. When initializing a configuration, it will only do a thing if the configuration hasn't already been initialized (So if you load the module multiple times or in multiple runspaces, it won't make a difference) Also, if there already was a non-initialized setting set for a given configuration, it will then try to set the old value again. This value will be processed by handlers, if any are set.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SimpleExport</maml:name><maml:description><maml:para>Enabling this will cause the module to use friendly json notation on export to file. This may result in loss of data precision, but makes it easier to edit settings in file.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ModuleExport</maml:name><maml:description><maml:para>Using 'Export-DbatoolsConfig -ModuleName &lt;dbatools&gt;' settings flagged with this switch will be exported to a default path if they have been changed from the initial default value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableValidation</maml:name><maml:description><maml:para>This parameters disables the input validation - if any - when processing a setting. Normally this shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableHandler</maml:name><maml:description><maml:para>This parameter disables the configuration handlers. Configuration handlers are designed to automatically process input set to a config value, in addition to writing the value. In many cases, this is used to improve performance, by forking the value location also to a static C#-field, which is then used, rather than searching a Hashtable. Normally these shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PassThru</maml:name><maml:description><maml:para>Return the changed configuration setting object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Register</maml:name><maml:description></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Default</maml:name><maml:description><maml:para>Setting this parameter causes the system to treat this configuration as a default setting. If the configuration already exists, no changes will be performed. Useful in scenarios where for some reason it is not practical to automatically set defaults before loading userprofiles.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>Using this, the configuration setting is given a description, making it easier for a user to comprehend, what a specific setting is for.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableHandler</maml:name><maml:description><maml:para>This parameter disables the configuration handlers. Configuration handlers are designed to automatically process input set to a config value, in addition to writing the value. In many cases, this is used to improve performance, by forking the value location also to a static C#-field, which is then used, rather than searching a Hashtable. Normally these shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableValidation</maml:name><maml:description><maml:para>This parameters disables the input validation - if any - when processing a setting. Normally this shouldn't be circumvented, but just in case, it can be disabled.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FullName</maml:name><maml:description><maml:para>The full name of a configuration element. Must be namespaced &lt;dbatools&gt;.&lt;Name&gt;. The name can have any number of sub-segments, in order to better group configurations thematically.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Handler</maml:name><maml:description><maml:para>A scriptblock that is executed when a value is being set. Is only executed if the validation was successful (assuming there was a validation, of course)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Scriptblock</command:parameterValue><dev:type><maml:name>Scriptblock</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Hidden</maml:name><maml:description><maml:para>Setting this parameter hides the configuration from casual discovery. Configurations with this set will only be returned by Get-Config, if the parameter "-Force" is used. This should be set for all system settings a user should have no business changing (e.g. for Infrastructure related settings such as mail server).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Use this when setting configurations as part of module import. When initializing a configuration, it will only do a thing if the configuration hasn't already been initialized (So if you load the module multiple times or in multiple runspaces, it won't make a difference) Also, if there already was a non-initialized setting set for a given configuration, it will then try to set the old value again. This value will be processed by handlers, if any are set.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Module</maml:name><maml:description><maml:para>This allows grouping configuration elements into groups based on the module/component they serve. If this parameter is not set, the configuration element must have a module name in the name parameter (the first segment will be taken, irrespective of whether that makes sense).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ModuleExport</maml:name><maml:description><maml:para>Using 'Export-DbatoolsConfig -ModuleName &lt;dbatools&gt;' settings flagged with this switch will be exported to a default path if they have been changed from the initial default value.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>Name of the configuration entry. If an entry of exactly this non-casesensitive name already exists, its value will be overwritten. Duplicate names across different modules are possible and will be treated separately. If a name contains namespace notation and no module is set, the first namespace element will be used as module instead of name. Example: -Name "Nordwind.Server" Is Equivalent to -Name "Server" -Module "Nordwind"</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PassThru</maml:name><maml:description><maml:para>Return the changed configuration setting object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PersistedType</maml:name><maml:description><maml:para>In most circumstances an internal parameter. Paired with PersistedValue, used to specify the data type of the serialized object set in its serialized state.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Configuration.ConfigurationValueType</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Configuration.ConfigurationValueType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PersistedValue</maml:name><maml:description><maml:para>In most circumstances an internal parameter. Applies the serialized value to a setting. Used for restoring data from configuration files that should only be deserialized when the module consuming it is already imported.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Register</maml:name><maml:description></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SimpleExport</maml:name><maml:description><maml:para>Enabling this will cause the module to use friendly json notation on export to file. This may result in loss of data precision, but makes it easier to edit settings in file.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Validation</maml:name><maml:description><maml:para>The name of the validation script used for input validation. These can be used to validate make sure that input is of the proper data type. New validation scripts can be registered using Register-DbatoolsConfigValidation</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Value</maml:name><maml:description><maml:para>The value to assign to the named configuration element.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object</command:parameterValue><dev:type><maml:name>System.Object</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:returnValues><command:returnValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Configuration.Config</maml:name><maml:uri /><maml:description /></dev:type></command:returnValue></command:returnValues><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> ---------------------- Example 1: Simple ---------------------- </maml:title><maml:introduction></maml:introduction><dev:code> C:\PS&gt; Set-DbatoolsConfig -FullName Path.DbatoolsData -Value E:\temp\dbatools </dev:code><dev:remarks><maml:para> Updates the configuration entry for Path.DbatoolsData to E:\temp\dbatools </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Documentation</maml:linkText><maml:uri>https://dbatools.io/Set-DbatoolsConfig</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaAgDatabase</command:name><command:noun>DbaAgDatabase</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds a database to an availability group on a SQL Server instance.</maml:para></maml:description></command:details><maml:description><maml:para>Adds a database to an availability group on a SQL Server instance.</maml:para><maml:para>Before joining the replica databases to the availablity group, the databases will be initialized with automatic seeding or full/log backup.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaAgDatabase</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.

This should be the primary replica.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AvailabilityGroup</maml:name><maml:description><maml:para>The availability group where the databases will be added.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database or databases to add.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Secondary</maml:name><maml:description><maml:para>Not required - the command will figure this out. But if you'd like to be explicit about replicas, this will help.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecondarySqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaDatabase, Get-DbaDbSharePoint and more.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Database[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Database[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="7" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SeedingMode</maml:name><maml:description><maml:para>Specifies how the secondary replica will be initially seeded. Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. If not specified, the setting from the availability group replica will be used. Otherwise the setting will be updated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="8" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SharedPath</maml:name><maml:description><maml:para>The network share where the backups will be backed up and restored from. Each SQL Server service account must have access to this share. NOTE: If a backup / restore is performed, the backups will be left in tact on the network share.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>UseLastBackup</maml:name><maml:description><maml:para>Use the last full backup of database.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AvailabilityGroup</maml:name><maml:description><maml:para>The availability group where the databases will be added.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database or databases to add.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaDatabase, Get-DbaDbSharePoint and more.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Database[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Database[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Secondary</maml:name><maml:description><maml:para>Not required - the command will figure this out. But if you'd like to be explicit about replicas, this will help.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecondarySqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SeedingMode</maml:name><maml:description><maml:para>Specifies how the secondary replica will be initially seeded.

Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.

Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.

If not specified, the setting from the availability group replica will be used. Otherwise the setting will be updated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SharedPath</maml:name><maml:description><maml:para>The network share where the backups will be backed up and restored from.

Each SQL Server service account must have access to this share.

NOTE: If a backup / restore is performed, the backups will be left in tact on the network share.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.

This should be the primary replica.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>UseLastBackup</maml:name><maml:description><maml:para>Use the last full backup of database.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1, db2 -Confirm </dev:code><dev:remarks><maml:para> Adds db1 and db2 to ag1 on sql2017a. Prompts for confirmation. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaDatabase -SqlInstance sql2017a | Out-GridView -Passthru | Add-DbaAgDatabase -AvailabilityGroup ag1 </dev:code><dev:remarks><maml:para> Adds selected databases from sql2017a to ag1 </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaDbSharePoint -SqlInstance sqlcluster | Add-DbaAgDatabase -AvailabilityGroup SharePoint </dev:code><dev:remarks><maml:para> Adds SharePoint databases as found in SharePoint_Config on sqlcluster to ag1 on sqlcluster </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaDbSharePoint -SqlInstance sqlcluster -ConfigDatabase SharePoint_Config_2019 | Add-DbaAgDatabase -AvailabilityGroup SharePoint </dev:code><dev:remarks><maml:para> Adds SharePoint databases as found in SharePoint_Config_2019 on sqlcluster to ag1 on sqlcluster </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaAgDatabase</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaAgListener</command:name><command:noun>DbaAgListener</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds a listener to an availability group on a SQL Server instance.</maml:para></maml:description></command:details><maml:description><maml:para>Adds a listener to an availability group on a SQL Server instance.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaAgListener</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AvailabilityGroup</maml:name><maml:description><maml:para>The Availability Group to which a listener will be bestowed upon.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>The name of the listener. If one is not specified, the Availability Group name will be used.

Note that Name cannot be used with Multiple Ags.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>IPAddress</maml:name><maml:description><maml:para>Sets the IP address(es) of the availability group listener.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Net.IPAddress[]</command:parameterValue><dev:type><maml:name>System.Net.IPAddress[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SubnetIP</maml:name><maml:description><maml:para>Sets the Subnet IP address(es) of the availability group listener.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Net.IPAddress[]</command:parameterValue><dev:type><maml:name>System.Net.IPAddress[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SubnetMask</maml:name><maml:description><maml:para>Sets the subnet IP mask(s) of the availability group listener. Defaults to 255.255.255.0.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Net.IPAddress[]</command:parameterValue><dev:type><maml:name>System.Net.IPAddress[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="7" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Port</maml:name><maml:description><maml:para>Sets the port number used to communicate with the availability group. Defaults to 1433.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Dhcp</maml:name><maml:description><maml:para>Indicates whether the listener uses DHCP.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Passthru</maml:name><maml:description><maml:para>Don't create the listener, just pass thru an object that can be further customized before creation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="8" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaAvailabilityGroup</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AvailabilityGroup</maml:name><maml:description><maml:para>The Availability Group to which a listener will be bestowed upon.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Dhcp</maml:name><maml:description><maml:para>Indicates whether the listener uses DHCP.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaAvailabilityGroup</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>IPAddress</maml:name><maml:description><maml:para>Sets the IP address(es) of the availability group listener.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Net.IPAddress[]</command:parameterValue><dev:type><maml:name>System.Net.IPAddress[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>The name of the listener. If one is not specified, the Availability Group name will be used. Note that Name cannot be used with Multiple Ags.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Passthru</maml:name><maml:description><maml:para>Don't create the listener, just pass thru an object that can be further customized before creation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Port</maml:name><maml:description><maml:para>Sets the port number used to communicate with the availability group. Defaults to 1433.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SubnetIP</maml:name><maml:description><maml:para>Sets the Subnet IP address(es) of the availability group listener.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Net.IPAddress[]</command:parameterValue><dev:type><maml:name>System.Net.IPAddress[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SubnetMask</maml:name><maml:description><maml:para>Sets the subnet IP mask(s) of the availability group listener. Defaults to 255.255.255.0.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Net.IPAddress[]</command:parameterValue><dev:type><maml:name>System.Net.IPAddress[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaAgListener -SqlInstance sql2017 -AvailabilityGroup SharePoint -IPAddress 10.0.20.20 </dev:code><dev:remarks><maml:para> Creates a listener on 10.0.20.20 port 1433 for the SharePoint availability group on sql2017. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaAvailabilityGroup -SqlInstance sql2017 -AvailabilityGroup availabilitygroup1 | Add-DbaAgListener -Dhcp </dev:code><dev:remarks><maml:para> Creates a listener on port 1433 with a dynamic IP for the group1 availability group on sql2017. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaAgListener -SqlInstance sql2017 -AvailabilityGroup SharePoint -IPAddress 10.0.20.20,10.1.77.77 -SubnetMask 255.255.252.0 </dev:code><dev:remarks><maml:para> Creates a multi-subnet listener with 10.0.20.20 and 10.1.77.77, on two /22 subnets, on port 1433 for the SharePoint availability group on sql2017. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaAgListener</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaAgReplica</command:name><command:noun>DbaAgReplica</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds a replica to an availability group on a SQL Server instance.</maml:para></maml:description></command:details><maml:description><maml:para>Adds a replica to an availability group on a SQL Server instance.</maml:para><maml:para>Automatically creates a database mirroring endpoint if required.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaAgReplica</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>The name of the replica. Defaults to the SQL Server instance name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AvailabilityMode</maml:name><maml:description><maml:para>Sets the availability mode of the availability group replica. Options are: AsynchronousCommit and SynchronousCommit. SynchronousCommit is default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FailoverMode</maml:name><maml:description><maml:para>Sets the failover mode of the availability group replica. Options are Automatic and Manual. Automatic is default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BackupPriority</maml:name><maml:description><maml:para>Sets the backup priority availability group replica. Default is 50.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectionModeInPrimaryRole</maml:name><maml:description><maml:para>Specifies the connection intent modes of an Availability Replica in primary role. AllowAllConnections by default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="7" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectionModeInSecondaryRole</maml:name><maml:description><maml:para>Specifies the connection modes of an Availability Replica in secondary role. AllowAllConnections by default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="8" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SeedingMode</maml:name><maml:description><maml:para>Specifies how the secondary replica will be initially seeded.

Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.

Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="9" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Endpoint</maml:name><maml:description><maml:para>By default, this command will attempt to find a DatabaseMirror endpoint. If one does not exist, it will create it.

If an endpoint must be created, the name "hadr_endpoint" will be used. If an alternative is preferred, use Endpoint.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Passthru</maml:name><maml:description><maml:para>Don't create the replica, just pass thru an object that can be further customized before creation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="10" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ReadonlyRoutingConnectionUrl</maml:name><maml:description><maml:para>Sets the read only routing connection url for the availability replica.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="11" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Certificate</maml:name><maml:description><maml:para>Specifies that the endpoint is to authenticate the connection using the certificate specified by certificate_name to establish identity for authorization. The far endpoint must have a certificate with the public key matching the private key of the specified certificate.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="12" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaAvailabilityGroup.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Microsoft.SqlServer.Management.Smo.AvailabilityGroup</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.AvailabilityGroup</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AvailabilityMode</maml:name><maml:description><maml:para>Sets the availability mode of the availability group replica. Options are: AsynchronousCommit and SynchronousCommit. SynchronousCommit is default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BackupPriority</maml:name><maml:description><maml:para>Sets the backup priority availability group replica. Default is 50.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Certificate</maml:name><maml:description><maml:para>Specifies that the endpoint is to authenticate the connection using the certificate specified by certificate_name to establish identity for authorization. The far endpoint must have a certificate with the public key matching the private key of the specified certificate.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectionModeInPrimaryRole</maml:name><maml:description><maml:para>Specifies the connection intent modes of an Availability Replica in primary role. AllowAllConnections by default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectionModeInSecondaryRole</maml:name><maml:description><maml:para>Specifies the connection modes of an Availability Replica in secondary role. AllowAllConnections by default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Endpoint</maml:name><maml:description><maml:para>By default, this command will attempt to find a DatabaseMirror endpoint. If one does not exist, it will create it. If an endpoint must be created, the name "hadr_endpoint" will be used. If an alternative is preferred, use Endpoint.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FailoverMode</maml:name><maml:description><maml:para>Sets the failover mode of the availability group replica. Options are Automatic and Manual. Automatic is default.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaAvailabilityGroup.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.AvailabilityGroup</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.AvailabilityGroup</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>The name of the replica. Defaults to the SQL Server instance name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Passthru</maml:name><maml:description><maml:para>Don't create the replica, just pass thru an object that can be further customized before creation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ReadonlyRoutingConnectionUrl</maml:name><maml:description><maml:para>Sets the read only routing connection url for the availability replica.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SeedingMode</maml:name><maml:description><maml:para>Specifies how the secondary replica will be initially seeded.

Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.

Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup SharePoint | Add-DbaAgReplica -SqlInstance sql2017b </dev:code><dev:remarks><maml:para> Adds sql2017b to the SharePoint availability group on sql2017a </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup SharePoint | Add-DbaAgReplica -SqlInstance sql2017b -FailoverMode Manual </dev:code><dev:remarks><maml:para> Adds sql2017b to the SharePoint availability group on sql2017a with a manual failover mode. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaAgReplica</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaComputerCertificate</command:name><command:noun>DbaComputerCertificate</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds a computer certificate - useful for older systems.</maml:para></maml:description></command:details><maml:description><maml:para>Adds a computer certificate from a local or remote computer.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaComputerCertificate</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ComputerName</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Defaults to localhost.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Allows you to login to $ComputerName using alternative credentials.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecurePassword</maml:name><maml:description><maml:para>The password for the certificate, if it is password protected.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>Certificate</maml:name><maml:description><maml:para>The target certificate object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Security.Cryptography.X509Certificates.X509Certificate2[]</command:parameterValue><dev:type><maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The local path to the target certificate object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Store</maml:name><maml:description><maml:para>Certificate store. Default is LocalMachine.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Folder</maml:name><maml:description><maml:para>Certificate folder. Default is My (Personal).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Certificate</maml:name><maml:description><maml:para>The target certificate object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Security.Cryptography.X509Certificates.X509Certificate2[]</command:parameterValue><dev:type><maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ComputerName</maml:name><maml:description><maml:para>The target SQL Server instance or instances. Defaults to localhost.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Allows you to login to $ComputerName using alternative credentials.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Folder</maml:name><maml:description><maml:para>Certificate folder. Default is My (Personal).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The local path to the target certificate object.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecurePassword</maml:name><maml:description><maml:para>The password for the certificate, if it is password protected.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Store</maml:name><maml:description><maml:para>Certificate store. Default is LocalMachine.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Certificate
Author: Chrissy LeMaire (@cl), netnerds.net

Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaComputerCertificate -ComputerName Server1 -Path C:\temp\cert.cer </dev:code><dev:remarks><maml:para> Adds the local C:\temp\cert.cer to the remote server Server1 in LocalMachine\My (Personal). </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaComputerCertificate -Path C:\temp\cert.cer </dev:code><dev:remarks><maml:para> Adds the local C:\temp\cert.cer to the local computer's LocalMachine\My (Personal) certificate store. </maml:para></dev:remarks></command:example></command:examples></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaDbMirrorMonitor</command:name><command:noun>DbaDbMirrorMonitor</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Creates a database mirroring monitor job that periodically updates the mirroring status for every mirrored database on the server instance.</maml:para></maml:description></command:details><maml:description><maml:para>Creates a database mirroring monitor job that periodically updates the mirroring status for every mirrored database on the server instance.</maml:para><maml:para>Basically executes sp_dbmmonitoraddmonitoring.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaDbMirrorMonitor</maml:name><command:parameter required="true" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternate Windows or SQL Login Authentication. Accepts credential objects (Get-Credential).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternate Windows or SQL Login Authentication. Accepts credential objects (Get-Credential).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Mirror, HA Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaDbMirrorMonitor -SqlInstance sql2008, sql2012 </dev:code><dev:remarks><maml:para> Creates a database mirroring monitor job that periodically updates the mirroring status for every mirrored database on sql2008 and sql2012. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaDbMirrorMonitor</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaDbRoleMember</command:name><command:noun>DbaDbRoleMember</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds a Database User to a database role for each instance(s) of SQL Server.</maml:para></maml:description></command:details><maml:description><maml:para>The Add-DbaDbRoleMember adds users in a database to a database role or roles for each instance(s) of SQL Server.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaDbRoleMember</maml:name><command:parameter required="false" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternate Windows or SQL Login Authentication. Accepts credential objects (Get-Credential).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Role</maml:name><maml:description><maml:para>The role(s) to process.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>User</maml:name><maml:description><maml:para>The user(s) to add to role(s) specified.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piped input from Get-DbaDbRole or Get-DbaDatabase</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piped input from Get-DbaDbRole or Get-DbaDatabase</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Role</maml:name><maml:description><maml:para>The role(s) to process.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternate Windows or SQL Login Authentication. Accepts credential objects (Get-Credential).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>User</maml:name><maml:description><maml:para>The user(s) to add to role(s) specified.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Role, Database, Security, Login Author: Ben Miller (@DBAduck) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaDbRoleMember -SqlInstance localhost -Database mydb -Role db_owner -DatabaseUser user1 </dev:code><dev:remarks><maml:para> Adds user1 to the role db_owner in the database mydb on the local default SQL Server instance </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaDbRoleMember -SqlInstance localhost, sql2016 -Role SqlAgentOperatorRole -User user1 -Database msdb </dev:code><dev:remarks><maml:para> Adds user1 in servers localhost and sql2016 in the msdb database to the SqlAgentOperatorRole </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> $servers = Get-Content C:\servers.txt </dev:code><dev:remarks><maml:para> PS C:\&gt; $servers | Add-DbaDbRoleMember -Role SqlAgentOperatorRole -User user1 -Database msdb Adds user1 to the SqlAgentOperatorROle in the msdb database in every server in C:\servers.txt </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaDbRoleMember -SqlInstance localhost -Role "db_datareader","db_datawriter" -User user1 -Database DEMODB </dev:code><dev:remarks><maml:para> Adds user1 in the database DEMODB on the server localhost to the roles db_datareader and db_datawriter </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> $roles = Get-DbaDbRole -SqlInstance localhost -Role "db_datareader","db_datawriter" -Database DEMODB </dev:code><dev:remarks><maml:para> PS C:\&gt; $roles | Add-DbaDbRoleMember -User user1 Adds user1 in the database DEMODB on the server localhost to the roles db_datareader and db_datawriter </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaDbRoleMember</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaPfDataCollectorCounter</command:name><command:noun>DbaPfDataCollectorCounter</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds a Performance Data Collector Counter.</maml:para></maml:description></command:details><maml:description><maml:para>Adds a Performance Data Collector Counter.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaPfDataCollectorCounter</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ComputerName</maml:name><maml:description><maml:para>The target computer. Defaults to localhost.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Allows you to login to $ComputerName using alternative credentials. To use: $cred = Get-Credential, then pass $cred object to the -Credential parameter.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CollectorSet</maml:name><maml:description><maml:para>The Collector Set name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Collector</maml:name><maml:description><maml:para>The Collector name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="4" pipelineInput="True (ByPropertyName)" aliases="" variableLength="true" globbing="false"><maml:name>Counter</maml:name><maml:description><maml:para>The Counter name. This must be in the form of '\Processor(_Total)\% Processor Time'.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Accepts the object output by Get-DbaPfDataCollector via the pipeline.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Collector</maml:name><maml:description><maml:para>The Collector name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CollectorSet</maml:name><maml:description><maml:para>The Collector Set name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ComputerName</maml:name><maml:description><maml:para>The target computer. Defaults to localhost.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Counter</maml:name><maml:description><maml:para>The Counter name. This must be in the form of '\Processor(_Total)\% Processor Time'.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Allows you to login to $ComputerName using alternative credentials. To use: $cred = Get-Credential, then pass $cred object to the -Credential parameter.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Accepts the object output by Get-DbaPfDataCollector via the pipeline.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: PerfMon Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaPfDataCollectorCounter -ComputerName sql2017 -CollectorSet 'System Correlation' -Collector DataCollector01 -Counter '\LogicalDisk(*)\Avg. Disk Queue Length' </dev:code><dev:remarks><maml:para> Adds the '\LogicalDisk(*)\Avg. Disk Queue Length' counter within the DataCollector01 collector within the System Correlation collector set on sql2017. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaPfDataCollector | Out-GridView -PassThru | Add-DbaPfDataCollectorCounter -Counter '\LogicalDisk(*)\Avg. Disk Queue Length' -Confirm </dev:code><dev:remarks><maml:para> Allows you to select which Data Collector you'd like to add the counter '\LogicalDisk(*)\Avg. Disk Queue Length' on localhost and prompts for confirmation. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaPfDataCollectorCounter</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaRegServer</command:name><command:noun>DbaRegServer</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds registered servers to SQL Server Central Management Server (CMS) or Local Server Groups</maml:para></maml:description></command:details><maml:description><maml:para>Adds registered servers to SQL Server Central Management Server (CMS) or Local Server Groups. If you need more flexiblity, look into Import-DbaRegServer which</maml:para><maml:para>accepts multiple kinds of input and allows you to add reg servers from different CMSes.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaRegServer</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance if a CMS is used</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ServerName</maml:name><maml:description><maml:para>Server Name is the actual SQL instance name (labeled Server Name)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>Name is basically the nickname in SSMS Registered Server interface (labeled Registered Server Name)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>Adds a description for the registered server</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Group</maml:name><maml:description><maml:para>Adds the registered server to a specific group.
If group does not exist it will be created</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object</command:parameterValue><dev:type><maml:name>System.Object</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ActiveDirectoryTenant</maml:name><maml:description><maml:para>Active Directory Tenant</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="7" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ActiveDirectoryUserId</maml:name><maml:description><maml:para>Active Directory User id</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="8" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectionString</maml:name><maml:description><maml:para>SQL Server connection string</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="9" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>OtherParams</maml:name><maml:description><maml:para>Additional parameters to append to the connection string</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="10" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Allows the piping of a registered server group</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="11" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>ServerObject</maml:name><maml:description><maml:para>SMO Server Objects (from Connect-DbaInstance)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Server[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Server[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.

This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.

Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ActiveDirectoryTenant</maml:name><maml:description><maml:para>Active Directory Tenant</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ActiveDirectoryUserId</maml:name><maml:description><maml:para>Active Directory User id</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectionString</maml:name><maml:description><maml:para>SQL Server connection string</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>Adds a description for the registered server</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.

This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.

Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Group</maml:name><maml:description><maml:para>Adds the registered server to a specific group.
If group does not exist it will be created</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object</command:parameterValue><dev:type><maml:name>System.Object</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Allows the piping of a registered server group</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>Name is basically the nickname in SSMS Registered Server interface (labeled Registered Server Name)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>OtherParams</maml:name><maml:description><maml:para>Additional parameters to append to the connection string</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ServerName</maml:name><maml:description><maml:para>Server Name is the actual SQL instance name (labeled Server Name)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ServerObject</maml:name><maml:description><maml:para>SMO Server Objects (from Connect-DbaInstance)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Server[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Server[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance if a CMS is used</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: RegisteredServer, CMS
Author: Chrissy LeMaire (@cl), netnerds.net

Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaRegServer -SqlInstance sql2008 -ServerName sql01 </dev:code><dev:remarks><maml:para> Creates a registered server on sql2008's CMS which points to the SQL Server, sql01. When scrolling in CMS, the name "sql01" will be visible. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaRegServer -ServerName sql01 </dev:code><dev:remarks><maml:para> Creates a registered server in Local Server Groups which points to the SQL Server, sql01. When scrolling in Registered Servers, the name "sql01" will be visible. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaRegServer -SqlInstance sql2008 -ServerName sql01 -Name "The 2008 Clustered Instance" -Description "HR's Dedicated SharePoint instance" </dev:code><dev:remarks><maml:para> Creates a registered server on sql2008's CMS which points to the SQL Server, sql01. When scrolling in CMS, "The 2008 Clustered Instance" will be visible. Clearly this is hard to explain ;) </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaRegServer -SqlInstance sql2008 -ServerName sql01 -Group hr\Seattle </dev:code><dev:remarks><maml:para> Creates a registered server on sql2008's CMS which points to the SQL Server, sql01. When scrolling in CMS, the name "sql01" will be visible within the Seattle group which is in the hr group. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Connect-DbaInstance -SqlInstance dockersql1 -SqlCredential sqladmin | Add-DbaRegServer -ServerName mydockerjam </dev:code><dev:remarks><maml:para> Creates a registered server called "mydockerjam" in Local Server Groups that uses SQL authentication and points to the server dockersql1. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaRegServer</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Add-DbaRegServerGroup</command:name><command:noun>DbaRegServerGroup</command:noun><command:verb>Add</command:verb><maml:description><maml:para>Adds registered server groups to SQL Server Central Management Server (CMS)</maml:para></maml:description></command:details><maml:description><maml:para>Adds registered server groups to SQL Server Central Management Server (CMS). If you need more flexibility, look into Import-DbaRegServer which accepts multiple kinds of input and allows you to add reg servers and groups from different CMS.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-DbaRegServerGroup</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>The name of the registered server group.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>The description for the registered server group</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Group</maml:name><maml:description><maml:para>The SQL Server Central Management Server group. If no groups are specified, the new group will be created at the root. You can pass sub groups using the '\' to split the path. Group\SubGroup will create both folders. Folder 'SubGroup' under 'Group' folder.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Allows results from Get-DbaRegServerGroup to be piped in</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Description</maml:name><maml:description><maml:para>The description for the registered server group</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Group</maml:name><maml:description><maml:para>The SQL Server Central Management Server group. If no groups are specified, the new group will be created at the root. You can pass sub groups using the '\' to split the path. Group\SubGroup will create both folders. Folder 'SubGroup' under 'Group' folder.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Allows results from Get-DbaRegServerGroup to be piped in</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Name</maml:name><maml:description><maml:para>The name of the registered server group.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: RegisteredServer, CMS Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaRegServerGroup -SqlInstance sql2012 -Name HR </dev:code><dev:remarks><maml:para> Creates a registered server group called HR, in the root of sql2012's CMS </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Add-DbaRegServerGroup -SqlInstance sql2012, sql2014 -Name sub-folder -Group HR </dev:code><dev:remarks><maml:para> Creates a registered server group on sql2012 and sql2014 called sub-folder within the HR group </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaRegServerGroup -SqlInstance sql2012, sql2014 -Group HR | Add-DbaRegServerGroup -Name sub-folder </dev:code><dev:remarks><maml:para> Creates a registered server group on sql2012 and sql2014 called sub-folder within the HR group of each server </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Add-DbaRegServerGroup</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Backup-DbaDatabase</command:name><command:noun>DbaDatabase</command:noun><command:verb>Backup</command:verb><maml:description><maml:para>Backup one or more SQL Sever databases from a single SQL Server SqlInstance.</maml:para></maml:description></command:details><maml:description><maml:para>Performs a backup of a specified type of 1 or more databases on a single SQL Server Instance. These backups may be Full, Differential or Transaction log backups.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Backup-DbaDatabase</maml:name><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Credentials to connect to the SQL Server instance if the calling user does not have permission.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>The database(s) to exclude. This list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>Path in which to place the backup files. If not specified, the backups will be placed in the default backup location for SqlInstance. If multiple paths are specified, the backups will be striped across these locations. This will overwrite the FileCount option. If the path does not exist, Sql Server will attempt to create it. Folders are created by the Sql Instance, and checks will be made for write permissions. File Names with be suffixed with x-of-y to enable identifying striped sets, where y is the number of files in the set and x ranges from 1 to y.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FilePath</maml:name><maml:description><maml:para>The name of the file to backup to. This is only accepted for single database backups. If no name is specified then the backup files will be named DatabaseName_yyyyMMddHHmm (i.e. "Database1_201714022131") with the appropriate extension. If the same name is used repeatedly, SQL Server will add backups to the same file at an incrementing position. SQL Server needs permissions to write to the specified location. Path names are based on the SQL Server (C:\ is the C drive on the SQL Server, not the machine running the script). Passing in NUL as the FilePath will backup to the NUL: device</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ReplaceInName</maml:name><maml:description><maml:para>If this switch is set, the following list of strings will be replaced in the FilePath and Path strings: instancename - will be replaced with the instance Name servername - will be replaced with the server name dbname - will be replaced with the database name timestamp - will be replaced with the timestamp (either the default, or the format provided) backuptype - will be replaced with Full, Log or Differential as appropriate</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CopyOnly</maml:name><maml:description><maml:para>If this switch is enabled, CopyOnly backups will be taken. By default function performs a normal backup, these backups interfere with the restore chain of the database. CopyOnly backups will not interfere with the restore chain of the database. For more details please refer to this MSDN article - https://msdn.microsoft.com/en-us/library/ms191495.aspx</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Type</maml:name><maml:description><maml:para>The type of SQL Server backup to perform. Accepted values are "Full", "Log", "Differential", "Diff", "Database"</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CreateFolder</maml:name><maml:description><maml:para>If this switch is enabled, each database will be backed up into a separate folder on each of the paths specified by Path.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FileCount</maml:name><maml:description><maml:para>This is the number of striped copies of the backups you wish to create. This value is overwritten if you specify multiple Backup Directories.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CompressBackup</maml:name><maml:description><maml:para>If this switch is enabled, the function will try to perform a compressed backup if supported by the version and edition of SQL Server. Otherwise, this function will use the server(s) default setting for compression.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Checksum</maml:name><maml:description><maml:para>If this switch is enabled, the backup checksum will be calculated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Verify</maml:name><maml:description><maml:para>If this switch is enabled, the backup will be verified by running a RESTORE VERIFYONLY against the SqlInstance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MaxTransferSize</maml:name><maml:description><maml:para>Sets the size of the unit of transfer. Values must be a multiple of 64kb.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BlockSize</maml:name><maml:description><maml:para>Specifies the block size to use. Must be one of 0.5KB, 1KB, 2KB, 4KB, 8KB, 16KB, 32KB or 64KB. This can be specified in bytes. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BufferCount</maml:name><maml:description><maml:para>Number of I/O buffers to use to perform the operation. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureBaseUrl</maml:name><maml:description><maml:para>The URL(s) to the base container of an Azure Storage account to write backups to. If specifying the AzureCredential parameter you can only provide 1 value as page blobs do not support multiple URLs If useing Shared Access keys, you may specify as many URLs as you want, as long as a corresponding credential exists on the source server. If specified, the only other parameters than can be used are "CopyOnly", "Type", "CompressBackup", "Checksum", "Verify", "AzureCredential", "CreateFolder".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureCredential</maml:name><maml:description><maml:para>The name of the credential on the SQL instance that can write to the AzureBaseUrl, only needed if using Storage access keys If using SAS credentials, the command will look for a credential with a name matching the AzureBaseUrl. As page blobs are used with this option we force the number of files to 1 and ignore any value passed in for BlockSize or MaxTransferSize</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>NoRecovery</maml:name><maml:description><maml:para>This is passed in to perform a tail log backup if needed</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BuildPath</maml:name><maml:description><maml:para>By default this command will not attempt to create missing paths, this switch will change the behaviour so that it will</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>WithFormat</maml:name><maml:description><maml:para>Formats the media as the first step of the backup operation. NOTE: This will set Initialize and SkipTapeHeader to $true.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SkipTapeHeader</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TimeStampFormat</maml:name><maml:description><maml:para>By default the command timestamps backups using the format yyyyMMddHHmm. Using this parameter this can be overridden. The timestamp format should be defined using the Get-Date formats, illegal formats will cause an error to be thrown</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>IgnoreFileChecks</maml:name><maml:description><maml:para>This switch stops the function from checking for the validity of paths. This can be useful if SQL Server only has read access to the backup area. Note, that as we cannot check the path you may well end up with errors.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>OutputScriptOnly</maml:name><maml:description><maml:para>Switch causes only the T-SQL script for the backup to be generated. Will not create any paths if they do not exist</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Backup-DbaDatabase</maml:name><command:parameter required="true" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The SQL Server instance hosting the databases to be backed up.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">DbaInstanceParameter</command:parameterValue><dev:type><maml:name>DbaInstanceParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Credentials to connect to the SQL Server instance if the calling user does not have permission.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>The database(s) to exclude. This list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>Path in which to place the backup files. If not specified, the backups will be placed in the default backup location for SqlInstance. If multiple paths are specified, the backups will be striped across these locations. This will overwrite the FileCount option. If the path does not exist, Sql Server will attempt to create it. Folders are created by the Sql Instance, and checks will be made for write permissions. File Names with be suffixed with x-of-y to enable identifying striped sets, where y is the number of files in the set and x ranges from 1 to y.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FilePath</maml:name><maml:description><maml:para>The name of the file to backup to. This is only accepted for single database backups. If no name is specified then the backup files will be named DatabaseName_yyyyMMddHHmm (i.e. "Database1_201714022131") with the appropriate extension. If the same name is used repeatedly, SQL Server will add backups to the same file at an incrementing position. SQL Server needs permissions to write to the specified location. Path names are based on the SQL Server (C:\ is the C drive on the SQL Server, not the machine running the script). Passing in NUL as the FilePath will backup to the NUL: device</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ReplaceInName</maml:name><maml:description><maml:para>If this switch is set, the following list of strings will be replaced in the FilePath and Path strings: instancename - will be replaced with the instance Name servername - will be replaced with the server name dbname - will be replaced with the database name timestamp - will be replaced with the timestamp (either the default, or the format provided) backuptype - will be replaced with Full, Log or Differential as appropriate</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CopyOnly</maml:name><maml:description><maml:para>If this switch is enabled, CopyOnly backups will be taken. By default function performs a normal backup, these backups interfere with the restore chain of the database. CopyOnly backups will not interfere with the restore chain of the database. For more details please refer to this MSDN article - https://msdn.microsoft.com/en-us/library/ms191495.aspx</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Type</maml:name><maml:description><maml:para>The type of SQL Server backup to perform. Accepted values are "Full", "Log", "Differential", "Diff", "Database"</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CreateFolder</maml:name><maml:description><maml:para>If this switch is enabled, each database will be backed up into a separate folder on each of the paths specified by Path.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FileCount</maml:name><maml:description><maml:para>This is the number of striped copies of the backups you wish to create. This value is overwritten if you specify multiple Backup Directories.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CompressBackup</maml:name><maml:description><maml:para>If this switch is enabled, the function will try to perform a compressed backup if supported by the version and edition of SQL Server. Otherwise, this function will use the server(s) default setting for compression.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Checksum</maml:name><maml:description><maml:para>If this switch is enabled, the backup checksum will be calculated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Verify</maml:name><maml:description><maml:para>If this switch is enabled, the backup will be verified by running a RESTORE VERIFYONLY against the SqlInstance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MaxTransferSize</maml:name><maml:description><maml:para>Sets the size of the unit of transfer. Values must be a multiple of 64kb.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BlockSize</maml:name><maml:description><maml:para>Specifies the block size to use. Must be one of 0.5KB, 1KB, 2KB, 4KB, 8KB, 16KB, 32KB or 64KB. This can be specified in bytes. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BufferCount</maml:name><maml:description><maml:para>Number of I/O buffers to use to perform the operation. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureBaseUrl</maml:name><maml:description><maml:para>The URL(s) to the base container of an Azure Storage account to write backups to. If specifying the AzureCredential parameter you can only provide 1 value as page blobs do not support multiple URLs If useing Shared Access keys, you may specify as many URLs as you want, as long as a corresponding credential exists on the source server. If specified, the only other parameters than can be used are "CopyOnly", "Type", "CompressBackup", "Checksum", "Verify", "AzureCredential", "CreateFolder".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureCredential</maml:name><maml:description><maml:para>The name of the credential on the SQL instance that can write to the AzureBaseUrl, only needed if using Storage access keys If using SAS credentials, the command will look for a credential with a name matching the AzureBaseUrl. As page blobs are used with this option we force the number of files to 1 and ignore any value passed in for BlockSize or MaxTransferSize</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>NoRecovery</maml:name><maml:description><maml:para>This is passed in to perform a tail log backup if needed</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BuildPath</maml:name><maml:description><maml:para>By default this command will not attempt to create missing paths, this switch will change the behaviour so that it will</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>WithFormat</maml:name><maml:description><maml:para>Formats the media as the first step of the backup operation. NOTE: This will set Initialize and SkipTapeHeader to $true.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SkipTapeHeader</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TimeStampFormat</maml:name><maml:description><maml:para>By default the command timestamps backups using the format yyyyMMddHHmm. Using this parameter this can be overridden. The timestamp format should be defined using the Get-Date formats, illegal formats will cause an error to be thrown</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>IgnoreFileChecks</maml:name><maml:description><maml:para>This switch stops the function from checking for the validity of paths. This can be useful if SQL Server only has read access to the backup area. Note, that as we cannot check the path you may well end up with errors.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>OutputScriptOnly</maml:name><maml:description><maml:para>Switch causes only the T-SQL script for the backup to be generated. Will not create any paths if they do not exist</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Backup-DbaDatabase</maml:name><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Credentials to connect to the SQL Server instance if the calling user does not have permission.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>The database(s) to exclude. This list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>Path in which to place the backup files. If not specified, the backups will be placed in the default backup location for SqlInstance. If multiple paths are specified, the backups will be striped across these locations. This will overwrite the FileCount option. If the path does not exist, Sql Server will attempt to create it. Folders are created by the Sql Instance, and checks will be made for write permissions. File Names with be suffixed with x-of-y to enable identifying striped sets, where y is the number of files in the set and x ranges from 1 to y.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FilePath</maml:name><maml:description><maml:para>The name of the file to backup to. This is only accepted for single database backups. If no name is specified then the backup files will be named DatabaseName_yyyyMMddHHmm (i.e. "Database1_201714022131") with the appropriate extension. If the same name is used repeatedly, SQL Server will add backups to the same file at an incrementing position. SQL Server needs permissions to write to the specified location. Path names are based on the SQL Server (C:\ is the C drive on the SQL Server, not the machine running the script). Passing in NUL as the FilePath will backup to the NUL: device</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ReplaceInName</maml:name><maml:description><maml:para>If this switch is set, the following list of strings will be replaced in the FilePath and Path strings: instancename - will be replaced with the instance Name servername - will be replaced with the server name dbname - will be replaced with the database name timestamp - will be replaced with the timestamp (either the default, or the format provided) backuptype - will be replaced with Full, Log or Differential as appropriate</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CopyOnly</maml:name><maml:description><maml:para>If this switch is enabled, CopyOnly backups will be taken. By default function performs a normal backup, these backups interfere with the restore chain of the database. CopyOnly backups will not interfere with the restore chain of the database. For more details please refer to this MSDN article - https://msdn.microsoft.com/en-us/library/ms191495.aspx</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Type</maml:name><maml:description><maml:para>The type of SQL Server backup to perform. Accepted values are "Full", "Log", "Differential", "Diff", "Database"</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" position="named" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Internal parameter</maml:para></maml:description><command:parameterValue required="true" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CreateFolder</maml:name><maml:description><maml:para>If this switch is enabled, each database will be backed up into a separate folder on each of the paths specified by Path.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FileCount</maml:name><maml:description><maml:para>This is the number of striped copies of the backups you wish to create. This value is overwritten if you specify multiple Backup Directories.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CompressBackup</maml:name><maml:description><maml:para>If this switch is enabled, the function will try to perform a compressed backup if supported by the version and edition of SQL Server. Otherwise, this function will use the server(s) default setting for compression.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Checksum</maml:name><maml:description><maml:para>If this switch is enabled, the backup checksum will be calculated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Verify</maml:name><maml:description><maml:para>If this switch is enabled, the backup will be verified by running a RESTORE VERIFYONLY against the SqlInstance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MaxTransferSize</maml:name><maml:description><maml:para>Sets the size of the unit of transfer. Values must be a multiple of 64kb.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BlockSize</maml:name><maml:description><maml:para>Specifies the block size to use. Must be one of 0.5KB, 1KB, 2KB, 4KB, 8KB, 16KB, 32KB or 64KB. This can be specified in bytes. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BufferCount</maml:name><maml:description><maml:para>Number of I/O buffers to use to perform the operation. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureBaseUrl</maml:name><maml:description><maml:para>The URL(s) to the base container of an Azure Storage account to write backups to. If specifying the AzureCredential parameter you can only provide 1 value as page blobs do not support multiple URLs If useing Shared Access keys, you may specify as many URLs as you want, as long as a corresponding credential exists on the source server. If specified, the only other parameters than can be used are "CopyOnly", "Type", "CompressBackup", "Checksum", "Verify", "AzureCredential", "CreateFolder".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureCredential</maml:name><maml:description><maml:para>The name of the credential on the SQL instance that can write to the AzureBaseUrl, only needed if using Storage access keys If using SAS credentials, the command will look for a credential with a name matching the AzureBaseUrl. As page blobs are used with this option we force the number of files to 1 and ignore any value passed in for BlockSize or MaxTransferSize</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>NoRecovery</maml:name><maml:description><maml:para>This is passed in to perform a tail log backup if needed</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BuildPath</maml:name><maml:description><maml:para>By default this command will not attempt to create missing paths, this switch will change the behaviour so that it will</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>WithFormat</maml:name><maml:description><maml:para>Formats the media as the first step of the backup operation. NOTE: This will set Initialize and SkipTapeHeader to $true.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SkipTapeHeader</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TimeStampFormat</maml:name><maml:description><maml:para>By default the command timestamps backups using the format yyyyMMddHHmm. Using this parameter this can be overridden. The timestamp format should be defined using the Get-Date formats, illegal formats will cause an error to be thrown</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>IgnoreFileChecks</maml:name><maml:description><maml:para>This switch stops the function from checking for the validity of paths. This can be useful if SQL Server only has read access to the backup area. Note, that as we cannot check the path you may well end up with errors.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>OutputScriptOnly</maml:name><maml:description><maml:para>Switch causes only the T-SQL script for the backup to be generated. Will not create any paths if they do not exist</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureBaseUrl</maml:name><maml:description><maml:para>The URL(s) to the base container of an Azure Storage account to write backups to. If specifying the AzureCredential parameter you can only provide 1 value as page blobs do not support multiple URLs If useing Shared Access keys, you may specify as many URLs as you want, as long as a corresponding credential exists on the source server. If specified, the only other parameters than can be used are "CopyOnly", "Type", "CompressBackup", "Checksum", "Verify", "AzureCredential", "CreateFolder".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureCredential</maml:name><maml:description><maml:para>The name of the credential on the SQL instance that can write to the AzureBaseUrl, only needed if using Storage access keys If using SAS credentials, the command will look for a credential with a name matching the AzureBaseUrl. As page blobs are used with this option we force the number of files to 1 and ignore any value passed in for BlockSize or MaxTransferSize</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BlockSize</maml:name><maml:description><maml:para>Specifies the block size to use. Must be one of 0.5KB, 1KB, 2KB, 4KB, 8KB, 16KB, 32KB or 64KB. This can be specified in bytes. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BufferCount</maml:name><maml:description><maml:para>Number of I/O buffers to use to perform the operation. Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BuildPath</maml:name><maml:description><maml:para>By default this command will not attempt to create missing paths, this switch will change the behaviour so that it will</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Checksum</maml:name><maml:description><maml:para>If this switch is enabled, the backup checksum will be calculated.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CompressBackup</maml:name><maml:description><maml:para>If this switch is enabled, the function will try to perform a compressed backup if supported by the version and edition of SQL Server. Otherwise, this function will use the server(s) default setting for compression.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CopyOnly</maml:name><maml:description><maml:para>If this switch is enabled, CopyOnly backups will be taken. By default function performs a normal backup, these backups interfere with the restore chain of the database. CopyOnly backups will not interfere with the restore chain of the database. For more details please refer to this MSDN article - https://msdn.microsoft.com/en-us/library/ms191495.aspx</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>CreateFolder</maml:name><maml:description><maml:para>If this switch is enabled, each database will be backed up into a separate folder on each of the paths specified by Path.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>The database(s) to exclude. This list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FileCount</maml:name><maml:description><maml:para>This is the number of striped copies of the backups you wish to create. This value is overwritten if you specify multiple Backup Directories.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FilePath</maml:name><maml:description><maml:para>The name of the file to backup to. This is only accepted for single database backups. If no name is specified then the backup files will be named DatabaseName_yyyyMMddHHmm (i.e. "Database1_201714022131") with the appropriate extension. If the same name is used repeatedly, SQL Server will add backups to the same file at an incrementing position. SQL Server needs permissions to write to the specified location. Path names are based on the SQL Server (C:\ is the C drive on the SQL Server, not the machine running the script). Passing in NUL as the FilePath will backup to the NUL: device</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>IgnoreFileChecks</maml:name><maml:description><maml:para>This switch stops the function from checking for the validity of paths. This can be useful if SQL Server only has read access to the backup area. Note, that as we cannot check the path you may well end up with errors.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Initialize</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Internal parameter</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MaxTransferSize</maml:name><maml:description><maml:para>Sets the size of the unit of transfer. Values must be a multiple of 64kb.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>NoRecovery</maml:name><maml:description><maml:para>This is passed in to perform a tail log backup if needed</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>OutputScriptOnly</maml:name><maml:description><maml:para>Switch causes only the T-SQL script for the backup to be generated. Will not create any paths if they do not exist</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>Path in which to place the backup files. If not specified, the backups will be placed in the default backup location for SqlInstance. If multiple paths are specified, the backups will be striped across these locations. This will overwrite the FileCount option. If the path does not exist, Sql Server will attempt to create it. Folders are created by the Sql Instance, and checks will be made for write permissions. File Names with be suffixed with x-of-y to enable identifying striped sets, where y is the number of files in the set and x ranges from 1 to y.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ReplaceInName</maml:name><maml:description><maml:para>If this switch is set, the following list of strings will be replaced in the FilePath and Path strings: instancename - will be replaced with the instance Name servername - will be replaced with the server name dbname - will be replaced with the database name timestamp - will be replaced with the timestamp (either the default, or the format provided) backuptype - will be replaced with Full, Log or Differential as appropriate</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SkipTapeHeader</maml:name><maml:description><maml:para>Initializes the media as part of the backup operation.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Credentials to connect to the SQL Server instance if the calling user does not have permission.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The SQL Server instance hosting the databases to be backed up.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">DbaInstanceParameter</command:parameterValue><dev:type><maml:name>DbaInstanceParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TimeStampFormat</maml:name><maml:description><maml:para>By default the command timestamps backups using the format yyyyMMddHHmm. Using this parameter this can be overridden. The timestamp format should be defined using the Get-Date formats, illegal formats will cause an error to be thrown</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Type</maml:name><maml:description><maml:para>The type of SQL Server backup to perform. Accepted values are "Full", "Log", "Differential", "Diff", "Database"</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Verify</maml:name><maml:description><maml:para>If this switch is enabled, the backup will be verified by running a RESTORE VERIFYONLY against the SqlInstance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>WithFormat</maml:name><maml:description><maml:para>Formats the media as the first step of the backup operation. NOTE: This will set Initialize and SkipTapeHeader to $true.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: DisasterRecovery, Backup, Restore Author: Stuart Moore (@napalmgram), stuart-moore.com Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDatabase -SqlInstance Server1 -Database HR, Finance </dev:code><dev:remarks><maml:para> This will perform a full database backup on the databases HR and Finance on SQL Server Instance Server1 to Server1 default backup directory. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDatabase -SqlInstance sql2016 -Path C:\temp -Database AdventureWorks2014 -Type Full </dev:code><dev:remarks><maml:para> Backs up AdventureWorks2014 to sql2016 C:\temp folder. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDatabase -SqlInstance sql2016 -AzureBaseUrl https://dbatoolsaz.blob.core.windows.net/azbackups/ -AzureCredential dbatoolscred -Type Full -CreateFolder </dev:code><dev:remarks><maml:para> Performs a full backup of all databases on the sql2016 instance to their own containers under the https://dbatoolsaz.blob.core.windows.net/azbackups/ container on Azure blog storage using the sql credential "dbatoolscred" registered on the sql2016 instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDatabase -SqlInstance sql2016 -AzureBaseUrl https://dbatoolsaz.blob.core.windows.net/azbackups/ -Type Full </dev:code><dev:remarks><maml:para> Performs a full backup of all databases on the sql2016 instance to the https://dbatoolsaz.blob.core.windows.net/azbackups/ container on Azure blog storage using the Shared Access Signature sql credential "https://dbatoolsaz.blob.core.windows.net/azbackups" registered on the sql2016 instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-Dbadatabase -SqlInstance Server1\Prod -Database db1 -Path \\filestore\backups\servername\instancename\dbname\backuptype -Type Full -ReplaceInName </dev:code><dev:remarks><maml:para> Performs a full backup of db1 into the folder \\filestore\backups\server1\prod\db1 </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 6 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-Dbadatabase -SqlInstance Server1\Prod -Path \\filestore\backups\servername\instancename\dbname\backuptype -FilePath dbname-backuptype-timestamp.trn -Type Log -ReplaceInName </dev:code><dev:remarks><maml:para> Performs a log backup for every database. For the database db1 this would results in backup files in \\filestore\backups\server1\prod\db1\Log\db1-log-31102018.trn </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 7 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDatabase -SqlInstance Sql2017 -Database master -FilePath NUL </dev:code><dev:remarks><maml:para> Performs a backup of master, but sends the output to the NUL device (ie; throws it away) </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 8 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> PS C:\ Backup-DbaDatabase -SqlInstance Sql2016 -Database stripetest -AzureBaseUrl https://az.blob.core.windows.net/sql,https://dbatools.blob.core.windows.net/sql </dev:code><dev:remarks><maml:para> Performs a backup of the database striptest, striping it across the 2 Azure blob containers at https://az.blob.core.windows.net/sql and https://dbatools.blob.core.windows.net/sql, assuming that Shared Access Signature credentials for both containers exist on the source instance </maml:para></dev:remarks></command:example></command:examples></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Backup-DbaDbCertificate</command:name><command:noun>DbaDbCertificate</command:noun><command:verb>Backup</command:verb><maml:description><maml:para>Exports database certificates from SQL Server using SMO.</maml:para></maml:description></command:details><maml:description><maml:para>Exports database certificates from SQL Server using SMO and outputs the .cer and .pvk files.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Backup-DbaDbCertificate</maml:name><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EncryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to encrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DecryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to decrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The path to output the files to. The path is relative to the SQL Server itself. If no path is specified, the default data directory will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.IO.FileInfo</command:parameterValue><dev:type><maml:name>System.IO.FileInfo</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Suffix</maml:name><maml:description><maml:para>The suffix of the filename of the exported certificate.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Backup-DbaDbCertificate</maml:name><command:parameter required="true" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Certificate</maml:name><maml:description><maml:para>Exports certificate that matches the name(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>Exports the encryptor for specific database(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>Database(s) to skip when exporting encryptors.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EncryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to encrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DecryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to decrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The path to output the files to. The path is relative to the SQL Server itself. If no path is specified, the default data directory will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.IO.FileInfo</command:parameterValue><dev:type><maml:name>System.IO.FileInfo</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Suffix</maml:name><maml:description><maml:para>The suffix of the filename of the exported certificate.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Backup-DbaDbCertificate</maml:name><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EncryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to encrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DecryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to decrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The path to output the files to. The path is relative to the SQL Server itself. If no path is specified, the default data directory will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.IO.FileInfo</command:parameterValue><dev:type><maml:name>System.IO.FileInfo</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Suffix</maml:name><maml:description><maml:para>The suffix of the filename of the exported certificate.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaDbCertificate</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Certificate[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Certificate[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Certificate</maml:name><maml:description><maml:para>Exports certificate that matches the name(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>Exports the encryptor for specific database(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DecryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to decrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EncryptionPassword</maml:name><maml:description><maml:para>A string value that specifies the system path to encrypt the private key.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>Database(s) to skip when exporting encryptors.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables piping from Get-DbaDbCertificate</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Certificate[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Certificate[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The path to output the files to. The path is relative to the SQL Server itself. If no path is specified, the default data directory will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.IO.FileInfo</command:parameterValue><dev:type><maml:name>System.IO.FileInfo</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Suffix</maml:name><maml:description><maml:para>The suffix of the filename of the exported certificate.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Migration, Certificate Author: Jess Pomfret (@jpomfret) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 </dev:code><dev:remarks><maml:para> Exports all the certificates on the specified SQL Server to the default data path for the instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> $cred = Get-Credential sqladmin </dev:code><dev:remarks><maml:para> PS C:\&gt; Backup-DbaDbCertificate -SqlInstance Server1 -SqlCredential $cred Connects using sqladmin credential and exports all the certificates on the specified SQL Server to the default data path for the instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 -Certificate Certificate1 </dev:code><dev:remarks><maml:para> Exports only the certificate named Certificate1 on the specified SQL Server to the default data path for the instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 -Database AdventureWorks </dev:code><dev:remarks><maml:para> Exports only the certificates for AdventureWorks on the specified SQL Server to the default data path for the instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 -ExcludeDatabase AdventureWorks </dev:code><dev:remarks><maml:para> Exports all certificates except those for AdventureWorks on the specified SQL Server to the default data path for the instance. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 6 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 -Path \\Server1\Certificates -EncryptionPassword (ConvertTo-SecureString -force -AsPlainText GoodPass1234!!) </dev:code><dev:remarks><maml:para> Exports all the certificates and private keys on the specified SQL Server. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 7 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> $EncryptionPassword = ConvertTo-SecureString -AsPlainText "GoodPass1234!!" -force </dev:code><dev:remarks><maml:para> PS C:\&gt; $DecryptionPassword = ConvertTo-SecureString -AsPlainText "Password4567!!" -force PS C:\&gt; Backup-DbaDbCertificate -SqlInstance Server1 -EncryptionPassword $EncryptionPassword -DecryptionPassword $DecryptionPassword Exports all the certificates on the specified SQL Server using the supplied DecryptionPassword, since an EncryptionPassword is specified private keys are also exported. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 8 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 -Path \\Server1\Certificates </dev:code><dev:remarks><maml:para> Exports all certificates on the specified SQL Server to the specified path. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 9 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbCertificate -SqlInstance Server1 -Suffix DbaTools </dev:code><dev:remarks><maml:para> Exports all certificates on the specified SQL Server to the specified path, appends DbaTools to the end of the filenames. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 10 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Get-DbaDbCertificate -SqlInstance sql2016 | Backup-DbaDbCertificate </dev:code><dev:remarks><maml:para> Exports all certificates found on sql2016 to the default data directory. </maml:para></dev:remarks></command:example></command:examples></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Backup-DbaDbMasterKey</command:name><command:noun>DbaDbMasterKey</command:noun><command:verb>Backup</command:verb><maml:description><maml:para>Backs up specified database master key.</maml:para></maml:description></command:details><maml:description><maml:para>Backs up specified database master key.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Backup-DbaDbMasterKey</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Allows you to login to SQL Server using alternative credentials.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Pass a credential object for the password</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>Backup master key from specific database(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>The database(s) to exclude - this list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecurePassword</maml:name><maml:description><maml:para>The password to encrypt the exported key. This must be a SecureString.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The directory to export the key. If no path is specified, the default backup directory for the instance will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="7" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Database object piped in from Get-DbaDatabase</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Database[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Database[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Pass a credential object for the password</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>Backup master key from specific database(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ExcludeDatabase</maml:name><maml:description><maml:para>The database(s) to exclude - this list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue><dev:type><maml:name>System.String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Database object piped in from Get-DbaDatabase</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Microsoft.SqlServer.Management.Smo.Database[]</command:parameterValue><dev:type><maml:name>Microsoft.SqlServer.Management.Smo.Database[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The directory to export the key. If no path is specified, the default backup directory for the instance will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecurePassword</maml:name><maml:description><maml:para>The password to encrypt the exported key. This must be a SecureString.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Allows you to login to SQL Server using alternative credentials.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Certificate, Database Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbMasterKey -SqlInstance server1\sql2016 </dev:code><dev:remarks><maml:para> ``` ComputerName : SERVER1 InstanceName : SQL2016 SqlInstance : SERVER1\SQL2016 Database : master Filename : E:\MSSQL13.SQL2016\MSSQL\Backup\server1$sql2016-master-20170614162311.key Status : Success ``` Prompts for export password, then logs into server1\sql2016 with Windows credentials then backs up all database keys to the default backup directory. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaDbMasterKey -SqlInstance Server1 -Database db1 -Path \\nas\sqlbackups\keys </dev:code><dev:remarks><maml:para> Logs into sql2016 with Windows credentials then backs up db1's keys to the \\nas\sqlbackups\keys directory. </maml:para></dev:remarks></command:example></command:examples></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Backup-DbaServiceMasterKey</command:name><command:noun>DbaServiceMasterKey</command:noun><command:verb>Backup</command:verb><maml:description><maml:para>Backs up specified service master key.</maml:para></maml:description></command:details><maml:description><maml:para>Backs up specified service master key.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Backup-DbaServiceMasterKey</maml:name><command:parameter required="true" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Allows you to login to SQL Server using alternative credentials.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>KeyCredential</maml:name><maml:description><maml:para>Pass a credential object for the password</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecurePassword</maml:name><maml:description><maml:para>The password to encrypt the exported key. This must be a SecureString.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The directory to export the key. If no path is specified, the default backup directory for the instance will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>KeyCredential</maml:name><maml:description><maml:para>Pass a credential object for the password</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Path</maml:name><maml:description><maml:para>The directory to export the key. If no path is specified, the default backup directory for the instance will be used.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SecurePassword</maml:name><maml:description><maml:para>The password to encrypt the exported key. This must be a SecureString.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Securestring</command:parameterValue><dev:type><maml:name>Securestring</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Allows you to login to SQL Server using alternative credentials.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Certificate, Database Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaServiceMasterKey -SqlInstance server1\sql2016 </dev:code><dev:remarks><maml:para> ``` ComputerName : SERVER1 InstanceName : SQL2016 SqlInstance : SERVER1\SQL2016 Filename : E:\MSSQL13.SQL2016\MSSQL\Backup\server1$sql2016-SMK-20170614162311.key Status : Success ``` Prompts for export password, then logs into server1\sql2016 with Windows credentials then backs up the service master key to the default backup directory. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Backup-DbaServiceMasterKey -SqlInstance Server1 -Path \\nas\sqlbackups\keys </dev:code><dev:remarks><maml:para> Logs into sql2016 with Windows credentials then backs up the service master key to the \\nas\sqlbackups\keys directory. </maml:para></dev:remarks></command:example></command:examples></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Clear-DbaConnectionPool</command:name><command:noun>DbaConnectionPool</command:noun><command:verb>Clear</command:verb><maml:description><maml:para>Resets (or empties) the connection pool.</maml:para></maml:description></command:details><maml:description><maml:para>This command resets (or empties) the connection pool.</maml:para><maml:para>If there are connections in use at the time of the call, they are marked appropriately and will be discarded (instead of being returned to the pool) when Close() is called on them.</maml:para><maml:para>Ref: https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.clearallpools(v=vs.110).aspx</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Clear-DbaConnectionPool</maml:name><command:parameter required="false" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>ComputerName</maml:name><maml:description><maml:para>Target computer(s). If no computer name is specified, the local computer is targeted.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Alternate credential object to use for accessing the target computer(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ComputerName</maml:name><maml:description><maml:para>Target computer(s). If no computer name is specified, the local computer is targeted.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Credential</maml:name><maml:description><maml:para>Alternate credential object to use for accessing the target computer(s).</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Connection Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaConnectionPool </dev:code><dev:remarks><maml:para> Clears all local connection pools. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaConnectionPool -ComputerName workstation27 </dev:code><dev:remarks><maml:para> Clears all connection pools on workstation27. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Clear-DbaConnectionPool</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Clear-DbaLatchStatistics</command:name><command:noun>DbaLatchStatistics</command:noun><command:verb>Clear</command:verb><maml:description><maml:para>Clears Latch Statistics</maml:para></maml:description></command:details><maml:description><maml:para>Reset the aggregated statistics - basically just executes DBCC SQLPERF (N'sys.dm_os_latch_stats', CLEAR)</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Clear-DbaLatchStatistics</maml:name><command:parameter required="true" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>Allows you to specify a comma separated list of servers to query.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>Allows you to specify a comma separated list of servers to query.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: LatchStatistic, Waits Author: Patrick Flynn (@sqllensman) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaLatchStatistics -SqlInstance sql2008, sqlserver2012 </dev:code><dev:remarks><maml:para> After confirmation, clears latch statistics on servers sql2008 and sqlserver2012 </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaLatchStatistics -SqlInstance sql2008, sqlserver2012 -Confirm:$false </dev:code><dev:remarks><maml:para> Clears latch statistics on servers sql2008 and sqlserver2012, without prompting </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> 'sql2008','sqlserver2012' | Clear-DbaLatchStatistics </dev:code><dev:remarks><maml:para> After confirmation, clears latch statistics on servers sql2008 and sqlserver2012 </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> $cred = Get-Credential sqladmin </dev:code><dev:remarks><maml:para> PS C:\&gt; Clear-DbaLatchStatistics -SqlInstance sql2008 -SqlCredential $cred Connects using sqladmin credential and clears latch statistics on servers sql2008 and sqlserver2012 </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Clear-DbaLatchStatistics</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Clear-DbaPlanCache</command:name><command:noun>DbaPlanCache</command:noun><command:verb>Clear</command:verb><maml:description><maml:para>Removes ad-hoc and prepared plan caches is single use plans are over defined threshold.</maml:para></maml:description></command:details><maml:description><maml:para>Checks ad-hoc and prepared plan cache for each database, if over 100 MBs removes from the cache.</maml:para><maml:para>This command automates that process.</maml:para><maml:para>References: https://www.sqlskills.com/blogs/kimberly/plan-cache-adhoc-workloads-and-clearing-the-single-use-plan-cache-bloat/</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Clear-DbaPlanCache</maml:name><command:parameter required="false" position="0" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Threshold</maml:name><maml:description><maml:para>Memory used threshold.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables results to be piped in from Get-DbaPlanCache.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>InputObject</maml:name><maml:description><maml:para>Enables results to be piped in from Get-DbaPlanCache.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">System.Object[]</command:parameterValue><dev:type><maml:name>System.Object[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Threshold</maml:name><maml:description><maml:para>Memory used threshold.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: Memory Author: Tracy Boggiano, databasesuperhero.com Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaPlanCache -SqlInstance sql2017 -Threshold 200 </dev:code><dev:remarks><maml:para> Logs into the SQL Server instance "sql2017" and removes plan caches if over 200 MB. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaPlanCache -SqlInstance sql2017 -SqlCredential sqladmin </dev:code><dev:remarks><maml:para> Logs into the SQL instance using the SQL Login 'sqladmin' and then Windows instance as 'ad\sqldba' and removes if Threshold over 100 MB. </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Find-DbaInstance -ComputerName localhost | Get-DbaPlanCache | Clear-DbaPlanCache -Threshold 200 </dev:code><dev:remarks><maml:para> Scans localhost for instances using the browser service, traverses all instances and gets the plan cache for each, clears them out if they are above 200 MB. </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Clear-DbaPlanCache</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Clear-DbaWaitStatistics</command:name><command:noun>DbaWaitStatistics</command:noun><command:verb>Clear</command:verb><maml:description><maml:para>Clears wait statistics</maml:para></maml:description></command:details><maml:description><maml:para>Reset the aggregated statistics - basically just executes DBCC SQLPERF (N'sys.dm_os_wait_stats', CLEAR)</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Clear-DbaWaitStatistics</maml:name><command:parameter required="true" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EnableException</maml:name><maml:description><maml:para>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><maml:alertSet><maml:title></maml:title><maml:alert><maml:para> Tags: WaitStatistic, Waits Author: Chrissy LeMaire (@cl) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaWaitStatistics -SqlInstance sql2008, sqlserver2012 </dev:code><dev:remarks><maml:para> After confirmation, clears wait stats on servers sql2008 and sqlserver2012 </maml:para></dev:remarks></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para> PS C:\&gt; </maml:para></maml:introduction><dev:code> Clear-DbaWaitStatistics -SqlInstance sql2008, sqlserver2012 -Confirm:$false </dev:code><dev:remarks><maml:para> Clears wait stats on servers sql2008 and sqlserver2012, without prompting </maml:para></dev:remarks></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri>https://dbatools.io/Clear-DbaWaitStatistics</maml:uri></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Connect-DbaInstance</command:name><command:noun>DbaInstance</command:noun><command:verb>Connect</command:verb><maml:description><maml:para>Creates a robust, reusable SQL Server object.</maml:para></maml:description></command:details><maml:description><maml:para>This command creates a robus, reusable sql server object.</maml:para><maml:para>It is robust because it initializes properties that do not cause enumeration by default. It also supports both Windows and SQL Server authentication methods, and detects which to use based upon the provided credentials.</maml:para><maml:para>By default, this command also sets the connection's ApplicationName property to "dbatools PowerShell module - dbatools.io - custom connection". If you're doing anything that requires profiling, you can look for this client name.</maml:para><maml:para>Alternatively, you can pass in whichever client name you'd like using the -ClientName parameter. There are a ton of other parameters for you to explore as well.</maml:para><maml:para>See https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.connectionstring.aspx</maml:para><maml:para>and https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnectionstringbuilder.aspx,</maml:para><maml:para>and https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.aspx</maml:para><maml:para>To execute SQL commands, you can use $server.ConnectionContext.ExecuteReader($sql) or $server.Databases['master'].ExecuteNonQuery($sql)</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Connect-DbaInstance</maml:name><command:parameter required="true" position="0" pipelineInput="True (ByValue)" aliases="" variableLength="true" globbing="false"><maml:name>SqlInstance</maml:name><maml:description><maml:para>The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</command:parameterValue><dev:type><maml:name>Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="1" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlCredential</maml:name><maml:description><maml:para>Credential object used to connect to the SQL Server Instance as a different user. This can be a Windows or SQL Server account. Windows users are determined by the existence of a backslash, so if you are intending to use an alternative Windows connection instead of a SQL login, ensure it contains a backslash.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Pscredential</command:parameterValue><dev:type><maml:name>Pscredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="2" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="3" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ApplicationIntent</maml:name><maml:description><maml:para>Declares the application workload type when connecting to a server. Valid values are "ReadOnly" and "ReadWrite".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureUnsupported</maml:name><maml:description><maml:para>Terminate if Azure is detected but not supported</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="4" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BatchSeparator</maml:name><maml:description><maml:para>A string to separate groups of SQL statements being executed. By default, this is "GO".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="5" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ClientName</maml:name><maml:description><maml:para>By default, this command sets the client's ApplicationName property to "dbatools PowerShell module - dbatools.io - custom connection" if you're doing anything that requires profiling, you can look for this client name. Using -ClientName allows you to set your own custom client application name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="6" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectTimeout</maml:name><maml:description><maml:para>The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Valid values are integers between 0 and 2147483647. When opening a connection to a Azure SQL Database, set the connection timeout to 30 seconds.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>EncryptConnection</maml:name><maml:description><maml:para>If this switch is enabled, SQL Server uses SSL encryption for all data sent between the client and server if the server has a certificate installed. For more information, see Connection String Syntax. https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax Beginning in .NET Framework 4.5, when TrustServerCertificate is false and Encrypt is true, the server name (or IP address) in a SQL Server SSL certificate must exactly match the server name (or IP address) specified in the connection string. Otherwise, the connection attempt will fail. For information about support for certificates whose subject starts with a wildcard character (*), see Accepted wildcards used by server certificates for server authentication. https://support.microsoft.com/en-us/help/258858/accepted-wildcards-used-by-server-certificates-for-server-authenticati</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="7" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>FailoverPartner</maml:name><maml:description><maml:para>The name of the failover partner server where database mirroring is configured. If the value of this key is "" (an empty string), then Initial Catalog must be present in the connection string, and its value must not be "". The server name can be 128 characters or less. If you specify a failover partner but the failover partner server is not configured for database mirroring and the primary server (specified with the Server keyword) is not available, then the connection will fail. If you specify a failover partner and the primary server is not configured for database mirroring, the connection to the primary server (specified with the Server keyword) will succeed if the primary server is available.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="8" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>LockTimeout</maml:name><maml:description><maml:para>Sets the time in seconds required for the connection to time out when the current transaction is locked.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="9" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MaxPoolSize</maml:name><maml:description><maml:para>Sets the maximum number of connections allowed in the connection pool for this specific connection string.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="10" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MinPoolSize</maml:name><maml:description><maml:para>Sets the minimum number of connections allowed in the connection pool for this specific connection string.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="11" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MinimumVersion</maml:name><maml:description><maml:para>Terminate if the target SQL Server instance version does not meet version requirements</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MultipleActiveResultSets</maml:name><maml:description><maml:para>If this switch is enabled, an application can maintain multiple active result sets (MARS). If this switch is not enabled, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>MultiSubnetFailover</maml:name><maml:description><maml:para>If this switch is enabled, and your application is connecting to an AlwaysOn availability group (AG) on different subnets, detection of and connection to the currently active server will be faster. For more information about SqlClient support for Always On Availability Groups, see https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/sql/sqlclient-support-for-high-availability-disaster-recovery</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="12" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>NetworkProtocol</maml:name><maml:description><maml:para>Explicitly sets the network protocol used to connect to the server. Valid values are "TcpIp","NamedPipes","Multiprotocol","AppleTalk","BanyanVines","Via","SharedMemory" and "NWLinkIpxSpx"</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>NonPooledConnection</maml:name><maml:description><maml:para>If this switch is enabled, a non-pooled connection will be requested.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="13" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PacketSize</maml:name><maml:description><maml:para>Sets the size in bytes of the network packets used to communicate with an instance of SQL Server. Must match at server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="14" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>PooledConnectionLifetime</maml:name><maml:description><maml:para>When a connection is returned to the pool, its creation time is compared with the current time and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A value of zero (0) causes pooled connections to have the maximum connection timeout.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="15" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlExecutionModes</maml:name><maml:description><maml:para>The SqlExecutionModes enumeration contains values that are used to specify whether the commands sent to the referenced connection to the server are executed immediately or saved in a buffer. Valid values include "CaptureSql", "ExecuteAndCaptureSql" and "ExecuteSql".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="16" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>StatementTimeout</maml:name><maml:description><maml:para>Sets the number of seconds a statement is given to run before failing with a timeout error.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>TrustServerCertificate</maml:name><maml:description><maml:para>When this switch is enabled, the channel will be encrypted while bypassing walking the certificate chain to validate trust.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="17" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>WorkstationId</maml:name><maml:description><maml:para>Sets the name of the workstation connecting to SQL Server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="18" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AppendConnectionString</maml:name><maml:description><maml:para>Appends to the current connection string. Note that you cannot pass authentication information using this method. Use -SqlInstance and optionally -SqlCredential to set authentication information.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>SqlConnectionOnly</maml:name><maml:description><maml:para>Instead of returning a rich SMO server object, this command will only return a SqlConnection object when setting this switch.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="19" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureDomain</maml:name><maml:description><maml:para>By default, this is set to database.windows.net In the event your AzureSqlDb is not on a database.windows.net domain, you can set a custom domain using the AzureDomain parameter. This tells Connect-DbaInstance to login to the database using the method that works best with Azure.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="20" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AuthenticationType</maml:name><maml:description><maml:para>Basically used to force AD Universal with MFA Support when other types have been detected</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="21" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Tenant</maml:name><maml:description><maml:para>The TenantId for an Azure Instance</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="22" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Thumbprint</maml:name><maml:description><maml:para>Thumbprint for connections to Azure MSI</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="23" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Store</maml:name><maml:description><maml:para>Store where the Azure MSI certificate is stored</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableException</maml:name><maml:description><maml:para>By default in most of our commands, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This command, however, gifts you with "sea of red" exceptions, by default, because it is useful for advanced scripting. Using this switch turns our "nice by default" feature on which makes errors into pretty warnings.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AppendConnectionString</maml:name><maml:description><maml:para>Appends to the current connection string. Note that you cannot pass authentication information using this method. Use -SqlInstance and optionally -SqlCredential to set authentication information.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ApplicationIntent</maml:name><maml:description><maml:para>Declares the application workload type when connecting to a server. Valid values are "ReadOnly" and "ReadWrite".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AuthenticationType</maml:name><maml:description><maml:para>Basically used to force AD Universal with MFA Support when other types have been detected</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureDomain</maml:name><maml:description><maml:para>By default, this is set to database.windows.net In the event your AzureSqlDb is not on a database.windows.net domain, you can set a custom domain using the AzureDomain parameter. This tells Connect-DbaInstance to login to the database using the method that works best with Azure.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>AzureUnsupported</maml:name><maml:description><maml:para>Terminate if Azure is detected but not supported</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>BatchSeparator</maml:name><maml:description><maml:para>A string to separate groups of SQL statements being executed. By default, this is "GO".</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ClientName</maml:name><maml:description><maml:para>By default, this command sets the client's ApplicationName property to "dbatools PowerShell module - dbatools.io - custom connection" if you're doing anything that requires profiling, you can look for this client name. Using -ClientName allows you to set your own custom client application name.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>ConnectTimeout</maml:name><maml:description><maml:para>The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Valid values are integers between 0 and 2147483647. When opening a connection to a Azure SQL Database, set the connection timeout to 30 seconds.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Int</command:parameterValue><dev:type><maml:name>Int</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>Database</maml:name><maml:description><maml:para>The database(s) to process. This list is auto-populated from the server.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" position="named" pipelineInput="False" aliases="" variableLength="true" globbing="false"><maml:name>DisableException</maml:name><maml:description><maml:para>By default in most of our commands, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This command, however, gifts you with "sea of red" exceptions, by default, because it is useful for advanced scripting. Using this switch turns our "nice by default" feature on which makes errors into pretty warnings.</maml:para></maml:description><command:parameterValue required="false" variableLength="true">Switch</command:parameterValue><dev:type><maml:name>Switch</maml:name>