3.11.3 仮想サーバの再起動
機能
このサービステンプレートは，Hyper-V環境の複数の仮想サーバを再起動します。
このサービステンプレートが前提とするサーバを次に示します。
・Hyper-Vサーバ
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
処理の概要を次に示します。
(1) 仮想サーバが起動している場合に，仮想サーバを再起動します。仮想サーバの状態が起動以外の場合は，該当する仮想サーバの処理がエラーになります。
(2) ネットワーク接続確認を実行する場合は，再起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから再起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。
上記の処理を，指定された仮想サーバ群に対して並列に実行します。
仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 12-00以降
【サービステンプレート実行システム内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2016 Hyper-V
【サービステンプレート実行システム内前提製品の稼働OS】
(1)Hyper-Vサーバの前提OS
・Windows Server 2016 Standard/Datacenter
ただし，Server Core/Nano Serverインストール環境は除く。
(2)仮想サーバの前提OS
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
ただし，Server Core/Nano Serverインストール環境は除く。
【サービステンプレート実行システム内前提製品の使用条件】
(1)仮想サーバ名はHyper-Vサーバ内で一意であること。
(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。
・オペレーティングシステムのシャットダウン
・データ交換
(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。
(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。
(5)仮想サーバが起動していること。
注意事項
(1)このサービスは指定した仮想サーバのOSを強制的にシャットダウンします。このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。
(2)ネットワーク接続確認を実行する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。
(3)ネットワーク接続確認を実行する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。
※IPアドレス(IPv4)1つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。
(4)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。
実行権限
ビルトイン Administrator
バージョン
03.00.00
タグ
Control VM,Hyper-V 2016
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
|
プロパティグループ |
説明 |
初期表示 |
|---|---|---|
|
仮想システム環境情報 |
Hyper-Vの情報を指定してください。 |
表示されます。 |
|
仮想サーバ情報 |
再起動する仮想サーバの情報を指定してください。 |
表示されます。 |
|
ネットワーク接続確認 |
仮想サーバを再起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。 |
表示されません。 |
|
実行時オプション |
仮想サーバを再起動する際の状態確認に関するプロパティです。必要に応じて変更してください。 |
表示されません。 |
［サービス設定］画面に表示されるプロパティの一覧を次に示します。
- （凡例）
-
○：プロパティの指定は必須です。
△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
hyperv.targetHost |
Hyper-Vサーバのホスト名 |
Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
hyperv.waitTime |
IPアドレス取得開始までの待機時間 |
ネットワーク接続確認を実行する場合，仮想サーバの再起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。 |
入力 |
無効 |
○ |
ネットワーク接続確認 |
|
common.icmpEchoTimeout |
ICMPエコー要求のタイムアウト時間 |
ネットワーク接続確認を実行する場合，仮想サーバの再起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。 |
入力 |
無効 |
○ |
ネットワーク接続確認 |
|
hyperv.checkVmStateEnabledCount |
仮想サーバの状態(起動完了)の確認回数 |
仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。 |
入力 |
無効 |
○ |
実行時オプション |
|
hyperv.checkVmStateEnabledInterval |
仮想サーバの状態(起動完了)の確認間隔 |
仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。 |
入力 |
無効 |
○ |
実行時オプション |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
hyperv.foreachVmName |
仮想サーバ名(複数指定可) |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。 |
入力 |
無効 |
○ |
仮想サーバ情報 |
|
hyperv.checkNetworkConnection |
ネットワーク接続確認の実行 |
仮想サーバの再起動後にネットワーク接続確認を実行するかどうかを指定します。 |
入力 |
無効 |
○ |
ネットワーク接続確認 |
［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
|---|---|---|---|---|
|
common.taskResult |
繰り返しタスクの実行結果 |
タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。 |
出力 |
無効 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
hyperv.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
|
hyperv.waitTime |
0〜3600の整数値。 |
|
common.icmpEchoTimeout |
1〜2147483647の整数値。 |
|
hyperv.checkVmStateEnabledCount |
1〜2147483647の整数値。 |
|
hyperv.checkVmStateEnabledInterval |
1〜60の整数値。 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
hyperv.foreachVmName |
1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。 |
|
hyperv.checkNetworkConnection |
次の値のどれかを選択する。 yes,no |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
仮想サーバの再起動 |
仮想サーバの再起動 |
繰り返し部品 |
複数の仮想サーバを再起動します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |