DSCResources/xHyper-V/DSCResources/MSFT_xVMProcessor/MSFT_xVMProcessor.psm1

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
#region localizeddata
if (Test-Path "${PSScriptRoot}\${PSUICulture}")
{
    Import-LocalizedData -BindingVariable localizedData -Filename MSFT_xVMProcessor.psd1 `
                         -BaseDirectory "${PSScriptRoot}\${PSUICulture}"
}
else
{
    # fallback to en-US
    Import-LocalizedData -BindingVariable localizedData -Filename MSFT_xVMProcessor.psd1 `
                         -BaseDirectory "${PSScriptRoot}\en-US"
}
#endregion

# Import the common HyperV functions
Import-Module -Name ( Join-Path `
    -Path (Split-Path -Path $PSScriptRoot -Parent) `
    -ChildPath '\HyperVCommon\HyperVCommon.psm1' )

<#
.SYNOPSIS
    Gets MSFT_xVMProcessor resource current state.

.PARAMETER VMName
    Specifies the name of the virtual machine on which the processor is to be configured.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $VMName
    )

    Assert-Module -Name 'Hyper-V'
    Write-Verbose -Message ($localizedData.QueryingVMProcessor -f $VMName)
    $vmProcessor = Get-VMProcessor -VMName $VMName -ErrorAction Stop
    $configuration = @{
        VMName = $VMName
        EnableHostResourceProtection = $vmProcessor.EnableHostResourceProtection
        ExposeVirtualizationExtensions = $vmProcessor.ExposeVirtualizationExtensions
        HwThreadCountPerCore = $vmProcessor.HwThreadCountPerCore
        Maximum = $vmProcessor.Maximum
        MaximumCountPerNumaNode = $vmProcessor.MaximumCountPerNumaNode
        MaximumCountPerNumaSocket = $vmProcessor.MaximumCountPerNumaSocket
        RelativeWeight = $vmProcessor.RelativeWeight
        Reserve = $vmProcessor.Reserve
        ResourcePoolName = $vmProcessor.ResourcePoolName
        CompatibilityForMigrationEnabled = $vmProcessor.CompatibilityForMigrationEnabled
        CompatibilityForOlderOperatingSystemsEnabled = $vmProcessor.CompatibilityForOlderOperatingSystemsEnabled
        RestartIfNeeded = $false
    }
    return $configuration
}

<#
.SYNOPSIS
    Tests if MSFT_xVMProcessor resource state is in the desired state or not.

.PARAMETER VMName
    Specifies the name of the virtual machine on which the processor is to be configured.

.PARAMETER EnableHostResourceProtection
    Specifies whether to enable host resource protection.
    NOTE: Only supported on Windows 10 and Server 2016.

.PARAMETER ExposeVirtualizationExtensions
    Specifies whether nested virtualization is enabled.
    NOTE: Only supported on Windows 10 and Server 2016.

.PARAMETER HwThreadCountPerCore
    Specifies the maximum thread core per processor core.
    NOTE: Only supported on Windows 10 and Server 2016.

.PARAMETER Maximum
    Specifies the maximum percentage of resources available to the virtual machine
    processor to be configured. Allowed values range from 0 to 100.

.PARAMETER MaximumCountPerNumaNode
    Specifies the maximum number of processors per NUMA node to be configured for
    the virtual machine.

.PARAMETER MaximumCountPerNumaSocket
    Specifies the maximum number of sockets per NUMA node to be configured for
    the virtual machine.

.PARAMETER RelativeWeight
    Specifies the priority for allocating the physical computer's processing
    power to this virtual machine relative to others. Allowed values range
    from 1 to 10000.

.PARAMETER Reserve
    Specifies the percentage of processor resources to be reserved for this
    virtual machine. Allowed values range from 0 to 100.

.PARAMETER ResourcePoolName
    Specifies the name of the processor resource pool to be used.

.PARAMETER CompatibilityForMigrationEnabled
    Specifies whether the virtual processors features are to be limited
    for compatibility when migrating the virtual machine to another host.

.PARAMETER CompatibilityForOlderOperatingSystemsEnabled
    Specifies whether the virtual processor’s features are to be limited
    for compatibility with older operating systems.

