SCVMM 2016 UR5 で利用可能なコマンドレット (Get-SCVirtualNetworkAdapter) について

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Get-SCVirtualNetworkAdapter コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCVirtualNetworkAdapter」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Get-SCVirtualNetworkAdapter コマンドレット

名前

Get-SCVirtualNetworkAdapter

概要

仮想マシン、仮想マシン テンプレート、もしくはハードウェア プロファイルから VMM 仮想ネットワーク アダプター オブジェクトを取得します。

構文

Get-SCVirtualNetworkAdapter  -All  [-OnBehalfOfUser <String>]  [-OnBehalfOfUserRole <UserRole>]  [-ParentTypeVMOrHost]  [-VMMServer <ServerConnection>]  [<CommonParameters>] Get-SCVirtualNetworkAdapter  -HardwareProfile <HardwareProfile>  [-OnBehalfOfUser <String>]  [-OnBehalfOfUserRole <UserRole>]  [-VMMServer <ServerConnection>]  [<CommonParameters>] Get-SCVirtualNetworkAdapter  [-ID] <Guid>  [[-Name] <String>]  [-OnBehalfOfUser <String>]  [-OnBehalfOfUserRole <UserRole>]  [-VMMServer <ServerConnection>]  [<CommonParameters>] Get-SCVirtualNetworkAdapter  [-OnBehalfOfUser <String>]  [-OnBehalfOfUserRole <UserRole>]  -VM <VM>  [-VMMServer <ServerConnection>]  [<CommonParameters>] Get-SCVirtualNetworkAdapter  [-OnBehalfOfUser <String>]  [-OnBehalfOfUserRole <UserRole>]  -VMHost <Host>  [-VMMServer <ServerConnection>]  [<CommonParameters>] Get-SCVirtualNetworkAdapter  [-OnBehalfOfUser <String>]  [-OnBehalfOfUserRole <UserRole>]  [-VMMServer <ServerConnection>]  -VMTemplate <Template>  [<CommonParameters>]

説明

Get-SCVirtualNetworkAdapter コマンドレットは、Virtual Machine Manager (VMM) 環境内の仮想マシン、仮想マシン テンプレート、もしくはハードウェア プロファイルから複数の仮想ネットワーク アダプター オブジェクトを取得します。

パラメーター

-All [<SwitchParameter>]

このコマンドレットは、親オブジェクトから独立したすべての従属オブジェクトを取得する場合に指定します。

たとえば、Get-SCVirtualDiskDrive -All コマンドは、各仮想ディスク ドライブ オブジェクトが関連付けられている仮想マシン オブジェクト、もしくはテンプレート オブジェクトに関係なく、すべての仮想ディスク ドライブ オブジェクトを取得します。

必須	true
位置	named
既定値	False
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-HardwareProfile <HardwareProfile>

ハードウェア プロファイル オブジェクトを指定します。

必須	true
位置	named
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-ID <Guid>

特定のオブジェクトに対するグローバル一意識別子、もしくは GUID として数値 ID を指定します。

必須	true
位置	0
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Name <String>

ネットワーク オブジェクト名を指定します。

必須	false
位置	1
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-OnBehalfOfUser <String>

ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。

必須	false
位置	named
既定値	None
パイプライン入力を許可する	False
ワイルドカード文字を許可する	false

-OnBehalfOfUserRole <UserRole>

ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。

必須	false
位置	named
既定値	None
パイプライン入力を許可する	False
ワイルドカード文字を許可する	false

-ParentTypeVMOrHost [<SwitchParameter>]

親の種類が仮想マシン、もしくはホストである場合に指定します。

必須	false
位置	named
既定値	False
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-VM <VM>

仮想マシン オブジェクトを指定します。

必須	true
位置	named
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-VMHost <Host>

仮想マシン ホスト オブジェクトを指定します。VMM は、Hyper-V ホスト、VMware ESX ホスト、および Citrix XenServer ホストをサポートします。

各ホストの種類に関する情報について、Add-SCVMHost コマンドレットを参照してください。

必須	true
位置	named
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-VMMServer <ServerConnection>

VMM サーバー オブジェクトを取得します。

必須	false
位置	named
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-VMTemplate <Template>

仮想マシンを作成するために使用される VMM テンプレート オブジェクトを指定します。

必須	true
位置	named
既定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

出力

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

メモ

Get-SCVirtualMachine、Get-SCVMTemplate、もしくは Get-SCHardwareProfile コマンドレットをそれぞれ用いて取得可能な VMM 仮想マシン オブジェクト、仮想マシン テンプレート オブジェクト、もしくはハードウェア プロファイル オブジェクトが必要となります。

例

例 1 : 仮想マシンから仮想ネットワーク アダプター情報を取得する

コマンド

$VM = Get-SCVirtualMachine -Name "VM01"
Get-SCVirtualNetworkAdapter -VM $VM

コマンドの説明

最初のコマンドは、仮想マシン オブジェクト “VM01” を取得、そのオブジェクトを $VM 変数を格納します。

2 番目のコマンドは、VM01 上のすべての仮想ネットワーク アダプター オブジェクトを取得し、そのアダプターに関する情報を表示します。

例 2 : 仮想マシン テンプレートから仮想ネットワーク アダプター情報を取得する

コマンド

$VMTemplate = Get-SCVMTemplate | where { $_.Name -eq "VMTemplate01" }
Get-SCVirtualNetworkAdapter -Template $VMTemplate

コマンドの説明

最初のコマンドは、VMM ライブラリからすべての仮想マシン テンプレート オブジェクトを取得し、テンプレート オブジェクト “VMTemplate01” を選択、そのオブジェクトを $VMTemplate 変数に格納します。

2 番目のコマンドは、すべての仮想ネットワーク アダプター オブジェクト VMTemplate01 を取得し、それらのアダプターに関する情報を表示します。

例 3 : ハードウェア プロファイルから仮想ネットワーク アダプター情報を取得する

コマンド

$HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01" }
Get-SCVirtualNetworkAdapter -HardwareProfile $HWProfile

コマンドの説明

最初のコマンドは、VMM ライブラリ内のすべてのハードウェア プロファイルを取得し、プロファイル オブジェクト “NewHWProfile01” を選択、そのオブジェクトを $HWProfile 変数に格納します。

2 番目のコマンドは、NewHWProfile01 からすべての仮想ネットワーク アダプター オブジェクトを取得し、それらのアダプターに関する情報を表示します。

関連するリンク

• Get-SCHardwareProfile
• Get-SCVMTemplate
• Get-SCVirtualMachine
• New-SCVirtualNetworkAdapter
• Remove-SCVirtualNetworkAdapter
• Repair-SCVirtualNetworkAdapter
• Set-SCVirtualNetworkAdapter

参考

• 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-SCVirtualNetworkAdapter (VirtualMachineManager) | Microsoft Docs
  https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/get-scvirtualnetworkadapter?view=systemcenter-ps-2016