forked from dataplat/dbatools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdbatools.xml
4305 lines (4180 loc) · 201 KB
/
dbatools.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
<?xml version="1.0"?>
<doc>
<assembly>
<name>dbatools</name>
</assembly>
<members>
<member name="T:Sqlcollaborative.Dbatools.Computer.DiskSpace">
<summary>
Data Container for the output of Get-DbaDiskSpace
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.ComputerName">
<summary>
The computer that was scanned
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Name">
<summary>
Name of the disk
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Label">
<summary>
Label of the disk
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Capacity">
<summary>
What's the total capacity of the disk?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Free">
<summary>
How much is still free?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.PercentFree">
<summary>
How much is still free
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.BlockSize">
<summary>
What blocksize is the object set to
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FileSystem">
<summary>
What filesystem is installed on the system
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Type">
<summary>
What kind of drive is it?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.IsSqlDisk">
<summary>
Whether the drive is a sql disk. Nullable, because it is an optional property and may not always be included, thus a third state is necessary.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.Server">
<summary>
The computer that was scanned. Legacy-Name
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.DriveType">
<summary>
The type of drive this is in the legacy string notation
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInBytes">
<summary>
The total capacity in Bytes
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInBytes">
<summary>
The free space in Bytes
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInKB">
<summary>
The total capacity in KB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInKB">
<summary>
The free space in KB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInMB">
<summary>
The total capacity in MB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInMB">
<summary>
The free space in MB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInGB">
<summary>
The total capacity in GB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInGB">
<summary>
The free space in GB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInTB">
<summary>
The total capacity in TB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInTB">
<summary>
The free space in TB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.SizeInPB">
<summary>
The total capacity in PB
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Computer.DiskSpace.FreeInPB">
<summary>
The free space in PB
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Computer.DriveType">
<summary>
What kind of drive are you?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.Unknown">
<summary>
The drive type is not actually known
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.NoRootDirectory">
<summary>
The drive has no root directory
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.RemovableDisk">
<summary>
The drive is a removable disk
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.LocalDisk">
<summary>
The drive is a local disk
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.NetworkDrive">
<summary>
The drive is a network drive
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.CompactDisk">
<summary>
The drive is a compact disk
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Computer.DriveType.RAMDisk">
<summary>
The drive is a RAM disk
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Configuration.ConfigScope">
<summary>
The location where a setting was applied
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.UserDefault">
<summary>
The configuration is set as default value for the user
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.UserMandatory">
<summary>
The configuration is enforced for the user
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.SystemDefault">
<summary>
The configuration is set as default value for all users on the system
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigScope.SystemMandatory">
<summary>
The configuration is enforced for all users on the system.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost">
<summary>
Host class providing static configuration settings that are constant across all runspaces within the process.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.Configurations">
<summary>
Hashtable containing all the configuration entries
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.Validation">
<summary>
Hashtable containing all the registered validations
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.ConfigurationHost.ImportFromRegistryDone">
<summary>
Whether the import from registry has been completed. Prevents multiple imports and overwrites when importing the module multiple times.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Configuration.Config">
<summary>
Configuration Manager as well as individual configuration object.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Name">
<summary>
The Name of the setting
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.FullName">
<summary>
The full name of the configuration entry, comprised of both Module and Name.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Module">
<summary>
The module of the setting. Helps being able to group configurations.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Description">
<summary>
A description of the specific setting
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Type">
<summary>
The data type of the value stored in the configuration element.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Value">
<summary>
The value stored in the configuration element
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Handler">
<summary>
The handler script that is run whenever the configuration value is set.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Validation">
<summary>
Validates the user input
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Hidden">
<summary>
Setting this to true will cause the element to not be discovered unless using the '-Force' parameter on "Get-DbaConfig"
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.Initialized">
<summary>
Whether the setting has been initialized. This handles module imports and avoids modules overwriting settings when imported in multiple runspaces.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.PolicySet">
<summary>
Whether this setting was set by policy
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.PolicyEnforced">
<summary>
Whether this setting was set by policy and forbids deletion.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Configuration.Config.RegistryData">
<summary>
The finalized value to put into the registry value when using policy to set this setting.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Database.BackupHistory">
<summary>
Object containing the information about the history of mankind ... or a database backup. WHo knows.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.ComputerName">
<summary>
The name of the computer running MSSQL Server
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.InstanceName">
<summary>
The Instance that was queried
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.SqlInstance">
<summary>
The full Instance name as seen from outside
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Database">
<summary>
The Database that was backed up
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.UserName">
<summary>
The user that is running the backup
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Start">
<summary>
When was the backup started
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.End">
<summary>
When did the backup end
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Duration">
<summary>
What was the longest duration among the backups
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Path">
<summary>
Where is the backup stored
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.TotalSize">
<summary>
What is the total size of the backup
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Type">
<summary>
The kind of backup this was
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.BackupSetId">
<summary>
The ID for the Backup job
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.DeviceType">
<summary>
What kind of backup-device was the backup stored to
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Software">
<summary>
What is the name of the backup software?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.FullName">
<summary>
The full name of the backup
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.FileList">
<summary>
The files that are part of this backup
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.Position">
<summary>
The position of the backup
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.FirstLsn">
<summary>
The first Log Sequence Number
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.DatabaseBackupLsn">
<summary>
The Log Squence Number that marks the beginning of the backup
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.CheckpointLsn">
<summary>
The checkpoint's Log Sequence Number
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.LastLsn">
<summary>
The last Log Sequence Number
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.SoftwareVersionMajor">
<summary>
The primary version number of the Sql Server
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.IsCopyOnly">
<summary>
Was the backup performed with the CopyOnlyOption
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.BackupHistory.LastRecoveryForkGUID">
<summary>
Recovery Fork backup was takeon
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Database.Dependency">
<summary>
Class containing all dependency information over a database object
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.ComputerName">
<summary>
The name of the SQL server from whence the query came
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.ServiceName">
<summary>
Name of the service running the database containing the dependency
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.SqlInstance">
<summary>
The Instance the database containing the dependency is running in.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Dependent">
<summary>
The name of the dependent
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Type">
<summary>
The kind of object the dependent is
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Owner">
<summary>
The owner of the dependent (usually the Database)
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.IsSchemaBound">
<summary>
Whether the dependency is Schemabound. If it is, then the creation statement order is of utmost importance.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Parent">
<summary>
The immediate parent of the dependent. Useful in multi-tier dependencies.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.ParentType">
<summary>
The type of object the immediate parent is.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Script">
<summary>
The script used to create the object.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Tier">
<summary>
The tier in the dependency hierarchy tree. Used to determine, which dependency must be applied in which order.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Object">
<summary>
The smo object of the dependent.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.Urn">
<summary>
The Uniform Resource Name of the dependent.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Database.Dependency.OriginalResource">
<summary>
The object of the original resource, from which the dependency hierachy has been calculated.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Connection.ConnectionHost">
<summary>
Provides static tools for managing connections
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.Connections">
<summary>
List of all registered connections.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.BadConnectionTimeout">
<summary>
The time interval that must pass, before a connection using a known to not work connection protocol is reattempted
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableCache">
<summary>
Globally disables all caching done by the Computer Management functions.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableBadCredentialCache">
<summary>
Disables the caching of bad credentials. dbatools caches bad logon credentials for wmi/cim and will not reuse them.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableCredentialAutoRegister">
<summary>
Disables the automatic registration of working credentials. dbatools will caches the last working credential when connecting using wmi/cim and will use those rather than using known bad credentials
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.OverrideExplicitCredential">
<summary>
Enabling this will force the use of the last credentials known to work, rather than even trying explicit credentials.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.EnableCredentialFailover">
<summary>
Enables automatic failover to working credentials, when passed credentials either are known, or turn out to not work.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableCimPersistence">
<summary>
Globally disables the persistence of Cim sessions used to connect to a target system.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableConnectionCimRM">
<summary>
Whether the CM connection using Cim over WinRM is disabled globally
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableConnectionCimDCOM">
<summary>
Whether the CM connection using Cim over DCOM is disabled globally
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableConnectionWMI">
<summary>
Whether the CM connection using WMI is disabled globally
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.DisableConnectionPowerShellRemoting">
<summary>
Whether the CM connection using PowerShell Remoting is disabled globally
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ConnectionHost.SqlConnectionTimeout">
<summary>
The number of seconds before a sql connection attempt times out
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Connection.ManagementConnection">
<summary>
Contains management connection information for a windows server
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.ComputerName">
<summary>
The computer to connect to
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.DisableBadCredentialCache">
<summary>
Locally disables the caching of bad credentials
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.DisableCredentialAutoRegister">
<summary>
Locally disables the caching of working credentials
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.OverrideExplicitCredential">
<summary>
Locally overrides explicit credentials with working ones that were cached
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.EnableCredentialFailover">
<summary>
Locally enables automatic failover to working credentials, when passed credentials either are known, or turn out to not work.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.DisableCimPersistence">
<summary>
Locally disables the persistence of Cim sessions used to connect to a target system.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.DisabledConnectionTypes">
<summary>
Connectiontypes that will never be used
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.RestoreDefaultConfiguration">
<summary>
Restores all deviations from public policy back to default
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.OverrideConnectionPolicy">
<summary>
Whether this connection adhers to the global connection lockdowns or not
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.CimRM">
<summary>
Did the last connection attempt using CimRM work?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.LastCimRM">
<summary>
When was the last connection attempt using CimRM?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.CimDCOM">
<summary>
Did the last connection attempt using CimDCOM work?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.LastCimDCOM">
<summary>
When was the last connection attempt using CimRM?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.Wmi">
<summary>
Did the last connection attempt using Wmi work?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.LastWmi">
<summary>
When was the last connection attempt using CimRM?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.PowerShellRemoting">
<summary>
Did the last connection attempt using PowerShellRemoting work?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.LastPowerShellRemoting">
<summary>
When was the last connection attempt using CimRM?
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.ReportSuccess(Sqlcollaborative.Dbatools.Connection.ManagementConnectionType)">
<summary>
Report the successful connection against the computer of this connection
</summary>
<param name="Type">What connection type succeeded?</param>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.ReportFailure(Sqlcollaborative.Dbatools.Connection.ManagementConnectionType)">
<summary>
Report the failure of connecting to the target computer
</summary>
<param name="Type">What connection type failed?</param>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.Credentials">
<summary>
Any registered credentials to use on the connection.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.WindowsCredentialsAreBad">
<summary>
Whether the default windows credentials are known to not work against the target.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.UseWindowsCredentials">
<summary>
Whether windows credentials are known to be good. Do not build conditions on them being false, just on true.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnection.KnownBadCredentials">
<summary>
Credentials known to not work. They will not be used when specified.
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.AddBadCredential(System.Management.Automation.PSCredential)">
<summary>
Adds a credentials object to the list of credentials known to not work.
</summary>
<param name="Credential">The bad credential that must be punished</param>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.AddGoodCredential(System.Management.Automation.PSCredential)">
<summary>
Reports a credentials object as being legit.
</summary>
<param name="Credential">The functioning credential that we may want to use again</param>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetCredential(System.Management.Automation.PSCredential)">
<summary>
Calculates, which credentials to use. Will consider input, compare it with know not-working credentials or use the configured working credentials for that.
</summary>
<param name="Credential">Any credential object a user may have explicitly specified.</param>
<returns>The Credentials to use</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.IsBadCredential(System.Management.Automation.PSCredential)">
<summary>
Tests whether the input credential is on the list known, bad credentials
</summary>
<param name="Credential">The credential to test</param>
<returns>True if the credential is known to not work, False if it is not yet known to not work</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.RemoveBadCredential(System.Management.Automation.PSCredential)">
<summary>
Removes an item from the list of known bad credentials
</summary>
<param name="Credential">The credential to remove</param>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetConnectionType(Sqlcollaborative.Dbatools.Connection.ManagementConnectionType,System.Boolean)">
<summary>
Returns the next connection type to try.
</summary>
<param name="ExcludedTypes">Exclude any type already tried and failed</param>
<param name="Force">Overrides the timeout on bad connections</param>
<returns>The next type to try.</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetConnectionTypesTimed(System.DateTime)">
<summary>
Returns a list of all available connection types whose inherent timeout has expired.
</summary>
<param name="Timestamp">All last connection failures older than this point in time are considered to be expired</param>
<returns>A list of all valid connection types</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetConnectionTypesTimed(System.TimeSpan)">
<summary>
Returns a list of all available connection types whose inherent timeout has expired.
</summary>
<param name="Timespan">All last connection failures older than this far back into the past are considered to be expired</param>
<returns>A list of all valid connection types</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.#ctor">
<summary>
Creates a new, empty connection object. Necessary for serialization.
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.#ctor(System.String)">
<summary>
Creates a new default connection object, containing only its computer's name and default results.
</summary>
<param name="ComputerName">The computer targeted. Will be forced to lowercase.</param>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.CimWinRMOptions">
<summary>
The options ot use when establishing a CIM Session
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetDefaultCimWsmanOptions">
<summary>
Returns the default wsman options object
</summary>
<returns>Something very default-y</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetCimRMInstance(System.Management.Automation.PSCredential,System.String,System.String)">
<summary>
Get all cim instances of the appropriate class using WinRM
</summary>
<param name="Credential">The credentiuls to use for the connection.</param>
<param name="Class">The class to query.</param>
<param name="Namespace">The namespace to look in (defaults to root\cimv2).</param>
<returns>Hopefully a mountainload of CimInstances</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.QueryCimRMInstance(System.Management.Automation.PSCredential,System.String,System.String,System.String)">
<summary>
Get all cim instances matching the query using WinRM
</summary>
<param name="Credential">The credentiuls to use for the connection.</param>
<param name="Query">The query to use requesting information.</param>
<param name="Dialect">Defaults to WQL.</param>
<param name="Namespace">The namespace to look in (defaults to root\cimv2).</param>
<returns></returns>
</member>
<member name="P:Sqlcollaborative.Dbatools.Connection.ManagementConnection.CimDComOptions">
<summary>
The options ot use when establishing a CIM Session
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetDefaultCimDcomOptions">
<summary>
Returns the default DCom options object
</summary>
<returns>Something very default-y</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.GetCimDComInstance(System.Management.Automation.PSCredential,System.String,System.String)">
<summary>
Get all cim instances of the appropriate class using DCOM
</summary>
<param name="Credential">The credentiuls to use for the connection.</param>
<param name="Class">The class to query</param>
<param name="Namespace">The namespace to look in (defaults to root\cimv2)</param>
<returns>Hopefully a mountainload of CimInstances</returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.QueryCimDCOMInstance(System.Management.Automation.PSCredential,System.String,System.String,System.String)">
<summary>
Get all cim instances matching the query using DCOM
</summary>
<param name="Credential">The credentiuls to use for the connection.</param>
<param name="Query">The query to use requesting information.</param>
<param name="Dialect">Defaults to WQL.</param>
<param name="Namespace">The namespace to look in (defaults to root\cimv2).</param>
<returns></returns>
</member>
<member name="M:Sqlcollaborative.Dbatools.Connection.ManagementConnection.ToString">
<summary>
Simple string representation
</summary>
<returns>Returns the computerName it is connection for</returns>
</member>
<member name="T:Sqlcollaborative.Dbatools.Connection.ManagementConnectionProtocolState">
<summary>
The various types of state a connection-protocol may have
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionProtocolState.Unknown">
<summary>
The default initial state, before any tests are performed
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionProtocolState.Success">
<summary>
A successful connection was last established
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionProtocolState.Error">
<summary>
Connecting using the relevant protocol failed last it was tried
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionProtocolState.Disabled">
<summary>
The relevant protocol has been disabled and should not be used
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Connection.ManagementConnectionType">
<summary>
The various ways to connect to a windows server fopr management purposes.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionType.None">
<summary>
No Connection-Type
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionType.CimRM">
<summary>
Cim over a WinRM connection
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionType.CimDCOM">
<summary>
Cim over a DCOM connection
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionType.Wmi">
<summary>
WMI Connection
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.ManagementConnectionType.PowerShellRemoting">
<summary>
Connecting with PowerShell remoting and performing WMI queries locally
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.Connection.SqlConnectionProtocol">
<summary>
The protocol to connect over via SMO
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.SqlConnectionProtocol.Any">
<summary>
Connect using any protocol available
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.SqlConnectionProtocol.TCP">
<summary>
Connect using TCP/IP
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.Connection.SqlConnectionProtocol.NP">
<summary>
Connect using named pipes or shared memory
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.dbaSystem.StartTimeEntry">
<summary>
Entry containing the information of a step during the import sequence
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.StartTimeEntry.Action">
<summary>
The action that has been taken
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.StartTimeEntry.Timestamp">
<summary>
When was the action taken?
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.StartTimeEntry.Runspace">
<summary>
The runspace the entry was written on
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.dbaSystem.StartTimeEntry.#ctor(System.String,System.DateTime,System.Guid)">
<summary>
Creates a new StartTimeEntry
</summary>
<param name="Action">The action that has been taken</param>
<param name="Timestamp">When was the action taken?</param>
<param name="Runspace">The runspace the entry was written on</param>
</member>
<member name="T:Sqlcollaborative.Dbatools.dbaSystem.StartTimeResult">
<summary>
The processed result how long a given step took
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.StartTimeResult.Action">
<summary>
What action was taken?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.StartTimeResult.Duration">
<summary>
How long did things take?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.StartTimeResult.Start">
<summary>
When did this action start?
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.StartTimeResult.End">
<summary>
When did this action end?
</summary>
</member>
<member name="M:Sqlcollaborative.Dbatools.dbaSystem.StartTimeResult.#ctor(System.String,System.DateTime,System.DateTime)">
<summary>
Creates a new StartTimeResult with all values preconfigured
</summary>
<param name="Action">The action that was taken</param>
<param name="Start">When did the action start?</param>
<param name="End">When did the action end?</param>
</member>
<member name="T:Sqlcollaborative.Dbatools.dbaSystem.SystemHost">
<summary>
Provides system-wide static resources regarding the dbatools system runtime in general
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.SystemHost.UnattendedMode">
<summary>
When this is set to true, functions must assume dbatools is in unattended mode. May not ask for user input of any kind.
</summary>
</member>
<member name="P:Sqlcollaborative.Dbatools.dbaSystem.SystemHost.ModuleBase">
<summary>
Path where the module was located when imported
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.SystemHost.ModuleImported">
<summary>
Flag whether the module has ever been imported in the current process. If that is true, several things (such as importing libraries) is no longer necessary and will be skipped on import.
</summary>
</member>
<member name="T:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord">
<summary>
An error record written by dbatools
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord.CategoryInfo">
<summary>
The category of the error
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord.ErrorDetails">
<summary>
The details on the error
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord.Exception">
<summary>
The actual exception thrown
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord.FullyQualifiedErrorId">
<summary>
The specific error identity, used to identify the target
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord.InvocationInfo">
<summary>
The details of how this was called.
</summary>
</member>
<member name="F:Sqlcollaborative.Dbatools.dbaSystem.DbaErrorRecord.ScriptStackTrace">
<summary>
The script's stacktrace
</summary>
</member>