Get-VMComPort
Gets the COM ports of a virtual machine or snapshot.
Syntax
Get-VMComPort
[-VMName] <String[]>
[[-Number] <Int32>]
[-ComputerName <String[]>]
[<CommonParameters>]
Get-VMComPort
[-VMSnapshot] <VMSnapshot>
[[-Number] <Int32>]
[<CommonParameters>]
Get-VMComPort
[[-Number] <Int32>]
[-VM] <VirtualMachine[]>
[<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
-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: | . |
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 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Outputs
Microsoft.HyperV.PowerShell.ComPort
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for