COMMAND EVERYTHING.

Get-VMComPort

Gets the COM ports of a virtual machine or snapshot.

Last verified: 2026-10-26

Microsoft Hyper-V reference: Gets the COM ports of a virtual machine or snapshot. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

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

Required permissions

Use an account with the target resource permissions documented for Get-VMComPort. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / Hyper-V · Windows Server 2025 documentation; feature/module prerequisites apply

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.

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

-Credential

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

-Number

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

-VM (required)

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

-VMName (required)

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

-VMSnapshot (required)

Specifies the snapshot whose COM ports are to be retrieved.

Prerequisites

Windows with the Hyper-V module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.

Examples

Get-VMComPort TestVM

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/Hyper-V/Get-VMComPort.md

https://learn.microsoft.com/powershell/module/hyper-v/get-vmcomport?view=windowsserver2025-ps

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer