Set-VMComPort

Set-VMComPort

Configures the COM port of a virtual machine.

構文

Parameter Set: VMComPort
Set-VMComPort [-VMComPort] <VMComPort[]> [[-Path] <String> ] [-DebuggerMode <Microsoft.HyperV.PowerShell.OnOffState> {On | Off} ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMName
Set-VMComPort [-VMName] <String[]> [-Number] <Int32> [[-Path] <String> ] [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-DebuggerMode <Microsoft.HyperV.PowerShell.OnOffState> {On | Off} ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Set-VMComPort [-VM] <VirtualMachine[]> [[-Path] <String> ] -Number <Int32> [-DebuggerMode <Microsoft.HyperV.PowerShell.OnOffState> {On | Off} ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-VMComPort cmdlet configures the COM port of a virtual machine.

パラメーター

-CimSession<Microsoft.Management.Infrastructure.CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。コンピューター名またはセッション オブジェクト (New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など) を入力します。既定値は、ローカル コンピューター上の現在のセッションです。

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the COM port of a virtual machine is to be configured. 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.

-Credential<System.Management.Automation.PSCredential[]>

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

-DebuggerMode<Microsoft.HyperV.PowerShell.OnOffState>

Specifies the state of the COM port for use by debuggers. このパラメーターに指定できる値は、次のとおりです。 On and Off.

-Number<Int32>

Specifies the Id (1 or 2) of the COM port to be configured.

-Passthru

Specifies that a Microsoft.HyperV.PowerShell.ComPort object is to be passed through to the pipeline representing the COM port to be configured.

-Path<String>

Specifies a named pipe path for the COM port to be configured. Specify local pipes as “\\.\pipe\PipeName” and remote pipes as "\\RemoteServer\pipe\PipeName".

-VM<VirtualMachine[]>

Specifies the virtual machine for which the COM port is to be configured.

-VMComPort<VMComPort[]>

Specifies the COM port to be configured.

-VMName<String[]>

Specifies the name of the virtual machine for which the COM port is to be configured.

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

<CommonParameters>

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

入力

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

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

• None by default; Microsoft.HyperV.PowerShell.ComPort if –PassThru is specified.

使用例

Example 1

Configure the second COM port on virtual machine TestVM to connect to named pipe TestPipe on the local computer.

PS C:\> Set-VMComPort TestVM 2 \\.\pipe\TestPipe