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

スポンサーリンク

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

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

Remove-SCVirtualNetworkAdapter コマンドレット

名前

Remove-SCVirtualNetworkAdapter

概要

VMM から仮想ネットワーク アダプター オブジェクトを削除します。

構文

Remove-SCVirtualNetworkAdapter
 [-VirtualNetworkAdapter] <VirtualNetworkAdapter>
 [-Confirm]
 [-JobGroup <Guid>]
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-WhatIf]
 [<CommonParameters>]

Remove-SCVirtualNetworkAdapter
 [-Confirm]
 -JobGroup <Guid>
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 -SlotID <Int32>
 [-WhatIf]
 [<CommonParameters>]

説明

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

このコマンドレットは、成功すると (MarkedForDeletion を $True に設定して) オブジェクトを返します。失敗するとエラー メッセージを返します。

パラメーター

-Confirm [<SwitchParameter>]

コマンドレットの実行前に確認のプロンプトを表示します。

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

-JobGroup <Guid>

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

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

-JobVariable <String>

ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。

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

-OnBehalfOfUser <String>

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

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

-OnBehalfOfUserRole <UserRole>

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

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

-PROTipID <Guid>

このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。

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

-RunAsynchronously [<SwitchParameter>]

ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。

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

-SlotID <Int32>

デバイスを識別するための数値 ID を指定します。

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

-VirtualNetworkAdapter <VirtualNetworkAdapter>

仮想マシンに対する仮想ネットワーク アダプターを指定します。

ホストの種類は、次の仮想ネットワーク アダプターをサポートします :

  • Hyper-V : 仮想マシンごとに最大 4 つのエミュレートされたアダプター。Windows Server 2003 x64 ゲスト OS では、エミュレートされたネットワーク アダプター用のドライバーはありません。
  • Hyper-V : 仮想マシンあたり最大 8 つの統合アダプター
  • VMware ESX : 仮想マシンごとに最大 4 つのエミュレートされたアダプター
  • Citrix XenServer : 仮想マシンごとに最大 7 つのエミュレートされたアダプター
必須 true
位置 0
既定値 None
パイプライン入力を許可する True (ByValue)
ワイルドカード文字を許可する false

-WhatIf [<SwitchParameter>]

コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。

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

<CommonParameters>

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

入力

出力

メモ

Get-SCVirtualNetworkAdapter コマンドレットを用いて取得可能な VMM 仮想ネットワーク アダプター オブジェクトが必要となります。

例 1 : 仮想マシンから指定された MAC アドレスを持つ仮想ネットワーク アダプターを削除する

コマンド
$VM = Get-SCVirtualMachine -Name "VM01"
$Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.PhysicalAddress -eq "00:16:D3:CC:00:1B" }
Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter
コマンドの説明

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

2 番目のコマンドは、指定された MAC アドレス “00:16:D3:CC:00:1B” を持つ VM01 上の仮想ネットワーク アダプター オブジェクトを取得し、そのオブジェクトを $Adapter 変数に格納します。

最後のコマンドは、$Adapter に格納されている仮想ネットワーク アダプターを VM01 から削除します。

例 2 : 仮想マシンから特定の仮想ネットワークに接続されている仮想ネットワーク アダプターを削除する

コマンド
$VM = Get-SCVirtualMachine -Name "VM02"
$Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.VirtualNetwork -eq "ExternalVirtualNetwork01" }
Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter
コマンドの説明

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

2 番目のコマンドは、指定された仮想ネットワークに接続されている VM02 上の仮想ネットワーク アダプター オブジェクトを取得し、そのオブジェクトを $Adapter 変数に格納します。

最後のコマンドは、$Adapter に格納されている仮想ネットワーク アダプター オブジェクトを VM02 から削除します。

例 3 : 仮想マシンから唯一の仮想ネットワーク アダプターを削除する

コマンド
$VM = Get-SCVirtualMachine -Name "VM03"
$Adapter = Get-SCVirtualNetworkAdapter -VM $VM
Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter
コマンドの説明

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

2 番目のコマンドは、VM03 上の仮想ネットワーク アダプター オブジェクトを取得し、そのオブジェクトを $Adapter 変数に格納します。

この例では、VM03 に仮想ネットワーク アダプターが 1 つしかないと想定しています。

最後のコマンドは、$Adapter に格納されている仮想ネットワーク アダプター オブジェクトを VM03 から削除します。

例 4 : 仮想マシンからすべてのネットワーク アダプターを削除する

コマンド
$VM = Get-SCVirtualMachine -Name "VM04"
$Adapters = Get-SCVirtualNetworkAdapter -VM $VM
$Adapters | Remove-SCVirtualNetworkAdapter
コマンドの説明

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

2 番目のコマンドは、VM04 上のすべての仮想ネットワーク アダプター オブジェクトを取得し、そのオブジェクトを $Adapters オブジェクト配列に格納します。

最後のコマンドは、$Adapters に格納されている各オブジェクトを Remove-SCVirtualNetworkAdapter に渡します。Remove-SCVirtualNetworkAdapter は、各仮想ネットワーク アダプター オブジェクトを VM04 から削除します。

例 5 : 3 つの仮想ネットワーク アダプターを持つ仮想マシンから 2 番目の仮想ネットワーク アダプターを削除する

コマンド
$VM = Get-SCVirtualMachine -Name "VM05"
$Adapters = Get-SCVirtualNetworkAdapter -VM $VM
$Adapters[1] | Remove-SCVirtualNetworkAdapter
コマンドの説明

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

2 番目のコマンドは、VM05 上のすべての仮想ネットワーク アダプター オブジェクトを取得し、そのオブジェクトを $Adapters オブジェクト配列に格納します。この例では、VM05 に 3 つの仮想ネットワーク アダプターがあることを前提としています。

最後のコマンドは、2 番目の仮想ネットワーク アダプター オブジェクト ($Adapters [1]) を Remove-SCVirtualNetworkAdapter コマンドレットに渡します。このコマンドレットは VM05 からこの仮想ネットワーク アダプター オブジェクトを削除します。

関連するリンク

  • Get-SCVirtualMachine
  • Get-SCVirtualNetworkAdapter
  • New-SCVirtualNetworkAdapter
  • Repair-SCVirtualNetworkAdapter
  • Set-SCVirtualNetworkAdapter

参考