Export (0) Print
Expand All
Expand Minimize

Get-VMComPort

Published: August 15, 2012

Updated: September 5, 2013

Applies To: Windows Server 2012

Get-VMComPort

Gets the COM ports of a virtual machine or snapshot.

Syntax

Parameter Set: VMName
Get-VMComPort [-VMName] <String[]> [[-Number] <Int32> ] [-ComputerName <String[]> ] [ <CommonParameters>]

Parameter Set: VMObject
Get-VMComPort [-VM] <VirtualMachine[]> [[-Number] <Int32> ] [ <CommonParameters>]

Parameter Set: VMSnapshot
Get-VMComPort [-VMSnapshot] <VMSnapshot> [[-Number] <Int32> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-ComputerName<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Number<Int32>

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


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-VMName<String[]>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

true

-VMSnapshot<VMSnapshot>

Specifies the snapshot whose COM ports are to be retrieved.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Virtualization.Powershell.ComPort

Examples

Example 1

Gets all COM ports associated with virtual machine TestVM.


PS C:\> Get-VMComPort TestVM

Example 2

Gets the second COM port associated with virtual machine TestVM.


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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft