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

スポンサーリンク

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

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

Remove-SCVirtualNetwork コマンドレット

名前

Remove-SCVirtualNetwork

概要

VMM によって管理されているホストから仮想ネットワークを削除します。

構文

Remove-SCVirtualNetwork
 [-ClusterVirtualNetwork] <ClusterVirtualNetwork>
 [-Confirm]
 [-JobGroup <Guid>]
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-WhatIf]
 [<CommonParameters>]

Remove-SCVirtualNetwork
 [-VirtualNetwork] <VirtualNetwork>
 [-Confirm]
 [-JobGroup <Guid>]
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-WhatIf]
 [<CommonParameters>]

説明

Remove-SCVirtualNetwork コマンドレットは、Virtual Machine Manager (VMM) から複数の仮想ネットワーク オブジェクトを削除します。

このコマンドレットは、成功すると (MarkedForDeletion プロパティが True に設定された) オブジェクトを返します。失敗するとエラー メッセージを返します。

パラメーター

-ClusterVirtualNetwork <ClusterVirtualNetwork>

クラスター 仮想ネットワーク オブジェクトを指定します。

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

-Confirm [<SwitchParameter>]

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

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

-JobGroup <Guid>

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

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

-JobVariable <String>

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

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

-PROTipID <Guid>

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

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

-RunAsynchronously [<SwitchParameter>]

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

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

-VirtualNetwork <VirtualNetwork>

仮想ネットワーク オブジェクトを返します。

必須 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 を参照してください。

入力

出力

メモ

例 1 : ホストから特定の仮想ネットワークを削除する

コマンド
$VMHost = Get-SCVMHost -ComputerName "VMHost01.Contoso.com" 
$Network = Get-SCVirtualNetwork -VMHost $VMHost -Name "InternalVNet01"
Remove-SCVirtualNetwork -VirtualNetwork $Network -Confirm
コマンドの説明

最初のコマンドは、ホスト オブジェクト “VMHost01.Contoso.com” を取得し、そのオブジェクトを $VMHost 変数に格納します。

2 番目のコマンドは、VMHost01で設定された仮想ネットワーク オブジェクト “InternalVNet01” を取得し、そのオブジェクトを $Network 変数に格納します。

最後のコマンドは、VMHost01 から InternalVNet01 を削除し、アクションを続行する前に確認のプロンプトを表示します。

関連するリンク

  • Get-SCVirtualNetwork
  • Get-SCVMHost
  • New-SCVirtualNetwork
  • Repair-SCVirtualNetwork
  • Set-SCVirtualNetwork

参考