VMware Cloud Builder アプライアンス で Supportability and Serviceability (SoS) ユーティリティを実行して、サポート バンドルを生成できます。これは、失敗した VMware Cloud Foundation のブリングアップのデバッグに役立ちます。
正常にブリングアップした後は、SDDC Manager 仮想マシン でのみ SoS ユーティリティを実行する必要があります。『VMware Cloud Foundation 運用および管理ガイド』のSupportability and Serviceability (SoS) Tool を参照してください。
SoS ユーティリティはデバッグ ツールではありませんが、失敗した展開のデバッグを容易にする健全性チェック操作を提供します。
VMware Cloud Builder で SoS ユーティリティを実行するには、admin 管理アカウントを使用して VMware Cloud Builder アプライアンス に SSH 接続してから、su と入力して root ユーザーに切り替え、/opt/vmware/sddc-support ディレクトリに移動し、./sos の後に目的の操作で必要なオプションを入力します。
./sos --option-1 --option-2 ... --option-n
SoS ユーティリティのヘルプ オプション
これらのオプションを使用して、SoS ツール自体に関する情報を表示します。
| オプション | 説明 |
|---|---|
|
|
使用可能な SoS ツール オプションのサマリを提供します。 |
|
|
SoS ツールのバージョン番号を提供します。 |
SoS ユーティリティの一般オプション
これらは、SoS ユーティリティの一般オプションです。
| オプション | 説明 |
|---|---|
--configure-sftp |
ログの SFTP を構成します。 |
--debug-mode |
SoS ツールをデバッグ モードで実行します。 |
--force |
導入後に
VMware Cloud Builder アプライアンスから SoS 操作を実行できるようにします。
注： ほとんどの場合、このオプションを使用することはお勧めしません。ブリングアップが完了すると、
SDDC Manager 仮想マシン から直接 SoS ユーティリティを実行できます。
|
--history |
直近に実行された 20 件の SoS 操作を表示します。 |
--log-dir LOGDIR |
ログを保存するディレクトリを指定します。 |
--log-folder LOGFOLDER |
ログ ディレクトリの名前を指定します。 |
--setup-json SETUP_JSON |
ログ収集用のカスタム setup-json ファイル。 SoS は、実行されている環境に基づいて自動的にインベントリを作成します。事前定義されたコンポーネント セットのログを収集する場合は、setup.json ファイルを作成し、そのファイルを入力として SoS に渡すことができます。サンプルの JSON ファイルを VMware Cloud Builderの /opt/vmware/sddc-support/ ディレクトリで入手できます。 |
--skip-known-host-check |
ホストの SSL サムプリントについて指定されているチェックを既知のホストでスキップします。 |
--zip |
出力用の圧縮された tar ファイルを作成します。 |
SoS ユーティリティのログ ファイルのオプション
| オプション | 説明 |
|---|---|
--api-logs |
API からの出力を収集します。 |
--cloud-builder-logs |
Cloud Foundation Builder のログを収集します。 |
--esx-logs |
ESXi ホストからのみログを収集します。 ログは、環境で使用可能な各 ESXi ホストから収集されます。 |
--no-clean-old-logs |
このオプションを使用して、前回の収集実行時の出力が削除されないようにします。 デフォルトでは、出力がディレクトリに書き込まれる前に、存在している可能性のある前回の実行時の出力ファイルが削除されます。古い出力ファイルを保持する場合は、このオプションを指定します。 |
--no-health-check |
ログ収集の一部として実行された健全性チェックをスキップします。 |
--nsx-logs |
NSX Manager インスタンスからのみログを収集します。 |
--rvc-logs |
Ruby vSphere Console (RVC) からのみログを収集します。RVC は ESXi および vCenter Server のインターフェイスです。
注： Bash シェルが vCenter Server で有効になっていない場合、RVC ログ収集はスキップされます。
注： デフォルトでは、RVC ログは ./sos ログ収集では収集されません。
|
--sddc-manager-logs |
SDDC Manager からのみログを収集します。 |
--test |
ファイルを検証してテスト ログを収集します。 |
--vc-logs |
vCenter Server インスタンスからのみログを収集します。 ログは、環境内の各 vCenter Server から収集されます。 |
--vm-screenshots |
すべての仮想マシンからスクリーンショットを収集します。 |
SoS ユーティリティの JSON ジェネレータ オプション
./sos --jsongenerator --jsongenerator-input JSONGENERATORINPUT --jsongenerator JSONGENERATORDESIGN
| オプション | 説明 |
|---|---|
--jsongenerator |
JSON ジェネレータ ユーティリティを起動します。 |
--jsongenerator-input JSONGENERATORINPUT |
JSON ジェネレータ ユーティリティで使用する入力ファイルへのパスを指定します。例：/tmp/vcf-ems-deployment-parameter.xlsx。 |
--jsongenerator-design JSONGENERATORDESIGN |
VMware Cloud Foundation に vcf-public-ems を使用します。 |
--jsongenerator-supress |
ディレクトリを強制的にクリーンアップするための確認を抑制します。（オプション） |
--jsongenerator-logs JSONGENERATORLOGS |
ログに使用するディレクトリを設定します。（オプション） |
SoS ユーティリティのプラットフォーム監査オプション
プラットフォーム監査オプションは、コマンド ラインから検証タスクを実行する方法を提供し、個々のタスクまたは一括ですべてのタスクを検証する柔軟性があります。個々のタスクを検証すると、タスクが成功するまで繰り返し検証できるので、トラブルシューティング プロセスを迅速化できます。
./sos --platformaudit --platformaudit-input FILE
| オプション | 説明 |
|---|---|
--platformaudit |
プラットフォーム監査操作を起動します。 |
--platformaudit-dependency |
依存関係を持つ監査テストを実行します。 |
--platformaudit-input FILE |
プラットフォーム監査ユーティリティで使用する JSON 入力ファイルへのパスを指定します。 |
--platformaudit-stop |
実行中のすべてのプラットフォーム監査プロセスを終了します。 |
--platformaudit-modules MODULE1,MODULE2,MODULE3 |
実行する特定の監査テストを指定します。複数のテストを指定する場合は、モジュールをカンマで区切ります。 |
--platformaudit-output OUTPUT |
指定したファイルに出力を保存します。 |
--platformaudit-reason |
失敗したテストまたはスキップされたテストの原因を出力します。 |
--platformaudit-tree |
使用可能な監査テストのリストを表示します。 |
SoS ユーティリティの健全性チェック オプション
SoS ユーティリティを使用して、接続、コンピューティング、ストレージなど、さまざまなコンポーネントまたはサービスでの健全性チェックを実行できます。
--force パラメータが必要です。このパラメータは、ブリングアップ プロセス中に
VMware Cloud Builder によって展開された
SDDC Manager 仮想マシン を識別し、リモートで健全性チェックを実行するように SoS ユーティリティに指示します。例：
./sos --health-check --force
| オプション | 説明 |
|---|---|
--certificate-health |
コンポーネント証明書が有効（有効期限内）であることを確認します。 |
--connectivity-health |
接続の健全性チェックを実行して、ESXi ホスト、vCenter Server、NSX Manager 仮想マシン、SDDC Manager 仮想マシンなど、システムのさまざまなコンポーネントを ping できるかどうかを調べます。 |
--compute-health |
コンピューティングの健全性チェックを実行します。 |
--general-health |
すべてのソースにわたって ESXi エントリを検証し、ホストの Postgres DB 操作ステータスを確認し、ESXi のエラー ダンプを確認し、NSX Manager とクラスタのステータスを取得します。 |
--get-host-ips |
サーバ情報を返します。 |
--health-check |
使用可能なすべての健全性チェックを実行します。 |
--ntp-health |
コンポーネントの時刻が VMware Cloud Builder アプライアンスの NTP サーバと同期されているかを確認します。 |
--services-health |
サービスの健全性チェックを実行して、サービスが実行中かどうかを確認します。 |
--run-vsan-checks |
プロアクティブな vSAN テストを実行して、vSAN ディスク内に仮想マシンを作成できるかどうかを検証します。 |
サンプル出力
次のテキストは、--ntp-health 操作の出力例です。
root@cloud-builder [ /opt/vmware/sddc-support ]# ./sos --ntp-health --skip-known-host --force Welcome to Supportability and Serviceability(SoS) utility! User passed --force flag, Running SOS from Cloud Builder VM, although Bringup is completed and SDDC Manager is available. Please expe ct failures with SoS operations. Health Check : /var/log/vmware/vcf/sddc-support/healthcheck-2020-02-11-23-03-53-24681 Health Check log : /var/log/vmware/vcf/sddc-support/healthcheck-2020-02-11-23-03-53-24681/sos.log SDDC Manager : sddc-manager.vrack.vsphere.local NTP : GREEN +-----+-----------------------------------------+------------+-------+ | SL# | Area | Title | State | +-----+-----------------------------------------+------------+-------+ | 1 | ESXi : esxi-1.vrack.vsphere.local | ESX Time | GREEN | | 2 | ESXi : esxi-2.vrack.vsphere.local | ESX Time | GREEN | | 3 | ESXi : esxi-3.vrack.vsphere.local | ESX Time | GREEN | | 4 | ESXi : esxi-4.vrack.vsphere.local | ESX Time | GREEN | | 5 | vCenter : vcenter-1.vrack.vsphere.local | NTP Status | GREEN | +-----+-----------------------------------------+------------+-------+ Legend: GREEN - No attention required, health status is NORMAL YELLOW - May require attention, health status is WARNING RED - Requires immediate attention, health status is CRITICAL Health Check completed successfully for : [NTP-CHECK]
次のテキストは、--vm-screenshots ログ収集操作の出力例です。
root@cloud-builder [ /opt/vmware/sddc-support ]# ./sos --vm-screenshots
--skip-known-host --force
Welcome to Supportability and Serviceability(SoS) utility!
User passed --force flag, Running SOS from Cloud Builder VM, although Bringup is completed
and SDDC Manager is available. Please expect failures with SoS operations.
Logs : /var/log/vmware/vcf/sddc-support/sos-2018-08-24-10-50-20-8013
Log file : /var/log/vmware/vcf/sddc-support/sos-2018-08-24-10-50-20-8013/sos.log
Log Collection completed successfully for : [VMS_SCREENSHOT]
