Set-SCVirtualCOMPort

  • リファレンス
モジュール:
VirtualMachineManager

仮想マシン、仮想マシン テンプレート、またはハードウェア プロファイルの仮想 COM ポートのプロパティを変更します。

構文

Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   -VMHostCOMPort <Byte>
   [-WaitForModem <Boolean>]
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   -TextFile <String>
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   [-NoAttach]
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VMMServer <ServerConnection>]
   -GuestPort <Byte>
   -NamedPipe <String>
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   -TextFile <String>
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   [-NoAttach]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   -VMHostCOMPort <Byte>
   [-WaitForModem <Boolean>]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCVirtualCOMPort
   [-VirtualCOMPort] <VirtualCOMPort>
   -NamedPipe <String>
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

説明

Set-SCVirtualCOMPort コマンドレットは、仮想通信 (COM) ポートの 1 つ以上のプロパティを変更します。 仮想 COM ポートは、仮想マシン、仮想マシン テンプレート、または仮想マシン マネージャー (VMM) 環境で使用されるハードウェア プロファイルの一部です。 VirtualCOMPort パラメーターを使用して COM ポートを指定するか、GuestPort パラメーターの仮想 COM ポート ID を指定します。 GuestPort の有効な値は、0 と 1 です。

このコマンドレットは、仮想 COM ポートを物理 COM ポート、テキスト ファイル、または名前付きパイプに接続できます。 このコマンドレットは、仮想 COM ポートを切断できます。 仮想マシン上の仮想 COM ポートをホスト上の物理 COM ポートに接続すると、仮想マシンは入力と出力に物理 COM ポートを使用できます。 ホストの種類では、次の仮想 COM ポート接続の種類がサポートされています。

  • Hyper-V。 名前付きパイプにのみ接続します。
  • VMware ESX。 物理 COM ポート、テキスト ファイル、または名前付きパイプに接続します。
  • Citrix XenServer。 サポートされていません。

WaitForModem パラメーターは、仮想マシンの起動時に、仮想マシン上の仮想 COM ポートがホスト上の物理 COM ポートにすぐに接続するかどうかを指定します。

WaitForModem に $True の値を指定した場合、仮想マシンで実行されているプログラムが物理 COM ポートにモデム コマンドを送信した場合にのみ、仮想マシンはホスト上の物理 COM ポートへの接続を試みます。 ホストの COM ポートが既に接続されている場合、仮想マシンはそのポートに接続できません。 仮想マシンが物理 COM ポートに正常に接続された場合、COM ポートを使用する仮想マシン上のプログラムが COM ポートの使用を停止した場合、仮想マシンは後で物理 COM ポートをホスト オペレーティング システムに解放します。

WaitForModem に $False の値を指定した場合、仮想マシンは、仮想マシンが起動するとすぐに、ホスト上の物理 COM ポートへの接続を試みます。 ホスト上の COM ポートが既にキャプチャされている場合、仮想マシンはそれに接続できません。 これは、$Trueの値の場合と同じ動作です。 仮想マシンが物理 COM ポートに正常に接続された場合、仮想マシンがシャットダウンされるまで、仮想マシンは物理 COM ポートをホスト オペレーティング システムに解放しません。

例

例 1: 仮想 COM ポートを名前付きパイプに接続する

PS C:\> $VM = Get-SCVirtualMachine -Name "VM02"
PS C:\> $COM1 = Get-SCVirtualCOMPort -VM $VM | where {$_.Name -eq "COM1"}
PS C:\> Set-SCVirtualCOMPort -VirtualCOMPort $COM1 -NamedPipe "\\Contoso\Pipe\PipeName"

最初のコマンドは、VM02 という名前の仮想マシンを取得し、そのオブジェクトを $VM 変数に格納します。

2 番目のコマンドは、VM02 から COM1 という名前の仮想 COM ポートを取得し、そのオブジェクトを $COM 1 変数に格納します。

最後のコマンドは、$COM 1 の仮想 COM ポートを名前付きパイプ \Contoso\Pipe\PipeName に接続します。

例 2: 仮想 COM ポートを切断する

PS C:\> $VM = Get-SCVirtualMachine -Name "VM04"
PS C:\> $COM1 = Get-SCVirtualCOMPort -VM $VM | where {$_.Name -eq "COM1"}
PS C:\> Set-SCVirtualCOMPort -VirtualCOMPort $COM1 -NoAttach

最初のコマンドは、VM04 という名前の仮想マシンを取得し、そのオブジェクトを $VM 変数に格納します。

2 番目のコマンドは、COM1 という名前の VM04 上の仮想 COM ポートを取得し、そのオブジェクトを $COM 1 変数に格納します。

最後のコマンドは NoAttach パラメーターを指定します。 これにより、コマンドは $COM 1 の仮想 COM ポートを切断します。 このコマンドを使用すると、ホスト上の物理 COM ポート、名前付きパイプ、またはテキスト ファイルに現在接続されている仮想 COM ポートの接続を解除できます。

パラメーター

-GuestPort

仮想マシン上の仮想 COM ポートの ID を指定します。 有効な値は 0 と 1 です。

Type:Byte
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JobGroup

同じジョブ グループ識別子を含む最後のコマンドが実行される直前に、セットとして実行される一連のコマンドの識別子を指定します。

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

ジョブの進行状況を追跡して格納する変数を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NamedPipe

仮想 COM ポートが接続する名前付きパイプを指定します。 一般的な用途には、ホスト上のデバッグ プログラムへの仮想マシンの接続が含まれます。 2 つの仮想マシン間に仮想 null モデム ケーブルを作成することもできます。 次の形式でパイプを指定します: \.\ComputerName\Pipe\PipeName

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoAttach

このコマンドレットは、ホスト、名前付きパイプ、またはファイル上の物理 COM ポートが仮想 COM ポートに接続されていないことを示します。 このパラメーターを指定すると、物理 COM ポート、名前付きパイプ、またはテキスト ファイルに既に接続されている仮想 COM ポートが切断されます。

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

この操作をトリガーしたパフォーマンスとリソースの最適化 (PRO) ヒントの ID を指定します。 これにより、PRO ヒントの監査が可能になります。

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TextFile

仮想 COM ポートの接続先となるホスト上のテキスト ファイルを指定します。 仮想マシンは、このパラメーターで指定されたテキスト ファイルを仮想 COM ポートから出力します。 ホスト上の有効なディスク ドライブ上にあるテキスト ファイルを指定できます。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VirtualCOMPort

このコマンドレットが変更する仮想 COM ポート オブジェクトを指定します。 VMM では、仮想マシン、テンプレート、またはハードウェア プロファイル上に 2 つの COM ポートを構成できます。

Type:VirtualCOMPort
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMHostCOMPort

仮想マシンが仮想 COM ポートを接続できるホスト サーバー上の物理 COM ポート オブジェクトを指定します。

Type:Byte
Aliases:HostPort
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

VMM サーバーを指定します。

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WaitForModem

仮想マシンの仮想 COM ポートが、仮想マシンの起動時にホスト上の物理 COM ポートにすぐに接続されるかどうかを示します。

$Trueの値を指定した場合、仮想 COM ポートはホスト上の物理 COM ポートへの接続を待機します。 $Falseの値を指定すると、仮想マシンが起動するとすぐに、仮想 COM ポートはホスト上の物理 COM ポートにすぐに接続されます。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

出力

VirtualCOMPort

このコマンドレットは 、VirtualCOMPort オブジェクトを返します。

メモ

  • VMM 仮想 COM ポート オブジェクトが必要です。 このオブジェクトは、 Get-SCVirtualCOMPort コマンドレットを使用して取得できます。