-
Notifications
You must be signed in to change notification settings - Fork 65
Expand file tree
/
Copy pathDSC_VMHyperV.psm1
More file actions
1085 lines (944 loc) · 39.6 KB
/
DSC_VMHyperV.psm1
File metadata and controls
1085 lines (944 loc) · 39.6 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
$script:dscResourceCommonModulePath = Join-Path -Path $PSScriptRoot -ChildPath '../../Modules/DscResource.Common'
$script:hyperVDscCommonModulePath = Join-Path -Path $PSScriptRoot -ChildPath '../../Modules/HyperVDsc.Common'
Import-Module -Name $script:dscResourceCommonModulePath
Import-Module -Name $script:hyperVDscCommonModulePath
$script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
function Get-TargetResource
{
[CmdletBinding()]
[OutputType([System.Collections.Hashtable])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$Name,
[Parameter(Mandatory = $true)]
[System.String]
$VhdPath
)
Write-Verbose -Message ($script:localizedData.QueryingVM -f $Name)
# Check if Hyper-V module is present for Hyper-V cmdlets
if (!(Get-Module -ListAvailable -Name Hyper-V))
{
throw ($script:localizedData.RoleMissingError -f 'Hyper-V')
}
$vmobj = Get-VM -Name $Name -ErrorAction SilentlyContinue
# Check if 1 or 0 VM with name = $name exist
if ($vmobj.count -gt 1)
{
throw ($script:localizedData.MoreThanOneVMExistsError -f $Name)
}
<#
Retrieve the Vhd hierarchy to ensure we enumerate snapshots/differencing disks
Fixes #28
#>
if ($null -ne $vmobj)
{
$vhdChain = @(Get-VhdHierarchy -VhdPath ($vmObj.HardDrives[0].Path))
}
$vmSecureBootState = $false
$vmTPMState = $false
if ($vmobj.Generation -eq 2)
{
# Retrieve secure boot status (can only be enabled on Generation 2 VMs) and convert to a boolean.
$vmSecureBootState = ($vmobj | Get-VMFirmware).SecureBoot -eq 'On'
# Retrieve TPM status (can only be enabled on Generation 2 VMs) and return boolean.
$vmTPMState = ($vmobj | Get-VMSecurity).TpmEnabled
}
$guestServiceId = 'Microsoft:{0}\6C09BB55-D683-4DA0-8931-C9BF705F6480' -f $vmObj.Id
$macAddress = @()
$switchName = @()
$ipAddress = @()
foreach ($networkAdapter in $vmobj.NetworkAdapters)
{
$macAddress += $networkAdapter.MacAddress
if (-Not ([System.String]::IsNullOrEmpty($networkAdapter.SwitchName)))
{
$switchName += $networkAdapter.SwitchName
}
if ($networkAdapter.IPAddresses.Count -ge 1)
{
$ipAddress += $networkAdapter.IPAddresses
}
}
@{
Name = $Name
# Return the Vhd specified if it exists in the Vhd chain
VhdPath = if ($vhdChain -contains $VhdPath)
{
$VhdPath
}
else
{
$null
}
SwitchName = $switchName
State = $vmobj.State
Path = $vmobj.Path
Generation = $vmobj.Generation
SecureBoot = $vmSecureBootState
TpmEnabled = $vmTPMState
StartupMemory = $vmobj.MemoryStartup
MinimumMemory = $vmobj.MemoryMinimum
MaximumMemory = $vmobj.MemoryMaximum
MACAddress = $macAddress
ProcessorCount = $vmobj.ProcessorCount
Ensure = if ($vmobj)
{
'Present'
}
else
{
'Absent'
}
ID = $vmobj.Id
Status = $vmobj.Status
CPUUsage = $vmobj.CPUUsage
MemoryAssigned = $vmobj.MemoryAssigned
Uptime = $vmobj.Uptime
CreationTime = $vmobj.CreationTime
HasDynamicMemory = $vmobj.DynamicMemoryEnabled
NetworkAdapters = $ipAddress
EnableGuestService = ($vmobj | Get-VMIntegrationService | Where-Object -FilterScript { $_.Id -eq $guestServiceId }).Enabled
AutomaticCheckpointsEnabled = $vmobj.AutomaticCheckpointsEnabled
}
}
function Set-TargetResource
{
[CmdletBinding()]
param
(
# Name of the VM
[Parameter(Mandatory = $true)]
[System.String]
$Name,
# VHD associated with the VM
[Parameter(Mandatory = $true)]
[System.String]
$VhdPath,
# Virtual switch associated with the VM
[Parameter()]
[System.String[]]
$SwitchName,
# State of the VM
[Parameter()]
[ValidateSet('Running', 'Paused', 'Off')]
[System.String]
$State,
# Folder where the VM data will be stored
[Parameter()]
[System.String]
$Path,
# Virtual machine generation
[Parameter()]
[ValidateRange(1, 2)]
[System.UInt32]
$Generation = 1,
# Startup RAM for the VM
[Parameter()]
[ValidateRange(32MB, 65536MB)]
[System.UInt64]
$StartupMemory,
# Minimum RAM for the VM. This enables dynamic memory
[Parameter()]
[ValidateRange(32MB, 65536MB)]
[System.UInt64]
$MinimumMemory,
# Maximum RAM for the VM. This enables dynamic memory
[Parameter()]
[ValidateRange(32MB, 1048576MB)]
[System.UInt64]
$MaximumMemory,
# MAC address of the VM
[Parameter()]
[System.String[]]
$MACAddress,
# Processor count for the VM
[Parameter()]
[System.UInt32]
$ProcessorCount,
# Waits for VM to get valid IP address
[Parameter()]
[System.Boolean]
$WaitForIP,
# If specified, shutdowns and restarts the VM as needed for property changes
[Parameter()]
[System.Boolean]
$RestartIfNeeded,
# Should the VM be created or deleted
[Parameter()]
[ValidateSet('Present', 'Absent')]
[System.String]
$Ensure = 'Present',
[Parameter()]
[System.String]
$Notes,
# Enable secure boot for Generation 2 VMs
[Parameter()]
[System.Boolean]
$SecureBoot = $true,
# Enable Trusted Platform Module for Generation 2 VMs
[Parameter()]
[System.Boolean]
$EnableTPM = $false,
# Enable Guest Services
[Parameter()]
[System.Boolean]
$EnableGuestService = $false,
# Enable AutomaticCheckpoints
[Parameter()]
[System.Boolean]
$AutomaticCheckpointsEnabled
)
# Check if Hyper-V module is present for Hyper-V cmdlets
if (!(Get-Module -ListAvailable -Name Hyper-V))
{
throw ($script:localizedData.RoleMissingError -f 'Hyper-V')
}
# Check if AutomaticCheckpointsEnabled is set in configuration
if ($PSBoundParameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
<#
Check if AutomaticCheckpoints are supported
If AutomaticCheckpoints are supported, parameter exists on Set-VM
#>
if (-Not (Get-Command -Name Set-VM -Module Hyper-V).Parameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
throw ($script:localizedData.AutomaticCheckpointsUnsupported)
}
}
Write-Verbose -Message ($script:localizedData.CheckingVMExists -f $Name)
$vmObj = Get-VM -Name $Name -ErrorAction SilentlyContinue
# VM already exists
if ($vmObj)
{
Write-Verbose -Message ($script:localizedData.VMExists -f $Name)
# If VM shouldn't be there, stop it and remove it
if ($Ensure -eq 'Absent')
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'Ensure', $Ensure, 'Present')
Get-VM $Name | Stop-VM -Force -Passthru -WarningAction SilentlyContinue | Remove-VM -Force
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'Ensure', $Ensure)
}
<#
If VM is present, check its state, startup memory, minimum memory, maximum memory,processor count, automatic checkpoint and mac address
One cannot set the VM's vhdpath, path, generation and switchName after creation
#>
else
{
# If state has been specified and the VM is not in right state, set it to right state
if ($State -and ($vmObj.State -ne $State))
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'State', $State, $vmObj.State)
Set-VMState -Name $Name -State $State -WaitForIP $WaitForIP
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'State', $State)
}
$changeProperty = @{ }
# If the VM does not have the right startup memory
if ($PSBoundParameters.ContainsKey('StartupMemory') -and ($vmObj.MemoryStartup -ne $StartupMemory))
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'MemoryStartup', $StartupMemory, $vmObj.MemoryStartup)
$changeProperty['MemoryStartup'] = $StartupMemory
}
elseif ($PSBoundParameters.ContainsKey('MinimumMemory') -and ($vmObj.MemoryStartup -lt $MinimumMemory))
{
Write-Verbose -Message ($script:localizedData.AdjustingLessThanMemoryWarning -f 'StartupMemory', $vmObj.MemoryStartup, 'MinimumMemory', $MinimumMemory)
$changeProperty['MemoryStartup'] = $MinimumMemory
}
elseif ($PSBoundParameters.ContainsKey('MaximumMemory') -and ($vmObj.MemoryStartup -gt $MaximumMemory))
{
Write-Verbose -Message ($script:localizedData.AdjustingGreaterThanMemoryWarning -f 'StartupMemory', $vmObj.MemoryStartup, 'MaximumMemory', $MaximumMemory)
$changeProperty['MemoryStartup'] = $MaximumMemory
}
# If the VM does not have the right minimum or maximum memory, stop the VM, set the right memory, start the VM
if ($PSBoundParameters.ContainsKey('MinimumMemory') -or $PSBoundParameters.ContainsKey('MaximumMemory'))
{
$changeProperty['DynamicMemory'] = $true
$changeProperty['StaticMemory'] = $false
if ($PSBoundParameters.ContainsKey('MinimumMemory') -and ($vmObj.Memoryminimum -ne $MinimumMemory))
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'MinimumMemory', $MinimumMemory, $vmObj.MemoryMinimum)
$changeProperty['MemoryMinimum'] = $MinimumMemory
}
if ($PSBoundParameters.ContainsKey('MaximumMemory') -and ($vmObj.Memorymaximum -ne $MaximumMemory))
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'MaximumMemory', $MaximumMemory, $vmObj.MemoryMaximum)
$changeProperty['MemoryMaximum'] = $MaximumMemory
}
}
# If the VM does not have the right processor count, stop the VM, set the right memory, start the VM
if ($PSBoundParameters.ContainsKey('ProcessorCount') -and ($vmObj.ProcessorCount -ne $ProcessorCount))
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'ProcessorCount', $ProcessorCount, $vmObj.ProcessorCount)
$changeProperty['ProcessorCount'] = $ProcessorCount
}
# Stop the VM, set the right properties, start the VM only if there are properties to change
if ($changeProperty.Count -gt 0)
{
Set-VMProperty -Name $Name -VMCommand 'Set-VM' -ChangeProperty $changeProperty -WaitForIP $WaitForIP -RestartIfNeeded $RestartIfNeeded
Write-Verbose -Message ($script:localizedData.VMPropertiesUpdated -f $Name)
}
<#
Special cases to disable dynamic memory:
- If startup, minimum and maximum memory are specified with equal values or
- If only startup memory is specified, but neither minimum nor maximum
#>
if ( ($PSBoundParameters.ContainsKey('StartupMemory') -and
($StartupMemory -eq $MinimumMemory) -and
($StartupMemory -eq $MaximumMemory)
) -or
( $PSBoundParameters.ContainsKey('StartupMemory') -and
(-not $PSBoundParameters.ContainsKey('MinimumMemory')) -and
(-not $PSBoundParameters.ContainsKey('MaximumMemory'))
)
)
{
# Refresh VM properties
$vmObj = Get-VM -Name $Name -ErrorAction SilentlyContinue
if ($vmObj.DynamicMemoryEnabled)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'DynamicMemoryEnabled', $false, $vmObj.DynamicMemoryEnabled)
$setVMPropertyParams = @{
VMName = $Name
VMCommand = 'Set-VM'
ChangeProperty = @{
StaticMemory = $true
DynamicMemory = $false
}
WaitForIP = $WaitForIP
RestartIfNeeded = $RestartIfNeeded
}
Set-VMProperty @setVMPropertyParams
Write-Verbose -Message ($script:localizedData.VMPropertiesUpdated -f $Name)
}
}
# Set VM network switches. This can be done while the VM is running.
for ($i = 0; $i -lt $SwitchName.Count; $i++)
{
$switch = $SwitchName[$i]
$nic = $vmObj.NetworkAdapters[$i]
if ($nic)
{
# We cannot change the MAC address whilst the VM is running.. This is changed later
if ($nic.SwitchName -ne $switch)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'NIC', $switch, $nic.SwitchName)
$nic | Connect-VMNetworkAdapter -SwitchName $switch
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'NIC', $switch)
}
}
else
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'NIC', $switch, '<missing>')
if ($MACAddress -and (-not [System.String]::IsNullOrEmpty($MACAddress[$i])))
{
Add-VMNetworkAdapter -VMName $Name -SwitchName $switch -StaticMacAddress $MACAddress[$i]
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'NIC', $switch)
}
else
{
Add-VMNetworkAdapter -VMName $Name -SwitchName $switch
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'NIC', $switch)
}
# Refresh the NICs after we've added one
$vmObj = Get-VM -Name $Name -ErrorAction SilentlyContinue
}
}
# If the VM does not have the right MACAddress, stop the VM, set the right MACAddress, start the VM
for ($i = 0; $i -lt $MACAddress.Count; $i++)
{
$address = $MACAddress[$i]
$nic = $vmObj.NetworkAdapters[$i]
if ($nic.MacAddress -ne $address)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'MACAddress', $address, $nic.MacAddress)
Set-VMMACAddress -Name $Name -NICIndex $i -MACAddress $address -WaitForIP $WaitForIP -RestartIfNeeded $RestartIfNeeded
}
}
if ($Generation -eq 2)
{
# Retrive the current secure boot state
$vmSecureBoot = Test-VMSecureBoot -Name $Name
if ($SecureBoot -ne $vmSecureBoot)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'SecureBoot', $SecureBoot, $vmSecureBoot)
if (-not $SecureBoot)
{
$enableSecureBoot = 'On'
}
else
{
$enableSecureBoot = 'Off'
}
# Cannot change the secure boot state whilst the VM is powered on.
$setVMPropertyParams = @{
VMName = $Name
VMCommand = 'Set-VMFirmware'
ChangeProperty = @{
EnableSecureBoot = $enableSecureBoot
}
RestartIfNeeded = $RestartIfNeeded
}
Set-VMProperty @setVMPropertyParams
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'SecureBoot', $SecureBoot)
}
# Retrive the current TPM state
$vmTPMEnabled = Test-VMTpmEnabled -Name $Name
if ($EnableTPM -ne $vmTPMEnabled)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'TPMEnabled', $EnableTPM, $vmTPMEnabled)
# Cannot change the TPM state whilst the VM is powered on.
if (-not $EnableTPM)
{
# The default value for the key protector is 0,0,0,4
$keyProtectorDefaultValue = @(0,0,0,4)
# compare the default key protector value and the VM's key protector value
$isVMKeyProtectorDefault = -not(Compare-Object -ReferenceObject (Get-VMKeyProtector -VMName $Name) -DifferenceObject $keyProtectorDefaultValue)
# If the VM has a default key protector, we need to create a new one before enabling the TPM
if ($isVMKeyProtectorDefault) {
Set-VMKeyProtector -VMName $Name -NewLocalKeyProtector
}
$setVMPropertyParams = @{
VMName = $Name
VMCommand = 'Enable-VMTPM'
RestartIfNeeded = $RestartIfNeeded
}
}
else
{
$setVMPropertyParams = @{
VMName = $Name
VMCommand = 'Disable-VMTPM'
RestartIfNeeded = $RestartIfNeeded
}
}
Set-VMProperty @setVMPropertyParams
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'TPMEnabled', $EnableTPM)
}
}
if ($Notes -ne $null)
{
# If the VM notes do not match the desire notes, update them. This can be done while the VM is running.
if ($vmObj.Notes -ne $Notes)
{
Set-Vm -Name $Name -Notes $Notes
}
}
# If the VM doesn't have Guest Service Interface correctly configured, update it.
$guestServiceId = 'Microsoft:{0}\6C09BB55-D683-4DA0-8931-C9BF705F6480' -f $vmObj.Id
$guestService = $vmObj | Get-VMIntegrationService | Where-Object -FilterScript { $_.Id -eq $guestServiceId }
if ($guestService.Enabled -eq $false -and $EnableGuestService)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'EnableGuestService', $EnableGuestService, $guestService.Enabled)
$guestService | Enable-VMIntegrationService
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'EnableGuestService', $EnableGuestService)
}
elseif ($guestService.Enabled -and -not $EnableGuestService)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'EnableGuestService', $EnableGuestService, $guestService.Enabled)
$guestService | Disable-VMIntegrationService
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'EnableGuestService', $EnableGuestService)
}
# If AutomaticCheckpointsEnabled is set in configuration
if ($PSBoundParameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
if ($vmObj.AutomaticCheckpointsEnabled -ne $AutomaticCheckpointsEnabled)
{
Set-VM -Name $Name -AutomaticCheckpointsEnabled $AutomaticCheckpointsEnabled
}
}
}
}
# VM is not present, create one
else
{
Write-Verbose -Message ($script:localizedData.VMDoesNotExist -f $Name)
if ($Ensure -eq 'Present')
{
Write-Verbose -Message ($script:localizedData.CreatingVM -f $Name)
$parameters = @{ }
$parameters['Name'] = $Name
$parameters['VHDPath'] = $VhdPath
$parameters['Generation'] = $Generation
# Optional parameters
if ($SwitchName)
{
$parameters['SwitchName'] = $SwitchName[0]
}
if ($Path)
{
$parameters['Path'] = $Path
}
$defaultStartupMemory = 512MB
if ($PSBoundParameters.ContainsKey('StartupMemory'))
{
$parameters['MemoryStartupBytes'] = $StartupMemory
}
elseif ($PSBoundParameters.ContainsKey('MinimumMemory') -and ($defaultStartupMemory -lt $MinimumMemory))
{
$parameters['MemoryStartupBytes'] = $MinimumMemory
}
elseif ($PSBoundParameters.ContainsKey('MaximumMemory') -and ($defaultStartupMemory -gt $MaximumMemory))
{
$parameters['MemoryStartupBytes'] = $MaximumMemory
}
$null = New-VM @parameters
$parameters = @{ }
$parameters['Name'] = $Name
$parameters['StaticMemory'] = $true
$parameters['DynamicMemory'] = $false
if ($PSBoundParameters.ContainsKey('MinimumMemory') -or $PSBoundParameters.ContainsKey('MaximumMemory'))
{
$parameters['DynamicMemory'] = $true
$parameters['StaticMemory'] = $false
if ($PSBoundParameters.ContainsKey('MinimumMemory'))
{
$parameters['MemoryMinimumBytes'] = $MinimumMemory
}
if ($PSBoundParameters.ContainsKey('MaximumMemory'))
{
$parameters['MemoryMaximumBytes'] = $MaximumMemory
}
}
if ($Notes)
{
$parameters['Notes'] = $Notes
}
if ($PSBoundParameters.ContainsKey('ProcessorCount'))
{
$parameters['ProcessorCount'] = $ProcessorCount
}
# If AutomaticCheckpointsEnabled is set in configuration
if ($PSBoundParameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
$parameters['AutomaticCheckpointsEnabled'] = $AutomaticCheckpointsEnabled
}
$null = Set-VM @parameters
# Special case: Disable dynamic memory if startup, minimum and maximum memory are equal
if ($PSBoundParameters.ContainsKey('StartupMemory') -and
($StartupMemory -eq $MinimumMemory) -and
($StartupMemory -eq $MaximumMemory))
{
Set-VMMemory -VMName $Name -DynamicMemoryEnabled $false
}
# There's always a NIC added with New-VM
if ($MACAddress)
{
Set-VMNetworkAdapter -VMName $Name -StaticMacAddress $MACAddress[0]
}
# Add additional NICs
for ($i = 1; $i -lt $SwitchName.Count; $i++)
{
$addVMNetworkAdapterParams = @{
VMName = $Name
SwitchName = $SwitchName[$i]
}
if ($MACAddress -and (-not [System.String]::IsNullOrEmpty($MACAddress[$i])))
{
$addVMNetworkAdapterParams['StaticMacAddress'] = $MACAddress[$i]
}
Add-VMNetworkAdapter @addVMNetworkAdapterParams
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'NIC', $SwitchName[$i])
}
if ($Generation -eq 2)
{
<#
Secure boot is only applicable to Generation 2 VMs and it defaults to on.
Therefore, we only need to explicitly set it to off if specified.
#>
if ($SecureBoot -eq $false)
{
Set-VMFirmware -VMName $Name -EnableSecureBoot Off
}
<#
TPM is only applicable to Generation 2 VMs and it defaults to disabled.
Therefore, we only need to explicitly set it to enabled if specified.
#>
if ($EnableTPM -eq $true)
{
# The default value for the key protector is 0,0,0,4
$keyProtectorDefaultValue = @(0,0,0,4)
# compare the default key protector value and the VM's key protector value
$isVMKeyProtectorDefault = -not(Compare-Object -ReferenceObject (Get-VMKeyProtector -VMName $Name) -DifferenceObject $keyProtectorDefaultValue)
# If the VM has a default key protector, we need to create a new one before enabling the TPM
if ($isVMKeyProtectorDefault) {
Set-VMKeyProtector -VMName $Name -NewLocalKeyProtector
}
Enable-VMTPM -VMName $Name
}
}
if ($EnableGuestService)
{
$guestServiceId = 'Microsoft:{0}\6C09BB55-D683-4DA0-8931-C9BF705F6480' -f (Get-VM -Name $Name).Id
Get-VMIntegrationService -VMName $Name | Where-Object -FilterScript { $_.Id -eq $guestServiceId } | Enable-VMIntegrationService
}
Write-Verbose -Message ($script:localizedData.VMCreated -f $Name)
if ($State)
{
Set-VMState -Name $Name -State $State -WaitForIP $WaitForIP
Write-Verbose -Message ($script:localizedData.VMPropertySet -f 'State', $State)
}
}
}
}
function Test-TargetResource
{
[CmdletBinding()]
[OutputType([System.Boolean])]
param
(
# Name of the VM
[Parameter(Mandatory = $true)]
[System.String]
$Name,
# VHD associated with the VM
[Parameter(Mandatory = $true)]
[System.String]
$VhdPath,
# Virtual switch associated with the VM
[Parameter()]
[System.String[]]
$SwitchName,
# State of the VM
[Parameter()]
[ValidateSet('Running', 'Paused', 'Off')]
[System.String]
$State,
# Folder where the VM data will be stored
[Parameter()]
[System.String]
$Path,
# Virtual machine generation
[Parameter()]
[ValidateRange(1, 2)]
[System.UInt32]
$Generation = 1,
# Startup RAM for the VM
[Parameter()]
[ValidateRange(32MB, 65536MB)]
[System.UInt64]
$StartupMemory,
# Minimum RAM for the VM. This enables dynamic memory
[Parameter()]
[ValidateRange(32MB, 65536MB)]
[System.UInt64]
$MinimumMemory,
# Maximum RAM for the VM. This enables dynamic memory
[Parameter()]
[ValidateRange(32MB, 1048576MB)]
[System.UInt64]
$MaximumMemory,
# MAC address of the VM
[Parameter()]
[System.String[]]
$MACAddress,
# Processor count for the VM
[Parameter()]
[System.UInt32]
$ProcessorCount,
# Waits for VM to get valid IP address
[Parameter()]
[System.Boolean]
$WaitForIP,
# If specified, shutdowns and restarts the VM as needed for property changes
[Parameter()]
[System.Boolean]
$RestartIfNeeded,
# Should the VM be created or deleted
[Parameter()]
[ValidateSet('Present', 'Absent')]
[System.String]
$Ensure = 'Present',
[Parameter()]
[System.String]
$Notes,
# Enable secure boot for Generation 2 VMs
[Parameter()]
[System.Boolean]
$SecureBoot = $true,
# Enable Trusted Platform Module for Generation 2 VMs
[Parameter()]
[System.Boolean]
$EnableTPM = $false,
[Parameter()]
[System.Boolean]
$EnableGuestService = $false,
# Enable AutomaticCheckpoints
[Parameter()]
[System.Boolean]
$AutomaticCheckpointsEnabled
)
# Check if Hyper-V module is present for Hyper-V cmdlets
if (!(Get-Module -ListAvailable -Name Hyper-V))
{
throw ($script:localizedData.RoleMissingError -f 'Hyper-V')
}
# Check if 1 or 0 VM with name = $name exist
if ((Get-VM -Name $Name -ErrorAction SilentlyContinue).count -gt 1)
{
throw ($script:localizedData.MoreThanOneVMExistsError -f $Name)
}
# Check if AutomaticCheckpointsEnabled is set in configuration
if ($PSBoundParameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
<#
Check if AutomaticCheckpoints are supported
If AutomaticCheckpoints are supported, parameter exists on Set-VM
#>
if (-Not (Get-Command -Name Set-VM -Module Hyper-V).Parameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
throw ($script:localizedData.AutomaticCheckpointsUnsupported)
}
}
try
{
$vmObj = Get-VM -Name $Name -ErrorAction Stop
if ($Ensure -eq 'Present')
{
# Check if $VhdPath exist
if (!(Test-Path $VhdPath))
{
throw ($script:localizedData.VhdPathDoesNotExistError -f $VhdPath)
}
# Check if Minimum memory is less than StartUpmemory
if ($PSBoundParameters.ContainsKey('StartupMemory') -and
$PSBoundParameters.ContainsKey('MinimumMemory') -and
($MinimumMemory -gt $StartupMemory))
{
throw ($script:localizedData.MinMemGreaterThanStartupMemError -f $MinimumMemory, $StartupMemory)
}
# Check if Minimum memory is greater than Maximummemory
if ($PSBoundParameters.ContainsKey('MaximumMemory') -and
$PSBoundParameters.ContainsKey('MinimumMemory') -and
($MinimumMemory -gt $MaximumMemory))
{
throw ($script:localizedData.MinMemGreaterThanMaxMemError -f $MinimumMemory, $MaximumMemory)
}
# Check if Startup memory is greater than Maximummemory
if ($PSBoundParameters.ContainsKey('MaximumMemory') -and
$PSBoundParameters.ContainsKey('StartupMemory') -and
($StartupMemory -gt $MaximumMemory))
{
throw ($script:localizedData.StartUpMemGreaterThanMaxMemError -f $StartupMemory, $MaximumMemory)
}
<#
VM Generation has no direct relation to the virtual hard disk format and cannot be changed
after the virtual machine has been created. Generation 2 VMs do not support .VHD files.
#>
if (($Generation -eq 2) -and ($VhdPath.Split('.')[-1] -eq 'vhd'))
{
throw ($script:localizedData.VhdUnsupportedOnGen2VMError)
}
# Check if $Path exist
if ($Path -and !(Test-Path -Path $Path))
{
throw ($script:localizedData.PathDoesNotExistError -f $Path)
}
$vhdChain = @(Get-VhdHierarchy -VhdPath ($vmObj.HardDrives[0].Path))
if ($vhdChain -notcontains $VhdPath)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'VhdPath', $VhdPath, ($vhdChain -join ','))
return $false
}
if ($state -and ($vmObj.State -ne $State))
{
return $false
}
if ($PSBoundParameters.ContainsKey('StartupMemory') -and
($vmObj.MemoryStartup -ne $StartupMemory))
{
return $false
}
if ($PSBoundParameters.ContainsKey('MaximumMemory') -and
($vmObj.MemoryMaximum -ne $MaximumMemory))
{
return $false
}
if ($PSBoundParameters.ContainsKey('MinimumMemory') -and
($vmObj.MemoryMinimum -ne $MinimumMemory))
{
return $false
}
# If startup memory but neither minimum nor maximum memory specified, dynamic memory should be disabled
if ($PSBoundParameters.ContainsKey('StartupMemory') -and
( -not $PSBoundParameters.ContainsKey('MinimumMemory')) -and
( -not $PSBoundParameters.ContainsKey('MaximumMemory')) -and
$vmobj.DynamicMemoryEnabled)
{
return $false
}
# If startup, minimum and maximum memory are specified with the same values, dynamic memory should be disabled
if ($PSBoundParameters.ContainsKey('StartupMemory') -and
$PSBoundParameters.ContainsKey('MinimumMemory') -and
$PSBoundParameters.ContainsKey('MaximumMemory') -and
($StartupMemory -eq $MinimumMemory) -and
($StartupMemory -eq $MaximumMemory) -and
$vmobj.DynamicMemoryEnabled)
{
return $false
}
if ($vmObj.HardDrives.Path -notcontains $VhdPath)
{
return $false
}
for ($i = 0; $i -lt $SwitchName.Count; $i++)
{
if ($vmObj.NetworkAdapters[$i].SwitchName -ne $SwitchName[$i])
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'SwitchName', $SwitchName[$i], $vmObj.NetworkAdapters[$i].SwitchName)
return $false
}
}
for ($i = 0; $i -lt $MACAddress.Count; $i++)
{
if ($vmObj.NetworkAdapters[$i].MACAddress -ne $MACAddress[$i])
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'MACAddress', $MACAddress[$i], $vmObj.NetworkAdapters[$i].MACAddress)
return $false
}
}
# $Generation always exists, only check if parameter has been explicitly specified
if ($PSBoundParameters.ContainsKey('Generation') -and ($Generation -ne $vmObj.Generation))
{
return $false
}
if ($PSBoundParameters.ContainsKey('ProcessorCount') -and ($vmObj.ProcessorCount -ne $ProcessorCount))
{
return $false
}
if ($vmObj.Generation -eq 2)
{
$vmSecureBoot = Test-VMSecureBoot -Name $Name
if ($SecureBoot -ne $vmSecureBoot)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'SecureBoot', $SecureBoot, $vmSecureBoot)
return $false
}
$vmTPMEnabled = Test-VMTpmEnabled -Name $Name
if ($EnableTPM -ne $vmTPMEnabled)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'TPMEnabled', $EnableTPM, $vmTPMEnabled)
return $false
}
}
$guestServiceId = 'Microsoft:{0}\6C09BB55-D683-4DA0-8931-C9BF705F6480' -f $vmObj.Id
$guestService = $vmObj | Get-VMIntegrationService | Where-Object -FilterScript { $_.Id -eq $guestServiceId }
if ($guestService.Enabled -ne $EnableGuestService)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'EnableGuestService', $EnableGuestService, $guestService.Enabled)
return $false
}
# If AutomaticCheckpointsEnabled is set in configuration
if ($PSBoundParameters.ContainsKey('AutomaticCheckpointsEnabled'))
{
if ($vmObj.AutomaticCheckpointsEnabled -ne $AutomaticCheckpointsEnabled)
{
Write-Verbose -Message ($script:localizedData.VMPropertyShouldBe -f 'AutomaticCheckpointsEnabled', $AutomaticCheckpointsEnabled, $vmObj.AutomaticCheckpointsEnabled)
return $false
}
}
return $true
}
else
{
return $false
}
}
catch [System.Management.Automation.ActionPreferenceStopException]
{
($Ensure -eq 'Absent')
}
}
#region Helper function
# Returns VM VHDs, including snapshots and differencing disks
function Get-VhdHierarchy
{
param
(
[Parameter(Mandatory = $true)]
[System.String]
$VhdPath
)
$vmVhdPath = Get-VHD -Path $VhdPath
Write-Output -InputObject $vmVhdPath.Path
while (-not [System.String]::IsNullOrEmpty($vmVhdPath.ParentPath))
{
$vmVhdPath.ParentPath
$vmVhdPath = (Get-VHD -Path $vmVhdPath.ParentPath)
}
}