-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathScan-ADComputers.ps1
More file actions
2853 lines (2345 loc) · 114 KB
/
Copy pathScan-ADComputers.ps1
File metadata and controls
2853 lines (2345 loc) · 114 KB
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
using module ./AdminToolsCommon.psm1
<#
.SYNOPSIS
Scan Active Directory for server or workstation computer objects and export reports.
.DESCRIPTION
Supports three broad feature phases in one script:
- AD inventory and reporting controls.
- Optional operational checks such as DNS, ports, and remote inventory.
- Usability controls such as config files, logging, and structured exit codes.
.PARAMETER ComputerType
The AD computer type to scan. Valid values are Server and Workstation.
.PARAMETER Mode
Full scans the selected computer type across the query scope.
Targeted scans only the names listed in ComputerListPath.
.PARAMETER DomainController
Optional writable Domain Controller to use after domain discovery verifies it against AD.
.PARAMETER DomainName
Optional AD DNS root. When supplied with DomainController from a VPN or non-domain client, DomainController is used as the bootstrap ADWS server and the discovered AD DNS root must match DomainName.
.PARAMETER ComputerListPath
Path to a text file containing computer names or FQDNs, one per line.
Required when Mode is Targeted.
.PARAMETER SearchBase
Optional distinguished name that limits the AD query scope to a specific OU or container.
.PARAMETER SearchBaseList
Optional list of distinguished names to query. Can be combined with SearchBase.
.PARAMETER ExcludeOU
Optional list of OU distinguished names to exclude from the final output.
.PARAMETER InactiveDays
Optional inactivity threshold used to flag stale devices.
.PARAMETER IncludeDisabled
Include disabled AD computer objects in the scan.
.PARAMETER ExportFormat
One or more export formats: Csv, Json, Html.
.PARAMETER CompareWithPrevious
Path to a previous Csv or Json inventory export. A delta report is generated.
.PARAMETER SummaryOnly
Skip the main inventory export and export summary breakdowns instead.
.PARAMETER SeparateStatusExports
In Targeted mode, export separate matched, unreachable, and not-found status reports.
.PARAMETER ResolveDns
Resolve forward DNS for each exported computer and flag mismatches.
.PARAMETER TestPorts
One or more TCP ports to test for each exported computer.
.PARAMETER RemoteInventory
Attempt remote inventory collection for each exported computer.
.PARAMETER TimeoutSeconds
Timeout for connectivity and remote inventory operations.
.PARAMETER ThrottleLimit
Throttle limit used for parallel connectivity and operational checks.
.PARAMETER PingCount
Number of ICMP echo requests to use when TestMethod is Ping.
.PARAMETER TestMethod
Connectivity method used in Targeted mode and optional operational enrichment.
Valid values are Ping, WinRM, and None.
.PARAMETER SkipPing
Backward-compatible shortcut that forces TestMethod to None.
.PARAMETER CredentialSecretName
SecretManagement secret name containing a PSCredential.
.PARAMETER CredentialPath
Path to a PSCredential exported with Export-Clixml. Credential files must be outside the repository directory.
.PARAMETER RemoteInventoryCredential
Separate least-privilege credential for CIM remote inventory. The AD query credential is not reused for remote inventory.
.PARAMETER RemoteInventoryCredentialSecretName
SecretManagement secret name containing the remote inventory PSCredential.
.PARAMETER RemoteInventoryCredentialPath
Path to a remote inventory PSCredential exported with Export-Clixml. Credential files must be outside the repository directory.
.PARAMETER ConfigPath
Optional path to a Json configuration file.
.PARAMETER LogPath
Optional path to the run log file.
.PARAMETER NoProgress
Suppress transient Write-Progress feedback for unattended or redirected runs.
.PARAMETER NoClobber
Fail if an output or log file already exists instead of overwriting it.
.PARAMETER ForceOverwrite
Overwrite existing output or log files. Existing files are not overwritten by default.
.PARAMETER AllowNetworkOutputPath
Allow writing reports and logs to UNC paths. Network output paths are rejected by default.
.PARAMETER AllowNetworkInputPath
Allow reading configuration, target list, or comparison files from UNC paths.
Network input paths are rejected by default.
.PARAMETER DisableCsvSanitization
Export raw string values without Excel formula injection protection.
.EXAMPLE
.\Scan-ADComputers.ps1 -ComputerType Server -Mode Full
.EXAMPLE
.\Scan-ADComputers.ps1 -ComputerType Workstation -Mode Targeted `
-ComputerListPath .\workstationlist.txt `
-ResolveDns `
-TestPorts 445,3389 `
-InactiveDays 90
.EXAMPLE
.\Scan-ADComputers.ps1 -ConfigPath .\Scan-ADComputers.json
.EXAMPLE
.\Scan-ADComputers.ps1 -ComputerType Server -Mode Full -NoProgress
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
"PSUseSingularNouns",
"",
Justification = "These established internal helpers intentionally return or validate collections."
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
"PSUseUsingScopeModifierInNewRunspaces",
"",
Justification = "Flagged names are parameters of nested functions declared inside each parallel runspace, not captured parent variables."
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
"PSAvoidUsingPlainTextForPassword",
"",
Justification = "CredentialSecretName and RemoteInventoryCredentialSecretName are SecretManagement lookup keys; CredentialPath and RemoteInventoryCredentialPath are file paths. None of these parameters carries a password value."
)]
[CmdletBinding(SupportsShouldProcess = $true)]
param(
[Parameter(Mandatory = $false)]
[ValidateSet("Server", "Workstation")]
[string]$ComputerType = "Server",
[Parameter(Mandatory = $false)]
[ValidateSet("Full", "Targeted")]
[string]$Mode = "Full",
[Parameter(Mandatory = $false)]
[string]$DomainController,
[Parameter(Mandatory = $false)]
[string]$DomainName,
[Parameter(Mandatory = $false)]
[PSCredential]$Credential,
[Parameter(Mandatory = $false)]
[string]$CredentialSecretName,
[Parameter(Mandatory = $false)]
[string]$CredentialPath,
[Parameter(Mandatory = $false)]
[PSCredential]$RemoteInventoryCredential,
[Parameter(Mandatory = $false)]
[string]$RemoteInventoryCredentialSecretName,
[Parameter(Mandatory = $false)]
[string]$RemoteInventoryCredentialPath,
[Parameter(Mandatory = $false)]
[string]$ComputerListPath,
[Parameter(Mandatory = $false)]
[string]$OutputDirectory,
[Parameter(Mandatory = $false)]
[string]$SearchBase,
[Parameter(Mandatory = $false)]
[string[]]$SearchBaseList,
[Parameter(Mandatory = $false)]
[string[]]$ExcludeOU,
[Parameter(Mandatory = $false)]
[ValidateRange(1, 3650)]
[int]$InactiveDays,
[Parameter(Mandatory = $false)]
[switch]$IncludeDisabled,
[Parameter(Mandatory = $false)]
[ValidateSet("Csv", "Json", "Html")]
[string[]]$ExportFormat = @("Csv"),
[Parameter(Mandatory = $false)]
[string]$CompareWithPrevious,
[Parameter(Mandatory = $false)]
[switch]$SummaryOnly,
[Parameter(Mandatory = $false)]
[switch]$SeparateStatusExports,
[Parameter(Mandatory = $false)]
[switch]$ResolveDns,
[Parameter(Mandatory = $false)]
[ValidateRange(1, 65535)]
[int[]]$TestPorts,
[Parameter(Mandatory = $false)]
[switch]$RemoteInventory,
[Parameter(Mandatory = $false)]
[ValidateRange(1, 300)]
[int]$TimeoutSeconds = 5,
[Parameter(Mandatory = $false)]
[ValidateRange(1, 128)]
[int]$ThrottleLimit = 10,
[Parameter(Mandatory = $false)]
[ValidateRange(0, 128)]
[int]$ConnectivityThrottleLimit = 0,
[Parameter(Mandatory = $false)]
[ValidateRange(0, 128)]
[int]$DnsThrottleLimit = 0,
[Parameter(Mandatory = $false)]
[ValidateRange(0, 128)]
[int]$PortThrottleLimit = 0,
[Parameter(Mandatory = $false)]
[ValidateRange(0, 128)]
[int]$RemoteInventoryThrottleLimit = 0,
[Parameter(Mandatory = $false)]
[ValidateRange(1, 100000)]
[int]$AdResultPageSize = 1000,
[Parameter(Mandatory = $false)]
[ValidateSet("Base", "OneLevel", "Subtree")]
[string]$AdSearchScope = "Subtree",
[Parameter(Mandatory = $false)]
[ValidateRange(1, 1000)]
[int]$TargetedQueryChunkSize = 40,
[Parameter(Mandatory = $false)]
[switch]$PerformanceSummary,
[Parameter(Mandatory = $false)]
[ValidateRange(1, 10)]
[int]$PingCount = 1,
[Parameter(Mandatory = $false)]
[ValidateSet("Ping", "WinRM", "None")]
[string]$TestMethod = "Ping",
[Parameter(Mandatory = $false)]
[switch]$SkipPing,
[Parameter(Mandatory = $false)]
[string]$ConfigPath,
[Parameter(Mandatory = $false)]
[string]$LogPath,
[Parameter(Mandatory = $false)]
[switch]$NoProgress,
[Parameter(Mandatory = $false)]
[switch]$NoClobber,
[Parameter(Mandatory = $false)]
[switch]$ForceOverwrite,
[Parameter(Mandatory = $false)]
[switch]$AllowNetworkOutputPath,
[Parameter(Mandatory = $false)]
[switch]$AllowNetworkInputPath,
[Parameter(Mandatory = $false)]
[switch]$DisableCsvSanitization
)
Import-Module (Join-Path $PSScriptRoot "AdminToolsCommon.psm1") -Force -ErrorAction Stop
$InformationPreference = "Continue"
$ScriptDirectory = if ($PSScriptRoot) {
$PSScriptRoot
}
else {
Split-Path -Parent $MyInvocation.MyCommand.Path
}
$RunTimestamp = (Get-Date).ToString("yyyyMMddHHmmss")
$RunStartedAt = Get-Date
$ExitCodes = @{
General = 1
Prereq = 2
Config = 3
Validation = 4
ADQuery = 5
Operational = 6
Export = 7
Compare = 8
}
$script:InitialBoundParameters = @{}
foreach ($key in $PSBoundParameters.Keys) {
$script:InitialBoundParameters[$key] = $PSBoundParameters[$key]
}
$script:LogFilePath = $null
$script:FileLoggingEnabled = $false
$script:PerformanceStages = New-Object 'System.Collections.Generic.List[object]'
if ($ForceOverwrite -and $NoClobber) {
Write-Error "ForceOverwrite and NoClobber cannot be used together."
exit $ExitCodes.Validation
}
function Write-AdminToolsLog {
param(
[Parameter(Mandatory = $true)]
[string]$Message,
[Parameter(Mandatory = $false)]
[ValidateSet("Info", "Warning", "Error", "Verbose")]
[string]$Level = "Info"
)
$timestamp = (Get-Date).ToString("yyyy-MM-dd HH:mm:ss")
$entry = "[{0}] [{1}] {2}" -f $timestamp, $Level.ToUpperInvariant(), $Message
switch ($Level) {
"Info" { Write-Information $Message }
"Warning" { Write-Warning $Message }
"Error" { Write-Error $Message }
"Verbose" { Write-Verbose $Message }
}
if ($script:FileLoggingEnabled -and -not [string]::IsNullOrWhiteSpace($script:LogFilePath)) {
Add-Content -LiteralPath $script:LogFilePath -Value $entry
}
}
function Write-ErrorAndExit {
param(
[Parameter(Mandatory = $true)]
[string]$Message,
[Parameter(Mandatory = $false)]
[ValidateSet("General", "Prereq", "Config", "Validation", "ADQuery", "Operational", "Export", "Compare")]
[string]$CodeKey = "General"
)
Write-AdminToolsLog -Message $Message -Level Error
exit $ExitCodes[$CodeKey]
}
function Resolve-ExistingPath {
param(
[Parameter(Mandatory = $true)]
[string]$Path,
[Parameter(Mandatory = $true)]
[string]$BaseDirectory
)
if ([string]::IsNullOrWhiteSpace($Path)) {
return $null
}
if ([System.IO.Path]::IsPathRooted($Path)) {
return $Path
}
$currentLocationCandidate = Join-Path (Get-Location).Path $Path
if (Test-Path -LiteralPath $currentLocationCandidate) {
return (Resolve-Path -LiteralPath $currentLocationCandidate).Path
}
return (Join-Path $BaseDirectory $Path)
}
function Resolve-OutputPath {
param(
[Parameter(Mandatory = $true)]
[string]$Path,
[Parameter(Mandatory = $true)]
[string]$BaseDirectory
)
if ([System.IO.Path]::IsPathRooted($Path)) {
return $Path
}
return (Join-Path $BaseDirectory $Path)
}
function Get-SafeFileNamePart {
param(
[Parameter(Mandatory = $false)]
[string]$Value
)
if ([string]::IsNullOrWhiteSpace($Value)) {
return "domain"
}
return ($Value -replace '[^a-zA-Z0-9._-]', '_')
}
function Test-IsInDnsSuffix {
param(
[Parameter(Mandatory = $true)]
[string]$Name,
[Parameter(Mandatory = $true)]
[string]$DnsSuffix
)
return (
$Name.Equals($DnsSuffix, [System.StringComparison]::OrdinalIgnoreCase) -or
$Name.EndsWith(".$DnsSuffix", [System.StringComparison]::OrdinalIgnoreCase)
)
}
function Test-IsSafeShortComputerName {
param(
[Parameter(Mandatory = $true)]
[string]$Name
)
return $Name -match '^[A-Za-z0-9][A-Za-z0-9_-]{0,14}$'
}
function Assert-SafeDnsName {
param(
[Parameter(Mandatory = $true)]
[string]$Name,
[Parameter(Mandatory = $true)]
[string]$Purpose
)
if (-not (Test-IsSafeDnsName -Name $Name)) {
Write-ErrorAndExit -Message "$Purpose contains invalid DNS name characters or length: $Name" -CodeKey Validation
}
}
function Get-VerifiedDomainControllerName {
param(
[Parameter(Mandatory = $true)]
[string]$DomainController,
[Parameter(Mandatory = $true)]
[PSCredential]$Credential,
[Parameter(Mandatory = $false)]
[string]$DiscoveryServer
)
Assert-SafeDnsName -Name $DomainController -Purpose "DomainController"
$domainControllerDiscoveryParameters = @{
Filter = "*"
Credential = $Credential
ErrorAction = "Stop"
}
if (-not [string]::IsNullOrWhiteSpace($DiscoveryServer)) {
Assert-SafeDnsName -Name $DiscoveryServer -Purpose "DomainControllerDiscoveryServer"
$domainControllerDiscoveryParameters["Server"] = $DiscoveryServer
}
try {
$discoveredDomainControllers = @(Get-ADDomainController @domainControllerDiscoveryParameters |
Where-Object { -not $_.IsReadOnly })
}
catch {
Write-ErrorAndExit -Message "Failed to verify DomainController '$DomainController' against discovered writable Domain Controllers: $($_.Exception.Message)" -CodeKey ADQuery
}
$discoveredNames = [System.Collections.Generic.HashSet[string]]::new([System.StringComparer]::OrdinalIgnoreCase)
foreach ($discoveredDomainController in $discoveredDomainControllers) {
foreach ($name in @($discoveredDomainController.HostName, $discoveredDomainController.Name)) {
if ([string]::IsNullOrWhiteSpace([string]$name)) {
continue
}
[void]$discoveredNames.Add([string]$name)
[void]$discoveredNames.Add(([string]$name -split '\.')[0])
}
}
if (-not $discoveredNames.Contains($DomainController)) {
Write-ErrorAndExit -Message "Provided DomainController '$DomainController' was not found in discovered writable Domain Controllers." -CodeKey Validation
}
foreach ($discoveredDomainController in $discoveredDomainControllers) {
if ($DomainController.Equals([string]$discoveredDomainController.HostName, [System.StringComparison]::OrdinalIgnoreCase)) {
return [string]$discoveredDomainController.HostName
}
if ($DomainController.Equals([string]$discoveredDomainController.Name, [System.StringComparison]::OrdinalIgnoreCase) -or $DomainController.Equals(([string]$discoveredDomainController.HostName -split '\.')[0], [System.StringComparison]::OrdinalIgnoreCase)) {
return [string]$discoveredDomainController.HostName
}
}
return $DomainController
}
function Test-ComputerHasExpectedSpn {
param(
[Parameter(Mandatory = $true)]
[psobject]$ComputerRecord,
[Parameter(Mandatory = $true)]
[string]$TargetName
)
$servicePrincipalNames = @([string]$ComputerRecord.ServicePrincipalName -split ';' | Where-Object { -not [string]::IsNullOrWhiteSpace($_) })
if ($servicePrincipalNames.Count -eq 0) {
return $false
}
$targetShortName = ($TargetName -split '\.')[0]
$expectedSpns = @(
"HOST/$TargetName",
"HOST/$targetShortName",
"HTTP/$TargetName",
"HTTP/$targetShortName",
"WSMAN/$TargetName",
"WSMAN/$targetShortName"
)
foreach ($expectedSpn in $expectedSpns) {
if ($servicePrincipalNames -contains $expectedSpn) {
return $true
}
}
return $false
}
function Assert-AllowedValues {
param(
[Parameter(Mandatory = $true)]
[string]$Purpose,
[Parameter(Mandatory = $false)]
[AllowNull()]
[string[]]$Values,
[Parameter(Mandatory = $true)]
[string[]]$AllowedValues
)
$AllowedSet = [System.Collections.Generic.HashSet[string]]::new(
[System.StringComparer]::OrdinalIgnoreCase
)
foreach ($AllowedValue in $AllowedValues) {
[void]$AllowedSet.Add($AllowedValue)
}
foreach ($Value in @($Values)) {
if ([string]::IsNullOrWhiteSpace($Value) -or $AllowedSet.Contains($Value)) {
continue
}
Write-ErrorAndExit -Message "$Purpose contains unsupported value '$Value'. Allowed values: $($AllowedValues -join ', ')." -CodeKey Validation
}
}
function Assert-IntegerRange {
param(
[Parameter(Mandatory = $true)]
[string]$Purpose,
[Parameter(Mandatory = $true)]
[int]$Value,
[Parameter(Mandatory = $true)]
[int]$Minimum,
[Parameter(Mandatory = $true)]
[int]$Maximum
)
if ($Value -lt $Minimum -or $Value -gt $Maximum) {
Write-ErrorAndExit -Message "$Purpose must be between $Minimum and $Maximum." -CodeKey Validation
}
}
function Assert-OutputPathAllowed {
param(
[Parameter(Mandatory = $true)]
[string]$Path,
[Parameter(Mandatory = $true)]
[string]$Purpose
)
if ((Test-IsUncPath -Path $Path) -and -not $AllowNetworkOutputPath) {
Write-ErrorAndExit -Message "Network $Purpose paths are not allowed by default: $Path. Re-run with -AllowNetworkOutputPath only if the location is trusted." -CodeKey Validation
}
if ((Test-Path -LiteralPath $Path) -and ($NoClobber -or -not $ForceOverwrite)) {
Write-ErrorAndExit -Message "$Purpose path already exists: $Path. Re-run with -ForceOverwrite only if replacing it is intended." -CodeKey Validation
}
if ((Test-Path -LiteralPath $Path) -and $ForceOverwrite) {
Write-Warning "Overwriting existing $Purpose path: $Path"
}
}
function Assert-InputPathAllowed {
param(
[Parameter(Mandatory = $true)]
[string]$Path,
[Parameter(Mandatory = $true)]
[string]$Purpose
)
if ((Test-IsUncPath -Path $Path) -and -not $AllowNetworkInputPath) {
Write-ErrorAndExit -Message "Network $Purpose paths are not allowed by default: $Path. Re-run with -AllowNetworkInputPath only if the location is trusted." -CodeKey Validation
}
}
function Import-TrustedActiveDirectoryModule {
$loadedModules = @(Get-Module -Name ActiveDirectory -ErrorAction SilentlyContinue)
if ($loadedModules.Count -gt 0) {
foreach ($loadedModule in $loadedModules) {
if (-not (Test-IsTrustedActiveDirectoryModulePath -Path $loadedModule.ModuleBase)) {
Write-ErrorAndExit -Message "ActiveDirectory module is already loaded from an untrusted path: $($loadedModule.ModuleBase)" -CodeKey Prereq
}
}
return
}
$trustedModule = @(Get-Module -ListAvailable -Name ActiveDirectory -ErrorAction SilentlyContinue |
Where-Object { Test-IsTrustedActiveDirectoryModulePath -Path $_.ModuleBase } |
Sort-Object -Property Version -Descending |
Select-Object -First 1)
if ($trustedModule.Count -eq 0) {
Write-ErrorAndExit -Message '"ActiveDirectory" module not found in the trusted Windows RSAT module path. Install RSAT Active Directory Tools on this machine.' -CodeKey Prereq
}
try {
$moduleSpecification = @{
ModuleName = "ActiveDirectory"
ModuleVersion = $trustedModule[0].Version
}
if ($trustedModule[0].Guid -and $trustedModule[0].Guid -ne [guid]::Empty) {
$moduleSpecification["Guid"] = $trustedModule[0].Guid
}
Import-Module -FullyQualifiedName $moduleSpecification -ErrorAction Stop
}
catch {
Write-ErrorAndExit -Message "ActiveDirectory module could not be loaded from trusted path '$($trustedModule[0].ModuleBase)'. Error: $($_.Exception.Message)" -CodeKey Prereq
}
}
$script:ConfigSourcedParameters = [System.Collections.Generic.HashSet[string]]::new(
[System.StringComparer]::OrdinalIgnoreCase
)
function Set-ParameterFromConfig {
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
"PSUseShouldProcessForStateChangingFunctions",
"",
Justification = "This initialization helper applies configuration to script-local variables; ShouldProcess would incorrectly skip config under WhatIf."
)]
param(
[Parameter(Mandatory = $true)]
[psobject]$ConfigObject,
[Parameter(Mandatory = $true)]
[string]$ParameterName
)
if ($script:InitialBoundParameters.ContainsKey($ParameterName)) {
return
}
$property = $ConfigObject.PSObject.Properties[$ParameterName]
if ($null -eq $property -or $null -eq $property.Value) {
return
}
Set-Variable -Name $ParameterName -Value $property.Value -Scope Script
[void]$script:ConfigSourcedParameters.Add($ParameterName)
}
function Write-ScanProgress {
param(
[Parameter(Mandatory = $true)]
[int]$Id,
[Parameter(Mandatory = $true)]
[string]$Activity,
[Parameter(Mandatory = $true)]
[string]$Status,
[Parameter(Mandatory = $false)]
[int]$CompletedCount = 0,
[Parameter(Mandatory = $false)]
[int]$TotalCount = 0
)
if ($NoProgress) {
return
}
$progressParameters = @{
Id = $Id
Activity = $Activity
Status = $Status
}
if ($TotalCount -gt 0) {
$boundedCompleted = [Math]::Min([Math]::Max($CompletedCount, 0), $TotalCount)
$progressParameters["PercentComplete"] = [int][Math]::Floor(($boundedCompleted / $TotalCount) * 100)
}
Write-Progress @progressParameters
}
function Complete-ScanProgress {
param(
[Parameter(Mandatory = $true)]
[int]$Id,
[Parameter(Mandatory = $true)]
[string]$Activity
)
if ($NoProgress) {
return
}
Write-Progress -Id $Id -Activity $Activity -Completed
}
function Measure-PerformanceStage {
param(
[Parameter(Mandatory = $true)]
[string]$Name,
[Parameter(Mandatory = $false)]
[Nullable[int]]$InputCount = $null,
[Parameter(Mandatory = $false)]
[Nullable[int]]$EffectiveThrottle = $null,
[Parameter(Mandatory = $false)]
[string]$Details = $null
)
[PSCustomObject]@{
Name = $Name
Stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
StartedAt = Get-Date
InputCount = $InputCount
OutputCount = $null
EffectiveThrottle = $EffectiveThrottle
Details = $Details
}
}
function Complete-PerformanceStage {
param(
[Parameter(Mandatory = $true)]
[psobject]$Stage,
[Parameter(Mandatory = $false)]
[Nullable[int]]$InputCount = $null,
[Parameter(Mandatory = $false)]
[Nullable[int]]$OutputCount = $null,
[Parameter(Mandatory = $false)]
[string]$Details = $null
)
$Stage.Stopwatch.Stop()
if ($null -ne $InputCount) { $Stage.InputCount = $InputCount }
if ($null -ne $OutputCount) { $Stage.OutputCount = $OutputCount }
if (-not [string]::IsNullOrWhiteSpace($Details)) {
if ([string]::IsNullOrWhiteSpace([string]$Stage.Details)) { $Stage.Details = $Details } else { $Stage.Details = "{0}; {1}" -f $Stage.Details, $Details }
}
$entry = [PSCustomObject]@{
Stage = [string]$Stage.Name
StartedAt = $Stage.StartedAt
ElapsedMs = [Math]::Round($Stage.Stopwatch.Elapsed.TotalMilliseconds, 2)
InputCount = $Stage.InputCount
OutputCount = $Stage.OutputCount
EffectiveThrottle = $Stage.EffectiveThrottle
Details = $Stage.Details
}
[void]$script:PerformanceStages.Add($entry)
Write-AdminToolsLog -Message ("Stage {0}: {1} ms; input={2}; output={3}; throttle={4}; {5}" -f $entry.Stage, $entry.ElapsedMs, $(if ($null -eq $entry.InputCount) { "n/a" } else { $entry.InputCount }), $(if ($null -eq $entry.OutputCount) { "n/a" } else { $entry.OutputCount }), $(if ($null -eq $entry.EffectiveThrottle) { "n/a" } else { $entry.EffectiveThrottle }), $entry.Details) -Level Info
return $entry
}
function Export-PerformanceSummary {
param(
[Parameter(Mandatory = $true)]
[string]$BasePath
)
if (-not $PerformanceSummary.IsPresent) {
return @()
}
$records = @($script:PerformanceStages)
$exportedPaths = New-Object 'System.Collections.Generic.List[string]'
$csvPath = "$BasePath.csv"
Assert-OutputPathAllowed -Path $csvPath -Purpose "performance summary"
if ((Test-Path -LiteralPath $csvPath) -and $NoClobber -and -not $ForceOverwrite) {
Write-ErrorAndExit -Message "Performance summary already exists: $csvPath. Use -ForceOverwrite or remove -NoClobber." -CodeKey Export
}
$records | Export-Csv -LiteralPath $csvPath -NoTypeInformation
[void]$exportedPaths.Add($csvPath)
$jsonPath = "$BasePath.json"
Assert-OutputPathAllowed -Path $jsonPath -Purpose "performance summary"
if ((Test-Path -LiteralPath $jsonPath) -and $NoClobber -and -not $ForceOverwrite) {
Write-ErrorAndExit -Message "Performance summary already exists: $jsonPath. Use -ForceOverwrite or remove -NoClobber." -CodeKey Export
}
$records | ConvertTo-Json -Depth 4 | Set-Content -LiteralPath $jsonPath
[void]$exportedPaths.Add($jsonPath)
Write-AdminToolsLog -Message ("Exported performance summary: {0}" -f ([string]::Join(', ', $exportedPaths))) -Level Info
return @($exportedPaths)
}
function Get-EffectiveThrottleLimit {
param(
[Parameter(Mandatory = $true)]
[int]$SpecificThrottleLimit,
[Parameter(Mandatory = $true)]
[int]$DefaultThrottleLimit
)
if ($SpecificThrottleLimit -gt 0) {
return $SpecificThrottleLimit
}
return $DefaultThrottleLimit
}
function Test-ShouldUpdateProgress {
param(
[Parameter(Mandatory = $true)]
[int]$CurrentCount,
[Parameter(Mandatory = $true)]
[int]$TotalCount,
[Parameter(Mandatory = $true)]
[int]$ProgressUpdateInterval
)
if ($CurrentCount -le 0) {
return $false
}
return (($CurrentCount % $ProgressUpdateInterval) -eq 0 -or $CurrentCount -ge $TotalCount)
}
function Initialize-LogFile {
param(
[Parameter(Mandatory = $true)]
[string]$Path
)
if ($WhatIfPreference) {
Write-Information "WhatIf: would initialize log file -> $Path"
return
}
Assert-OutputPathAllowed -Path $Path -Purpose "log"
$logDirectory = Split-Path -Parent $Path
if (-not [string]::IsNullOrWhiteSpace($logDirectory) -and -not (Test-Path -LiteralPath $logDirectory)) {
New-Item -ItemType Directory -Path $logDirectory -Force -ErrorAction Stop | Out-Null
}
if (-not (Test-Path -LiteralPath $Path)) {
New-Item -ItemType File -Path $Path -Force -ErrorAction Stop | Out-Null
}
$script:LogFilePath = $Path
$script:FileLoggingEnabled = $true
}
function Get-WithRetry {
param(
[Parameter(Mandatory = $true)]
[scriptblock]$ScriptBlock,
[int]$MaxAttempts = 3,
[int]$DelaySeconds = 5
)
# These patterns indicate transient conditions worth retrying.
# Authorization, filter, and object-not-found errors are permanent
# and are re-thrown immediately.
$TransientPatterns = @(
"timeout",
"RPC",
"network",
"busy",
"temporarily unavailable",
"server is unavailable"
)
$PermanentPatterns = @(
"Access is denied",
"Insufficient access",
"UnauthorizedAccessException",
"invalid filter",
"No such object",
"The server does not support the requested critical extension"
)
$attempt = 0
while ($attempt -lt $MaxAttempts) {
try {
return & $ScriptBlock
}
catch {
$errorMessage = $_.Exception.Message
$isPermanent = $PermanentPatterns | Where-Object { $errorMessage -match $_ }
if ($isPermanent) {
Write-AdminToolsLog -Message ("Permanent failure, not retrying: {0}" -f $errorMessage) -Level Warning
throw
}
$attempt++
Write-AdminToolsLog -Message ("Attempt {0} failed: {1}" -f $attempt, $errorMessage) -Level Warning
if ($attempt -lt $MaxAttempts) {
$isTransient = $TransientPatterns | Where-Object { $errorMessage -match $_ }
if (-not $isTransient) {
Write-AdminToolsLog -Message "Failure does not match known transient patterns; retrying anyway." -Level Warning
}
Start-Sleep -Seconds $DelaySeconds
}
else {
throw
}
}
}
}
function Get-ComputerTypeFilter {
param(
[Parameter(Mandatory = $true)]