en-US/VMConnectConfig-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Edit-VMConnectConfig</command:name> <command:verb>Edit</command:verb> <command:noun>VMConnectConfig</command:noun> <maml:description> <maml:para>Edits saved Hyper-V virtual machine enhanced session settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Edit-VMConnectConfig cmdlet edits saved Hyper-V virtual machine enhanced session settings. Specify the Verbose parameter to get additional information regarding the command's operation. You can also pipe the output of Get-VM or Get-VMConnectConfig to Edit-VMConnectConfig.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="True" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be modified. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ShowEnhancedConnectionDialog</maml:name> <maml:description> <maml:para>Opens the vmconnect.exe connection settings dialog which can edit enhanced session settings for existing virtual machines. The virtual machine specified must be running and able to establish an enhanced session connection.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be modified. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio capture redirection enhanced session setting. The default configuration setting is False. The acceptable values for this parameter are: - True: Indicates that the host computer will redirect its default audio input device to the remote session. This setting is the same as selecting the "Record from this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - False: Indicates that the host computer will not redirect its default audio input device to the remote session. This setting is the same as selecting the "Do not record" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioPlaybackRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio playback redirection enhanced session setting. The default configuration setting is AUDIO_MODE_REDIRECT. The acceptable values for this parameter are: - AUDIO_MODE_NONE: Indicates that the virtual machine's audio will not be redirected to the host computer. This setting is the same as selecting the "Do not play" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_PLAY_ON_SERVER: Indicates that the virtual machine's audio will play on the remote computer. This setting is the same as selecting the "Play on remote computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_REDIRECT: Indicates that the virtual machine's audio will be redirected to the host computer. This setting is the same as selecting the "Play on this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ClipboardRedirection</maml:name> <maml:description> <maml:para>Sets the clipboard sharing enhanced session setting. True indicates that the clipboard will be shared between the host computer and the virtual machine. False indicates that the clipboard will not be shared between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>DesktopSize</maml:name> <maml:description> <maml:para>Sets the enhanced session display resolution. The default configuration setting value for DesktopSize , typically 1366 x 768, is stored in %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\clientsettings.config and hard-coded in the Microsoft.Virtualization.Client.dll assembly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Size</command:parameterValue> <dev:type> <maml:name>Size</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>EnablePrinterRedirection</maml:name> <maml:description> <maml:para>The EnablePrinterRedirection enhanced session setting enables or disables printer redirection functionality. If set to False, the "Printers" checkbox in the "Local Resources" settings tab of the vmconnect.exe connection settings dialog will be disabled (grayed out and unchecked) and the PrinterRedirection setting will be ignored. The EnablePrinterRedirection setting generally applies to version 8.1 (and higher) virtual machines. This setting is not exposed in the vmconnect.exe connection settings dialog. For more information, run "Get-Help Get-VMConnectConfig" and consult the NOTES section. The default configuration setting is True for version 8.1 (and higher) virtual machines that use the VMBus enhanced session transport type and False for virtual machines that use the HvSocket enhanced session transport type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:description> <maml:para>Sets the full screen mode enhanced session setting. True indicates that the enhanced session will run in full screen mode. False indicates that the enhanced session will run in windowed mode. This setting is the same as sliding the "Display configuration" resolution slider to the highest value ("Full Screen") in the "Display" settings tab of the vmconnect.exe connection settings dialog. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PrinterRedirection</maml:name> <maml:description> <maml:para>Sets the printer redirection enhanced session setting. True indicates that enhanced session printer redirection is enabled and will allow the virtual machine to access printers installed on the host computer. False disables enhanced session printer redirection. Enhanced session printer redirection functionality is automatically disabled in enhanced session connections for version 8.1 (and higher) virtual machines if EnablePrinterRedirection is set to False. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedDrives</maml:name> <maml:description> <maml:para>Sets the drives to redirect from the host computer to the virtual machine. The acceptable values for this parameter are: - A drive letter (a-z). Indicates that the host computer will redirect the specified drive(s) to the remote session. - *. Indicates that the host computer will redirect all drives, including "Drives that I plug in later" to the remote session. - dynamicdrives. Indicates that the host computer will redirect "Drives that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no drives to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedPnpDevices</maml:name> <maml:description> <maml:para>Sets the Plug and Play devices to redirect from the host computer to the virtual machine. Plug and Play devices that are eligible for redirection must support the Media Transport Protocol or Picture Transfer Protocol. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable PnP devices found on the host computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified Plug and Play device(s) to the remote session. - *. Indicates that the host computer will redirect all Plug and Play devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect Plug and Play "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no Plug and Play devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedUsbDevices</maml:name> <maml:description> <maml:para>Sets the RemoteFX USB devices to redirect from the host computer to the virtual machine. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable USB devices found on the local computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified RemoteFX USB device(s) to the remote session. - *. Indicates that the host computer will redirect all RemoteFX USB devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect RemoteFX USB "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no RemoteFX USB devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SaveButtonChecked</maml:name> <maml:description> <maml:para>Sets the value of the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog. True indicates that the checkbox is checked . False indicates that the checkbox is unchecked. Setting this to False will automatically launch the vmconnect.exe connection settings dialog the next time the virtual machine is connected to in Hyper-V Manager. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SmartCardsRedirection</maml:name> <maml:description> <maml:para>The SmartCardsRedirection enhanced session setting determines whether smart card devices on the host computer will be redirected and available in the virtual machine. True enables the sharing of smart cards between the host computer and the virtual machine. False disables the sharing of smart cards between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>UseAllMonitors</maml:name> <maml:description> <maml:para>The UseAllMonitors enhanced session setting determines if the virtual machine will use every monitor on the host computer in full screen mode. By default, the FullScreen setting will inherit the value of the UseAllMonitors setting. True indicates that the enhanced session will use all monitors in full screen mode. False indicates that the enhanced session will use only a single monitor. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>WebAuthnRedirection</maml:name> <maml:description> <maml:para>The WebAuthnRedirection enhanced session setting determines whether WebAuthn requests from the remote session are redirected to the host computer. True indicates that WebAuthn requests from the virtual machine are redirected to the host computer. False indicates that WebAuthn requests from the virtual machine are not redirected to the host computer. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ShowEnhancedConnectionDialog</maml:name> <maml:description> <maml:para>Opens the vmconnect.exe connection settings dialog which can edit enhanced session settings for existing virtual machines. The virtual machine specified must be running and able to establish an enhanced session connection.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio capture redirection enhanced session setting. The default configuration setting is False. The acceptable values for this parameter are: - True: Indicates that the host computer will redirect its default audio input device to the remote session. This setting is the same as selecting the "Record from this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - False: Indicates that the host computer will not redirect its default audio input device to the remote session. This setting is the same as selecting the "Do not record" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioPlaybackRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio playback redirection enhanced session setting. The default configuration setting is AUDIO_MODE_REDIRECT. The acceptable values for this parameter are: - AUDIO_MODE_NONE: Indicates that the virtual machine's audio will not be redirected to the host computer. This setting is the same as selecting the "Do not play" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_PLAY_ON_SERVER: Indicates that the virtual machine's audio will play on the remote computer. This setting is the same as selecting the "Play on remote computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_REDIRECT: Indicates that the virtual machine's audio will be redirected to the host computer. This setting is the same as selecting the "Play on this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ClipboardRedirection</maml:name> <maml:description> <maml:para>Sets the clipboard sharing enhanced session setting. True indicates that the clipboard will be shared between the host computer and the virtual machine. False indicates that the clipboard will not be shared between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>DesktopSize</maml:name> <maml:description> <maml:para>Sets the enhanced session display resolution. The default configuration setting value for DesktopSize , typically 1366 x 768, is stored in %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\clientsettings.config and hard-coded in the Microsoft.Virtualization.Client.dll assembly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Size</command:parameterValue> <dev:type> <maml:name>Size</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>EnablePrinterRedirection</maml:name> <maml:description> <maml:para>The EnablePrinterRedirection enhanced session setting enables or disables printer redirection functionality. If set to False, the "Printers" checkbox in the "Local Resources" settings tab of the vmconnect.exe connection settings dialog will be disabled (grayed out and unchecked) and the PrinterRedirection setting will be ignored. The EnablePrinterRedirection setting generally applies to version 8.1 (and higher) virtual machines. This setting is not exposed in the vmconnect.exe connection settings dialog. For more information, run "Get-Help Get-VMConnectConfig" and consult the NOTES section. The default configuration setting is True for version 8.1 (and higher) virtual machines that use the VMBus enhanced session transport type and False for virtual machines that use the HvSocket enhanced session transport type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:description> <maml:para>Sets the full screen mode enhanced session setting. True indicates that the enhanced session will run in full screen mode. False indicates that the enhanced session will run in windowed mode. This setting is the same as sliding the "Display configuration" resolution slider to the highest value ("Full Screen") in the "Display" settings tab of the vmconnect.exe connection settings dialog. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PrinterRedirection</maml:name> <maml:description> <maml:para>Sets the printer redirection enhanced session setting. True indicates that enhanced session printer redirection is enabled and will allow the virtual machine to access printers installed on the host computer. False disables enhanced session printer redirection. Enhanced session printer redirection functionality is automatically disabled in enhanced session connections for version 8.1 (and higher) virtual machines if EnablePrinterRedirection is set to False. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedDrives</maml:name> <maml:description> <maml:para>Sets the drives to redirect from the host computer to the virtual machine. The acceptable values for this parameter are: - A drive letter (a-z). Indicates that the host computer will redirect the specified drive(s) to the remote session. - *. Indicates that the host computer will redirect all drives, including "Drives that I plug in later" to the remote session. - dynamicdrives. Indicates that the host computer will redirect "Drives that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no drives to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedPnpDevices</maml:name> <maml:description> <maml:para>Sets the Plug and Play devices to redirect from the host computer to the virtual machine. Plug and Play devices that are eligible for redirection must support the Media Transport Protocol or Picture Transfer Protocol. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable PnP devices found on the host computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified Plug and Play device(s) to the remote session. - *. Indicates that the host computer will redirect all Plug and Play devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect Plug and Play "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no Plug and Play devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedUsbDevices</maml:name> <maml:description> <maml:para>Sets the RemoteFX USB devices to redirect from the host computer to the virtual machine. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable USB devices found on the local computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified RemoteFX USB device(s) to the remote session. - *. Indicates that the host computer will redirect all RemoteFX USB devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect RemoteFX USB "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no RemoteFX USB devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SaveButtonChecked</maml:name> <maml:description> <maml:para>Sets the value of the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog. True indicates that the checkbox is checked . False indicates that the checkbox is unchecked. Setting this to False will automatically launch the vmconnect.exe connection settings dialog the next time the virtual machine is connected to in Hyper-V Manager. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SmartCardsRedirection</maml:name> <maml:description> <maml:para>The SmartCardsRedirection enhanced session setting determines whether smart card devices on the host computer will be redirected and available in the virtual machine. True enables the sharing of smart cards between the host computer and the virtual machine. False disables the sharing of smart cards between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>UseAllMonitors</maml:name> <maml:description> <maml:para>The UseAllMonitors enhanced session setting determines if the virtual machine will use every monitor on the host computer in full screen mode. By default, the FullScreen setting will inherit the value of the UseAllMonitors setting. True indicates that the enhanced session will use all monitors in full screen mode. False indicates that the enhanced session will use only a single monitor. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>WebAuthnRedirection</maml:name> <maml:description> <maml:para>The WebAuthnRedirection enhanced session setting determines whether WebAuthn requests from the remote session are redirected to the host computer. True indicates that WebAuthn requests from the virtual machine are redirected to the host computer. False indicates that WebAuthn requests from the virtual machine are not redirected to the host computer. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ShowEnhancedConnectionDialog</maml:name> <maml:description> <maml:para>Opens the vmconnect.exe connection settings dialog which can edit enhanced session settings for existing virtual machines. The virtual machine specified must be running and able to establish an enhanced session connection.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio capture redirection enhanced session setting. The default configuration setting is False. The acceptable values for this parameter are: - True: Indicates that the host computer will redirect its default audio input device to the remote session. This setting is the same as selecting the "Record from this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - False: Indicates that the host computer will not redirect its default audio input device to the remote session. This setting is the same as selecting the "Do not record" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioPlaybackRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio playback redirection enhanced session setting. The default configuration setting is AUDIO_MODE_REDIRECT. The acceptable values for this parameter are: - AUDIO_MODE_NONE: Indicates that the virtual machine's audio will not be redirected to the host computer. This setting is the same as selecting the "Do not play" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_PLAY_ON_SERVER: Indicates that the virtual machine's audio will play on the remote computer. This setting is the same as selecting the "Play on remote computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_REDIRECT: Indicates that the virtual machine's audio will be redirected to the host computer. This setting is the same as selecting the "Play on this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ClipboardRedirection</maml:name> <maml:description> <maml:para>Sets the clipboard sharing enhanced session setting. True indicates that the clipboard will be shared between the host computer and the virtual machine. False indicates that the clipboard will not be shared between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>DesktopSize</maml:name> <maml:description> <maml:para>Sets the enhanced session display resolution. The default configuration setting value for DesktopSize , typically 1366 x 768, is stored in "%APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\clientsettings.config" and hard-coded in the Microsoft.Virtualization.Client.dll assembly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Size</command:parameterValue> <dev:type> <maml:name>Size</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>EnablePrinterRedirection</maml:name> <maml:description> <maml:para>The EnablePrinterRedirection enhanced session setting enables or disables printer redirection functionality. If set to False, the "Printers" checkbox in the "Local Resources" settings tab of the vmconnect.exe connection settings dialog will be disabled (grayed out and unchecked) and the PrinterRedirection setting will be ignored. The EnablePrinterRedirection setting generally applies to version 8.1 (and higher) virtual machines. This setting is not exposed in the vmconnect.exe connection settings dialog. For more information, run "Get-Help Get-VMConnectConfig" and consult the NOTES section. The default configuration setting is True for version 8.1 (and higher) virtual machines that use the VMBus enhanced session transport type and False for virtual machines that use the HvSocket enhanced session transport type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:description> <maml:para>Sets the full screen mode enhanced session setting. True indicates that the enhanced session will run in full screen mode. False indicates that the enhanced session will run in windowed mode. This setting is the same as sliding the "Display configuration" resolution slider to the highest value ("Full Screen") in the "Display" settings tab of the vmconnect.exe connection settings dialog. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PrinterRedirection</maml:name> <maml:description> <maml:para>Sets the printer redirection enhanced session setting. True indicates that enhanced session printer redirection is enabled and will allow the virtual machine to access printers installed on the host computer. False disables enhanced session printer redirection. Enhanced session printer redirection functionality is automatically disabled in enhanced session connections for version 8.1 (and higher) virtual machines if EnablePrinterRedirection is set to False. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedDrives</maml:name> <maml:description> <maml:para>Sets the drives to redirect from the host computer to the virtual machine. The acceptable values for this parameter are: - A drive letter (a-z). Indicates that the host computer will redirect the specified drive(s) to the remote session. - *. Indicates that the host computer will redirect all drives, including "Drives that I plug in later" to the remote session. - dynamicdrives. Indicates that the host computer will redirect "Drives that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no drives to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedPnpDevices</maml:name> <maml:description> <maml:para>Sets the Plug and Play devices to redirect from the host computer to the virtual machine. Plug and Play devices that are eligible for redirection must support the Media Transport Protocol or Picture Transfer Protocol. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable PnP devices found on the host computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified Plug and Play device(s) to the remote session. - *. Indicates that the host computer will redirect all Plug and Play devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect Plug and Play "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no Plug and Play devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedUsbDevices</maml:name> <maml:description> <maml:para>Sets the RemoteFX USB devices to redirect from the host computer to the virtual machine. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable USB devices found on the local computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified RemoteFX USB device(s) to the remote session. - *. Indicates that the host computer will redirect all RemoteFX USB devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect RemoteFX USB "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no RemoteFX USB devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SaveButtonChecked</maml:name> <maml:description> <maml:para>Sets the value of the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog. True indicates that the checkbox is checked . False indicates that the checkbox is unchecked. Setting this to False will automatically launch the vmconnect.exe connection settings dialog the next time the virtual machine is connected to in Hyper-V Manager. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SmartCardsRedirection</maml:name> <maml:description> <maml:para>The SmartCardsRedirection enhanced session setting determines whether smart card devices on the host computer will be redirected and available in the virtual machine. True enables the sharing of smart cards between the host computer and the virtual machine. False disables the sharing of smart cards between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>UseAllMonitors</maml:name> <maml:description> <maml:para>The UseAllMonitors enhanced session setting determines if the virtual machine will use every monitor on the host computer in full screen mode. By default, the FullScreen setting will inherit the value of the UseAllMonitors setting. True indicates that the enhanced session will use all monitors in full screen mode. False indicates that the enhanced session will use only a single monitor. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>WebAuthnRedirection</maml:name> <maml:description> <maml:para>The WebAuthnRedirection enhanced session setting determines whether WebAuthn requests from the remote session are redirected to the host computer. True indicates that WebAuthn requests from the virtual machine are redirected to the host computer. False indicates that WebAuthn requests from the virtual machine are not redirected to the host computer. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be modified. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ShowEnhancedConnectionDialog</maml:name> <maml:description> <maml:para>Opens the vmconnect.exe connection settings dialog which can edit enhanced session settings for existing virtual machines. The virtual machine specified must be running and able to establish an enhanced session connection.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be modified. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio capture redirection enhanced session setting. The default configuration setting is False. The acceptable values for this parameter are: - True: Indicates that the host computer will redirect its default audio input device to the remote session. This setting is the same as selecting the "Record from this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - False: Indicates that the host computer will not redirect its default audio input device to the remote session. This setting is the same as selecting the "Do not record" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioPlaybackRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio playback redirection enhanced session setting. The default configuration setting is AUDIO_MODE_REDIRECT. The acceptable values for this parameter are: - AUDIO_MODE_NONE: Indicates that the virtual machine's audio will not be redirected to the host computer. This setting is the same as selecting the "Do not play" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_PLAY_ON_SERVER: Indicates that the virtual machine's audio will play on the remote computer. This setting is the same as selecting the "Play on remote computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_REDIRECT: Indicates that the virtual machine's audio will be redirected to the host computer. This setting is the same as selecting the "Play on this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ClipboardRedirection</maml:name> <maml:description> <maml:para>Sets the clipboard sharing enhanced session setting. True indicates that the clipboard will be shared between the host computer and the virtual machine. False indicates that the clipboard will not be shared between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>DesktopSize</maml:name> <maml:description> <maml:para>Sets the enhanced session display resolution. The default configuration setting value for DesktopSize , typically 1366 x 768, is stored in "%APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\clientsettings.config" and hard-coded in the Microsoft.Virtualization.Client.dll assembly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Size</command:parameterValue> <dev:type> <maml:name>Size</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>EnablePrinterRedirection</maml:name> <maml:description> <maml:para>The EnablePrinterRedirection enhanced session setting enables or disables printer redirection functionality. If set to False, the "Printers" checkbox in the "Local Resources" settings tab of the vmconnect.exe connection settings dialog will be disabled (grayed out and unchecked) and the PrinterRedirection setting will be ignored. The EnablePrinterRedirection setting generally applies to version 8.1 (and higher) virtual machines. This setting is not exposed in the vmconnect.exe connection settings dialog. For more information, run "Get-Help Get-VMConnectConfig" and consult the NOTES section. The default configuration setting is True for version 8.1 (and higher) virtual machines that use the VMBus enhanced session transport type and False for virtual machines that use the HvSocket enhanced session transport type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:description> <maml:para>Sets the full screen mode enhanced session setting. True indicates that the enhanced session will run in full screen mode. False indicates that the enhanced session will run in windowed mode. This setting is the same as sliding the "Display configuration" resolution slider to the highest value ("Full Screen") in the "Display" settings tab of the vmconnect.exe connection settings dialog. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PrinterRedirection</maml:name> <maml:description> <maml:para>Sets the printer redirection enhanced session setting. True indicates that enhanced session printer redirection is enabled and will allow the virtual machine to access printers installed on the host computer. False disables enhanced session printer redirection. Enhanced session printer redirection functionality is automatically disabled in enhanced session connections for version 8.1 (and higher) virtual machines if EnablePrinterRedirection is set to False. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedDrives</maml:name> <maml:description> <maml:para>Sets the drives to redirect from the host computer to the virtual machine. The acceptable values for this parameter are: - A drive letter (a-z). Indicates that the host computer will redirect the specified drive(s) to the remote session. - *. Indicates that the host computer will redirect all drives, including "Drives that I plug in later" to the remote session. - dynamicdrives. Indicates that the host computer will redirect "Drives that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no drives to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedPnpDevices</maml:name> <maml:description> <maml:para>Sets the Plug and Play devices to redirect from the host computer to the virtual machine. Plug and Play devices that are eligible for redirection must support the Media Transport Protocol or Picture Transfer Protocol. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable PnP devices found on the host computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified Plug and Play device(s) to the remote session. - *. Indicates that the host computer will redirect all Plug and Play devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect Plug and Play "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no Plug and Play devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedUsbDevices</maml:name> <maml:description> <maml:para>Sets the RemoteFX USB devices to redirect from the host computer to the virtual machine. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable USB devices found on the local computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified RemoteFX USB device(s) to the remote session. - *. Indicates that the host computer will redirect all RemoteFX USB devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect RemoteFX USB "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no RemoteFX USB devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SaveButtonChecked</maml:name> <maml:description> <maml:para>Sets the value of the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog. True indicates that the checkbox is checked . False indicates that the checkbox is unchecked. Setting this to False will automatically launch the vmconnect.exe connection settings dialog the next time the virtual machine is connected to in Hyper-V Manager. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SmartCardsRedirection</maml:name> <maml:description> <maml:para>The SmartCardsRedirection enhanced session setting determines whether smart card devices on the host computer will be redirected and available in the virtual machine. True enables the sharing of smart cards between the host computer and the virtual machine. False disables the sharing of smart cards between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>UseAllMonitors</maml:name> <maml:description> <maml:para>The UseAllMonitors enhanced session setting determines if the virtual machine will use every monitor on the host computer in full screen mode. By default, the FullScreen setting will inherit the value of the UseAllMonitors setting. True indicates that the enhanced session will use all monitors in full screen mode. False indicates that the enhanced session will use only a single monitor. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>WebAuthnRedirection</maml:name> <maml:description> <maml:para>The WebAuthnRedirection enhanced session setting determines whether WebAuthn requests from the remote session are redirected to the host computer. True indicates that WebAuthn requests from the virtual machine are redirected to the host computer. False indicates that WebAuthn requests from the virtual machine are not redirected to the host computer. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio capture redirection enhanced session setting. The default configuration setting is False. The acceptable values for this parameter are: - True: Indicates that the host computer will redirect its default audio input device to the remote session. This setting is the same as selecting the "Record from this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - False: Indicates that the host computer will not redirect its default audio input device to the remote session. This setting is the same as selecting the "Do not record" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioPlaybackRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio playback redirection enhanced session setting. The default configuration setting is AUDIO_MODE_REDIRECT. The acceptable values for this parameter are: - AUDIO_MODE_NONE: Indicates that the virtual machine's audio will not be redirected to the host computer. This setting is the same as selecting the "Do not play" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_PLAY_ON_SERVER: Indicates that the virtual machine's audio will play on the remote computer. This setting is the same as selecting the "Play on remote computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_REDIRECT: Indicates that the virtual machine's audio will be redirected to the host computer. This setting is the same as selecting the "Play on this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ClipboardRedirection</maml:name> <maml:description> <maml:para>Sets the clipboard sharing enhanced session setting. True indicates that the clipboard will be shared between the host computer and the virtual machine. False indicates that the clipboard will not be shared between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>DesktopSize</maml:name> <maml:description> <maml:para>Sets the enhanced session display resolution. The default configuration setting value for DesktopSize , typically 1366 x 768, is stored in "%APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\clientsettings.config" and hard-coded in the Microsoft.Virtualization.Client.dll assembly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Size</command:parameterValue> <dev:type> <maml:name>Size</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>EnablePrinterRedirection</maml:name> <maml:description> <maml:para>The EnablePrinterRedirection enhanced session setting enables or disables printer redirection functionality. If set to False, the "Printers" checkbox in the "Local Resources" settings tab of the vmconnect.exe connection settings dialog will be disabled (grayed out and unchecked) and the PrinterRedirection setting will be ignored. The EnablePrinterRedirection setting generally applies to version 8.1 (and higher) virtual machines. This setting is not exposed in the vmconnect.exe connection settings dialog. For more information, run "Get-Help Get-VMConnectConfig" and consult the NOTES section. The default configuration setting is True for version 8.1 (and higher) virtual machines that use the VMBus enhanced session transport type and False for virtual machines that use the HvSocket enhanced session transport type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:description> <maml:para>Sets the full screen mode enhanced session setting. True indicates that the enhanced session will run in full screen mode. False indicates that the enhanced session will run in windowed mode. This setting is the same as sliding the "Display configuration" resolution slider to the highest value ("Full Screen") in the "Display" settings tab of the vmconnect.exe connection settings dialog. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PrinterRedirection</maml:name> <maml:description> <maml:para>Sets the printer redirection enhanced session setting. True indicates that enhanced session printer redirection is enabled and will allow the virtual machine to access printers installed on the host computer. False disables enhanced session printer redirection. Enhanced session printer redirection functionality is automatically disabled in enhanced session connections for version 8.1 (and higher) virtual machines if EnablePrinterRedirection is set to False. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedDrives</maml:name> <maml:description> <maml:para>Sets the drives to redirect from the host computer to the virtual machine. The acceptable values for this parameter are: - A drive letter (a-z). Indicates that the host computer will redirect the specified drive(s) to the remote session. - *. Indicates that the host computer will redirect all drives, including "Drives that I plug in later" to the remote session. - dynamicdrives. Indicates that the host computer will redirect "Drives that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no drives to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedPnpDevices</maml:name> <maml:description> <maml:para>Sets the Plug and Play devices to redirect from the host computer to the virtual machine. Plug and Play devices that are eligible for redirection must support the Media Transport Protocol or Picture Transfer Protocol. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable PnP devices found on the host computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified Plug and Play device(s) to the remote session. - *. Indicates that the host computer will redirect all Plug and Play devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect Plug and Play "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no Plug and Play devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedUsbDevices</maml:name> <maml:description> <maml:para>Sets the RemoteFX USB devices to redirect from the host computer to the virtual machine. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable USB devices found on the local computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified RemoteFX USB device(s) to the remote session. - *. Indicates that the host computer will redirect all RemoteFX USB devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect RemoteFX USB "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no RemoteFX USB devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SaveButtonChecked</maml:name> <maml:description> <maml:para>Sets the value of the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog. True indicates that the checkbox is checked . False indicates that the checkbox is unchecked. Setting this to False will automatically launch the vmconnect.exe connection settings dialog the next time the virtual machine is connected to in Hyper-V Manager. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SmartCardsRedirection</maml:name> <maml:description> <maml:para>The SmartCardsRedirection enhanced session setting determines whether smart card devices on the host computer will be redirected and available in the virtual machine. True enables the sharing of smart cards between the host computer and the virtual machine. False disables the sharing of smart cards between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>UseAllMonitors</maml:name> <maml:description> <maml:para>The UseAllMonitors enhanced session setting determines if the virtual machine will use every monitor on the host computer in full screen mode. By default, the FullScreen setting will inherit the value of the UseAllMonitors setting. True indicates that the enhanced session will use all monitors in full screen mode. False indicates that the enhanced session will use only a single monitor. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>WebAuthnRedirection</maml:name> <maml:description> <maml:para>The WebAuthnRedirection enhanced session setting determines whether WebAuthn requests from the remote session are redirected to the host computer. True indicates that WebAuthn requests from the virtual machine are redirected to the host computer. False indicates that WebAuthn requests from the virtual machine are not redirected to the host computer. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ShowEnhancedConnectionDialog</maml:name> <maml:description> <maml:para>Opens the vmconnect.exe connection settings dialog which can edit enhanced session settings for existing virtual machines. The virtual machine specified must be running and able to establish an enhanced session connection.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be modified. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be modified. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ShowEnhancedConnectionDialog</maml:name> <maml:description> <maml:para>Opens the vmconnect.exe connection settings dialog which can edit enhanced session settings for existing virtual machines. The virtual machine specified must be running and able to establish an enhanced session connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio capture redirection enhanced session setting. The default configuration setting is False. The acceptable values for this parameter are: - True. Indicates that the host computer will redirect its default audio input device to the remote session. This setting is the same as selecting the "Record from this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - False. Indicates that the host computer will not redirect its default audio input device to the remote session. This setting is the same as selecting the "Do not record" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>AudioPlaybackRedirectionMode</maml:name> <maml:description> <maml:para>Sets the remote audio playback redirection enhanced session setting. The default configuration setting is AUDIO_MODE_REDIRECT. The acceptable values for this parameter are: - AUDIO_MODE_NONE. Indicates that the virtual machine's audio will not be redirected to the host computer. This setting is the same as selecting the "Do not play" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_PLAY_ON_SERVER. Indicates that the virtual machine's audio will play on the remote computer. This setting is the same as selecting the "Play on remote computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog. - AUDIO_MODE_REDIRECT. Indicates that the virtual machine's audio will be redirected to the host computer. This setting is the same as selecting the "Play on this computer" radio button found in the remote audio settings section within the vmconnect.exe connection settings dialog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>ClipboardRedirection</maml:name> <maml:description> <maml:para>Sets the clipboard sharing enhanced session setting. True indicates that the clipboard will be shared between the host computer and the virtual machine. False indicates that the clipboard will not be shared between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>DesktopSize</maml:name> <maml:description> <maml:para>Sets the enhanced session display resolution. The default configuration setting value for DesktopSize , typically 1366 x 768, is stored in %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\clientsettings.config and hard-coded in the Microsoft.Virtualization.Client.dll assembly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Size</command:parameterValue> <dev:type> <maml:name>Size</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>EnablePrinterRedirection</maml:name> <maml:description> <maml:para>The EnablePrinterRedirection enhanced session setting enables or disables printer redirection functionality. If set to False, the "Printers" checkbox in the "Local Resources" settings tab of the vmconnect.exe connection settings dialog will be disabled (grayed out and unchecked) and the PrinterRedirection setting will be ignored. The EnablePrinterRedirection setting generally applies to version 8.1 (and higher) virtual machines. This setting is not exposed in the vmconnect.exe connection settings dialog. For more information, run "Get-Help Get-VMConnectConfig" and consult the NOTES section. The default configuration setting is True for version 8.1 (and higher) virtual machines that use the VMBus enhanced session transport type and False for virtual machines that use the HvSocket enhanced session transport type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:description> <maml:para>Sets the full screen mode enhanced session setting. True indicates that the enhanced session will run in full screen mode. False indicates that the enhanced session will run in windowed mode. This setting is the same as sliding the "Display configuration" resolution slider to the highest value ("Full Screen") in the "Display" settings tab of the vmconnect.exe connection settings dialog. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PrinterRedirection</maml:name> <maml:description> <maml:para>Sets the printer redirection enhanced session setting. True indicates that enhanced session printer redirection is enabled and will allow the virtual machine to access printers installed on the host computer. False disables enhanced session printer redirection. Enhanced session printer redirection functionality is automatically disabled in enhanced session connections for version 8.1 (and higher) virtual machines if EnablePrinterRedirection is set to False. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedDrives</maml:name> <maml:description> <maml:para>Sets the drives to redirect from the host computer to the virtual machine. The acceptable values for this parameter are: - A drive letter (a-z). Indicates that the host computer will redirect the specified drive(s) to the remote session. - *. Indicates that the host computer will redirect all drives, including "Drives that I plug in later" to the remote session. - dynamicdrives. Indicates that the host computer will redirect "Drives that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no drives to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedPnpDevices</maml:name> <maml:description> <maml:para>Sets the Plug and Play devices to redirect from the host computer to the virtual machine. Plug and Play devices that are eligible for redirection must support the Media Transport Protocol or Picture Transfer Protocol. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable PnP devices found on the host computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified Plug and Play device(s) to the remote session. - *. Indicates that the host computer will redirect all Plug and Play devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect Plug and Play "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no Plug and Play devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>RedirectedUsbDevices</maml:name> <maml:description> <maml:para>Sets the RemoteFX USB devices to redirect from the host computer to the virtual machine. You can use tab completion in PowerShell 5 and higher to browse a list of redirectable USB devices found on the local computer. The acceptable values for this parameter are: - A device instance path. Indicates that the host computer will redirect the specified RemoteFX USB device(s) to the remote session. - *. Indicates that the host computer will redirect all RemoteFX USB devices, including "Devices that I plug in later" to the remote session. - dynamicdevices. Indicates that the host computer will redirect RemoteFX USB "Devices that I plug in later" to the remote session. - $null or an empty string. Indicates that the host computer will redirect no RemoteFX USB devices to the remote session.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SaveButtonChecked</maml:name> <maml:description> <maml:para>Sets the value of the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog. True indicates that the checkbox is checked . False indicates that the checkbox is unchecked. Setting this to False will automatically launch the vmconnect.exe connection settings dialog the next time the virtual machine is connected to in Hyper-V Manager. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>SmartCardsRedirection</maml:name> <maml:description> <maml:para>The SmartCardsRedirection enhanced session setting determines whether smart card devices on the host computer will be redirected and available in the virtual machine. True enables the sharing of smart cards between the host computer and the virtual machine. False disables the sharing of smart cards between the host computer and the virtual machine. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>UseAllMonitors</maml:name> <maml:description> <maml:para>The UseAllMonitors enhanced session setting determines if the virtual machine will use every monitor on the host computer in full screen mode. By default, the FullScreen setting will inherit the value of the UseAllMonitors setting. True indicates that the enhanced session will use all monitors in full screen mode. False indicates that the enhanced session will use only a single monitor. The default configuration setting is False.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>WebAuthnRedirection</maml:name> <maml:description> <maml:para>The WebAuthnRedirection enhanced session setting determines whether WebAuthn requests from the remote session are redirected to the host computer. True indicates that WebAuthn requests from the virtual machine are redirected to the host computer. False indicates that WebAuthn requests from the virtual machine are not redirected to the host computer. The default configuration setting is True.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.HyperV.PowerShell.VirtualMachine[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can also refer to this cmdlet by its built-in alias edvmc.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Edit-VMConnectConfig -Id 262e29c6-beb5-4805-8d5f-3546ffc78e70 -PrinterRedirection $false</dev:code> <dev:remarks> <maml:para>This command disables enhanced session printer redirection for the virtual machine with ID 262e29c6-beb5-4805-8d5f-3546ffc78e70.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Edit-VMConnectConfig -Name 'Server*' -DesktopSize '1440, 900' -PrinterRedirection 1</dev:code> <dev:remarks> <maml:para>This command sets the enhanced session display resolution to 1440x900 and enables enhanced session printer redirection for virtual machines whose names start with "Server*".</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Edit-VMConnectConfig -Path "$env:APPDATA\Microsoft\Windows\Hyper-V\Client\1.0\vmconnect\rdp.vmconnect.262e29c6-beb5-4805-8d5f-3546ffc78e70.config" -RedirectedPnpDevices 'usb\vid_045e&pid_0a12\7npvcwu5gvcm'</dev:code> <dev:remarks> <maml:para>This command sets the enhanced session PnP device redirection setting for the configuration file %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\rdp.vmconnect.262e29c6-beb5-4805-8d5f-3546ffc78e70.config.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-VM -Name 'Windows 11 Pro' | Edit-VMConnectConfig -ShowEnhancedConnectionDialog</dev:code> <dev:remarks> <maml:para>This command launches the connection settings dialog for the virtual machine(s) named Windows 11 Pro. The command will generate an error for virtual machines that are unable to establish an enhanced session connection.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -All | Edit-VMConnectConfig -SaveButtonChecked $false -PassThru</dev:code> <dev:remarks> <maml:para>This command unchecks the "Save my settings for future connections to this virtual machine" checkbox and outputs an object for each enhanced session configuration file. The connection settings dialog will open the next time an enhanced session connection is made to the virtual machine(s).</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-Item -Path 'C:\vmconnectBackups\Server2vmconnectFile.config' | Edit-VMConnectConfig -AudioPlaybackRedirectionMode AUDIO_MODE_NONE -Verbose</dev:code> <dev:remarks> <maml:para>This command disables enhanced session audio redirection for the configuration file C:\vmconnectBackups\Server2vmconnectFile.config and outputs verbose messages.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://thegraffix.github.io/VMConnectConfig/edit-vmconnectconfig.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn282274(v=ws.11)</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows-server/virtualization/hyper-v/learn-more/hyper-v-virtual-machine-connect</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows-server/virtualization/hyper-v/learn-more/use-local-resources-on-hyper-v-virtual-machine-with-vmconnect</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/hyperv_v2/msvm-computersystem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/termserv/imsrdpclientadvancedsettings-interface</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/termserv/imsrdpclientadvancedsettings5</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/termserv/imsrdpclientadvancedsettings7</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VMConnectConfig</command:name> <command:verb>Get</command:verb> <command:noun>VMConnectConfig</command:noun> <maml:description> <maml:para>Gets saved Hyper-V virtual machine enhanced session settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VMConnectConfig cmdlet gets Hyper-V virtual machine enhanced session settings from enhanced session configuration files created by vmconnect.exe or Hyper-V Manager. By default, Get-VMConnectConfig gets the enhanced session settings for existing virtual machines as well as virtual machines whose state of existence cannot be determined. Specify the Verbose parameter to get additional information regarding the command's operation. You can also pipe the output of Get-VM to Get-VMConnectConfig.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets the enhanced session settings from all enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets the enhanced session settings from enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory for virtual machines that no longer exist.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be retrieved. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be retrieved. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets the enhanced session settings from all enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets the enhanced session settings from enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory for virtual machines that no longer exist.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be retrieved. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be retrieved. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.HyperV.PowerShell.VirtualMachine[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can also refer to this cmdlet by its built-in alias gvmc. The Get-VMConnectConfig cmdlet and VMConnectConfig cmdlets that use the -PassThru switch return a psobject with the following properties: - Name. The virtual machine's name, extracted from the content of the "VmName" element in the configuration file. - Id. The virtual machine's unique identifier, extracted from the configuration file's filename. A null/empty value indicates that a valid GUID could not be extracted from the configuration file's filename. - Path. The full path of the configuration file. - DateModified. The date and time that the configuration file was last modified. - VMExists. A boolean value that indicates whether the virtual machine exists. The value of VMExists is calculated by querying the Msvm_ComputerSystem WMI class on the virtual machine's host computer (VmServerName). - True. Indicates that a WMI query to the virtual machine's host computer was successful and the virtual machine was found. - False. Indicates that a WMI query to the virtual machine's host computer was successful and the virtual machine was not found. - null. Indicates that a WMI query to the virtual machine's host computer was not successful or the host computer could not be connected to. - VMVersion. The virtual machine's Hyper-V virtual machine configuration version. The value of VMVersion is calculated by querying the Msvm_VirtualSystemSettingData WMI class on the virtual machine's host computer (VmServerName). - null. Indicates that a WMI query to the virtual machine's host computer was not successful or the computer could not be connected to. - AudioCaptureRedirectionMode. A boolean value that indicates whether the default audio input device is redirected from the host to the remote session. - AudioPlaybackRedirectionMode. Determines whether the local or remote machine plays audio. - AUDIO_MODE_NONE. Disables audio redirection. - AUDIO_MODE_PLAY_ON_SERVER. Plays the virtual machine's audio on the remote computer. - AUDIO_MODE_REDIRECT. Plays the virtual machine's audio on the host computer. - ClipboardRedirection. A boolean value that indicates whether the clipboard is redirected and shared between the host computer and the virtual machine. - DesktopSize. The dimensions of the remote session desktop (width, height). - EnablePrinterRedirection. A boolean value that indicates whether printer redirection functionality is enabled. - The EnablePrinterRedirection configuration setting is generally included in enhanced session configuration files generated on operating systems that are eligible to host version 8.1 (and higher) Hyper-V virtual machines. - Factors that can influence the presence of the EnablePrinterRedirection configuration setting include (but are not limited to) the Hyper-V host's configuration, the host and client's operating system versions, and group policy settings. - The EnablePrinterRedirection setting is ignored if the virtualization environment/configuration does not support it. - The value of the PrinterRedirection setting is ignored when EnablePrinterRedirection is set to False. - The default setting is True if the virtual machine uses the VMBus enhanced session transport type. - The default setting is False if the virtual machine uses the HvSocket enhanced session transport type. - FullScreen. A boolean value that indicates whether the remote session will run in full screen mode or in windowed mode. - PrinterRedirection. A boolean value that indicates whether printers will be redirected to the remote session. - RedirectedDrives. Indicates which fixed, removable, and network drives on the host computer will be redirected to the remote session. - RedirectedPnpDevices. Indicates which peripherals that use the Media Transfer Protocol (MTP) or Picture Transfer Protocol (PTP) on the host computer will be redirected to the remote session. - RedirectedUsbDevices. Indicates which supported USB devices on the host computer will be redirected to the remote session. - SaveButtonChecked. A boolean value that indicates whether the "Save my settings for future connections to this virtual machine" checkbox in the vmconnect.exe connection settings dialog is checked. - SmartCardsRedirection. A boolean value that indicates whether smart card devices on the host computer will be redirected to the remote session. - UseAllMonitors. A boolean value that indicates whether the remote session will use one or multiple displays on the host computer. - VmServerName. The name of the computer on which the Hyper-V virtual machine is hosted. - WebAuthnRedirection. A boolean value that indicates whether WebAuthn requests from the remote session are redirected to the host computer. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-VMConnectConfig</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings from enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory for existing virtual machines as well as virtual machines whose state of existence cannot be determined.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -All</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings from all enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -Deleted</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings from enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory for virtual machines that no longer exist.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -Id 262e29c6-beb5-4805-8d5f-3546ffc78e70</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings for the virtual machine with ID 262e29c6-beb5-4805-8d5f-3546ffc78e70.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -Name Win*</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings for virtual machines whose names start with "Win*".</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -Path 'C:\vmconnectBackups\rdp.vmconnect.262e29c6-beb5-4805-8d5f-3546ffc78e70.config'</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings for the configuration file C:\vmconnectBackups\rdp.vmconnect.262e29c6-beb5-4805-8d5f-3546ffc78e70.config.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Get-VM | Get-VMConnectConfig</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings for each virtual machine that has an enhanced session configuration file found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <dev:code>Get-ChildItem -Path 'C:\vmconnectBackups\vmconnect.rdp.*.config' | Get-VMConnectConfig -Verbose</dev:code> <dev:remarks> <maml:para>This command gets the enhanced session settings for the configuration files in the C:\vmconnectBackups\ directory and outputs verbose messages.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://thegraffix.github.io/VMConnectConfig/get-vmconnectconfig.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/hyperv_v2/msvm-computersystem</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/hyperv_v2/msvm-virtualsystemsettingdata</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/termserv/imsrdpclientadvancedsettings-interface</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/termserv/imsrdpclientadvancedsettings5</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/windows/win32/termserv/imsrdpclientadvancedsettings7</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VMConnectConfig</command:name> <command:verb>New</command:verb> <command:noun>VMConnectConfig</command:noun> <maml:description> <maml:para>Creates a new Hyper-V virtual machine enhanced session configuration file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-VMConnectConfig cmdlet creates a new enhanced session configuration file using default values. Specify the Verbose parameter to get additional information regarding the command's operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a virtual machine name for the enhanced session configuration file. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="2" aliases="none"> <maml:name>VMServerName</maml:name> <maml:description> <maml:para>Specifies the Hyper-V host computer name for the enhanced session configuration file. The default value is the local computer name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Local computer</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="3" aliases="none"> <maml:name>ConfigFileType</maml:name> <maml:description> <maml:para>Specifies the type of enhanced session configuration file to create. The acceptable values for this parameter are: - Legacy. Indicates that the new configuration file will not include the EnablePrinterRedirection configuration setting. Use Legacy for enhanced session configuration files that reference a version 8.0 (or lower) Hyper-V virtual machine. - Modern. Indicates that the new configuration file will include the EnablePrinterRedirection configuration setting. Use Modern for enhanced session configuration files that reference a version 8.1 (or higher) Hyper-V virtual machine. - WebAuthn. Indicates that the new configuration file will include the EnablePrinterRedirection and WebAuthnRedirection configuration settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet will overwrite the specified output file if it already exists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine. The new enhanced session configuration file will be named vmconnect.rdp.<Id>.config. If Path is specified when using the Id parameter, the path must be a path to a container. If Path is not specified when using the Id parameter, the new enhanced session configuration file will be saved to the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path where the new enhanced session configuration file is to be stored. If Id is specified, the path must be a path to a container. If Id is not specified, the path must be a path to an item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>%APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a virtual machine name for the enhanced session configuration file. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="2" aliases="none"> <maml:name>VMServerName</maml:name> <maml:description> <maml:para>Specifies the Hyper-V host computer name for the enhanced session configuration file. The default value is the local computer name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Local computer</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="3" aliases="none"> <maml:name>ConfigFileType</maml:name> <maml:description> <maml:para>Specifies the type of enhanced session configuration file to create. The acceptable values for this parameter are: - Legacy. Indicates that the new configuration file will not include the EnablePrinterRedirection configuration setting. Use Legacy for enhanced session configuration files that reference a version 8.0 (or lower) Hyper-V virtual machine. - Modern. Indicates that the new configuration file will include the EnablePrinterRedirection configuration setting. Use Modern for enhanced session configuration files that reference a version 8.1 (or higher) Hyper-V virtual machine. - WebAuthn. Indicates that the new configuration file will include the EnablePrinterRedirection and WebAuthnRedirection configuration settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet will overwrite the specified output file if it already exists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine. The new enhanced session configuration file will be named vmconnect.rdp.<Id>.config. If Path is specified when using the Id parameter, the path must be a path to a container. If Path is not specified when using the Id parameter, the new enhanced session configuration file will be saved to the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path where the new enhanced session configuration file is to be stored. If Id is specified, the path must be a path to a container. If Id is not specified, the path must be a path to an item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="3" aliases="none"> <maml:name>ConfigFileType</maml:name> <maml:description> <maml:para>Specifies the type of enhanced session configuration file to create. The acceptable values for this parameter are: - Legacy. Indicates that the new configuration file will not include the EnablePrinterRedirection configuration setting. Use Legacy for enhanced session configuration files that reference a version 8.0 (or lower) Hyper-V virtual machine. - Modern. Indicates that the new configuration file will include the EnablePrinterRedirection configuration setting. Use Modern for enhanced session configuration files that reference a version 8.1 (or higher) Hyper-V virtual machine. - WebAuthn. Indicates that the new configuration file will include the EnablePrinterRedirection and WebAuthnRedirection configuration settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet will overwrite the specified output file if it already exists.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine. The new enhanced session configuration file will be named vmconnect.rdp.<Id>.config. If Path is specified when using the Id parameter, the path must be a path to a container. If Path is not specified when using the Id parameter, the new enhanced session configuration file will be saved to the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a virtual machine name for the enhanced session configuration file. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path where the new enhanced session configuration file is to be stored. If Id is specified, the path must be a path to a container. If Id is not specified, the path must be a path to an item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>%APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="2" aliases="none"> <maml:name>VMServerName</maml:name> <maml:description> <maml:para>Specifies the Hyper-V host computer name for the enhanced session configuration file. The default value is the local computer name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Local computer</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can also refer to this cmdlet by its built-in alias nvmc.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-VMConnectConfig -Name 'Server2' -VMServerName 'HVServer1' -Path 'C:\vmconnectBackups\Server2vmconnectFile.config' -Verbose</dev:code> <dev:remarks> <maml:para>This command creates a new enhanced session configuration file for a version 8.1 (or higher) Hyper-V virtual machine, saves the file to C:\vmconnectBackups\Server2vmconnectFile.config and outputs verbose messages.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-VMConnectConfig -Name 'Server2' -VMServerName 'HVServer1' -ConfigFileType 'Modern' -Id 74c8b3c8-f0b4-497c-852e-5cc1e33898b1</dev:code> <dev:remarks> <maml:para>This command creates a new enhanced session configuration file for a version 8.1 (or higher) Hyper-V virtual machine and saves the file vmconnect.rdp.74c8b3c8-f0b4-497c-852e-5cc1e33898b1.config in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>New-VMConnectConfig -Name 'Win7 Pro' -ConfigFileType 'Legacy' -Id cb845c31-4d69-4cd3-8aa2-d851b2a73caf -Path 'C:\vmconnectBackups' -Force -PassThru</dev:code> <dev:remarks> <maml:para>This command creates a new enhanced session configuration file for a version 8.0 (or lower) Hyper-V virtual machine, saves the file vmconnect.rdp.cb845c31-4d69-4cd3-8aa2-d851b2a73caf.config in the C:\vmconnectBackups\ directory, overwrites the file if it already exists, uses the local computer name as the value for the enhanced session configuration file's VmServerName configuration setting and outputs an object that represents the enhanced session settings.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://thegraffix.github.io/VMConnectConfig/new-vmconnectconfig.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VMConnectConfig</command:name> <command:verb>Remove</command:verb> <command:noun>VMConnectConfig</command:noun> <maml:description> <maml:para>Deletes Hyper-V virtual machine enhanced session configuration files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-VMConnectConfig cmdlet deletes one or more specified Hyper-V virtual machine enhanced session configuration files. By default, the Remove-VMConnectConfig cmdlet moves files to the Recycle Bin. Specify the Verbose parameter to get additional information regarding the command's operation. You can also pipe the output of Get-VM or Get-VMConnectConfig to Remove-VMConnectConfig.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that this cmdlet deletes all enhanced session configuration files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Indicates that this cmdlet deletes enhanced session configuration files for virtual machines that no longer exist.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session configuration file is to be deleted. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session configuration file is to be deleted. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VMConnectConfig</maml:name> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Nuke</maml:name> <maml:description> <maml:para>Indicates that this cmdlet will delete the entire %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory, including all enhanced session and Hyper-V Manager configuration files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that this cmdlet deletes all enhanced session configuration files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Indicates that this cmdlet deletes enhanced session configuration files for virtual machines that no longer exist.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet permanently deletes enhanced session configuration files that cannot otherwise be changed, such as hidden or read-only files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session configuration file is to be deleted. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session configuration file is to be deleted. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>Nuke</maml:name> <maml:description> <maml:para>Indicates that this cmdlet will delete the entire %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory, including all enhanced session and Hyper-V Manager configuration files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.HyperV.PowerShell.VirtualMachine[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can also refer to this cmdlet by its built-in alias rvmc.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-VMConnectConfig -All -Force</dev:code> <dev:remarks> <maml:para>This command permanently deletes all enhanced session configuration files.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Remove-VMConnectConfig -Deleted -Verbose</dev:code> <dev:remarks> <maml:para>This command moves enhanced session configuration files to the Recycle Bin for virtual machines that no longer exist and outputs verbose messages.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Remove-VMConnectConfig -Name 'Server*'</dev:code> <dev:remarks> <maml:para>This command moves the enhanced session configuration files to the Recycle Bin for virtual machines whose names start with "Server*".</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Remove-VMConnectConfig -Id 262e29c6-beb5-4805-8d5f-3546ffc78e70</dev:code> <dev:remarks> <maml:para>This command moves the enhanced session configuration file(s) to the Recycle Bin for the virtual machine with ID 262e29c6-beb5-4805-8d5f-3546ffc78e70.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Remove-VMConnectConfig -Nuke</dev:code> <dev:remarks> <maml:para>This command moves the entire %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory to the Recycle Bin.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -Name 'Win*' | Where-Object {$_.VMExists -eq $false} | Remove-VMConnectConfig</dev:code> <dev:remarks> <maml:para>This command moves the enhanced session configuration files to the Recycle Bin for virtual machines that no longer exist whose names start with "Win*".</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Get-VM | Remove-VMConnectConfig</dev:code> <dev:remarks> <maml:para>This command moves the enhanced session configuration file(s) to the Recycle Bin for each virtual machine that has an enhanced session configuration file found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://thegraffix.github.io/VMConnectConfig/remove-vmconnectconfig.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-VMConnectConfig</command:name> <command:verb>Reset</command:verb> <command:noun>VMConnectConfig</command:noun> <maml:description> <maml:para>Resets enhanced session connection settings for Hyper-V virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Reset-VMConnectConfig cmdlet resets enhanced session connection settings to default values for Hyper-V virtual machines. Specify the Verbose parameter to get additional information regarding the command's operation. You can also pipe the output of Get-VM or Get-VMConnectConfig to Reset-VMConnectConfig.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be reset to default values. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Reset-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Reset-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Reset-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be reset to default values. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Reset-VMConnectConfig</maml:name> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="VMId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the virtual machine whose enhanced session settings are to be reset to default values. Enter one or more unique identifiers. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine unique identifiers which are extracted from the enhanced session configuration filenames found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the input to this cmdlet. You can use this parameter or you can pipe the output of Get-VMConnectConfig to this cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">VMConnectConfig[]</command:parameterValue> <dev:type> <maml:name>VMConnectConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose enhanced session settings are to be reset to default values. Enter one or more virtual machine names. Wildcard characters are permitted. You can use tab completion in PowerShell 5 and higher to browse a list of virtual machine names which are extracted from the "VmName" value within the enhanced session configuration files found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the virtual machine's enhanced session settings. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" variableLength="true" globbing="False" pipelineInput="False" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.HyperV.PowerShell.VirtualMachine[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can also refer to this cmdlet by its built-in alias rsvmc.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Reset-VMConnectConfig -Name 'Windows 11 Pro'</dev:code> <dev:remarks> <maml:para>This command resets the enhanced session settings to default values for the virtual machine(s) named Windows 11 Pro.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-VMConnectConfig -Id 74c8b3c8-f0b4-497c-852e-5cc1e33898b1 | Reset-VMConnectConfig -PassThru</dev:code> <dev:remarks> <maml:para>This command resets the enhanced session settings to default values for the virtual machine with ID 74c8b3c8-f0b4-497c-852e-5cc1e33898b1 and outputs an object that represents the enhanced session settings.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Reset-VMConnectConfig -Path 'C:\vmconnectBackups\Server2.config'</dev:code> <dev:remarks> <maml:para>This command resets the enhanced session settings stored in the file C:\vmconnectBackups\Server2.config to default values.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Reset-VMConnectConfig -Id 74c8b3c8-f0b4-497c-852e-5cc1e33898b1</dev:code> <dev:remarks> <maml:para>This command resets the enhanced session settings to default values for the virtual machine with ID 74c8b3c8-f0b4-497c-852e-5cc1e33898b1.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-Item -Path 'C:\vmconnectBackups\vmconnect.rdp.*.config' | Reset-VMConnectConfig -Verbose</dev:code> <dev:remarks> <maml:para>This command resets the enhanced session settings to default values for configuration files found in the C:\vmconnectBackups\ directory and outputs verbose messages.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-VM | Reset-VMConnectConfig</dev:code> <dev:remarks> <maml:para>This command resets the enhanced session settings to default values for each virtual machine that has an enhanced session configuration file found in the %APPDATA%\Microsoft\Windows\Hyper-V\Client\1.0\ directory.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://thegraffix.github.io/VMConnectConfig/reset-vmconnectconfig.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-VMConnectConfig</command:name> <command:verb>Test</command:verb> <command:noun>VMConnectConfig</command:noun> <maml:description> <maml:para>Tests if a file is a valid Hyper-V virtual machine enhanced session configuration file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Test-VMConnectConfig cmdlet verifies enhanced session configuration files, such as those created by vmconnect.exe or Hyper-V Manager. The cmdlet returns True if the file passes all tests and False if it does not. Specify the Verbose parameter to get additional information regarding the command's operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-VMConnectConfig</maml:name> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="true" globbing="False" pipelineInput="True (ByPropertyName)" position="Named" aliases="FullName"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="true" globbing="True" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to one or more enhanced session configuration files. Wildcard characters are permitted. The paths must be paths to items, not to containers.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can also refer to this cmdlet by its built-in alias tvmc.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Test-VMConnectConfig -Path 'C:\vmconnectBackups\Server2.config'</dev:code> <dev:remarks> <maml:para>This command tests whether the file C:\vmconnectBackups\Server2.config is a valid enhanced session configuration file.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ChildItem -Path .\Subfolder\*.* | Test-VMConnectConfig -Verbose</dev:code> <dev:remarks> <maml:para>This command tests all files in the Subfolder\ directory to determine whether each file is a valid enhanced session configuration file.</maml:para> <maml:para/> <maml:para/> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://thegraffix.github.io/VMConnectConfig/test-vmconnectconfig.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |