Set-HyperVVMDvdDrive

Hyper-V: Configures virtual DVD drive settings

Script

#Requires -Version 5.1
#Requires -Modules Hyper-V

[CmdletBinding()]
Param (
    [string]$ComputerName = "localhost",

    [PSCredential]$Credential,

    [Parameter(Mandatory = $true)]
    [string]$Name,

    [string]$Path,

    [ValidateSet('SCSI', 'IDE')]
    [string]$ControllerType = "SCSI",

    [int]$ControllerNumber = 0,

    [int]$ControllerLocation = 0
)

Process {
    try {
        $params = @{
            'ComputerName' = $ComputerName
            'ErrorAction'  = 'Stop'
        }
        if ($Credential) { $params.Add('Credential', $Credential) }

        $vm = Get-VM @params | Where-Object { $_.Name -eq $Name -or $_.Id -eq $Name }

        if (-not $vm) {
            throw "Virtual machine '$Name' not found on '$ComputerName'."
        }

        $dvdDrive = Get-VMDvdDrive -VM $vm | Where-Object { 
            $_.ControllerType -eq $ControllerType -and 
            $_.ControllerNumber -eq $ControllerNumber -and 
            $_.ControllerLocation -eq $ControllerLocation 
        }

        if (-not $dvdDrive) {
            throw "No DVD drive found on $ControllerType controller $ControllerNumber at location $ControllerLocation for VM '$Name'."
        }

        $setParams = @{ 'VMDvdDrive' = $dvdDrive; 'ErrorAction' = 'Stop' }
        if ($Path) { $setParams.Add('Path', $Path) }
        else { $setParams.Add('Path', $null) } # Eject

        Set-VMDvdDrive @setParams

        $updatedDrive = Get-VMDvdDrive -VM $vm | Where-Object { 
            $_.ControllerType -eq $ControllerType -and 
            $_.ControllerNumber -eq $ControllerNumber -and 
            $_.ControllerLocation -eq $ControllerLocation 
        }

        $result = [PSCustomObject]@{
            VMName             = $vm.Name
            ControllerType     = $updatedDrive.ControllerType
            ControllerNumber   = $updatedDrive.ControllerNumber
            ControllerLocation = $updatedDrive.ControllerLocation
            MediaPath          = $updatedDrive.Path
            Action             = "DvdDriveConfigUpdated"
            Status             = "Success"
            Timestamp          = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        }

        Write-Output $result
    }
    catch {
        throw
    }
}

Customize

ComputerName string

Specifies the name of the Hyper-V host. Defaults to the local machine.

Credential PSCredential

Specifies the credentials to use for the remote connection.

Name string

Specifies the name or ID of the virtual machine.

Path string

Optional. Specifies the path to an ISO file to mount. If empty, the drive is cleared.

ControllerType string

Optional. Specifies the controller type (SCSI or IDE). Defaults to SCSI.

ControllerNumber int

Optional. Specifies the controller number. Defaults to 0.

ControllerLocation int

Optional. Specifies the location on the controller. Defaults to 0.