Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Disable-VMRemoteFXPhysicalVideoAdapter

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Disables one or more RemoteFX physical video adapters from use with RemoteFX-enabled virtual machines.

SYNTAX

GPUByName (Default)

Disable-VMRemoteFXPhysicalVideoAdapter [-CimSession <CimSession[]>] [-ComputerName <String[]>]
 [-Credential <PSCredential[]>] [-Name] <String[]> [-Passthru] [-WhatIf] [-Confirm] [<CommonParameters>]

GPUByObject

Disable-VMRemoteFXPhysicalVideoAdapter [-GPU] <VMRemoteFXPhysicalVideoAdapter[]> [-Passthru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

The Disable-VMRemoteFXPhysicalVideoAdapter cmdlet disables one or more RemoteFX physical video adapter from use with RemoteFX-enabled virtual machines.

EXAMPLES

Example 1

PS C:\> Disable-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia*

This example disables all RemoteFX physical video adapters that include the string "Nvidia" in their names.

Example 2

PS C:\> Get-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* | Disable-VMRemotePhysicalVideoAdapter

This example disables all RemoteFX physical video adapters that include the string "Nvidia" in their names.

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[]
Parameter Sets: GPUByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies one or more Hyper-V hosts on which the RemoteFX physical video adapters are to be disabled. 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[]
Parameter Sets: GPUByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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[]
Parameter Sets: GPUByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GPU

Specifies one or more RemoteFX physical video adapters to disable.

Type: VMRemoteFXPhysicalVideoAdapter[]
Parameter Sets: GPUByObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies an array of names of adapters. The cmdlet disables the RemoteFX physical video adapters that you specify.

Type: String[]
Parameter Sets: GPUByName
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Passthru

Specifies that Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter objects are to be passed to the pipeline representing the RemoteFX physical video adapters to be disabled.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter[]

System.String[]

OUTPUTS

None by default; Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter if PassThru is specified.

NOTES

© 2017 Microsoft