DSCResources/xHyper-V/DSCResources/MSFT_xVMDvdDrive/MSFT_xVMDvdDrive.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
#region localizeddata
if (Test-Path "${PSScriptRoot}\${PSUICulture}")
{
    Import-LocalizedData `
        -BindingVariable LocalizedData `
        -Filename MSFT_xVMDvdDrive.strings.psd1 `
        -BaseDirectory "${PSScriptRoot}\${PSUICulture}"
}
else
{
    #fallback to en-US
    Import-LocalizedData `
        -BindingVariable LocalizedData `
        -Filename MSFT_xVMDvdDrive.strings.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
    Returns the current status of the VM DVD Drive.

    .PARAMETER VMName
    Specifies the name of the virtual machine to which the DVD drive is to be added.

    .PARAMETER ControllerNumber
    Specifies the number of the controller to which the DVD drive is to be added.

    .PARAMETER ControllerLocation
    Specifies the number of the location on the controller at which the DVD drive is to be added.
#>

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

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerNumber,

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerLocation
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($LocalizedData.GettingVMDVDDriveMessage `
                -f $VMName,$ControllerNumber,$ControllerLocation)
        ) -join '' )

    Test-ParameterValid @PSBoundParameters

    $dvdDrive = Get-VMDvdDrive @PSBoundParameters

    if ($dvdDrive)
    {
        $returnValue = @{
            VMName             = $VMName
            ControllerLocation = $ControllerLocation
            ControllerNumber   = $ControllerNumber
            Path               = $dvdDrive.Path
            Ensure             = 'Present'
        }
    }
    else
    {
        $returnValue = @{
            VMName             = $VMName
            ControllerLocation = $ControllerLocation
            ControllerNumber   = $ControllerNumber
            Path               = ''
            Ensure             = 'Absent'
        }
    } # if

    $returnValue
} # Get-TargetResource

<#
    .SYNOPSIS
    Adds, removes or changes the mounted ISO on a VM DVD Drive.

    .PARAMETER VMName
    Specifies the name of the virtual machine to which the DVD drive is to be added.

    .PARAMETER ControllerNumber
    Specifies the number of the controller to which the DVD drive is to be added.

    .PARAMETER ControllerLocation
    Specifies the number of the location on the controller at which the DVD drive is to be added.

    .PARAMETER Path
    Specifies the full path to the virtual hard disk file or physical hard disk volume for the
    added DVD drive.

    .PARAMETER Ensure
    Specifies if the DVD Drive should exist or not.
#>

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

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerLocation,

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerNumber,

        [System.String]
        $Path,

        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure = 'Present'
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($LocalizedData.SettingVMDVDDriveMessage `
                -f $VMName,$ControllerNumber,$ControllerLocation)
        ) -join '' )

    $null = $PSBoundParameters.Remove('Path')
    $null = $PSBoundParameters.Remove('Ensure')

    # Get the current status of the VM DVD Drive
    $dvdDrive = Get-TargetResource @PSBoundParameters

    if ($Ensure -eq 'Present')
    {
        # The DVD Drive should exist
        if ($dvdDrive.Ensure -eq 'Present')
        {
            # The DVD Drive already exists
            if (-not [String]::IsNullOrWhiteSpace($Path) `
                -and ($Path -ne $dvdDrive.Path))
            {
                # The current path assigned to the DVD Drive needs to be changed.
                Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($LocalizedData.VMDVDDriveChangePathMessage) `
                        -f $VMName,$ControllerNumber,$ControllerLocation,$Path `
                    ) -join '' )

                Set-VMDvdDrive @PSBoundParameters -Path $Path
            }
        }
        else
        {
            # The DVD Drive does not exist but should. Change required.
            Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                 $($LocalizedData.VMDVDDriveAddMessage) `
                    -f $VMName,$ControllerNumber,$ControllerLocation,$Path `
                ) -join '' )

            if (-not [String]::IsNullOrWhiteSpace($Path)) {
                $PSBoundParameters.Add('Path',$Path)
            } # if

            Add-VMDvdDrive @PSBoundParameters
        } # if
    }
    else
    {
        # The DVD Drive should not exist
        if ($dvdDrive.Ensure -eq 'Present')
        {
            # The DVD Drive does exist, but should not. Change required.
            Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                 $($LocalizedData.VMDVDDriveRemoveMessage) `
                    -f $VMName,$ControllerNumber,$ControllerLocation `
                ) -join '' )

            Remove-VMDvdDrive @PSBoundParameters
        } # if
    } # if
} # Set-TargetResource

<#
    .SYNOPSIS
    Tests the state of a VM DVD Drive and the mounted ISO.

    .PARAMETER VMName
    Specifies the name of the virtual machine to which the DVD drive is to be added.

    .PARAMETER ControllerNumber
    Specifies the number of the controller to which the DVD drive is to be added.

    .PARAMETER ControllerLocation
    Specifies the number of the location on the controller at which the DVD drive is to be added.

    .PARAMETER Path
    Specifies the full path to the virtual hard disk file or physical hard disk volume for the
    added DVD drive.

    .PARAMETER Ensure
    Specifies if the DVD Drive should exist or not.
