3.15.4 仮想サーバ削除
機能
VMware vSphere環境の仮想サーバを削除します。
このサービステンプレートが前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ
VMware vSphere PowerCLIがインストールされているサーバです。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。
処理の概要を以下に示します。
(1) 仮想サーバの電源状態を取得します。
(2) 仮想サーバの電源状態がOFFになっていることを確認します。
電源状態がOFFでない場合は，ユーザー応答待ち部品を実行して，電源をOFFにするか・しないかを確認します。
ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。
ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのシャットダウンを行います。
"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにサービスが異常終了します。
仮想サーバを停止する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。
(3) 仮想サーバを削除します。
なお，仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 12-00以降
【サービステンプレート実行システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0
(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)
・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0
(3)vCenter操作サーバの前提製品
・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0
・VMware PowerCLI 6.5 Release1
・VMware PowerCLI 6.5.1，6.5.4
・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0
【サービステンプレート実行システム内前提製品の稼働OS】
(1)仮想サーバの前提OS
vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
・Windows Server 2019 Standard/Datacenter
・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)
・Red Hat Enterprise Linux Server 7 (64-bit x86_64)
・Red Hat Enterprise Linux Server 8 (64-bit x86_64)
・CentOS 6 (64-bit x86_64)
・CentOS 7 (64-bit x86_64)
・CentOS 8 (64-bit x86_64)
(2)vCenter操作サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
・Windows Server 2019 Standard/Datacenter
【サービステンプレート実行システム内前提製品の使用条件】
(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
(2)仮想サーバ名はvCenterサーバ内で一意になるようにしてください。
(3)対象となる仮想サーバに，VMwareToolsがインストールされていること。
注意事項
(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。
(2)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。
システム管理者ロール
バージョン
03.00.00
タグ
Delete VM,VMware vSphere
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
|
プロパティグループ |
説明 |
初期表示 |
|---|---|---|
|
仮想システム環境情報 |
VMware vCenter Serverの情報を指定してください。 |
表示されます。 |
|
仮想サーバ情報 |
削除する仮想サーバの情報を指定してください。 |
表示されます。 |
|
ユーザー応答待ちオプション |
仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。 |
表示されません。 |
|
実行時オプション |
仮想サーバの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。 |
表示されません。 |
［サービス設定］画面に表示されるプロパティの一覧を次に示します。
- （凡例）
-
○：プロパティの指定は必須です。
△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
vmware.targetHost |
VMware vCenter操作サーバのホスト名 |
VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.vCenterServerName |
vCenterサーバ名 |
VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.userName |
VMware vCenter Serverに接続するためのユーザー名 |
VMware vCenter Serverに接続するためのユーザー名を指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.password |
VMware vCenter Serverに接続するためのパスワード |
VMware vCenter Serverに接続するためのパスワードを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.portNumber |
VMware vCenter Server接続用ポート番号 |
VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。 |
入力 |
無効 |
△ |
仮想システム環境情報 |
|
vmware.protocol |
VMware vCenter Server接続用プロトコル |
VMware vCenter Serverに接続するためのプロトコルを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
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 |
応答タイムアウト時間(分) |
ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。 |
入力 |
無効 |
○ |
ユーザー応答待ちオプション |
|
vmware.checkPowerStateCount |
電源状態の確認回数 |
仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。 |
入力 |
無効 |
○ |
実行時オプション |
|
vmware.checkPowerStateInterval |
電源状態の確認間隔 |
仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
vmware.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
入力 |
無効 |
○ |
仮想サーバ情報 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
vmware.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.vCenterServerName |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.userName |
512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。 |
|
vmware.password |
127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。 |
|
vmware.portNumber |
1〜65535の整数値。 |
|
vmware.protocol |
次の値のどれかを選択する。 http,https |
|
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の整数値。 |
|
vmware.checkPowerStateCount |
1〜3600の整数値。 |
|
vmware.checkPowerStateInterval |
1〜60の整数値。 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
vmware.vmName |
60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
電源状態取得 |
電源状態取得 |
仮想サーバの電源状態取得 |
VMware vSphere環境において，仮想サーバの電源状態を取得します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
|
2 |
電源状態確認 |
電源状態確認 |
階層フロー部品 |
電源状態を調べ，電源状態がOFFでなければ，ユーザーに確認します。 |
− |
|
2-3 |
値判定分岐部品 |
出力文字列がPoweredOnを含むか判定します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
||
|
2-4 |
階層フロー部品 |
− |
− |
||
|
2-4-1 |
ユーザー応答待ち部品 |
電源をOFFにするか・しないかを確認します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
||
|
2-4-2 |
戻り値判定分岐部品 |
ユーザー応答待ち部品の戻り値が1か判定します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
||
|
2-4-3 |
異常終了部品 |
ジョブネットをエラーにします。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
||
|
2-4-4 |
仮想サーバのシャットダウン |
VMware vSphere環境において，仮想サーバのシャットダウンを行い，電源状態をOFFに設定します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
||
|
3 |
仮想サーバ削除 |
仮想サーバ削除 |
階層フロー部品 |
仮想サーバを削除します。 |
− |
|
3-1 |
仮想サーバの削除 |
VMware vSphere環境において，指定された仮想サーバを削除します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
||