Disable-VMRemoteFXPhysicalVideoAdapter
Disables one or more RemoteFX physical video adapters from use with RemoteFX-enabled virtual machines.
Syntax
GPUByName (Default)
Disable-VMRemoteFXPhysicalVideoAdapter
[-Name] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GPUByName
| 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 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GPUByName
| 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
GPUByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-GPU
Specifies one or more RemoteFX physical video adapters to disable.
Parameter properties
| Type: | VMRemoteFXPhysicalVideoAdapter[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GPUByObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies an array of names of adapters. The cmdlet disables the RemoteFX physical video adapters that you specify.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GPUByName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
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 |
-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.
Inputs
Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter
String
Outputs
None
Default
Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter
If -PassThru is specified.