Set-VMComPort
Set-VMComPort
Configures the COM port of a virtual machine.
Syntax
Parameter Set: VMComPort
Set-VMComPort [-VMComPort] <VMComPort[]> [-Path] <String> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMName
Set-VMComPort [-VMName] <String[]> [-Number] <Int32> [-Path] <String> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Set-VMComPort [-VM] <VirtualMachine[]> [-Path] <String> -Number <Int32> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-VMComPort cmdlet configures the COM port of a virtual machine.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which the COM port of a virtual machine is to be configured. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Number<Int32>
Specifies the Id (1 or 2) of the COM port to be configured.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Passthru
Specifies that a Microsoft.Virtualization.Powershell.ComPort object is to be passed through to the pipeline representing the COM port to be configured.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies a named pipe path for the COM port to be configured. Specify local pipes as “\\.\pipe\PipeName” and remote pipes as "\\RemoteServer\pipe\PipeName".
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine for which the COM port is to be configured.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMComPort<VMComPort[]>
Specifies the COM port to be configured.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies the name of the virtual machine for which the COM port is to be configured.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None by default; Microsoft.Virtualization.Powershell.ComPort if –PassThru is specified.
Examples
Example 1
Configure the second COM port on virtual machine TestVM to connect to named pipe TestPipe on the local computer.
PS C:\> Set-VMComPort TestVM 2 \\.\pipe\TestPipe