Get-VMComPort

Gets the COM ports of a virtual machine or snapshot.

Syntax

Get-VMComPort
   [-VMName] <String[]>
   [[-Number] <Int32>]
   [-ComputerName <String[]>]
Get-VMComPort
   [-VM] <VirtualMachine[]>
   [[-Number] <Int32>]
Get-VMComPort
   [-VMSnapshot] <VMSnapshot>
   [[-Number] <Int32>]

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.

Required Parameters

-VM

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

Type:VirtualMachine[]
Position:1
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[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:True
-VMSnapshot

Specifies the snapshot whose COM ports are to be retrieved.

Type:VMSnapshot
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-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[]
Position:Named
Default value:.
Accept pipeline input:False
Accept wildcard characters:False
-Number

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

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

Outputs

Microsoft.Virtualization.Powershell.ComPort