5.4.7 仮想サーバの削除
機能
この部品は，Hyper-V環境において，仮想サーバを削除します。
Hyper-Vサーバから仮想サーバを削除するとき，スナップショットも併せて削除します。
hyperv.vHardDiskDeletePermanentlyプロパティに，"yes"を指定した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。
hyperv.vhdListOutputFileNameプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)
仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。
Found：ファイルの存在を確認
NotFound：ファイルが設定されているが，存在を確認できない
(b) ファイルの削除結果 (ヘッダー名：DeleteResult)
hyperv.vHardDiskDeletePermanentlyプロパティに"yes"を指定した場合，仮想ディスクファイルの削除の実行結果を出力します。"no"を指定した場合でも"Skipped"を出力します。項目の値を次に示します。
Completed：ファイルの削除が成功
Failed：ファイルの削除が失敗
Skipped：ファイルの削除が未実施
(c) ファイルのパス (ヘッダー名：FilePath)
(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
利用場面
この部品は，仮想サーバの滅却などのタイミングで，仮想サーバを削除する際に利用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2008 R2 Hyper-V
(2)仮想サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
ただし，Server Coreインストール環境は除く。
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
ただし，Server Coreインストール環境は除く。
【実行対象サーバ内前提製品の使用条件】
(1)仮想サーバ名はHyper-Vサーバ内で一意であること。
(2)仮想サーバが停止完了の状態であること。
注意事項
(1)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。
(2)hyperv.vhdListOutputFileNameプロパティに指定したファイル名がすでに存在する場合，既存のファイルを上書きします。
(3)hyperv.vhdListOutputFileNameプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。
(4)hyperv.vhdListOutputFileNameプロパティを指定した場合，仮想サーバ，または仮想ディスクファイルの削除時にエラーが発生した場合でも，仮想ディスクファイル一覧を出力します。
(5)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。
バージョン
02.00.00
部品のタグ
Delete VM,Hyper-V 2008
タスクログに表示される部品の名称
hypervDeleteVM
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
hyperv.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
|
hyperv.vHardDiskDeletePermanently |
仮想ディスクファイルの削除の要否 |
仮想サーバで使用している仮想ディスクファイルを削除するかどうか指定します。 |
no |
入力 |
○ |
|
hyperv.vhdListOutputFileName |
仮想ディスクファイル一覧出力ファイル名 |
仮想ディスクファイル一覧を出力するファイル名をフルパスで指定します。 |
− |
入力 |
△ |
|
hyperv.checkJobDelVMCount |
ジョブ監視回数(DestroyVirtualSystemメソッド) |
Hyper-Vに要求した処理を監視する，ジョブ監視回数(DestroyVirtualSystemメソッド)調整用のプロパティです。変更の必要はありません。 |
28800 |
入力 |
○ |
|
hyperv.checkJobDelVMInterval |
ジョブ監視間隔(DestroyVirtualSystemメソッド) |
Hyper-Vに要求した処理を監視する，ジョブ監視間隔(DestroyVirtualSystemメソッド)調整用のプロパティです。変更の必要はありません。 |
3 |
入力 |
○ |
|
hyperv.checkJobDelSnapshotCount |
ジョブ監視回数(RemoveVirtualSystemSnapshotTreeメソッド) |
Hyper-Vに要求した処理を監視する，ジョブ監視回数(RemoveVirtualSystemSnapshotTreeメソッド)調整用のプロパティです。変更の必要はありません。 |
28800 |
入力 |
○ |
|
hyperv.checkJobDelSnapshotInterval |
ジョブ監視間隔(RemoveVirtualSystemSnapshotTreeメソッド) |
Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RemoveVirtualSystemSnapshotTreeメソッド)調整用のプロパティです。変更の必要はありません。 |
3 |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |