5.5.5 ESXサーバの仮想ネットワーク情報一覧取得部品
機能
VMware vSphere環境で，ESXサーバの仮想ネットワーク情報の一覧を取得します。
出力ファイルパス(common.outputFilePathプロパティ)に指定したファイルに，ESXサーバの仮想ネットワーク情報一覧をCSV形式で出力します。
出力ファイルのエンコード形式は，実行対象サーバのシステムデフォルトエンコードです。
この部品が前提とするサーバを次に示します。
・ESXサーバ
VMware vSphere ESXiがインストールされているサーバです。
・実行対象サーバ
VMware vSphere PowerCLIがインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。
この部品内のスクリプトでは，次に示すVMware vSphere PowerCLIのコマンドレットを実行し特定の項目を参照します。
・Get-EsxTop -CounterName "NetPort"※1
・ClientName (仮想マシン名，Kernelポート名などインタフェース名)
・TeamUplink (有効アダプタ名)
・Get-VirtualSwitch
・Name (仮想スイッチ名)
・Nic (アダプタ名)
※1 Option「CounterName」に指定する"NetPort"は固定値
上記2つのコマンドレットの実行結果から，Get-VirtualSwitch.NicがGet-EsxTop.TeamUplinkと一致する値を取得します。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a)インタフェース名(ヘッダー名：ClientName)
(b)アダプタ名(ヘッダー名：TeamUplink)
(c)仮想スイッチ名(ヘッダー名：DNAME)
CSVファイル出力例
"ClientName","TeamUplink","DNAME"
"vmk0","vmnic0","vSwitch0"
"vm01","vmnic1","vSwitch1"
利用場面
ESXサーバの仮想ネットワークで有効なアダプタを参照する場合に使用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象システム内前提製品】
(1)仮想サーバを管理するVMware vSphere ESXi
【実行対象システム内前提製品の使用条件】
・特になし。
【実行対象サーバ内前提製品】
・VMware PowerCLI
【実行対象サーバ内前提製品の稼働OS】
・Windows Server
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)出力ファイルパス(common.outputFilePathプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。
(3)出力ファイルパス(common.outputFilePathプロパティ)に指定したファイルを作成するフォルダが存在しない場合は，そのフォルダを作成します。
実行権限
(1)ESXサーバに接続するユーザーに，システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Gather VM information,VMware vSphere
タスクログに表示される部品の名称
vsphereOutputVmNetworkInfo
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
VMware.ESXServerName |
ESXサーバ名 |
ESXサーバのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
VMware.ESXUserName |
ESXサーバに接続するためのユーザー名 |
ESXサーバに接続するためのユーザー名を指定します。 |
− |
入力 |
○ |
|
VMware.ESXPassword |
ESXサーバに接続するためのパスワード |
ESXサーバに接続するためのパスワードを指定します。 |
− |
入力 |
○ |
|
VMware.ESXPortNumber |
ESXサーバ接続用ポート番号 |
ESXサーバに接続するためのポート番号を指定します。 |
443 |
入力 |
△ |
|
VMware.ESXProtocol |
ESXサーバ接続用プロトコル |
ESXサーバに接続するためのプロトコルを指定します。 |
HTTPS |
入力 |
△ |
|
common.outputFilePath |
出力ファイルのパス |
出力するファイルをフルパスで指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |