Set-VMComPort

Reference

Module:: Hyper-V

Configures the COM port of a virtual machine.

Syntax

Set-VMComPort
   -Number <Int32>
   [-Path] <String>
   [-Passthru]
   [-ComputerName <String[]>]
   [-VMName] <String[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-VMComPort
   [-VMComPort] <VMComPort[]>
   [-Path] <String>
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-VMComPort
   -Number <Int32>
   [-Path] <String>
   [-Passthru]
   [-VM] <VirtualMachine[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VMComPort cmdlet configures the COM port of a virtual machine.

Examples

Example 1

PS C:\>Set-VMComPort TestVM 2 \\.\pipe\TestPipe

Configure the second COM port on virtual machine TestVM to connect to named pipe TestPipe on the local computer.

Parameters

-ComputerName

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.

Type:	String[]
Position:	Named
Default value:	.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Number

Specifies the Id (1 or 2) of the COM port to be configured.

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

-Passthru

Specifies that a Microsoft.HyperV.PowerShell.ComPort object is to be passed through to the pipeline representing the COM port to be configured.

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

-Path

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".

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VM

Specifies the virtual machine for which the COM port is to be configured.

Type:	VirtualMachine[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMComPort

Specifies the COM port to be configured.

Type:	VMComPort[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Specifies the name of the virtual machine for which the COM port is to be configured.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

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

Share via