Get-VMComPort
Gets the COM ports of a virtual machine or snapshot.
Syntax
Get-VMComPort
[-VMName] <String[]>
[[-Number] <Int32>]
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>] Get-VMComPort
[-VM] <VirtualMachine[]>
[[-Number] <Int32>]
[<CommonParameters>] 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 TestVMGets all COM ports associated with virtual machine TestVM.
Example 2
PS C:\> Get-VMComPort TestVM -Number 2Gets 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[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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[] |
| Position: | Named |
| Default value: | None |
| Required: | 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[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine whose COM ports are to be retrieved.
| Type: | VirtualMachine[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine whose COM ports are to be retrieved.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMSnapshot
Specifies the snapshot whose COM ports are to be retrieved.
| Type: | VMSnapshot |
| Aliases: | VMCheckpoint |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
Microsoft.HyperV.PowerShell.VMComPort