5.8.7 仮想サーバのIPアドレス取得
機能
OpenStack管理下のKVM環境で,インスタンスのすべてのNICに設定されたIPアドレス(IPv4)を取得します。
このドキュメント内で使用しているOpenStackに関する用語は,OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。
・Identity
IdentityまたはKeyStoneと記載されています。
・プロジェクト
プロジェクトまたはテナントと記載されています。
この部品が前提とするサーバを次に示します。
・OpenStackサーバ
OpenStackがインストールされているサーバです。
・KVMサーバ
Kernel-based Virtual Machineがインストールされているサーバです。
・OpenStack操作サーバ
OpenStackサーバにREST-APIを実行するサーバです。
・インスタンス
OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。
利用場面
インスタンスに設定されているIPアドレス(IPv4)の確認や,インスタンスに対してICMPエコー要求を発行する場合に使用できます。
ICMPエコー要求を発行する処理は,この部品でインスタンスのIPアドレスを取得し,osSendIcmp部品の入力として使用するという流れになります。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1)OpenStackサーバの前提製品
・OpenStack
(2)インスタンスを管理する仮想化環境
・Kernel-based Virtual Machine
・VMware vCenter Server
・VMware vSphere ESXi
(3)OpenStack操作サーバ
・Microsoft .Net Framework 3.5以降
(4)インスタンスの前提OS
・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)
・Red Hat Enterprise Linux Server 7 (64-bit x86_64)
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter
・Windows Server 2012 R2 Standard/Datacenter
ただし,Server Coreインストール環境は除く。
【実行対象システム内前提製品の使用条件】
(1)インスタンスに関する条件
・同一プロジェクト内でインスタンス名が重複しないこと。
実行権限
(1)OpenStackサーバにログインするユーザーに次の権限が必要です。
admin権限
バージョン
02.00.00
部品のタグ
Gather VM information,OpenStack
タスクログに表示される部品の名称
openstackGetVMIPaddress
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
openstack.identityServerHostName |
Identityサーバのホスト名 |
Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
openstack.userName |
Identityサーバにログインするためのユーザー名 |
Identityサーバにログインするためのユーザー名を指定します。 |
− |
入力 |
○ |
openstack.password |
Identityサーバにログインするためのパスワード |
Identityサーバにログインするためのパスワードを指定します。 |
− |
入力 |
○ |
openstack.protocol |
Identityサーバ接続用プロトコル |
Identityサーバに接続するためのプロトコルを指定します。 |
− |
入力 |
○ |
openstack.portNumber |
Identityサーバ接続用ポート番号 |
Identityサーバに接続するためのポート番号を指定します。 |
− |
入力 |
○ |
openstack.projectName |
プロジェクト名 |
プロジェクトの名称を指定します。 |
− |
入力 |
○ |
openstack.instanceName |
インスタンス名 |
インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
openstack.instanceIPaddress |
インスタンスのIPアドレス |
インスタンスのIPアドレスが格納されるワークプロパティです。インスタンスに複数のIPアドレスが設定されている場合には,コンマ区切りで出力されます。 |
− |
出力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |