5.4.2 仮想サーバのIPアドレス取得
機能
この部品は，Hyper-V環境における仮想サーバのすべてのNICに設定されたIPアドレス(IPv4)を取得します。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
取得したIPアドレスは，hyperv.vmIPaddressプロパティに格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力します。
ただし，IPアドレスの長さの合計が1024文字を超える場合，1025文字目以降を含むIPアドレスは切り捨てられます。すべてのNICでIPv4のIPアドレスが65個以上設定されていると，1024文字を超える場合があります。
利用場面
仮想サーバ設定されているIPアドレス(IPv4)の確認や，仮想サーバに対してICMPエコー要求を発行する場合に使用できます。
ICMPエコー要求を発行する処理は，この部品で仮想サーバのIPアドレスを取得し，osSendIcmp部品の入力として使用するという流れになります。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働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)仮想サーバが起動完了していること。
バージョン
02.00.00
部品のタグ
Gather VM information,Hyper-V 2008
タスクログに表示される部品の名称
hypervGetVMIPaddress
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
30 |
異常(仮想サーバの消失) 処理中の仮想サーバの消失 |
|
31 |
異常(データ交換(KVP)による仮想サーバの情報取得の失敗) データ交換(KVP)による仮想サーバの情報取得の失敗 |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
hyperv.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
|
hyperv.waitTime |
IPアドレス取得開始前の待機処理時間 |
IPアドレス取得開始前に実施する待機処理の時間を秒単位で指定します。 |
0 |
入力 |
○ |
|
hyperv.vmIPaddress |
仮想サーバのIPアドレス |
仮想サーバのIPアドレスが格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。 |
− |
出力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |