DSCResources/xHyper-V/DSCResources/MSFT_xVMHardDiskDrive/MSFT_xVMHardDiskDrive.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
#region localizeddata
if (Test-Path "${PSScriptRoot}\${PSUICulture}")
{
    Import-LocalizedData `
        -BindingVariable LocalizedData `
        -Filename MSFT_xVMHardDiskDrive.strings.psd1 `
        -BaseDirectory "${PSScriptRoot}\${PSUICulture}"
}
else
{
    # fallback to en-US
    Import-LocalizedData `
        -BindingVariable LocalizedData `
        -Filename MSFT_xVMHardDiskDrive.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 hard disk drive.
    .PARAMETER VMName
    Specifies the name of the virtual machine whose hard disk drive status is to be fetched.
    .PARAMETER Path
    Specifies the full path of the VHD file linked to the hard disk drive.
#>

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

        [Parameter(Mandatory = $true)]
        [System.String]
        $Path
    )

    Assert-Module -Name 'Hyper-V'

    $hardDiskDrive = Get-VMHardDiskDrive -VMName $VMName -ErrorAction Stop |
                        Where-Object -FilterScript { $_.Path -eq $Path }

    if ($null -eq $hardDiskDrive)
    {
        Write-Verbose -Message ($localizedData.DiskNotFound -f $Path, $VMName)
        $ensure = 'Absent'
    }
    else
    {
        Write-Verbose -Message ($localizedData.DiskFound -f $Path, $VMName)
        $ensure = 'Present'
    }

    return @{
        VMName             = $VMName
        Path               = $hardDiskDrive.Path
        ControllerType     = $hardDiskDrive.ControllerType
        ControllerNumber   = $hardDiskDrive.ControllerNumber
        ControllerLocation = $hardDiskDrive.ControllerLocation
        Ensure             = $ensure
    }
}

<#
    .SYNOPSIS
    Tests the state of a VM hard disk drive.
    .PARAMETER VMName
    Specifies the name of the virtual machine whose hard disk drive is to be tested.
    .PARAMETER Path
    Specifies the full path of the VHD file to be tested.
    .PARAMETER ControllerType
    Specifies the type of controller to which the the hard disk drive is to be set (IDE/SCSI).
    Default to SCSI.
    .PARAMETER ControllerNumber
    Specifies the number of the controller to which the hard disk drive is to be set.
    If not specified, the controller number defaults to 0.
    .PARAMETER ControllerLocation
    Specifies the number of the location on the controller at which the hard disk drive is to be
    set. If not specified, the controller location defaults to 0.
    .PARAMETER Ensure
    Specifies if the hard disk drive should exist or not. Defaults to Present.
#>

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

        [Parameter(Mandatory = $true)]
        [System.String]
        $Path,

        [Parameter()]
        [ValidateSet('IDE', 'SCSI')]
        [System.String]
        $ControllerType = 'SCSI',

        [Parameter()]
        [ValidateSet(0, 1, 2, 3)]
        [System.UInt32]
        $ControllerNumber,

        [Parameter()]
        [ValidateRange(0, 63)]
        [System.UInt32]
        $ControllerLocation,

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

    $resource = Get-TargetResource -VMName $VMName -Path $Path

    # Throw exception when the ControllerNumber or ControllerLocation are out of bounds for IDE
    if ($ControllerType -eq 'IDE' -and ($ControllerNumber -gt 1 -or $ControllerLocation -gt 1))
    {
        $errorMessage = $localizedData.IdeLocationError -f $ControllerNumber, $ControllerLocation
        New-InvalidOperationError -ErrorId 'InvalidLocation' -ErrorMessage $errorMessage
    }

    $isCompliant = $true
    foreach ($key in $PSBoundParameters.Keys)
    {
        # Only check passed parameter values
        if ($resource.ContainsKey($key))
        {
            Write-Verbose -Message ($localizedData.ComparingParameter -f $key,
                                                                    $PSBoundParameters[$key],
                                                                    $resource[$key])
            $isCompliant = $isCompliant -and ($PSBoundParameters[$key] -eq $resource[$key])
        }
    }
    return $isCompliant
}

<#
    .SYNOPSIS
    Tests the state of a VM hard disk drive.
    .PARAMETER VMName
    Specifies the name of the virtual machine whose hard disk drive is to be tested.
    .PARAMETER Path
    Specifies the full path of the VHD file to be tested.
    .PARAMETER ControllerType
    Specifies the type of controller to which the the hard disk drive is to be set (IDE/SCSI).
    Default to SCSI.
    .PARAMETER ControllerNumber
    Specifies the number of the controller to which the hard disk drive is to be set.
    If not specified, the controller number defaults to 0.
    .PARAMETER ControllerLocation
    Specifies the number of the location on the controller at which the hard disk drive is to be
    set. If not specified, the controller location defaults to 0.
    .PARAMETER Ensure
    Specifies if the hard disk drive should exist or not. Defaults to Present.
#>

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

        [Parameter(Mandatory = $true)]
        [System.String]
        $Path,

        [Parameter()]
        [ValidateSet('IDE', 'SCSI')]
        [System.String]
        $ControllerType = 'SCSI',

        [Parameter()]
        [ValidateSet(0, 1, 2, 3)]
        [System.UInt32]
        $ControllerNumber,

        [Parameter()]
        [ValidateRange(0, 63)]
        [System.UInt32]
        $ControllerLocation,

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

    Assert-Module -Name 'Hyper-V'

    $hardDiskDrive = Get-VMHardDiskDrive -VMName $VMName |
                        Where-Object -FilterScript { $_.Path -eq $Path }

    if ($Ensure -eq 'Present')
    {
        $null = $PSBoundParameters.Remove('Ensure')

        Write-Verbose -Message ($localizedData.CheckingDiskIsAttached)
        if ($hardDiskDrive)
        {
            Write-Verbose -Message ($localizedData.DiskFound -f $Path, $VMName)
            $null = $PSBoundParameters.Remove('VMName')
            $null = $PSBoundParameters.Remove('Path')
            # As the operation is a move, we must use ToController instead of Controller
            if ($PSBoundParameters.ContainsKey('ControllerType'))
            {
                $null = $PSBoundParameters.Remove('ControllerType')
                $null = $PSBoundParameters.Add('ToControllerType', $ControllerType)
            }
            if ($PSBoundParameters.ContainsKey('ControllerNumber'))
            {
                $null = $PSBoundParameters.Remove('ControllerNumber')
                $null = $PSBoundParameters.Add('ToControllerNumber', $ControllerNumber)
            }
            if ($PSBoundParameters.ContainsKey('ControllerLocation'))
            {
                $null = $PSBoundParameters.Remove('ControllerLocation')
                $null = $PSBoundParameters.Add('ToControllerLocation', $ControllerLocation)
            }
            $null = $hardDiskDrive | Set-VMHardDiskDrive @PSBoundParameters
        }
        else
        {
            Write-Verbose -Message ($localizedData.CheckingExistingDiskLocation)
            $getVMHardDiskDriveParams = @{
                VMName             = $VMName
                ControllerType     = $ControllerType
                ControllerNumber   = $ControllerNumber
                ControllerLocation = $ControllerLocation
            }
            $existingHardDiskDrive = Get-VMHardDiskDrive @getVMHardDiskDriveParams
            if ($null -ne $existingHardDiskDrive)
            {
                $errorMessage = $localizedData.DiskPresentError -f $ControllerNumber, `
                                                                    $ControllerLocation
                New-InvalidOperationError -ErrorId 'ControllerNotEmpty' -ErrorMessage $errorMessage
            }

            Write-Verbose -Message ($localizedData.AddingDisk -f $Path, $VMName)
            $null = Add-VMHardDiskDrive @PSBoundParameters
        }
    }
    else
    {
        # We must ensure that the disk is absent
        if ($hardDiskDrive)
        {
            Write-Verbose -Message ($localizedData.RemovingDisk -f $Path, $VMName)
            $null = $hardDiskDrive | Remove-VMHardDiskDrive
        }
        else
        {
            Write-Warning -Message ($localizedData.DiskNotFound -f $Path, $VMName)
        }
    }
}

Export-ModuleMember -Function *-TargetResource