5.11.26 ログバンドルの取得
機能
この部品は，VMware vSphere環境で，vCenterサーバまたはESXサーバからログバンドルを取得し，vCenter操作サーバ上に転送して保存します。オプションとして，1回の部品実行で両方のサーバのログバンドルを取得することもできます。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・ESXサーバ
VMware vSphere ESXiがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。
この部品内のスクリプトでは，次に示すVMware vSphere PowerCLIのコマンドレットを実行し，対象となるサーバのログバンドルを取得します。
(1)ESXサーバ名(VMware.vmHostNameプロパティ)を指定した場合，ESXサーバからログバンドルを取得します。
Get-Log -Bundle
-VMHost "ESXサーバのオブジェクト" ※1
-DestinationPath "ファイル出力先フォルダパス(common.outputFolderPathプロパティ)の値"
※1 ESXサーバ名(VMware.vmHostNameプロパティ)の値から取得したオブジェクト
(2)ESXサーバ名(VMware.vmHostNameプロパティ)を指定しない，またはログバンドル取得対象オプション(VMware.logBundleTargetOptionプロパティ)に"true"を指定した場合，vCenterサーバからログバンドルを取得します。
Get-Log -Bundle
-DestinationPath "ファイル出力先フォルダパス(common.outputFolderPathプロパティ)の値"
Get-Logコマンドレットの詳細については，vSphere PowerCLI Documentation の「Cmdlets Reference」を参照してください。
ファイル出力先フォルダパス(common.outputFolderPathプロパティ)に指定したフォルダの配下に，取得したログバンドルを保存します。
指定したフォルダが存在しない場合はフォルダを作成します。
取得したログバンドル名は次のようになります。
・vCenterサーバのログバンドル
vcsupport-<UUID>.拡張子
・ESXサーバのログバンドル
vmsupport-<UUID>.拡張子，または<ESXサーバ名>-<取得年月日時分>.拡張子
例：vcsupport-52030251-97e6-e5f2-042e-eee52079822b.tgz
vmsupport-5219d2ae-c328-c617-2525-09ed4a3111f0.tgz
esx-ed801a-2017-03-24--13.36-1080701.tgz
<UUID>は，同一のサーバであっても部品を実行する度に別の値になります。
取得したログバンドルのフルパスを次に示すプロパティに格納します。
・vCenterサーバのログバンドル
vCenterサーバのログバンドルパス(VMware.vCenterLogBundlePathプロパティ)
・ESXサーバのログバンドル
ESXサーバのログバンドルパス(VMware.esxLogBundlePathプロパティ)
利用場面
VMware vSphere環境で障害が発生したときに，トラブルシュート情報としてVMware vCenter ServerまたはVMware vSphere ESXiのログバンドルを取得する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-10以降
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0
(2)ESXサーバの前提製品
・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXiのログバンドルを取得する場合の条件
・VMware vSphere ESXiがVMware vCenter Serverで管理されていること。
・VMware vSphere ESXiがVMware vCenter Serverと接続状態であること。
【実行対象サーバ内前提製品】
・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0
・VMware PowerCLI 6.5 Release1
・VMware PowerCLI 6.5.1，6.5.4
・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
・Windows Server 2019 Standard/Datacenter
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) この部品を複数同時に実行する際にファイル出力先フォルダパス(common.outputFolderPathプロパティ)に同一の存在しないフォルダを指定した場合，フォルダ作成処理が競合して部品が異常終了することがあります。その場合は再実行してください。
(3) 同一のvCenterサーバまたはESXサーバに対してこの部品を複数同時に実行した場合，ログバンドル取得処理が競合して部品が異常終了することがあります。その場合は再実行してください。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Gather VM information,VMware vSphere
タスクログに表示される部品の名称
vsphereGetLogBundle
戻り値
|
戻り値 |
説明 |
|---|---|
|
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サーバ名を指定します。省略した場合，vCenterサーバからログバンドルを取得します。 |
− |
入力 |
△ |
|
VMware.logBundleTargetOption |
ログバンドル取得対象オプション |
ESXサーバからログバンドルを取得する際に，vCenterサーバからもログバンドルを取得する場合は"true"を指定します。"true"以外の場合は，ESXサーバのログバンドルだけを取得します。 |
True |
入力 |
△ |
|
common.outputFolderPath |
ファイル出力先フォルダパス |
取得したログバンドルの出力先となる実行対象サーバ上のフォルダをフルパスで指定します。 |
− |
入力 |
○ |
|
VMware.esxLogBundlePath |
ESXサーバのログバンドルパス |
ESXサーバから取得したログバンドルのフルパスが格納されます。 |
− |
出力 |
△ |
|
VMware.vCenterLogBundlePath |
vCenterサーバのログバンドルパス |
vCenterサーバから取得したログバンドルのフルパスが格納されます。 |
− |
出力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |