DSCResources/xHyper-V/DSCResources/MSFT_xVMHost/MSFT_xVMHost.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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
#region localizeddata
if (Test-Path "${PSScriptRoot}\${PSUICulture}")
{
    Import-LocalizedData -BindingVariable localizedData -Filename MSFT_xVMHost.psd1 `
        -BaseDirectory "${PSScriptRoot}\${PSUICulture}"
}
else
{
    # fallback to en-US
    Import-LocalizedData -BindingVariable localizedData -Filename MSFT_xVMHost.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_xVMHost resource current state.

.PARAMETER IsSingleInstance
    Specifies the resource is a single instance, the value must be 'Yes'.
#>

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

    Assert-Module -Name 'Hyper-V'

    Write-Verbose -Message $localizedData.QueryingVMHost
    $vmHost = Get-VMHost

    # Convert the current TimeSpan into minutes
    $convertFromTimeSpanParams = @{
        TimeSpan = $vmHost.ResourceMeteringSaveInterval
        TimeSpanType = 'Minutes'
    }
    $resourceMeteringSaveInterval = ConvertFrom-TimeSpan @convertFromTimeSpanParams

    $configuration = @{
        IsSingleInstance = $IsSingleInstance
        EnableEnhancedSessionMode = $vmHost.EnableEnhancedSessionMode
        FibreChannelWwnn = $vmHost.FibreChannelWwnn
        FibreChannelWwpnMaximum = $vmHost.FibreChannelWwpnMaximum
        FibreChannelWwpnMinimum = $vmHost.FibreChannelWwpnMinimum
        MacAddressMaximum = $vmHost.MacAddressMaximum
        MacAddressMinimum = $vmHost.MacAddressMinimum
        MaximumStorageMigrations = $vmHost.MaximumStorageMigrations
        MaximumVirtualMachineMigrations = $vmHost.MaximumVirtualMachineMigrations
        NumaSpanningEnabled = $vmHost.NumaSpanningEnabled
        ResourceMeteringSaveIntervalMinute = $resourceMeteringSaveInterval
        UseAnyNetworkForMigration = $vmHost.UseAnyNetworkForMigration
        VirtualHardDiskPath = $vmHost.VirtualHardDiskPath
        VirtualMachineMigrationAuthenticationType = $vmHost.VirtualMachineMigrationAuthenticationType
        VirtualMachineMigrationPerformanceOption = $vmHost.VirtualMachineMigrationPerformanceOption
        VirtualMachinePath = $vmHost.VirtualMachinePath
        VirtualMachineMigrationEnabled = $vmHost.VirtualMachineMigrationEnabled
    }

    return $configuration
}

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

.PARAMETER IsSingleInstance
    Specifies the resource is a single instance, the value must be 'Yes'.

.PARAMETER EnableEnhancedSessionMode
    Indicates whether users can use enhanced mode when they connect to virtual machines on this
    server by using Virtual Machine Connection.

.PARAMETER FibreChannelWwnn
    Specifies the default value of the World Wide Node Name on the Hyper-V host.

.PARAMETER FibreChannelWwpnMaximum
    Specifies the maximum value that can be used to generate World Wide Port Names on the Hyper-V
    host. Use with the FibreChannelWwpnMinimum parameter to establish a range of WWPNs that the
    specified Hyper-V host can assign to virtual Fibre Channel adapters.

.PARAMETER FibreChannelWwpnMinimum
   Specifies the minimum value that can be used to generate the World Wide Port Names on the
   Hyper-V host. Use with the FibreChannelWwpnMaximum parameter to establish a range of WWPNs that
   the specified Hyper-V host can assign to virtual Fibre Channel adapters.

.PARAMETER MacAddressMaximum
    Specifies the maximum MAC address using a valid hexadecimal value. Use with the
    MacAddressMinimum parameter to establish a range of MAC addresses that the specified Hyper-V
    host can assign to virtual machines configured to receive dynamic MAC addresses.

.PARAMETER MacAddressMinimum
    Specifies the minimum MAC address using a valid hexadecimal value. Use with the
    MacAddressMaximum parameter to establish a range of MAC addresses that the specified Hyper-V
    host can assign to virtual machines configured to receive dynamic MAC addresses.

.PARAMETER MaximumStorageMigrations
    Specifies the maximum number of storage migrations that can be performed at the same time on
    the Hyper-V host.

.PARAMETER MaximumVirtualMachineMigrations
    Specifies the maximum number of live migrations that can be performed at the same time on the
    Hyper-V host.

.PARAMETER NumaSpanningEnabled
    Specifies whether virtual machines on the Hyper-V host can use resources from more than one
    NUMA node.

.PARAMETER ResourceMeteringSaveIntervalMinute
    Specifies how often the Hyper-V host saves the data that tracks resource usage. The range is a
    minimum of 60 minutes to a maximum 1440 minutes (24 hours).

.PARAMETER UseAnyNetworkForMigration
    Specifies how networks are selected for incoming live migration traffic. If set to $True, any
    available network on the host can be used for this traffic. If set to $False, incoming live
    migration traffic is transmitted only on the networks specified in the MigrationNetworks
    property of the host.

.PARAMETER VirtualHardDiskPath
    Specifies the default folder to store virtual hard disks on the Hyper-V host.

.PARAMETER VirtualMachineMigrationAuthenticationType
    Specifies the type of authentication to be used for live migrations. The acceptable values for
    this parameter are 'Kerberos' and 'CredSSP'.

.PARAMETER VirtualMachineMigrationPerformanceOption
    Specifies the performance option to use for live migration. The acceptable values for this
    parameter are 'TCPIP', 'Compression' and 'SMB'.

.PARAMETER VirtualMachinePath
    Specifies the default folder to store virtual machine configuration files on the Hyper-V host.

.PARAMETER VirtualMachineMigrationEnabled
    Indicates whether Live Migration should be enabled or disabled on the Hyper-V host.
#>

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

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

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

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

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

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

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

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

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

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

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

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

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

        [Parameter()]
        [ValidateSet('Kerberos', 'CredSSP')]
        [System.String]
        $VirtualMachineMigrationAuthenticationType,

        [Parameter()]
        [ValidateSet('TCPIP', 'Compression', 'SMB')]
        [System.String]
        $VirtualMachineMigrationPerformanceOption,

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

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

    Assert-Module -Name 'Hyper-V'

    $targetResource = Get-TargetResource -IsSingleInstance $IsSingleInstance
    $isTargetResourceCompliant = $true

    foreach ($parameter in $PSBoundParameters.GetEnumerator())
    {
        if (($targetResource.ContainsKey($parameter.Key)) -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.VMHostInDesiredState
    }
    else
    {
        Write-Verbose -Message $localizedData.VMHostNotInDesiredState
    }

    return $isTargetResourceCompliant
} #end function

<#
.SYNOPSIS
    Configures MSFT_xVMHost resource state.

.PARAMETER IsSingleInstance
    Specifies the resource is a single instance, the value must be 'Yes'.

.PARAMETER EnableEnhancedSessionMode
    Indicates whether users can use enhanced mode when they connect to virtual machines on this
    server by using Virtual Machine Connection.

.PARAMETER FibreChannelWwnn
    Specifies the default value of the World Wide Node Name on the Hyper-V host.

.PARAMETER FibreChannelWwpnMaximum
    Specifies the maximum value that can be used to generate World Wide Port Names on the Hyper-V
    host. Use with the FibreChannelWwpnMinimum parameter to establish a range of WWPNs that the
    specified Hyper-V host can assign to virtual Fibre Channel adapters.

.PARAMETER FibreChannelWwpnMinimum
   Specifies the minimum value that can be used to generate the World Wide Port Names on the
   Hyper-V host. Use with the FibreChannelWwpnMaximum parameter to establish a range of WWPNs that
   the specified Hyper-V host can assign to virtual Fibre Channel adapters.

.PARAMETER MacAddressMaximum
    Specifies the maximum MAC address using a valid hexadecimal value. Use with the
    MacAddressMinimum parameter to establish a range of MAC addresses that the specified Hyper-V
    host can assign to virtual machines configured to receive dynamic MAC addresses.

.PARAMETER MacAddressMinimum
    Specifies the minimum MAC address using a valid hexadecimal value. Use with the
    MacAddressMaximum parameter to establish a range of MAC addresses that the specified Hyper-V
    host can assign to virtual machines configured to receive dynamic MAC addresses.

.PARAMETER MaximumStorageMigrations
    Specifies the maximum number of storage migrations that can be performed at the same time on
    the Hyper-V host.

.PARAMETER MaximumVirtualMachineMigrations
    Specifies the maximum number of live migrations that can be performed at the same time on the
    Hyper-V host.

.PARAMETER NumaSpanningEnabled
    Specifies whether virtual machines on the Hyper-V host can use resources from more than one
    NUMA node.

.PARAMETER ResourceMeteringSaveIntervalMinute
    Specifies how often the Hyper-V host saves the data that tracks resource usage. The range is a
    minimum of 60 minutes to a maximum 1440 minutes (24 hours).

.PARAMETER UseAnyNetworkForMigration
    Specifies how networks are selected for incoming live migration traffic. If set to $True, any
    available network on the host can be used for this traffic. If set to $False, incoming live
    migration traffic is transmitted only on the networks specified in the MigrationNetworks
    property of the host.

.PARAMETER VirtualHardDiskPath
    Specifies the default folder to store virtual hard disks on the Hyper-V host.

.PARAMETER VirtualMachineMigrationAuthenticationType
    Specifies the type of authentication to be used for live migrations. The acceptable values for
    this parameter are 'Kerberos' and 'CredSSP'.

.PARAMETER VirtualMachineMigrationPerformanceOption
    Specifies the performance option to use for live migration. The acceptable values for this
    parameter are 'TCPIP', 'Compression' and 'SMB'.

.PARAMETER VirtualMachinePath
    Specifies the default folder to store virtual machine configuration files on the Hyper-V host.

.PARAMETER VirtualMachineMigrationEnabled
    Indicates whether Live Migration should be enabled or disabled on the Hyper-V host.
#>

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

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

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

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

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

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

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

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

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

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

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

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

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

        [Parameter()]
        [ValidateSet('Kerberos', 'CredSSP')]
        [System.String]
        $VirtualMachineMigrationAuthenticationType,

        [Parameter()]
        [ValidateSet('TCPIP', 'Compression', 'SMB')]
        [System.String]
        $VirtualMachineMigrationPerformanceOption,

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

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

    Assert-Module -Name 'Hyper-V'

    $null = $PSBoundParameters.Remove('IsSingleInstance')

    if ($PSBoundParameters.ContainsKey('ResourceMeteringSaveIntervalMinute'))
    {
        # Need to convert the specified minutes into a TimeSpan object first
        $convertToTimeSpanParams = @{
            TimeInterval = $PSBoundParameters['ResourceMeteringSaveIntervalMinute']
            TimeIntervalType = 'Minutes'
        }
        $resourceMeteringSaveInterval = ConvertTo-TimeSpan @convertToTimeSpanParams

        # Remove the existing UInt32 explicit type and add the TimeSpan type parameter
        $null = $PSBoundParameters.Remove('ResourceMeteringSaveIntervalMinute')
        $PSBoundParameters['ResourceMeteringSaveInterval'] = $resourceMeteringSaveInterval
    }

    if ($PSBoundParameters.ContainsKey('VirtualMachineMigrationEnabled'))
    {
        $null = $PSBoundParameters.Remove('VirtualMachineMigrationEnabled')

        if ($VirtualMachineMigrationEnabled)
        {
            if ((Get-CimInstance -ClassName Win32_ComputerSystem).PartOfDomain)
            {
                Write-Verbose -Message $localizedData.EnableLiveMigration
                Enable-VMMigration
            }
            else
            {
                New-InvalidOperationError -ErrorId InvalidState -ErrorMessage $localizedData.LiveMigrationDomainOnly
            }
        }
        else
        {
            Write-Verbose -Message $localizedData.DisableLiveMigration
            Disable-VMMigration
        }
    }

    $vmHostParams = $PSBoundParameters.GetEnumerator() | Where-Object -FilterScript {
        $_.Key -notin (
            [System.Management.Automation.PSCmdlet]::CommonParameters +
            [System.Management.Automation.PSCmdlet]::OptionalCommonParameters
        )
    }

    if ($vmHostParams.Count -ne 0)
    {
        Write-Verbose -Message $localizedData.UpdatingVMHostProperties
        Set-VMHost @PSBoundParameters
        Write-Verbose -Message $localizedData.VMHostPropertiesUpdated
    }
} #end function