DSCResources/BMD_ciSCSIVirtualDisk/BMD_ciSCSIVirtualDisk.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 |
data LocalizedData { # culture="en-US" ConvertFrom-StringData -StringData @' GettingiSCSIVirtualDiskMessage=Getting iSCSI Virtual Disk "{0}". iSCSIVirtualDiskExistsMessage=iSCSI Virtual Disk "{0}" exists. iSCSIVirtualDiskDoesNotExistMessage=iSCSI Virtual Disk "{0}" does not exist. SettingiSCSIVirtualDiskMessage=Setting iSCSI Virtual Disk "{0}". EnsureiSCSIVirtualDiskExistsMessage=Ensuring iSCSI Virtual Disk "{0}" exists. EnsureiSCSIVirtualDiskDoesNotExistMessage=Ensuring iSCSI Virtual Disk "{0}" does not exist. iSCSIVirtualDiskCreatedMessage=iSCSI Virtual Disk "{0}" has been created. iSCSIVirtualDiskUpdatedMessage=iSCSI Virtual Disk "{0}" has been updated. iSCSIVirtualDiskRemovedMessage=iSCSI Virtual Disk "{0}" has been removed. TestingiSCSIVirtualDiskMessage=Testing iSCSI Virtual Disk "{0}". iSCSIVirtualDiskParameterNeedsUpdateMessage=iSCSI Virtual Disk "{0}" {1} is different. Change required. iSCSIVirtualDiskDoesNotExistButShouldMessage=iSCSI Virtual Disk "{0}" does not exist but should. Change required. iSCSIVirtualDiskExistsButShouldNotMessage=iSCSI Virtual Disk "{0}" exists but should not. Change required. iSCSIVirtualDiskDoesNotExistAndShouldNotMessage=iSCSI Virtual Disk "{0}" does not exist and should not. Change not required. iSCSIVirtualDiskRequiresRecreateError=iSCSI Virtual Disk "{0}" needs to be deleted and recreated. Please perform this manually. '@ } function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [parameter(Mandatory = $true)] [System.String] $Path ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.GettingiSCSIVirtualDiskMessage) ` -f $Path ) -join '' ) $VirtualDisk = Get-VirtualDisk -Path $Path $returnValue = @{ Path = $Path } if ($VirtualDisk) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskExistsMessage) ` -f $Path ) -join '' ) $returnValue += @{ Ensure = 'Present' SizeBytes = $VirtualDisk.Size DiskType = $VirtualDisk.DiskType Description = $VirtualDisk.Description ParentPath = $VirtualDisk.ParentPath } } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskDoesNotExistMessage) ` -f $Path ) -join '' ) $returnValue += @{ Ensure = 'Absent' } } $returnValue } # Get-TargetResource function Set-TargetResource { [CmdletBinding()] param ( [parameter(Mandatory = $true)] [System.String] $Path, [ValidateSet('Present','Absent')] [System.String] $Ensure = 'Present', [ValidateSet('Dynamic','Fixed','Differencing')] [System.String] $DiskType = 'Dynamic', [System.Uint64] $SizeBytes, [System.Uint32] $BlockSizeBytes, [ValidateSet(512,4096)] [System.Uint32] $LogicalSectorSizeBytes, [ValidateSet(512,4096)] [System.UInt32] $PhysicalSectorSizeBytes, [System.String] $Description, [System.String] $ParentPath ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.SettingiSCSIVirtualDiskMessage) ` -f $Path ) -join '' ) # Remove any parameters that can't be splatted. $null = $PSBoundParameters.Remove('Ensure') $null = $PSBoundParameters.Remove('DiskType') # Lookup the existing iSCSI Virtual Disk $VirtualDisk = Get-VirtualDisk -Path $Path if ($Ensure -eq 'Present') { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.EnsureiSCSIVirtualDiskExistsMessage) ` -f $Path ) -join '' ) if ($VirtualDisk) { # The iSCSI Virtual Disk exists [Boolean] $Recreate = $false if (($DiskType) ` -and ($VirtualDisk.DiskType -ne $DiskType)) { $Recreate = $true } if (($SizeBytes) ` -and ($VirtualDisk.Size -ne $SizeBytes)) { $Recreate = $true } if (($ParentPath) ` -and ($VirtualDisk.ParentPath -ne $ParentPath)) { $Recreate = $true } # If any parameters differ that require this Virtual Disk to be recreated # then throw an error. Recreating the Virtual Disk is too dangerous as it # may contain data. If the Virtual Disk *must* be recreated then the user # will need to manually delete the Virtual Disk and the config will then # create a new one. if ($Recreate) { $errorId = 'iSCSIVirtualDiskRequiresRecreateError' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.iSCSIVirtualDiskRequiresRecreateError) -f $Path $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null $PSCmdlet.ThrowTerminatingError($errorRecord) } Set-iSCSIVirtualDisk ` -ComputerName LOCALHOST ` -Path $Path ` -Description $Description ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskUpdatedMessage) ` -f $Path ) -join '' ) } else { # Create the iSCSI Virtual Disk if ($DiskType -eq 'Fixed') { $null = $PSBoundParameters.Add('UseFixed',$True) } else { $null = $PSBoundParameters.Remove('LogicalSectorSizeBytes') } New-iSCSIVirtualDisk ` @PSBoundParameters ` -ComputerName LOCALHOST ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskCreatedMessage) ` -f $Path ) -join '' ) } } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.EnsureiSCSIVirtualDiskDoesNotExistMessage) ` -f $Path ) -join '' ) if ($VirtualDisk) { # The iSCSI Virtual Disk shouldn't exist - remove it Remove-iSCSIVirtualDisk ` -ComputerName LOCALHOST ` -Path $Path ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskRemovedMessage) ` -f $Path ) -join '' ) } # if } # if } # Set-TargetResource function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [parameter(Mandatory = $true)] [System.String] $Path, [ValidateSet('Present','Absent')] [System.String] $Ensure = 'Present', [ValidateSet('Dynamic','Fixed','Differencing')] [System.String] $DiskType = 'Dynamic', [System.Uint64] $SizeBytes, [System.Uint32] $BlockSizeBytes, [ValidateSet(512,4096)] [System.Uint32] $LogicalSectorSizeBytes, [ValidateSet(512,4096)] [System.UInt32] $PhysicalSectorSizeBytes, [System.String] $Description, [System.String] $ParentPath ) # Flag to signal whether settings are correct [Boolean] $desiredConfigurationMatch = $true Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.TestingiSCSIVirtualDiskMessage) ` -f $Path ) -join '' ) # Lookup the existing iSCSI Virtual Disk $VirtualDisk = Get-VirtualDisk -Path $Path if ($Ensure -eq 'Present') { # The iSCSI Virtual Disk should exist if ($VirtualDisk) { # The iSCSI Virtual Disk exists already - check the parameters [Boolean] $Recreate = $false if (($Description) ` -and ($VirtualDisk.Description -ne $Description)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskParameterNeedsUpdateMessage) ` -f $Path,'Description' ) -join '' ) $desiredConfigurationMatch = $false } if (($DiskType) ` -and ($VirtualDisk.DiskType -ne $DiskType)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskParameterNeedsUpdateMessage) ` -f $Path,'SizeBytes' ) -join '' ) $Recreate = $true } if (($SizeBytes) ` -and ($VirtualDisk.Size -ne $SizeBytes)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskParameterNeedsUpdateMessage) ` -f $Path,'SizeBytes' ) -join '' ) $Recreate = $true } if (($ParentPath) ` -and ($VirtualDisk.ParentPath -ne $ParentPath)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskParameterNeedsUpdateMessage) ` -f $Path,'ParentPath' ) -join '' ) $Recreate = $true } # If any parameters differ that require this Virtual Disk to be recreated # then throw an error. Recreating the Virtual Disk is too dangerous as it # may contain data. If the Virtual Disk *must* be recreated then the user # will need to manually delete the Virtual Disk and the config will then # create a new one. if ($Recreate) { $errorId = 'iSCSIVirtualDiskRequiresRecreateError' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.iSCSIVirtualDiskRequiresRecreateError) -f $Path $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null $PSCmdlet.ThrowTerminatingError($errorRecord) } } else { # Ths iSCSI Virtual Disk doesn't exist but should Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskDoesNotExistButShouldMessage) ` -f $Path ) -join '' ) $desiredConfigurationMatch = $false } } else { # The iSCSI Virtual Disk should not exist if ($VirtualDisk) { # The iSCSI Virtual Disk exists but should not Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskExistsButShouldNotMessage) ` -f $Path ) -join '' ) $desiredConfigurationMatch = $false } else { # The iSCSI Virtual Disk does not exist and should not Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($LocalizedData.iSCSIVirtualDiskDoesNotExistAndShouldNotMessage) ` -f $Path ) -join '' ) } } # if return $desiredConfigurationMatch } # Test-TargetResource # Helper Functions Function Get-VirtualDisk { param ( [parameter(Mandatory = $true)] [System.String] $Path ) try { # Specify Localhost as computer because # it speeds cmdlet up significantly $VirtualDisk = Get-iSCSIVirtualDisk ` -ComputerName LOCALHOST ` -Path $Path ` -ErrorAction Stop } catch [Microsoft.Iscsi.Target.Commands.IscsiCmdException] { $VirtualDisk = $null } catch { Throw $_ } Return $VirtualDisk } Export-ModuleMember -Function *-TargetResource |