#>

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

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerLocation,

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerNumber,

        [System.String]
        $Path,

        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure = 'Present'
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($LocalizedData.TestingVMDVDDriveMessage `
                -f $VMName,$ControllerNumber,$ControllerLocation)
        ) -join '' )

    $null = $PSBoundParameters.Remove('Path')
    $null = $PSBoundParameters.Remove('Ensure')

    # Get the current status of the VM DVD Drive
    $dvdDrive = Get-TargetResource @PSBoundParameters

    # Flag to signal whether settings are correct
    [Boolean] $desiredConfigurationMatch = $true

    if ($Ensure -eq 'Present')
    {
        # The DVD Drive should exist
        if ($dvdDrive.Ensure -eq 'Present')
        {
            # The DVD Drive already exists
            if (-not [String]::IsNullOrWhiteSpace($Path) `
                -and ($Path -ne $dvdDrive.Path))
            {
                # The current path assigned to the DVD drive is wrong. Change required.
                Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($LocalizedData.VMDVDDriveExistsAndShouldPathMismatchMessage) `
                        -f $VMName,$ControllerNumber,$ControllerLocation,$Path,$dvdDrive.Path `
                    ) -join '' )

                $desiredConfigurationMatch = $false
            }
            else
            {
                # The DVD drive exists and should. Change not required.
                Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($LocalizedData.VMDVDDriveExistsAndShouldMessage) `
                        -f $VMName,$ControllerNumber,$ControllerLocation,$Path `
                    ) -join '' )
            } # if
        }
        else
        {
            # The DVD Drive does not exist but should. Change required.
            Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                 $($LocalizedData.VMDVDDriveDoesNotExistButShouldMessage) `
                    -f $VMName,$ControllerNumber,$ControllerLocation `
                ) -join '' )

            $desiredConfigurationMatch = $false
        } # if
    }
    else
    {
        # The DVD Drive should not exist
        if ($dvdDrive.Ensure -eq 'Present')
        {
            # The DVD Drive does exist, but should not. Change required.
            Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                 $($LocalizedData.VMDVDDriveDoesExistButShouldNotMessage) `
                    -f $VMName,$ControllerNumber,$ControllerLocation `
                ) -join '' )

            $desiredConfigurationMatch = $false
        }
        else
        {
            # The DVD Drive does not exist and should not. Change not required.
            Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                 $($LocalizedData.VMDVDDriveDoesNotExistAndShouldNotMessage) `
                    -f $VMName,$ControllerNumber,$ControllerLocation `
                ) -join '' )
        } # if
    } # if

    return $desiredConfigurationMatch
} # Test-TargetResource

<#
    .SYNOPSIS
    Validates that the parameters passed are valid. If the parameter combination
    is invalid then an exception will be thrown. The following items are validated:
    - The VM exists.
    - A disk mount point at the controller number/location exists.
    - A hard disk is not already mounted at the controller number/location.
    - The Path if required is valid.

    .PARAMETER VMName
    Specifies the name of the virtual machine to which the DVD drive is to be added.

    .PARAMETER ControllerNumber
    Specifies the number of the controller to which the DVD drive is to be added.

    .PARAMETER ControllerLocation
    Specifies the number of the location on the controller at which the DVD drive is to be added.

    .PARAMETER Path
    Specifies the full path to the virtual hard disk file or physical hard disk volume for the
    added DVD drive.

    .PARAMETER Ensure
    Specifies if the DVD Drive should exist or not.

    .OUTPUTS
    Returns true if the parameters are valid, but will throw a specific error if not.
#>

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

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerLocation,

        [parameter(Mandatory = $true)]
        [System.Uint32]
        $ControllerNumber,

        [System.String]
        $Path,

        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure = 'Present'
    )

    # Check if Hyper-V module is present for Hyper-V cmdlets
    if(-not (Get-Module -ListAvailable -Name Hyper-V))
    {
        New-InvalidArgumentError `
            -ErrorId 'RoleMissingError' `
            -ErrorMessage ($LocalizedData.RoleMissingError -f `
                'Hyper-V')
    } # if

    # Does the VM exist?
    $null = Get-VM -Name $VMName

    # Does the controller exist?
    if (-not (Get-VMScsiController -VMName $VMName -ControllerNumber $ControllerNumber) `
        -and -not (Get-VMIdeController -VMName $VMName -ControllerNumber $ControllerNumber))
    {
        # No it does not
        New-InvalidArgumentError `
            -ErrorId 'VMControllerDoesNotExistError' `
            -ErrorMessage ($LocalizedData.VMControllerDoesNotExistError -f `
                $VMName,$ControllerNumber)
    } # if

    # Is a Hard Drive assigned to this controller location/number?
    if (Get-VMHardDiskDrive `
        -VMName $VMName `
        -ControllerLocation $ControllerLocation `
        -ControllerNumber $ControllerNumber)
    {
        # Yes, so don't even try and touch this
        New-InvalidArgumentError `
            -ErrorId 'ControllerConflictError' `
            -ErrorMessage ($LocalizedData.ControllerConflictError -f `
                $VMName,$ControllerNumber,$ControllerLocation)
    } # if

    if ($Ensure -eq 'Present')
    {
        # If the path is not blank does it exist?
        if (-not ([String]::IsNullOrWhiteSpace($Path)))
        {
            if (-not (Test-Path -Path $Path))
            {
                # Path does not exist
                New-InvalidArgumentError `
                    -ErrorId 'PathDoesNotExistError' `
                    -ErrorMessage ($LocalizedData.PathDoesNotExistError -f `
                        $Path)
            } # if
        } # if
    } # if

    return $true
} # Test-ParameterValid

Export-ModuleMember -Function *-TargetResource