Edit

Share via


Set-VMRemoteFx3dVideoAdapter

Configures the RemoteFX 3D video adapter of a virtual machine.

Syntax

VMName (Default)

Set-VMRemoteFx3dVideoAdapter
    [-VMName] <String[]>
    [[-MonitorCount] <Byte>]
    [[-MaximumResolution] <String>]
    [[-VRAMSizeBytes] <UInt64>]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

VMObject

Set-VMRemoteFx3dVideoAdapter
    [-VM] <VirtualMachine[]>
    [[-MonitorCount] <Byte>]
    [[-MaximumResolution] <String>]
    [[-VRAMSizeBytes] <UInt64>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Object

Set-VMRemoteFx3dVideoAdapter
    [-VMRemoteFx3dVideoAdapter] <VMRemoteFx3DVideoAdapter[]>
    [[-MonitorCount] <Byte>]
    [[-MaximumResolution] <String>]
    [[-VRAMSizeBytes] <UInt64>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-VMRemoteFx3dVideoAdapter cmdlet configures the RemoteFX 3D video adapter of a virtual machine.

Examples

Example 1

PS C:\> Set-VMRemoteFx3dVideoAdapter -VMName TestVM -MaximumResolution 1920x1200

Sets the maximum resolution of the RemoteFX adapter on virtual machine TestVM to 1920x1200.

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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

Specifies one or more Hyper-V hosts on which the RemoteFX 3D video adapter is to be configured. 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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

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

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumResolution

Specifies the maximum resolution supported by this adapter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MonitorCount

Specifies the maximum number of monitors supported by this adapter.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Passthru

Specifies that a Microsoft.HyperV.PowerShell.RemoteFxVideoAdapter object is to be passed through to the pipeline representing the adapter to be configured.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VM

Specifies the virtual machine on which the adapter is to be configured.

Parameter properties

Type:

VirtualMachine[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

Specifies the name of the virtual machine on which the adapter is to be configured.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMRemoteFx3dVideoAdapter

Specifies the adapter to be configured.

Parameter properties

Type:

VMRemoteFx3DVideoAdapter[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Object
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VRAMSizeBytes

Specifies the size, in bytes, of VRAM supported that this adapter supports.

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

None

By default, this cmdlet doesn't return any output.

Microsoft.HyperV.PowerShell.RemoteFxVideoAdapter

When you use the PassThru parameter, this cmdlet returns a Microsoft.HyperV.PowerShell.RemoteFxVideoAdapter object.