5.5.53 物理アダプタの情報一覧取得
機能
VMware vSphere環境で,ESXサーバに接続されている物理アダプタの情報を出力します。
物理アダプタ名(VMware.physicalAdapterNameプロパティ)を指定した場合は,指定した物理アダプタのリンク状態のみを物理アダプタの状態(VMware.outPhysicalAdapterStatusプロパティ)に格納します。
物理アダプタ名(VMware.physicalAdapterNameプロパティ)を省略した場合は,物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)に指定したvCenter操作サーバのファイルに,ESXサーバに接続されている物理アダプタの情報一覧をCSV形式で出力します。
出力ファイルのエンコード形式は,vCenter操作サーバのシステムのデフォルトエンコードです。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・ESXサーバ
VMware vSphere ESXiがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され,実行されます。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。
物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)について次に示します。
・物理アダプタ名(VMware.physicalAdapterNameプロパティ)を指定した場合,このプロパティの指定内容は無視されます。
この部品内のスクリプトでは,次に示すVMware vSphere PowerCLIのコマンドレットを実行します。
・Get-EsxCli -VMHost VMHostオブジェクト※1
※1 ESXサーバ名(VMware.vmHostNameプロパティ)の値から取得したオブジェクト
上記のコマンドレットの実行結果からnetwork.nic.list()の値を取得して「物理アダプタの状態(VMware.outPhysicalAdapterStatusプロパティ)」に格納します。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) ESXサーバ名(ヘッダー名:VmHostName)
(b) 標準仮想スイッチ名(ヘッダー名:VirtualSwitchName)
(c) 物理アダプタ名(ヘッダー名:PhysicalAdapterName)
(d) 物理アダプタの状態(ヘッダー名:PhysicalAdapterStatus)
CSVファイル出力例
"VmHostName","VirtualSwitchName","PhysicalAdapterName","PhysicalAdapterStatus"
"sysbsx10","vSwitch0","vmnic0","Up"
"sysbsx10","vSwitch1","vmnic1","Up"
"sysbsx10","vSwitch1","vmnic2","Down"
利用場面
ESXサーバに接続されている物理アダプタの情報を取得する場合に使用できます。
前提条件
【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server
(2)仮想サーバを管理するVMware vSphere ESXi
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。
(2)VMware vSphere ESXi上の設定に関する条件
・VMwareに関連する次の名称について,VMware上では英字の大文字・小文字は区別されますが,この部品が実行するvSphere Power CLIからは,指定した名称の英字の大文字・小文字を区別できません。
そのため,英字の大文字・小文字が異なる同名の名称を使用している環境に対して,この部品を使用することはできません。
- 標準仮想スイッチ名
【実行対象サーバ内前提製品】
・VMware PowerCLI
【実行対象サーバ内前提製品の稼働OS】
・Windows Server
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)に指定したファイルが既に存在する場合,既存のファイルを上書きします。そのため,指定したファイル名に誤りがないか,十分に確認してください。
(3)物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)に指定したファイルを作成するフォルダが存在しない場合は,そのフォルダを作成します。
(4)物理アダプタ名(VMware.physicalAdapterNameプロパティ)を省略した場合は,物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)を必ず指定してください。物理アダプタ情報一覧出力ファイル名を省略すると,この部品は異常終了します。
実行権限
(1)VMware vCenter Serverに接続するユーザーに,システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Gather VM information,VMware vSphere
タスクログに表示される部品の名称
vsphereOutputPhysicalAdapInfo
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
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.vmHostName |
ESXサーバ名 |
VMware vCenter Serverが管理する[ホストおよびクラスタ]に表示されるESXサーバ名を指定します。 |
− |
入力 |
○ |
VMware.physicalAdapterName |
物理アダプタ名 |
情報を取得する物理アダプタ名を指定します。 |
− |
入力 |
△ |
VMware.esxAdapterOutputFileName |
物理アダプタ情報一覧出力ファイル名 |
ESXサーバの物理アダプタ情報一覧を出力するファイル名をフルパスで指定します。 |
− |
入力 |
△ |
VMware.outPhysicalAdapterStatus |
物理アダプタの状態 |
指定した物理アダプタの状態が格納されます。 |
− |
出力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |