5.3.11 仮想サーバの状態取得
機能
この部品は,Hyper-V環境における仮想サーバの状態を取得します。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
取得した仮想サーバの状態を表す値(数値)を,hyperv.vmStateプロパティに格納します。格納された値が意味する仮想サーバの状態を確認する場合は,タスクログの「vmState:」で始まる行をご覧ください。その場合,タスクのログ出力レベルを標準出力内容が出力されるレベル(30または40)に設定する必要があります。
利用場面
この部品は,仮想サーバの状態を確認し,仮想サーバの起動や停止,削除など,状態に応じた対処を実施する場合に使用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【実行対象サーバ内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2016 Hyper-V
(2)仮想サーバの前提OS
・Windows Server 2016 Standard/Datacenter
ただし,Server Core/Nano Serverインストール環境は除く。
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2016 Standard/Datacenter
ただし,Server Core/Nano Serverインストール環境は除く。
【実行対象サーバ内前提製品の使用条件】
(1)仮想サーバ名はHyper-Vサーバ内で一意であること。
バージョン
02.12.00
部品のタグ
Gather VM information,Hyper-V 2016
タスクログに表示される部品の名称
hyperv2016GetVMState
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
hyperv.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
hyperv.vmState |
仮想サーバの状態 |
仮想サーバの状態が格納されます。 |
− |
出力 |
− |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |