5.11.4 仮想サーバのIPアドレス取得
機能
VMware vSphere環境において，指定した仮想サーバのIPアドレスを取得します。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによりこのサーバに部品が転送され，実行されます。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。
出力プロパティVMware.vmIPaddressに取得したIPアドレスを出力します。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力します。ただし，IPアドレスの長さの合計が1024文字を超える場合，1025文字以降は切り捨てられます。取得するIPアドレスの種類は次の3種類であり，IPv4だけの場合は65個以上で1024文字を超える場合があります。
・IPv4(最大長16文字)
・IPv6(最大長36文字)
・DHCPによって設定されたIPv4とIPv6
利用場面
仮想サーバ設定されているIPアドレスの確認や，仮想サーバに対してICMPエコー要求を発行する場合に利用できます。
ICMPエコー要求を発行する処理は，この部品で仮想サーバのIPアドレスを取得を行い，osSendIcmp部品の入力として使用するという流れになります。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 10-00以降
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 6.0，5.5，5.1，5.0，4.1，4.0
(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)
・VMware vSphere ESXi 6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0
(3)仮想サーバの前提OS
vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。
・Windows Server 2003，Standard Edition/Enterprise Edition (x86/x64) SP1以降，Windows Server 2003 R2，Standard Edition/Enterprise Edition (x86/x64)
・Windows Server 2008 Standard/Enterprise (x86/x64)，Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Red Hat Enterprise Linux 5 Advanced Platform (x86)，Red Hat Enterprise Linux 5 (x86)，Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64)，Red Hat Enterprise Linux 5 (AMD/Intel 64)
・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
(2)仮想サーバが起動していること。
(3)仮想サーバ名はvCenterサーバ内で一意になっていること。
(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。
【実行対象サーバ内前提製品】
・VMware vSphere PowerCLI 6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
実行権限
(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。
対象とする仮想サーバに対して「読み取り専用」の権限を持つロール，またはシステム管理者ロール
バージョン
01.00.04
カテゴリ
VirtualMachine/vSphere
タスクログに表示される部品の名称
vsphereGetVMIPaddress
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
30 |
異常(IPアドレス取得不正) IPアドレスの未取得 |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
VMware.vCenterServerName |
vCenterサーバ名 |
VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
VMware.userName |
VMware vCenter Serverに接続するためのユーザー名 |
VMware vCenter Serverに接続するためのユーザー名を指定します。 |
− |
入力 |
○ |
|
VMware.password |
VMware vCenter Serverに接続するためのパスワード |
VMware vCenter Serverに接続するためのパスワードを指定します。 |
− |
入力 |
○ |
|
VMware.portNumber |
VMware vCenter Server接続用ポート番号 |
VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。 |
443 |
入力 |
△ |
|
VMware.protocol |
VMware vCenter Server接続用プロトコル |
VMware vCenter Serverに接続するためのプロトコルを指定します。 |
https |
入力 |
○ |
|
VMware.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。 |
− |
入力 |
○ |
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |
|
VMware.vmIPaddress |
仮想サーバのIPアドレス |
仮想サーバのIPアドレスを格納するプロパティです。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。 |
− |
出力 |
○ |