DSCResources/xHyper-V/DSCResources/MSFT_xVMDvdDrive/MSFT_xVMDvdDrive.psm1

#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