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

Set-VMComPort

Last Updated: 3/8/2017

SYNOPSIS

Configures the COM port of a virtual machine.

SYNTAX

VMName (Default)

Set-VMComPort [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>]
 [-VMName] <String[]> -Number <Int32> [[-Path] <String>] [-DebuggerMode <OnOffState>] [-Passthru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

VMObject

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

VMComPort

Set-VMComPort [-VMComPort] <VMComPort[]> [[-Path] <String>] [-DebuggerMode <OnOffState>] [-Passthru] [-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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: VMName
Aliases: 

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

-ComputerName

Specifies one or more Hyper-V hosts on which the 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[]
Parameter Sets: VMName
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

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

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type: PSCredential[]
Parameter Sets: VMName
Aliases: 

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

-DebuggerMode

Specifies the state of the COM port for use by debuggers. The acceptable values for this parameter are: On and Off.

Type: OnOffState
Parameter Sets: (All)
Aliases: 
Accepted values: On, Off

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

-Number

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

Type: Int32
Parameter Sets: VMName, VMObject
Aliases: 

Required: True
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

-VM

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

Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases: 

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

-VMComPort

Specifies the COM port to be configured.

Type: VMComPort[]
Parameter Sets: VMComPort
Aliases: 

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

-VMName

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

Type: String[]
Parameter Sets: VMName
Aliases: 

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

-WhatIf

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

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

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

CommonParameters

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

INPUTS

OUTPUTS

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

NOTES

© 2017 Microsoft