DSCResources/BMD_ciSCSIVirtualDisk/BMD_ciSCSIVirtualDisk.psm1
|
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 |