.PARAMETER RestartIfNeeded
    If specified, shutdowns and restarts the VM if needed for property
    changes.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $VMName,

        [Parameter()]
        [System.Boolean]
        $EnableHostResourceProtection,

        [Parameter()]
        [System.Boolean]
        $ExposeVirtualizationExtensions,

        [Parameter()]
        [System.UInt64]
        $HwThreadCountPerCore,

        [Parameter()]
        [ValidateRange(0,100)]
        [System.UInt64]
        $Maximum,

        [Parameter()]
        [System.UInt32]
        $MaximumCountPerNumaNode,

        [Parameter()]
        [System.UInt32]
        $MaximumCountPerNumaSocket,

        [Parameter()]
        [ValidateRange(0,10000)]
        [System.UInt32]
        $RelativeWeight,

        [Parameter()]
        [ValidateRange(0,100)]
        [System.UInt64]
        $Reserve,

        [Parameter()]
        [System.String]
        $ResourcePoolName,

        [Parameter()]
        [System.Boolean]
        $CompatibilityForMigrationEnabled,

        [Parameter()]
        [System.Boolean]
        $CompatibilityForOlderOperatingSystemsEnabled,

        [Parameter()]
        [System.Boolean]
        $RestartIfNeeded
    )

    Assert-Module -Name 'Hyper-V'
    Assert-TargetResourceParameter @PSBoundParameters

    $targetResource = Get-TargetResource -VMName $VMName
    $excludedTestParameters = @('RestartIfNeeded')
    $isTargetResourceCompliant = $true

    foreach ($parameter in $PSBoundParameters.GetEnumerator())
    {
        if (($targetResource.ContainsKey($parameter.Key)) -and
            ($parameter.Key -notin $excludedTestParameters) -and
            ($parameter.Value -ne $targetResource[$parameter.Key]))
        {
            $isTargetResourceCompliant = $false
            Write-Verbose -Message ($localizedData.PropertyMismatch -f $parameter.Key,
                                    $parameter.Value, $targetResource[$parameter.Key])
        }
    }

    if ($isTargetResourceCompliant)
    {
        Write-Verbose -Message ($localizedData.VMProcessorInDesiredState -f $VMName)
    }
    else
    {
        Write-Verbose -Message ($localizedData.VMProcessorNotInDesiredState -f $VMName)
    }

    return $isTargetResourceCompliant
} #end function

<#
.SYNOPSIS
    Configures MSFT_xVMProcessor resource state.

.PARAMETER VMName
    Specifies the name of the virtual machine on which the processor is to be configured.

.PARAMETER EnableHostResourceProtection
    Specifies whether to enable host resource protection.
    NOTE: Only supported on Windows 10 and Server 2016.

.PARAMETER ExposeVirtualizationExtensions
    Specifies whether nested virtualization is enabled.
    NOTE: Only supported on Windows 10 and Server 2016.

.PARAMETER HwThreadCountPerCore
    Specifies the maximum thread core per processor core
    NOTE: Only supported on Windows 10 and Server 2016.

.PARAMETER Maximum
    Specifies the maximum percentage of resources available to the virtual machine
    processor to be configured. Allowed values range from 0 to 100.

.PARAMETER MaximumCountPerNumaNode
    Specifies the maximum number of processors per NUMA node to be configured for
    the virtual machine.

.PARAMETER MaximumCountPerNumaSocket
    Specifies the maximum number of sockets per NUMA node to be configured for
    the virtual machine.

.PARAMETER RelativeWeight
    Specifies the priority for allocating the physical computer's processing
    power to this virtual machine relative to others. Allowed values range
    from 1 to 10000.

.PARAMETER Reserve
    Specifies the percentage of processor resources to be reserved for this
    virtual machine. Allowed values range from 0 to 100.

.PARAMETER ResourcePoolName
    Specifies the name of the processor resource pool to be used.

.PARAMETER CompatibilityForMigrationEnabled
    Specifies whether the virtual processors features are to be limited
    for compatibility when migrating the virtual machine to another host.

.PARAMETER CompatibilityForOlderOperatingSystemsEnabled
    Specifies whether the virtual processor’s features are to be limited
    for compatibility with older operating systems.

