-
Notifications
You must be signed in to change notification settings - Fork 4
/
ESXiAccountManagement.ps1
1354 lines (1261 loc) · 57.2 KB
/
ESXiAccountManagement.ps1
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
function Get-ESXiAccount {
<#
.SYNOPSIS
Get ESXi 6.x and above local account
.DESCRIPTION
List all local ESXi 6.x and above account(s) and their role
.NOTES
Author: Edgar Sanchez - @edmsanchez13
.Link
https://github.com/edmsanchez/PowerShell
.INPUTS
No inputs required
.OUTPUTS
To Screen
.PARAMETER VMhost
The name(s) of the vSphere ESXi Host(s)
.EXAMPLE
Get-ESXiAccount -VMhost devvm001.lab.local
.PARAMETER Cluster
The name(s) of the vSphere Cluster(s)
.EXAMPLE
Get-ESXiAccount -Cluster production-cluster
.PARAMETER Datacenter
The name(s) of the vSphere Virtual Datacenter(s).
.EXAMPLE
Get-ESXiAccount -Datacenter vDC001
#>
<#
----------------------------------------------------------[Declarations]----------------------------------------------------------
#>
[CmdletBinding()]
param (
[Parameter(Mandatory = $false)]$VMhost,
[Parameter(Mandatory = $false)]$Cluster,
[Parameter(Mandatory = $false)]$Datacenter
)
$skipCollection = @()
$outputCollection = @()
$vHostList = @()
$date = Get-Date -format s
$date = $date -replace ":", "-"
<#
----------------------------------------------------------[Execution]----------------------------------------------------------
#>
<#
Query PowerCLI version if
running Verbose
#>
if ($VerbosePreference -eq "continue") {
Write-Verbose -Message ((Get-Date -Format G) + "`tPowerCLI Version:")
Get-Module -Name VMware.* | Select-Object -Property Name, Version | Format-Table -AutoSize
} #END if
<#
Validate if a parameter was specified (-VMhost, -Cluster, or -Datacenter)
Although all 3 can be specified, only the first one is used
Example: -VMhost "host001" -Cluster "test-cluster". -VMhost is the first parameter
and what will be used.
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate parameters used")
if ([string]::IsNullOrWhiteSpace($VMhost) -and [string]::IsNullOrWhiteSpace($Cluster) -and [string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Error -Message "You must specify a parameter (-VMhost, -Cluster, or -Datacenter)."
break
} #END if
<#
Check for an active connection to a VIServer
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate connection to a vSphere server")
if ($Global:DefaultViServers.Count -gt 0) {
Write-Host "`tConnected to $Global:DefaultViServers" -ForegroundColor Green
}
else {
Write-Error -Message "You must be connected to a vSphere server before running this Cmdlet."
break
} #END if/else
<#
Gather host list based on parameter used
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tGather host list")
if ([string]::IsNullOrWhiteSpace($VMhost)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-VMhost parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Cluster)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Cluster parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Datacenter parameter is Null or Empty")
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using Datacenter parameter")
Write-Host "`tGathering host list from the following DataCenter(s): " (@($Datacenter) -join ',')
foreach ($vDCname in $Datacenter) {
$tempList = Get-Datacenter -Name $vDCname.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tDatacenter with name $vDCname was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using cluster parameter")
Write-Host "`tGathering host list from the following Cluster(s): " (@($cluster) -join ',')
foreach ($vClusterName in $Cluster) {
$tempList = Get-Cluster -Name $vClusterName.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tCluster with name $vClusterName was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using VMhost parameter")
Write-Host "`tGathering host list..."
foreach ($invidualHost in $VMhost) {
$tempList = Get-VMHost -Name $invidualHost.Trim() -ErrorAction SilentlyContinue
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tESXi host $invidualHost was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
$tempList = $null
<#
Main code execution
#>
foreach ($vmhost in $vHostList) {
<#
Skip if ESXi host is not in a Connected
or Maintenance ConnectionState
#>
Write-Verbose -Message ((Get-Date -Format G) + "`t$vmhost Connection State: " + $vmhost.ConnectionState)
if ($vmhost.ConnectionState -eq "Connected" -or $vmhost.ConnectionState -eq "Maintenance") {
<#
Do nothing - ESXi host is reachable
#>
}
else {
<#
Use a custom object to keep track of skipped
hosts and continue to the next foreach loop
#>
$skipCollection += [pscustomobject]@{
'Hostname' = $vmhost.Name
'Connection State' = $vmhost.ConnectionState
} #END [PSCustomObject]
continue
} #END if/else
<#
Validate ESXi Version
Will run only of 6.x and above
#>
if ([decimal]$vmHost.ApiVersion.Substring(0, 3) -lt 6) {
Write-Warning -Message ("`t$vmhost is ESXi v" + $vmhost.ApiVersion + ". Skipping host.")
continue
}
<#
Get list of local accounts
#>
Write-Host "`tGathering local accounts from $vmhost ..."
$esxcli = Get-EsxCli -VMHost $vmhost -V2
$localAccounts = $esxcli.system.account.list.Invoke()
$systemPermission = $esxcli.system.permission.list.Invoke()
foreach ($account in $localAccounts) {
$accountRole = $systemPermission | Where-Object { $_.Principal -eq $account.UserID } | Select-Object -ExpandProperty Role
<#
Use a custom object to store
collected data
#>
$outputCollection += [PSCustomObject]@{
'Hostname' = $vmhost.Name
'UserID' = $account.UserID
'Role' = $accountRole
'Description' = $account.Description
} #END [PSCustomObject]
} #END foreach
} #END foreach
<#
Display skipped hosts and their connection status
#>
If ($skipCollection) {
Write-Warning -Message "`tCheck Connection State or Host name"
Write-Warning -Message "`tSkipped hosts:"
$skipCollection | Format-Table -AutoSize
} #END if
<#
Validate output arrays
#>
if ($outputCollection) {
Write-Verbose -Message ((Get-Date -Format G) + "`tInformation gathered")
Write-Host "`nESXi Local Accounts:" -ForegroundColor Green
return $outputCollection
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tNo information gathered")
} #END if/else
} #END function
function Add-ESXiAccount {
<#
.SYNOPSIS
Add ESXi 6.x and above local account
.DESCRIPTION
Create local ESXi 6.x and above account
.NOTES
Author: Edgar Sanchez - @edmsanchez13
.Link
https://github.com/edmsanchez/PowerShell
.INPUTS
No inputs required
.OUTPUTS
To Screen
.PARAMETER Name
User ID to add
.Example
Add-ESXiAccount -Name "testuser"
.PARAMETER Description
User ID Description to add
.EXAMPLE
Add-ESXiAccount -Name "testuser" -Description "Local test User"
.PARAMETER Permission
Permission to assign the new User ID (Admin,ReadOnly,NoAccess)
.Example
Add-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin"
.PARAMETER VMhost
The name(s) of the vSphere ESXi Host(s)
.EXAMPLE
Add-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin" -VMhost devvm001.lab.local
.PARAMETER Cluster
The name(s) of the vSphere Cluster(s)
.EXAMPLE
Add-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin" -Cluster production-cluster
.PARAMETER Datacenter
The name(s) of the vSphere Virtual Datacenter(s).
.EXAMPLE
Add-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin" -Datacenter vDC001
.PARAMETER Credentials
Provides User Credentials as a PSCredential Object
.EXAMPLE
Add-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin" -Datacenter vDC001 -Credentials $UserCredentials
#>
<#
----------------------------------------------------------[Declarations]----------------------------------------------------------
#>
[CmdletBinding()]
param (
[Parameter(Mandatory = $true)][String]$Name,
[Parameter(Mandatory = $false)][String]$Description,
[Parameter(Mandatory = $false)][ValidateSet("Admin", "ReadOnly", "NoAccess")]$Permission,
[Parameter(Mandatory = $false)]$VMhost,
[Parameter(Mandatory = $false)]$Cluster,
[Parameter(Mandatory = $false)]$Datacenter,
[ValidateNotNull()]
[System.Management.Automation.PSCredential]
[System.Management.Automation.Credential()]
$Credentials = [System.Management.Automation.PSCredential]::Empty
)
$skipCollection = @()
$outputCollection = @()
$vHostList = @()
$date = Get-Date -format s
$date = $date -replace ":", "-"
<#
----------------------------------------------------------[Execution]----------------------------------------------------------
#>
<#
Query PowerCLI version if
running Verbose
#>
if ($VerbosePreference -eq "continue") {
Write-Verbose -Message ((Get-Date -Format G) + "`tPowerCLI Version:")
Get-Module -Name VMware.* | Select-Object -Property Name, Version | Format-Table -AutoSize
} #END if
<#
Validate if a parameter was specified (-VMhost, -Cluster, or -Datacenter)
Although all 3 can be specified, only the first one is used
Example: -VMhost "host001" -Cluster "test-cluster". -VMhost is the first parameter
and what will be used.
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate parameters used")
if ([string]::IsNullOrWhiteSpace($VMhost) -and [string]::IsNullOrWhiteSpace($Cluster) -and [string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Error -Message "You must specify a parameter (-VMhost, -Cluster, or -Datacenter)."
break
} #END if
<#
Check for an active connection to a VIServer
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate connection to a vSphere server")
if ($Global:DefaultViServers.Count -gt 0) {
Write-Host "`tConnected to $Global:DefaultViServers" -ForegroundColor Green
}
else {
Write-Error -Message "You must be connected to a vSphere server before running this Cmdlet."
break
} #END if/else
<#
Gather host list based on parameter used
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tGather host list")
if ([string]::IsNullOrWhiteSpace($VMhost)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-VMhost parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Cluster)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Cluster parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Datacenter parameter is Null or Empty")
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using Datacenter parameter")
Write-Host "`tGathering host list from the following DataCenter(s): " (@($Datacenter) -join ',')
foreach ($vDCname in $Datacenter) {
$tempList = Get-Datacenter -Name $vDCname.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tDatacenter with name $vDCname was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using cluster parameter")
Write-Host "`tGathering host list from the following Cluster(s): " (@($cluster) -join ',')
foreach ($vClusterName in $Cluster) {
$tempList = Get-Cluster -Name $vClusterName.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tCluster with name $vClusterName was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using VMhost parameter")
Write-Host "`tGathering host list..."
foreach ($invidualHost in $VMhost) {
$tempList = Get-VMHost -Name $invidualHost.Trim() -ErrorAction SilentlyContinue
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tESXi host $invidualHost was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
$tempList = $null
<#
Main code execution
#>
#Validate PSCredential
if ($Credentials -eq [System.Management.Automation.PSCredential]::Empty) {
Write-Verbose -Message ((Get-Date -Format G) + "`tPrompt for $Name password...")
$Credentials = Get-Credential -UserName $Name -Message "Enter Password for UserID: $Name"
} #END if
foreach ($vmhost in $vHostList) {
<#
Skip if ESXi host is not in a Connected
or Maintenance ConnectionState
#>
Write-Verbose -Message ((Get-Date -Format G) + "`t$vmhost Connection State: " + $vmhost.ConnectionState)
if ($vmhost.ConnectionState -eq "Connected" -or $vmhost.ConnectionState -eq "Maintenance") {
<#
Do nothing - ESXi host is reachable
#>
}
else {
<#
Use a custom object to keep track of skipped
hosts and continue to the next foreach loop
#>
$skipCollection += [pscustomobject]@{
'Hostname' = $vmhost.Name
'Connection State' = $vmhost.ConnectionState
} #END [PSCustomObject]
continue
} #END if/else
<#
Validate ESXi Version
Will run only of 6.x and above
#>
if ([decimal]$vmHost.ApiVersion.Substring(0, 3) -lt 6) {
Write-Warning -Message ("`t$vmhost is ESXi v" + $vmhost.ApiVersion + ". Skipping host.")
continue
}
<#
Validate that Account to add does not exist
#>
$esxcli = Get-EsxCli -VMHost $vmhost -V2
Write-Verbose -Message ((Get-Date -Format G) + "`tValidating if $Name User ID exists on $vmhost...")
if ($esxcli.system.account.list.Invoke() | Where-Object { $_.UserID -eq $Name }) {
Write-Warning -Message "`t$Name User ID already exists on $vmhost. Skipping host."
continue
} #END if
<#
Add ESXi Local Account
#>
$accountArgs = $esxcli.system.account.add.CreateArgs()
$accountArgs.id = $Credentials.UserName
$accountArgs.description = $Description
try {
$accountArgs.password = $Credentials.GetNetworkCredential().Password
$accountArgs.passwordconfirmation = $Credentials.GetNetworkCredential().Password
}
catch {
Write-Host "`nError: Failed to gather User ID: $Name password" -ForegroundColor Red
Write-Host $_.Exception.Message -ForegroundColor Red
break
} #END catch
Write-Host "`tAdding UserID: "$Credentials.UserName" on $vmhost..."
try {
$esxcli.system.account.add.Invoke($accountArgs)
}
catch {
$vmhostAdvancedView = Get-View $vmhost.ExtensionData.ConfigManager.AdvancedOption
$pwdQualityControl = $vmhostAdvancedView.Setting | Where-Object { $_.Key -eq "Security.PasswordQualityControl" } | Select-Object -ExpandProperty Value
$retry = ($pwdQualityControl.Split('')[0])
$pwd = ($pwdQualityControl.Split('')[1]).Split('=')[1]
Write-Host "`nError: Failed to add User ID: $Name" -ForegroundColor Red
Write-Host $_.Exception.Message -ForegroundColor Red
Write-Host "`nPassword Quality Control: " $pwdQualityControl -ForegroundColor Green
Write-Host $retry ": is the number of times a user is prompted for a new password if the password candidate is not sufficiently strong."
Write-Host "N0 =" $pwd.Split(',')[0] ": is the number of characters required for a password that uses characters from only one character class. For example, the password contains only lowercase letters."
Write-Host "N1 =" $pwd.Split(',')[1] ": is the number of characters required for a password that uses characters from two character classes."
Write-Host "N2 =" $pwd.Split(',')[2] ": is used for passphrases. ESXi requires three words for a passphrase. Each word in the passphrase must be 8-40 characters long."
Write-Host "N3 =" $pwd.Split(',')[3] ": is the number of characters required for a password that uses characters from three character classes."
Write-Host "N4 =" $pwd.Split(',')[4] ": is the number of characters required for a password that uses characters from all four character classes."
break
} #END try
<#
Assign Permission if parameter was specified
#>
if ($Permission) {
Write-Verbose -Message ((Get-Date -Format G) + "`tAssigning Permission for UserID: $Name on $vmhost...")
$permissionArgs = $esxcli.system.permission.set.CreateArgs()
$permissionArgs.id = $Name.Trim()
$permissionArgs.group = $false
$permissionArgs.role = $Permission.Trim()
$esxcli.system.permission.set.Invoke($permissionArgs)
} #END if
<#
List account added
#>
$accountAdded = $esxcli.system.account.list.Invoke() | Where-Object { $_.UserID -eq $Name.Trim() }
$accountRole = $esxcli.system.permission.list.Invoke() | Where-Object { $_.Principal -eq $Name.Trim() } | Select-Object -ExpandProperty Role
<#
Use a custom object to store
collected data
#>
$outputCollection += [PSCustomObject]@{
'Hostname' = $vmhost.Name
'UserID' = $accountAdded.UserID
'Role' = $accountRole
'Description' = $accountAdded.Description
} #END [PSCustomObject]
} #END foreach
<#
Display skipped hosts and their connection status
#>
If ($skipCollection) {
Write-Warning -Message "`tCheck Connection State or Host name"
Write-Warning -Message "`tSkipped hosts:"
$skipCollection | Format-Table -AutoSize
} #END if
<#
Validate output arrays
#>
if ($outputCollection) {
Write-Verbose -Message ((Get-Date -Format G) + "`tAccount Added")
Write-Host "`nESXi Local Account Added:" -ForegroundColor Green
$outputCollection | Format-Table -Wrap
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tNo Account Added")
} #END if/else
} #END function
function Set-ESXiAccount {
<#
.SYNOPSIS
Set ESXi 6.x and above account security settings
.DESCRIPTION
Updates ESXi local account Description, Password or Permission
.NOTES
Author: Edgar Sanchez - @edmsanchez13
.Link
https://github.com/edmsanchez/PowerShell
.INPUTS
No inputs required
.OUTPUTS
To Screen
.PARAMETER Name
User name (UserID) to update
.Example
Set-ESXiAccount -Name "testuser"
.PARAMETER Description
User ID Description to update
.EXAMPLE
Set-ESXiAccount -Name "testuser" -Description "Local test User"
.PARAMETER Permission
Permission to assign the User ID (Admin,ReadOnly,NoAccess)
.Example
Set-ESXiAccount -Name "testuser" -Permission "Admin" -VMhost devvm001.lab.local
.PARAMETER ResetPassword
Switch to reset the User ID's Password. This is a switch ONLY, You will be prompted for the Password during the script execution
.EXAMPLE
Set-ESXiAccount -Name "testuser" -ResetPassword -VMhost devvm001.lab.local
.PARAMETER VMhost
The name(s) of the vSphere ESXi Host(s)
.EXAMPLE
Set-ESXiAccount -Name "testuser" -ResetPassword -VMhost devvm001.lab.local
.PARAMETER Cluster
The name(s) of the vSphere Cluster(s)
.EXAMPLE
Set-ESXiAccount -Name "testuser" -Permission "Admin" -Cluster production-cluster
.PARAMETER Datacenter
The name(s) of the vSphere Virtual Datacenter(s).
.EXAMPLE
Set-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin" -Datacenter vDC001
.PARAMETER Credentials
Provides User Credentials as a PSCredential Object
.EXAMPLE
Set-ESXiAccount -Name "testuser" -Description "Local test User" -Permission "Admin" -Datacenter vDC001 -Credentials $UserCredentials
#>
<#
----------------------------------------------------------[Declarations]----------------------------------------------------------
#>
[CmdletBinding()]
param (
[Parameter(Mandatory = $true)][String]$Name,
[Parameter(Mandatory = $false)][String]$Description,
[Parameter(Mandatory = $false)][ValidateSet("Admin", "ReadOnly", "NoAccess")]$Permission,
[switch]$ResetPassword,
[Parameter(Mandatory = $false)]$VMhost,
[Parameter(Mandatory = $false)]$Cluster,
[Parameter(Mandatory = $false)]$Datacenter,
[ValidateNotNull()]
[System.Management.Automation.PSCredential]
[System.Management.Automation.Credential()]
$Credentials = [System.Management.Automation.PSCredential]::Empty
)
$skipCollection = @()
$outputCollection = @()
$vHostList = @()
$date = Get-Date -format s
$date = $date -replace ":", "-"
<#
----------------------------------------------------------[Execution]----------------------------------------------------------
#>
<#
Query PowerCLI version if
running Verbose
#>
if ($VerbosePreference -eq "continue") {
Write-Verbose -Message ((Get-Date -Format G) + "`tPowerCLI Version:")
Get-Module -Name VMware.* | Select-Object -Property Name, Version | Format-Table -AutoSize
} #END if
<#
Validate if a parameter was specified (-VMhost, -Cluster, or -Datacenter)
Although all 3 can be specified, only the first one is used
Example: -VMhost "host001" -Cluster "test-cluster". -VMhost is the first parameter
and what will be used.
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate parameters used")
if ([string]::IsNullOrWhiteSpace($VMhost) -and [string]::IsNullOrWhiteSpace($Cluster) -and [string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Error -Message "You must specify a parameter (-VMhost, -Cluster, or -Datacenter)."
break
} #END if
if ($Description -or $Permission -or $ResetPassword) {
Write-Verbose -Message ((Get-Date -Format G) + "`tA Cmdlet Paramter was used")
}
else {
Write-Error -Message "You must specify a Cmdlet parameter to update (-Description, -Permission, or -ResetPassword)."
break
} #END if/else
<#
Check for an active connection to a ViServer
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate connection to a vSphere server")
if ($Global:DefaultViServers.Count -gt 0) {
Write-Host "`tConnected to $Global:DefaultViServers" -ForegroundColor Green
}
else {
Write-Error -Message "You must be connected to a vSphere server before running this Cmdlet."
break
} #END if/else
<#
Gather host list based on parameter used
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tGather host list")
if ([string]::IsNullOrWhiteSpace($VMhost)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-VMhost parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Cluster)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Cluster parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Datacenter parameter is Null or Empty")
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using Datacenter parameter")
Write-Host "`tGathering host list from the following DataCenter(s): " (@($Datacenter) -join ',')
foreach ($vDCname in $Datacenter) {
$tempList = Get-Datacenter -Name $vDCname.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tDatacenter with name $vDCname was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using cluster parameter")
Write-Host "`tGathering host list from the following Cluster(s): " (@($Cluster) -join ',')
foreach ($vClusterName in $Cluster) {
$tempList = Get-Cluster -Name $vClusterName.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tCluster with name $vClusterName was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using VMhost parameter")
Write-Host "`tGathering host list..."
foreach ($invidualHost in $VMhost) {
$tempList = Get-VMHost -Name $invidualHost.Trim() -ErrorAction SilentlyContinue
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tESXi host $invidualHost was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
$tempList = $null
<#
Main code execution
#>
foreach ($vmhost in $vHostList) {
<#
Skip if ESXi host is not in a Connected
or Maintenance ConnectionState
#>
Write-Verbose -Message ((Get-Date -Format G) + "`t$vmhost Connection State: " + $vmhost.ConnectionState)
if ($vmhost.ConnectionState -eq "Connected" -or $vmhost.ConnectionState -eq "Maintenance") {
<#
Do nothing - ESXi host is reachable
#>
}
else {
<#
Use a custom object to keep track of skipped
hosts and continue to the next foreach loop
#>
$skipCollection += [pscustomobject]@{
'Hostname' = $vmhost.Name
'Connection State' = $vmhost.ConnectionState
} #END [PSCustomObject]
continue
} #END if/else
<#
Validate ESXi Version
Will run only of 6.x and above
#>
if ([decimal]$vmHost.ApiVersion.Substring(0, 3) -lt 6) {
Write-Warning -Message ("`t$vmhost is ESXi v" + $vmhost.ApiVersion + ". Skipping host.")
continue
}
<#
Validate that Account to update exists
#>
$esxcli = Get-EsxCli -VMHost $vmhost -V2
Write-Verbose -Message ((Get-Date -Format G) + "`tValidating $Name User ID exists on $vmhost...")
if ($esxcli.system.account.list.Invoke() | Where-Object { $_.UserID -eq $Name.Trim() }) {
$accountArgs = $esxcli.system.account.set.CreateArgs()
$updateAccount = $false
$updatePermission = $false
<#
Update ESXi Local Account
Query for Pasword if -ResetPassword switch is used
#>
if ($Description) {
$updateAccount = $true
$accountArgs.id = $Name.Trim()
$accountArgs.description = $Description.Trim()
} #END if
if ($ResetPassword) {
#Validate PSCredential
if ($Credentials -eq [System.Management.Automation.PSCredential]::Empty) {
Write-Verbose -Message ((Get-Date -Format G) + "`tPrompt for $Name password...")
$Credentials = Get-Credential -UserName $Name -Message "Enter Password for UserID: $Name"
} #END if
$updateAccount = $true
$accountArgs.id = $Name.Trim()
try {
$accountArgs.password = $Credentials.GetNetworkCredential().Password
$accountArgs.passwordconfirmation = $Credentials.GetNetworkCredential().Password
}
catch {
Write-Host "`nError: Failed to gather User ID: $Name password" -ForegroundColor Red
Write-Host $_.Exception.Message -ForegroundColor Red
break
} #END catch
} #END if
if ($updateAccount) {
Write-Host "`tUpdating UserID: $Name on $vmhost..."
try {
$esxcli.system.account.set.Invoke($accountArgs)
}
catch {
$vmhostAdvancedView = Get-View $vmhost.ExtensionData.ConfigManager.AdvancedOption
$pwdQualityControl = $vmhostAdvancedView.Setting | Where-Object { $_.Key -eq "Security.PasswordQualityControl" } | Select-Object -ExpandProperty Value
$retry = ($pwdQualityControl.Split('')[0])
$pwd = ($pwdQualityControl.Split('')[1]).Split('=')[1]
Write-Host "`nError: Failed to update User ID: $Name" -ForegroundColor Red
Write-Host $_.Exception.Message -ForegroundColor Red
Write-Host "`nPassword Quality Control: " $pwdQualityControl -ForegroundColor Green
Write-Host $retry ": is the number of times a user is prompted for a new password if the password candidate is not sufficiently strong."
Write-Host "N0 =" $pwd.Split(',')[0] ": is the number of characters required for a password that uses characters from only one character class. For example, the password contains only lowercase letters."
Write-Host "N1 =" $pwd.Split(',')[1] ": is the number of characters required for a password that uses characters from two character classes."
Write-Host "N2 =" $pwd.Split(',')[2] ": is used for passphrases. ESXi requires three words for a passphrase. Each word in the passphrase must be 8-40 characters long."
Write-Host "N3 =" $pwd.Split(',')[3] ": is the number of characters required for a password that uses characters from three character classes."
Write-Host "N4 =" $pwd.Split(',')[4] ": is the number of characters required for a password that uses characters from all four character classes."
break
} #END try
} #END if
<#
Update Permission if parameter was specified
#>
if ($Permission) {
Write-Host "`tUpdating Permission for UserID: $Name on $vmhost..."
$updatePermission = $true
$permissionArgs = $esxcli.system.permission.set.CreateArgs()
$permissionArgs.id = $Name.Trim()
$permissionArgs.group = $false
$permissionArgs.role = $Permission.Trim()
$esxcli.system.permission.set.Invoke($permissionArgs)
} #END if
<#
List account added
#>
$accountUpdated = $esxcli.system.account.list.Invoke() | Where-Object { $_.UserID -eq $Name.Trim() }
$accountRole = $esxcli.system.permission.list.Invoke() | Where-Object { $_.Principal -eq $Name.Trim() } | Select-Object -ExpandProperty Role
<#
Use a custom object to store
collected data
#>
$outputCollection += [PSCustomObject]@{
'Hostname' = $vmhost.Name
'UserID' = $accountUpdated.UserID
'Role' = $accountRole
'Description' = $accountUpdated.Description
} #END [PSCustomObject]
}
else {
Write-Warning -Message "`t$Name User ID does not exist $vmhost. Skipping host."
continue
} #END if/else
} #END foreach
<#
Display skipped hosts and their connection status
#>
If ($skipCollection) {
Write-Warning -Message "`tCheck Connection State or Host name"
Write-Warning -Message "`tSkipped hosts:"
$skipCollection | Format-Table -AutoSize
} #END if
<#
Validate output arrays
#>
if ($outputCollection) {
Write-Verbose -Message ((Get-Date -Format G) + "`tAccount Updated")
Write-Host "`nESXi Local Account Updated:" -ForegroundColor Green
$outputCollection | Format-Table -Wrap
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tNo Account Updated")
} #END if/else
} #END function
function Remove-ESXiAccount {
<#
.SYNOPSIS
Removes ESXi 6.x and above local account
.DESCRIPTION
Checks and removes ESXi local account
.NOTES
Author: Edgar Sanchez - @edmsanchez13
.Link
https://github.com/edmsanchez/PowerShell
.INPUTS
No inputs required
.OUTPUTS
To Screen
.PARAMETER Name
The name (UserID) of the local account to remove
.EXAMPLE
Remove-ESXiAccount -Name "testuser" -VMhost devvm001.lab.local
.PARAMETER VMhost
The name(s) of the vSphere ESXi Host(s)
.EXAMPLE
Remove-ESXiAccount -VMhost devvm001.lab.local
.PARAMETER Cluster
The name(s) of the vSphere Cluster(s)
.EXAMPLE
Remove-ESXiAccount -Cluster production-cluster
.PARAMETER Datacenter
The name(s) of the vSphere Virtual Datacenter(s).
.EXAMPLE
Remove-ESXiAccount -Datacenter vDC001
#>
<#
----------------------------------------------------------[Declarations]----------------------------------------------------------
#>
[CmdletBinding()]
param (
[Parameter(Mandatory = $true)][String]$Name,
[Parameter(Mandatory = $false)]$VMhost,
[Parameter(Mandatory = $false)]$Cluster,
[Parameter(Mandatory = $false)]$Datacenter
)
$skipCollection = @()
$outputCollection = @()
$vHostList = @()
$date = Get-Date -format s
$date = $date -replace ":", "-"
<#
----------------------------------------------------------[Execution]----------------------------------------------------------
#>
<#
Query PowerCLI version if
running Verbose
#>
if ($VerbosePreference -eq "continue") {
Write-Verbose -Message ((Get-Date -Format G) + "`tPowerCLI Version:")
Get-Module -Name VMware.* | Select-Object -Property Name, Version | Format-Table -AutoSize
} #END if
<#
Validate if a parameter was specified (-VMhost, -Cluster, or -Datacenter)
Although all 3 can be specified, only the first one is used
Example: -VMhost "host001" -Cluster "test-cluster". -VMhost is the first parameter
and what will be used.
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate parameters used")
if ([string]::IsNullOrWhiteSpace($VMhost) -and [string]::IsNullOrWhiteSpace($Cluster) -and [string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Error -Message "You must specify a parameter (-VMhost, -Cluster, or -Datacenter)."
break
} #END if
<#
Check for an active connection to a VIServer
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tValidate connection to a vSphere server")
if ($Global:DefaultViServers.Count -gt 0) {
Write-Host "`tConnected to $Global:DefaultViServers" -ForegroundColor Green
}
else {
Write-Error -Message "You must be connected to a vSphere server before running this Cmdlet."
break
} #END if/else
<#
Gather host list based on parameter used
#>
Write-Verbose -Message ((Get-Date -Format G) + "`tGather host list")
if ([string]::IsNullOrWhiteSpace($VMhost)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-VMhost parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Cluster)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Cluster parameter is Null or Empty")
if ([string]::IsNullOrWhiteSpace($Datacenter)) {
Write-Verbose -Message ((Get-Date -Format G) + "`t-Datacenter parameter is Null or Empty")
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using Datacenter parameter")
Write-Host "`tGathering host list from the following DataCenter(s): " (@($Datacenter) -join ',')
foreach ($vDCname in $Datacenter) {
$tempList = Get-Datacenter -Name $vDCname.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tDatacenter with name $vDCname was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using cluster parameter")
Write-Host "`tGathering host list from the following Cluster(s): " (@($Cluster) -join ',')
foreach ($vClusterName in $Cluster) {
$tempList = Get-Cluster -Name $vClusterName.Trim() -ErrorAction SilentlyContinue | Get-VMHost
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tCluster with name $vClusterName was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
}
else {
Write-Verbose -Message ((Get-Date -Format G) + "`tExecuting Cmdlet using VMhost parameter")
Write-Host "`tGathering host list..."
foreach ($invidualHost in $VMhost) {
$tempList = Get-VMHost -Name $invidualHost.Trim() -ErrorAction SilentlyContinue
if ($tempList) {
$vHostList += $tempList | Sort-Object -Property Name
}
else {
Write-Warning -Message "`tESXi host $invidualHost was not found in $Global:DefaultViServers"
} #END if/else
} #END foreach
} #END if/else
$tempList = $null
<#
Main code execution
#>
foreach ($vmhost in $vHostList) {
<#
Skip if ESXi host is not in a Connected
or Maintenance ConnectionState
#>
Write-Verbose -Message ((Get-Date -Format G) + "`t$vmhost Connection State: " + $vmhost.ConnectionState)
if ($vmhost.ConnectionState -eq "Connected" -or $vmhost.ConnectionState -eq "Maintenance") {
<#
Do nothing - ESXi host is reachable
#>