3.16.8 仮想サーバ再起動
機能
VMware vSphere環境の複数の仮想サーバを再起動します。
このサービステンプレートが前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ
VMware vSphere PowerCLIがインストールされているサーバです。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。
処理の概要を次に示します。
(1) 仮想サーバの電源状態を取得します。
(2) 仮想サーバの電源状態がONの場合に，仮想サーバを再起動します。
仮想サーバがOFFの場合は，該当する仮想サーバの処理がエラーとなります。
(3) ICMPエコー要求を送信し，仮想サーバが起動したことを確認します。
上記の処理を，指定された仮想サーバ群に対して並列に実行します。
仮想サーバを再起動する際には，まずvmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，仮想サーバが停止状態になることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。次に，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，仮想サーバが起動状態になったことを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。したがって，最大でこれらのプロパティを掛け合わせた秒数の2倍の時間待ち合わせることになります。
デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働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)対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。
(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。
注意事項
(1)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。
(2)システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。
タスクログから，ネットワーク接続確認(部品「仮想サーバのIPアドレス取得」(vsphereGetVMIPaddress)もしくは部品「ICMPエコー要求メッセージの送信」(osSendIcmp))でエラーが発生しているか確認してください。
これらの部品でエラーが発生している場合，仮想サーバが起動しているか確認してください。
(3)仮想サーバのNICにIPアドレスが大量に設定されている(※1)と，部品「ICMPエコー要求メッセージの送信」でエラーが発生し，タスクが異常終了する場合があります。NICに設定されているIPアドレスの長さの合計が，1024文字以内であることを確認してください。
※1)次のIPアドレスが対象です。例えば，IPv4だけの場合は64個までの範囲で設定されていれば問題ありません。
・IPv4(最大長16文字)
・IPv6(最大長36文字)
・DHCPによって設定されるIPv4とIPv6
実行権限
(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。
対象とする仮想サーバに対して「読み取り専用」と「パワーオン」「パワーオフ」の権限を持つロール，またはシステム管理者ロール
(2)vCenter操作サーバに接続するユーザーに、次の権限が必要です。
ビルトイン Administrator
バージョン
03.00.00
タグ
Control 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に接続するためのプロトコルを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.checkPowerStateCount |
電源状態の確認回数 |
仮想サーバの停止および起動を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。 |
入力 |
無効 |
○ |
実行時オプション |
|
vmware.checkPowerStateInterval |
電源状態の確認間隔 |
仮想サーバの停止および起動を確認する際の，電源状態の確認間隔を秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
|
common.icmpEchoTimeout |
ICMPエコー要求のタイムアウト時間 |
仮想サーバの起動確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
vmware.foreachVmName |
仮想サーバ名(複数指定可) |
仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。 |
入力 |
無効 |
○ |
仮想サーバ情報 |
［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
|---|---|---|---|---|
|
common.taskResult |
繰り返しタスクの実行結果 |
タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。 |
出力 |
無効 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
vmware.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.vCenterServerName |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.userName |
512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。 |
|
vmware.password |
127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。 |
|
vmware.portNumber |
1〜65535の整数値。 |
|
vmware.protocol |
次の値のどれかを選択する。 http,https |
|
vmware.checkPowerStateCount |
1〜3600の整数値。 |
|
vmware.checkPowerStateInterval |
1〜60の整数値。 |
|
common.icmpEchoTimeout |
1〜214783647の整数値。 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
vmware.foreachVmName |
1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
仮想サーバを再起動 |
仮想サーバを再起動 |
繰り返し実行部品 |
複数の仮想サーバを再起動します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |