Disable-​VM​Console​Support

Disables keyboard, video, and mouse for a generation 2 virtual machine.

Syntax

Disable-VMConsoleSupport
       [-VMName] <String[]>
       [-CimSession <CimSession[]>]
       [-ComputerName <String[]>]
       [-Confirm]
       [-Credential <PSCredential[]>]
       [-Passthru]
       [-WhatIf]
       [<CommonParameters>]
Disable-VMConsoleSupport
       [-VM] <VirtualMachine[]>
       [-Confirm]
       [-Passthru]
       [-WhatIf]
       [<CommonParameters>]

Description

The Disable-VMConsoleSupport cmdlet disables keyboard, video, and mouse for virtual machines.

Examples

Example 1: Disable keyboard, video, and mouse support

PS C:\> $VM = Get-VM -ComputerName "Server01"
PS C:\> Disable-VMConsoleSupport -VM $VM

The first command uses the Get-VM cmdlet to obtain the virtual machines on the host named Server01. The command stores the results in the $VM variable.

The second command disables keyboard, video, and mouse support on the virtual machine or virtual machines in $VM.

Required Parameters

-VM

Specifies an array of virtual machines on which this cmdlet disables support for keyboard, video, and mouse. To obtain a VirtualMachine object, use the Get-VM cmdlet.

Type:VirtualMachine[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMName

Specifies an array of names of virtual machines on which this cmdlet disables support for keyboard, video, and mouse.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Indicates that this cmdlet returns the Microsoft.HyperV.VirtualMachine object that it modifies.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.HyperV.Powershell.VirtualMachine

This cmdlet returns a VirtualMachine object, if you specify the Passthru parameter.