Set-VMVideo

Module:
hyper-v
Configures video settings for virtual machines.

Syntax 

Set-VMVideo
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [[-ResolutionType] <ResolutionType>]
   [[-HorizontalResolution] <UInt16>]
   [[-VerticalResolution] <UInt16>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMVideo
   [-VM] <VirtualMachine[]>
   [[-ResolutionType] <ResolutionType>]
   [[-HorizontalResolution] <UInt16>]
   [[-VerticalResolution] <UInt16>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMVideo
   [-VMVideo] <VMVideo[]>
   [[-ResolutionType] <ResolutionType>]
   [[-HorizontalResolution] <UInt16>]
   [[-VerticalResolution] <UInt16>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VMVideo cmdlet configures the video settings for virtual machines.

Examples

Example 1: Set resolution for a virtual machine display 

PS C:\> Set-VMVideo -VMName "VM06" -HorizontalResolution 1920 -VerticalResolution 1200

This command sets the video resolution for the virtual machine named VM06 to 1920x1200.

Required Parameters

-VM

Specifies an array of virtual machines for which this cmdlet configures video settings. 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 for which this cmdlet configures video settings.

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

Specifies an array of virtual machine video settings that this cmdlet configures. To obtain a VMVideo object, use the Get-VMVideo cmdlet.

Type: VMVideo[]
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
-HorizontalResolution

Specifies the horizontal resolution for the virtual machine display.

Type: UInt16
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Passthru

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

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

Specifies the resolution type for the virtual machine display. The acceptable values for this parameter are:

  • Maximum. The input HorizontalResolution * VerticalResolution is the maximum supported resolution. All standard resolutions smaller than HorizontalResolution * VerticalResolution are also supported.
  • Single. The input HorizontalResolution * VerticalResolution is the only supported resolution.
  • Default. The supported resolutions are those in the list of standard resolutions. Input HorizontalResolution * VerticalResolution is ignored.
Type: ResolutionType
Parameter Sets: Maximum, Single, Default
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VerticalResolution

Specifies the vertical resolution for the virtual machine display.

Type: UInt16
Position: 3
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.VMVideo

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