Msvm_VirtualSystemManagementService クラスの DestroySystem メソッド
以前に定義した仮想マシンをホスト システムの管理スコープから削除します。 関連付けられているリソース定義も削除されます。 このメソッドを呼び出す前に、仮想マシンの電源がオフになっているか保存されている必要があります。
構文
uint32 DestroySystem(
[in] CIM_ComputerSystem REF AffectedSystem,
[out] CIM_ConcreteJob REF Job
);
パラメーター
-
AffectedSystem [in]
-
種類: CIM_ComputerSystem
破棄される仮想マシン インスタンスを表す CIM_ComputerSystem のインスタンスへの参照。
-
ジョブ [out]
-
種類: CIM_ConcreteJob
操作が非同期に実行された場合、このメソッドは 4096 を返し、このパラメーターには CIM_ConcreteJob から派生したオブジェクトへの参照が含 まれます。
戻り値
型: uint32
このメソッドを同期的に実行すると、成功した場合は 0 が返されます。 このメソッドを非同期に実行すると、4096 が返され、 Job 出力パラメーターを使用して非同期操作の進行状況を追跡できます。 その他の戻り値はエラーを示します。
-
エラーなしで完了 (0)
-
サポートされていません (1)
-
失敗 ( 2)
-
タイムアウト (3)
-
無効なパラメーター (4)
-
無効な状態 (5)
-
DMTF 予約済み (..)
-
チェックされたメソッド パラメーター - ジョブの開始 (4096)
-
メソッド予約済み (4097..32767)
-
ベンダー固有 (32768..65535)
注釈
UAC フィルター処理によって 、Msvm_VirtualSystemManagementService クラスへのアクセスが制限される場合があります。 詳細については、「 ユーザー アカウント制御と WMI」を参照してください。
例
次の C# サンプルでは、 DestroySystem メソッドを使用して、計画された仮想マシンを削除します。 このコードは、 Hyper-V 計画仮想マシンのサンプルから取得します。 参照されるユーティリティについては、「 仮想化サンプルの一般的なユーティリティ (V2)」を参照してください。
重要
正しく機能するには、次のコードを仮想マシン ホスト サーバーで実行し、管理者特権で実行する必要があります。
/// <summary>
/// Finds the first Planned VM matching pvmName and removes it.
/// </summary>
/// <param name="pvmName">The name of the PVM to be removed.</param>
internal static void
RemovePvm(
string pvmName
)
{
ManagementScope scope = new ManagementScope(@"root\virtualization\v2");
using (ManagementObject pvm = WmiUtilities.GetPlannedVirtualMachine(pvmName, scope))
using (ManagementObject managementService = WmiUtilities.GetVirtualMachineManagementService(scope))
using (ManagementBaseObject inParams =
managementService.GetMethodParameters("DestroySystem"))
{
inParams["AffectedSystem"] = pvm.Path;
Console.WriteLine("Removing Planned Virtual Machine \"{0}\" ({1})...",
pvm["ElementName"], pvm["Name"]);
using (ManagementBaseObject outParams =
managementService.InvokeMethod("DestroySystem", inParams, null))
{
WmiUtilities.ValidateOutput(outParams, scope);
}
}
}
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント |
Windows 8 [デスクトップ アプリのみ] |
サポートされている最小のサーバー |
Windows Server 2012 [デスクトップ アプリのみ] |
名前空間 |
Root\Virtualization\V2 |
MOF |
|
[DLL] |
|