3.8.2 仮想サーバの削除
機能
このサービステンプレートは,Hyper-V環境の仮想サーバを削除します。
このサービステンプレートが前提とするサーバを次に示します。
・Hyper-Vサーバ
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
処理の概要を次に示します。
(1) 仮想サーバの状態を取得します。
(2) 仮想サーバが停止していることを確認します。
仮想サーバが停止している場合は処理を継続しますが,それ以外の場合は,ユーザー応答待ち部品を実行して,シャットダウンするか・しないかを確認します。
ユーザー応答待ちのGUIで"Shutdown"を選択した場合は,起動している仮想サーバをシャットダウンします。起動以外の仮想サーバに対して"Shutdown"を選択した場合は,仮想サーバには操作を行わずにタスクが異常終了します。
"Cancel"を選択するか,応答待ちがタイムアウトになった場合は,仮想サーバには操作を行わずにタスクが異常終了します。
(3) 仮想サーバを削除します。
Hyper-Vサーバから仮想サーバを削除します。このとき,スナップショットも併せて削除します。
hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで,"yes"を選択した場合,削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク,フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合,仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。
仮想サーバの仮想ディスクファイルの削除に失敗した場合,ファイル削除処理を中断し,タスクは異常終了します。
(4) 仮想サーバの仮想ディスクファイルの一覧を出力します。
hyperv.vhdListOutputFileNameRemoteプロパティとhyperv.vhdListOutputFileNameLocalプロパティを指定した場合,Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力,ファイルをローカルに転送し,リモートのファイルは削除します。仮想ディスク(差分)が割り当てられている場合,仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。
hyperv.vhdListOutputFileNameRemoteプロパティだけを指定した場合,仮想ディスクファイルのパス一覧をCSV形式で出力しますが,ファイルをローカルに転送しません。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) 仮想ディスクファイルの有無 (ヘッダー名:Existence)
仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。
Found:ファイルの存在を確認
NotFound:ファイルが設定されているが,存在を確認できない
(b) ファイルの削除結果 (ヘッダー名:DeleteResult)
hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで,"yes"を選択した場合,仮想ディスクファイルの削除の実行結果を出力します。hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで,"no"を選択した場合でも"Skipped"を出力します。項目の値を次に示します。
Completed:ファイルの削除が成功
Failed:ファイルの削除が失敗
Skipped:ファイルの削除が未実施
(c) ファイルのパス (ヘッダー名:FilePath)
(a)(b)の内容に関わらず,Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-10以降
【サービステンプレート実行システム内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2012 Hyper-V,Windows Server 2012 R2 Hyper-V
【サービステンプレート実行システム内前提製品の稼働OS】
(1)Hyper-Vサーバの前提OS
・Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
ただし,Server Coreインストール環境は除く。
(2)仮想サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
ただし,Server Coreインストール環境は除く。
【サービステンプレート実行システム内前提製品の使用条件】
(1)仮想サーバ名はHyper-Vサーバ内で一意であること。
(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。
・オペレーティングシステムのシャットダウン
注意事項
(1)同一の仮想サーバに対して,このサービスを複数同時に実行しないでください。
(2)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合,その仮想ディスクファイルは削除されません。この場合は手動で削除してください。
(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合,指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については,本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。
(4)hyperv.vhdListOutputFileNameRemoteプロパティおよびhyperv.vhdListOutputFileNameLocalプロパティに指定するファイル名がすでに存在する場合,既存のファイルを上書きします。また,リモート側のファイルは削除します。そのため,指定したファイル名に誤りがないか,十分に確認してください。
(5)hyperv.vhdListOutputFileNameRemoteプロパティに指定したパスのフォルダが存在しない場合は,そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。
(6)hyperv.vhdListOutputFileNameRemoteプロパティを指定した場合,hyperv.vhdListOutputFileNameLocalプロパティを指定しない場合や,仮想サーバまたは仮想ディスクファイルの削除時にエラーが発生しても,リモート側にファイルを出力します。出力したファイルは削除せずに残ります。そのため,使用しない場合は削除してください。
(7)このサービスは,フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。
(8)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は,仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。
バージョン
02.50.00
タグ
Delete VM,Hyper-V 2012
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
プロパティグループ |
説明 |
初期表示 |
---|---|---|
仮想システム環境情報 |
Hyper-Vサーバの情報を指定してください。 |
表示されます。 |
仮想サーバ情報 |
削除する仮想サーバの情報を指定してください。 |
表示されます。 |
出力ファイル格納情報 |
出力ファイルの格納先を必要に応じて指定してください。 |
表示されません。 |
ユーザー応答待ちオプション |
仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。 |
表示されません。 |
[サービス設定]画面に表示されるプロパティの一覧を次に示します。
- (凡例)
-
○:プロパティの指定は必須です。
△:プロパティの指定は省略可能です。ただし,ほかのプロパティの指定内容によっては,指定が必須になります。各プロパティの「説明」を確認してください。
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
---|---|---|---|---|---|---|
hyperv.targetHost |
Hyper-Vサーバのホスト名 |
Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
UserResponsePlugin.toAddress |
TOメールアドレス |
ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は,「,」で区切って指定してください。例:mailA,mailB |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.ccAddress |
CCメールアドレス |
ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は,「,」で区切って指定してください。例:mailA,mailB |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.bccAddress |
BCCメールアドレス |
ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は,「,」で区切って指定してください。例:mailA,mailB |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.mailSubject |
メール件名 |
ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。 |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.mailBody |
メール本文 |
ユーザー応答待ちになった場合のメール通知のメール本文を指定します。 |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.encodeType |
エンコード種別 |
ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8。指定しなかった場合には,utf-8で送信されます。 |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.dialogText |
応答入力画面の補足情報 |
ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式,またはHTML形式で指定できます。指定可能なHTMLタグは,アンカータグ,ボールドタグ,ブレークタグ,フォントタグ,イタリックタグ,下線タグです。 |
入力 |
無効 |
△ |
ユーザー応答待ちオプション |
UserResponsePlugin.responseTimeOut |
応答タイムアウト時間(分) |
ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると,サービスが異常終了します。 |
入力 |
無効 |
○ |
ユーザー応答待ちオプション |
[サービス設定]画面および[サービス実行]画面に表示されるプロパティの一覧を次に示します。
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
---|---|---|---|---|---|---|
hyperv.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
入力 |
無効 |
○ |
仮想サーバ情報 |
hyperv.vHardDiskDeletePermanently |
仮想ディスクファイルの削除の要否 |
仮想サーバで使用している仮想ディスクファイルを削除するかどうか指定します。 |
入力 |
無効 |
○ |
仮想サーバ情報 |
hyperv.vhdListOutputFileNameRemote |
出力ファイル名(リモート) |
仮想サーバが使用している仮想ディスクファイル一覧をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。 |
入力 |
無効 |
△ |
出力ファイル格納情報 |
hyperv.vhdListOutputFileNameLocal |
出力ファイル名(ローカル) |
仮想ディスクファイル一覧をローカルサーバに格納する際のファイル名をフルパスで指定します。 |
入力 |
無効 |
△ |
出力ファイル格納情報 |
[サービス設定]画面に表示されるプロパティの入力制限を次に示します。
プロパティキー |
入力可能文字 |
---|---|
hyperv.targetHost |
256文字以内の半角英数字および「.」,「-」。 |
UserResponsePlugin.toAddress |
1024文字以内の半角英数字および半角記号。 |
UserResponsePlugin.ccAddress |
1024文字以内の半角英数字および半角記号。 |
UserResponsePlugin.bccAddress |
1024文字以内の半角英数字および半角記号。 |
UserResponsePlugin.mailSubject |
256文字以内の文字列。 |
UserResponsePlugin.mailBody |
1024文字以内の文字列。 |
UserResponsePlugin.encodeType |
次の値のどれかを選択する。 us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8 |
UserResponsePlugin.dialogText |
512文字以内の文字列。 |
UserResponsePlugin.responseTimeOut |
1〜9999の整数値。 |
[サービス設定]画面および[サービス実行]画面に表示されるプロパティの入力制限を次に示します。
プロパティキー |
入力可能文字 |
---|---|
hyperv.vmName |
100文字以内の文字列。ただし,「<」,「>」,「|」,「;」,「&」,「'」,「"」,「*」,「?」,「[」,「]」,「`」,「,」,「%」,「¥」,「/」,「:」,先頭の「 (スペース)」および末尾の「 (スペース)」,「.」を除く。 |
hyperv.vHardDiskDeletePermanently |
次の値のどれかを選択する。 yes,no |
hyperv.vhdListOutputFileNameRemote |
256文字以内の文字列。ただし,「<」,「>」,「|」,「;」,「&」,「*」,「?」,「"」,「%」,「/」,「'」,「[」,「]」,「`」および末尾の「¥」を除く。 |
hyperv.vhdListOutputFileNameLocal |
256文字以内の文字列。ただし,「<」,「>」,「|」,「;」,「&」,「*」,「?」,「"」,「%」および末尾の「¥」,「/」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
---|---|---|---|---|---|
部品名 |
説明 |
エラー時の回復方法 |
|||
1 |
仮想サーバの状態確認 |
仮想サーバの状態確認 |
階層フロー部品 |
仮想サーバの状態を調べ,仮想サーバが起動している場合はユーザーに確認します。 |
− |
1-2 |
仮想サーバの状態取得 |
指定した仮想サーバの状態を取得します。 |
エラーの原因を取り除いたあと,サービスを再実行してください。 |
||
1-3 |
値判定分岐部品 |
仮想サーバが停止しているか確認します。 |
エラーの原因を取り除いたあと,サービスを再実行してください。 |
||
1-4 |
階層フロー部品 |
ユーザーに仮想サーバを停止するか確認し,停止する場合は仮想サーバをシャットダウンします。 |
− |
||
1-4-1 |
ユーザー応答待ち部品 |
ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。 |
エラーの原因を取り除いたあと,サービスを再実行してください。 |
||
1-4-2 |
仮想サーバの状態取得 |
指定した仮想サーバの状態を取得します。 |
エラーの原因を取り除いたあと,サービスを再実行してください。 |
||
1-4-3 |
値判定分岐部品 |
仮想サーバが停止しているか確認します。 |
エラーの原因を取り除いたあと,サービスを再実行してください。 |
||
1-4-4 |
仮想サーバのシャットダウン |
仮想サーバをシャットダウンします。 |
エラーの原因を取り除いたあと,サービスを再実行してください。 |
||
2 |
仮想サーバの削除 |
仮想サーバの削除 |
仮想サーバの削除 |
仮想サーバを削除します。 |
仮想サーバが削除されていない場合は,エラーの原因を取り除いたあと,サービスを再実行してください。 仮想サーバが削除されている場合は,仮想ディスクファイルの有無を確認,または仮想ディスクファイル一覧を出力していればHyper-Vサーバでファイルを参照し,必要に応じ手動で仮想ディスクファイルを削除してください。 |
3 |
ファイル転送 |
ファイル転送 |
階層フロー部品 |
仮想ディスクファイル一覧を転送します。 |
− |
3-1 |
値判定分岐部品 |
仮想ディスクファイル一覧の出力ファイル名(リモート)が指定されているかチェックします。 |
仮想ディスクファイル一覧を出力していれば,Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。 |
||
3-2 |
階層フロー部品 |
仮想ディスクファイル一覧を転送します。 |
− |
||
3-2-1 |
値判定分岐部品 |
仮想ディスクファイル一覧の出力ファイル名(ローカル)が指定されているかチェックします。 |
仮想ディスクファイル一覧を出力していれば,Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。 |
||
3-2-2 |
階層フロー部品 |
仮想ディスクファイル一覧を転送します。 |
− |
||
3-2-2-1 |
ファイル転送部品 |
リモートの一時ファイルをローカルの指定された出力ファイルに転送します。 |
Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。 |
||
3-2-2-2 |
ファイル削除 |
リモートの一時ファイルを削除します。 |
Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。 |