.PARAMETER RestartIfNeeded
    If specified, shutdowns and restarts the VM if needed for property
    changes.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $VMName,

        [Parameter()]
        [System.Boolean]
        $EnableHostResourceProtection,

        [Parameter()]
        [System.Boolean]
        $ExposeVirtualizationExtensions,

        [Parameter()]
        [System.UInt64]
        $HwThreadCountPerCore,

        [Parameter()]
        [ValidateRange(0,100)]
        [System.UInt64]
        $Maximum,

        [Parameter()]
        [System.UInt32]
        $MaximumCountPerNumaNode,

        [Parameter()]
        [System.UInt32]
        $MaximumCountPerNumaSocket,

        [Parameter()]
        [ValidateRange(0,10000)]
        [System.UInt32]
        $RelativeWeight,

        [Parameter()]
        [ValidateRange(0,100)]
        [System.UInt64]
        $Reserve,

        [Parameter()]
        [System.String]
        $ResourcePoolName,

        [Parameter()]
        [System.Boolean]
        $CompatibilityForMigrationEnabled,

        [Parameter()]
        [System.Boolean]
        $CompatibilityForOlderOperatingSystemsEnabled,

        [Parameter()]
        [System.Boolean]
        $RestartIfNeeded
    )

    Assert-Module -Name 'Hyper-V'
    Assert-TargetResourceParameter @PSBoundParameters

    # Parameters requiring shutdown.
    $restartRequiredParameterNames = @(
        'ExposeVirtualizationExtensions',
        'CompatibilityForMigrationEnabled',
        'CompatibilityForOlderOperatingSystemsEnabled',
        'HwThreadCountPerCore',
        'MaximumCountPerNumaNode',
        'MaximumCountPerNumaSocket',
        'ResourcePoolName'
    )
    $isRestartRequired = $false
    $vmObject = Get-VM -Name $VMName

    # Only check for restart required parameters if VM is not off
    if ($vmObject.State -ne 'Off')
    {
        foreach ($parameterName in $restartRequiredParameterNames)
        {
            if ($PSBoundParameters.ContainsKey($parameterName))
            {
                if (-not $RestartIfNeeded)
                {
                    $errorMessage = $localized.CannotUpdateVmOnlineError -f $parameterName
                    New-InvalidOperationError -ErrorId InvalidState -ErrorMessage $errorMessage
                }
                else
                {
                    $isRestartRequired = $true
                }
            }
        } #end foreach parameter
    }

    $null = $PSBoundParameters.Remove('RestartIfNeeded')
    $null = $PSBoundParameters.Remove('VMName')

    if (-not $isRestartRequired)
    {
        # No parameter specified that requires a restart, so disable the restart flag
        Write-Verbose -Message ($localizedData.UpdatingVMProperties -f $VMName)
        Set-VMProcessor -VMName $VMName @PSBoundParameters
        Write-Verbose -Message ($localizedData.VMPropertiesUpdated -f $VMName)
    }
    else
    {
        # Restart is required and that requires turning VM off
        $setVMPropertyParameters = @{
            VMName = $VMName
            VMCommand = 'Set-VMProcessor'
            ChangeProperty = $PSBoundParameters
            RestartIfNeeded = $true
            Verbose = $Verbose
        }
        Set-VMProperty @setVMPropertyParameters
    }
} #end function

<#
.SYNOPSIS
    Ensures OS supports the supplied parameters.

.PARAMETER EnableHostResourceProtection
    Specifies whether to enable host resource protection.
    NOTE: Only supported on Windows 10, Server 2016 and Nano.

.PARAMETER ExposeVirtualizationExtensions
    Specifies whether nested virtualization is enabled.
    NOTE: Only supported on Windows 10, Server 2016 and Nano.

.PARAMETER HwThreadCountPerCore
    Specifies the maximum thread core per processor core
    NOTE: Only supported on Windows 10, Server 2016 and Nano.

.PARAMETER RemainingArgument
    Catch all to enable splatting of remaining parameters.
#>

function Assert-TargetResourceParameter
{
    [CmdletBinding()]
    param
    (
        [Parameter()]
        [System.Boolean]
        $EnableHostResourceProtection,

        [Parameter()]
        [System.Boolean]
        $ExposeVirtualizationExtensions,

        [Parameter()]
        [System.UInt64]
        $HwThreadCountPerCore,

        [Parameter(ValueFromRemainingArguments)]
        [System.Object[]]
        $RemainingArguments
    )

    # Get-CimInstance returns build number as a string
    $win32OperatingSystem = Get-CimInstance -ClassName Win32_OperatingSystem -Verbose:$false
    $osBuildNumber = $win32OperatingSystem.BuildNumber -as [System.Int64]
    $build14393RequiredParameterNames = @(
        'EnableHostResourceProtection',
        'ExposeVirtualizationExtensions',
        'HwThreadCountPerCore'
    )

    foreach ($parameterName in $build14393RequiredParameterNames)
    {
        if (($PSBoundParameters.ContainsKey($parameterName)) -and ($osBuildNumber -lt 14393))
        {
            $errorMessage = $localizedData.UnsupportedSystemError -f $parameterName, 14393
            New-InvalidArgumentError -ErrorId SystemUnsupported -ErrorMessage $errorMessage
        }
    }
} #end function

Export-ModuleMember -Function *-TargetResource