Get-VMComPort.md

description	external help file	Module Name	ms.date	online version	schema	title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.	Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml	Hyper-V	12/20/2016	https://learn.microsoft.com/powershell/module/hyper-v/get-vmcomport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp	2.0.0	Get-VMComPort

Get-VMComPort

SYNOPSIS

Gets the COM ports of a virtual machine or snapshot.

SYNTAX

VMName (Default)

Get-VMComPort [-VMName] <String[]> [[-Number] <Int32>] [-CimSession <CimSession[]>] [-ComputerName <String[]>]
 [-Credential <PSCredential[]>] [<CommonParameters>]

VMObject

Get-VMComPort [-VM] <VirtualMachine[]> [[-Number] <Int32>] [<CommonParameters>]

VMSnapshot

Get-VMComPort [-VMSnapshot] <VMSnapshot> [[-Number] <Int32>] [<CommonParameters>]

DESCRIPTION

The Get-VMComPort cmdlet gets the COM ports of a virtual machine or snapshot.

EXAMPLES

Example 1

PS C:\> Get-VMComPort TestVM

Gets all COM ports associated with virtual machine TestVM.

Example 2

PS C:\> Get-VMComPort TestVM -Number 2

Gets the second COM port associated with virtual machine TestVM.

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 ports of a virtual machine or snapshot are to be retrieved. 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

-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

-Number

Specifies the Id (1 or 2) of the COM ports to be retrieved.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-VM

Specifies the virtual machine whose COM ports are to be retrieved.

Type: VirtualMachine[]
Parameter Sets: VMObject
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 whose COM ports are to be retrieved.

Type: String[]
Parameter Sets: VMName
Aliases: 

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

-VMSnapshot

Specifies the snapshot whose COM ports are to be retrieved.

Type: VMSnapshot
Parameter Sets: VMSnapshot
Aliases: VMCheckpoint

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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

Microsoft.HyperV.PowerShell.VMComPort

NOTES

RELATED LINKS