System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Get-SCVirtualCOMPort コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCVirtualCOMPort」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Get-SCVirtualCOMPort コマンドレット
名前
Get-SCVirtualCOMPort
概要
仮想マシン、仮想マシン テンプレート、もしくはハードウェア プロファイルから仮想 COM ポートを取得します。
構文
| Get-SCVirtualCOMPort -All [-VMMServer <ServerConnection>] [<CommonParameters>] Get-SCVirtualCOMPort Get-SCVirtualCOMPort Get-SCVirtualCOMPort |
説明
Get-SCVirtualCOMPort コマンドレットは、仮想通信 (COM) ポート オブジェクト情報を取得します。このコマンドレットは、Virtual Machine Manager (VMM) が管理する仮想マシン オブジェクト、仮想マシン テンプレート オブジェクト、もしくはハードウェア プロファイル オブジェクトから 1 つ、もしくは両方の COM ポート情報を取得します。
仮想 COM ポートは、仮想マシン ホスト サーバーの物理ポート、テキストファイル、もしくは名前付きパイプに接続可能です。各仮想マシン、仮想マシン テンプレート、および ハードウェア プロファイルには、正確に 2 つの COM ポートが含まれています。
パラメーター
-All [<SwitchParameter>]
このコマンドレットが親オブジェクトとは独立した従属 COM ポートの完全なリストを取得する場合に指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-HardwareProfile <HardwareProfile>
ハードウェア プロファイル オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VM <VM>
このコマンドれとが取得する仮想 COM ポートの仮想マシンを指定します。仮想マシン オブジェクトを取得するには、Get-SCVirtualMachine コマンドレットを用います。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VMTemplate <Template>
このコマンドレットが取得する仮想 COM ポートの仮想マシンを作成するために使用される VMM テンプレートを指定します。VMM テンプレート オブジェクトを取得するには、Get-SCVMTemplate コマンドレットを用います。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- VirtualCOMPort
- このコマンドレットは、VirtualCOMPort オブジェクトを返します。
メモ
例
例 1 : 仮想マシンに対する COM ポート情報を取得する
コマンド
$VM = Get-SCVirtualMachine -Name "VM01" Get-SCVirtualCOMPort -VM $VM
コマンドの説明
最初のコマンドは、仮想マシン “VM01” を取得し、そのオブジェクトを $VM 変数に格納します。
2 番目のコマンドは、VM01 の仮想 com ポート オブジェクトを取得し、それらのポートに関する情報を表示ます。
例 2 : テンプレートに対する COM ポート情報を取得する
コマンド
$VMTemplate = Get-SCVMTemplate | where { $_.Name -eq "VMTemplate01" }
Get-SCVirtualCOMPort -VMTemplate $VMTemplate
コマンドの説明
最初のコマンドは、仮想マシン テンプレート “VMTemplate01” を取得し、そのオブジェクトを $VMTemplate 変数に格納します。
2 番目のコマンドは、VMTemplate01 に対する仮想 COM ポート オブジェクトを取得し、それらのポートに関する情報を表示します。
例 3 : ハードウェア プロファイルに対する COM ポート情報を取得する
コマンド
$HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01" }
Get-SCVirtualCOMPort -HardwareProfile $HWProfile
コマンドの説明
最初のコマンドは、”NewHWProfile01″ というハードウェア プロファイルを取得し、そのオブジェクトを $HWProfile 変数に格納します。
2 番目のコマンドは、NewHWProfile01 の仮想 COM ポート オブジェクトを取得し、それらのポートに関する情報を表示します。
関連するリンク
- Get-SCHardwareProfile
- Get-SCVirtualMachine
- Get-SCVMTemplate
- Set-SCVirtualCOMPort
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Get-SCVirtualCOMPort (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/get-scvirtualcomport?view=systemcenter-ps-2016