Get-SCVirtualCOMPort

Get-SCVirtualCOMPort

Gets a VMM virtual COM port object.

構文

Parameter Set: All
Get-SCVirtualCOMPort -All [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: HardwareProfile
Get-SCVirtualCOMPort -HardwareProfile <HardwareProfile> [ <CommonParameters>]

Parameter Set: Template
Get-SCVirtualCOMPort -VMTemplate <Template> [ <CommonParameters>]

Parameter Set: VM
Get-SCVirtualCOMPort -VM <VM> [ <CommonParameters>]

詳細説明

The Get-SCVirtualCOMPort cmdlet gets one or both Virtual Machine Manager (VMM) virtual communication (COM) port objects from a virtual machine object, a virtual machine template object, or a hardware profile object.

A virtual COM port can connect to a physical port on a virtual machine host server, to a text file, or to a named pipe. Each virtual machine, virtual machine template, and hardware profile contains exactly two COM ports.

パラメーター

-All

Indicates that this cmdlet retrieves a full list of all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

エイリアス

none

必須?

true

位置は?

named

既定値

none

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-HardwareProfile<HardwareProfile>

Specifies a hardware profile object.

エイリアス

none

必須?

true

位置は?

named

既定値

none

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-VM<VM>

Specifies a virtual machine object.

エイリアス

none

必須?

true

位置は?

named

既定値

none

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

エイリアス

none

必須?

false

位置は?

named

既定値

none

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-VMTemplate<Template>

Specifies a VMM template object used to create virtual machines.

エイリアス

Template

必須?

true

位置は?

named

既定値

none

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • VirtualCOMPort

  • Requires a VMM virtual machine object, virtual machine template object, or hardware profile object. You can retrieve these objects by using the Get-SCVirtualMachine, Get-SCVMTemplate, and Get-SCHardwareProfile cmdlets, respectively.

Example 1: Get COM ports from a virtual machine

The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.

The second command retrieves the virtual COM port objects on VM01 and displays information about these ports.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> Get-SCVirtualCOMPort -VM $VM

Example Example 2: Get COM ports from a template.

The first command gets the virtual machine template object VMTemplate01, and then stores the object in the $VMTemplate variable.

The second command gets the virtual COM port objects VMTemplate01 and displays information about these ports.

PS C:\> $VMTemplate = Get-SCVMTemplate | where { $_.Name -eq "VMTemplate01" }
PS C:\> Get-SCVirtualCOMPort -VMTemplate $VMTemplate

Example Example 3: Get COM ports from a hardware profile.

The first command gets the hardware profile object named NewHWProfile01, and then stores the object in the $HWProfile variable.

The second command gets the virtual COM port objects NewHWProfile01 and displays information about these ports.

PS C:\> $HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01" }
PS C:\> Get-SCVirtualCOMPort -HardwareProfile $HWProfile

関連トピック

Get-SCHardwareProfile

Get-SCVirtualDiskDrive

Get-SCVirtualMachine

Get-SCVMTemplate

Set-SCVirtualCOMPort