5.4.3 仮想サーバのシャットダウン
機能
この部品は，Hyper-V環境における仮想サーバのOSに対して強制的にシャットダウンを実行します。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
仮想サーバのOSをシャットダウンする際には，hyperv.checkVmStateDisabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateDisabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。
部品が正常終了した場合は，hyperv.vmStateプロパティに"3"を格納します。
格納する値と仮想サーバの状態の関係については，JP1/AOマニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。
利用場面
仮想サーバのOSをシャットダウンする場合に使用できます。
シャットダウン処理は，hypervGetVMState部品で仮想サーバの状態を取得し，状態を判定したあとに，この部品を実行するという流れになります。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働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)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。
・オペレーティングシステムのシャットダウン
(3)仮想サーバが起動完了していること。
注意事項
(1)この部品は指定した仮想サーバのOSを強制的にシャットダウンします。この部品を使用した場合，仮想サーバで編集中のファイルデータは保存されません。
バージョン
02.00.00
部品のタグ
Control VM,Hyper-V 2008
タスクログに表示される部品の名称
hypervShutdownVM
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
28 |
異常(仮想サーバの不正な状態変更) 仮想サーバの不正な状態変更 |
|
29 |
異常(仮想サーバの状態確認のタイムアウト) 仮想サーバの状態確認のタイムアウト |
|
30 |
異常(仮想サーバの消失) 処理中の仮想サーバの消失 |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
hyperv.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
|
hyperv.checkVmStateDisabledCount |
仮想サーバの状態(停止完了)の確認回数 |
仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。 |
1440 |
入力 |
○ |
|
hyperv.checkVmStateDisabledInterval |
仮想サーバの状態(停止完了)の確認間隔 |
仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。 |
5 |
入力 |
○ |
|
hyperv.checkJobShutdownCount |
ジョブ監視回数(InitiateShutdownメソッド) |
Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。 |
1200 |
入力 |
○ |
|
hyperv.checkJobShutdownInterval |
ジョブ監視間隔(InitiateShutdownメソッド) |
Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。 |
3 |
入力 |
○ |
|
hyperv.vmState |
仮想サーバの状態 |
仮想サーバの状態が格納されます。 |
− |
出力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |