このセクションには、SoS ユーティリティで使用できる特定のオプションが記載されています。
SoS ユーティリティを使用したログ ファイルの収集の詳細については、VMware Cloud Foundation システムのログの収集を参照してください。
SoS ユーティリティのヘルプ オプション
sudo /opt/vmware/sddc-support/sos --option-nameプロンプトが表示されたら、 vcf パスワードを入力します。
| オプション | 説明 |
|---|---|
|
|
使用可能な SoS ユーティリティ オプションのサマリを提供します。 |
|
|
SoS ユーティリティのバージョン番号を提供します。 |
SoS ユーティリティの一般オプション
sudo /opt/vmware/sddc-support/sos --option-nameプロンプトが表示されたら、 vcf パスワードを入力します。
| オプション | 説明 |
|---|---|
--history |
直近に実行された 20 件の SoS 操作を表示します。 |
--force |
ワークフローの実行中に SoS 操作を実行できるようにします。
注： このオプションは使用しないことをお勧めします。
|
--configure-sftp |
ログの SFTP を構成します。 |
--setup-json SETUPJSON |
ログ収集用のカスタム setup-json ファイル。 SoS は、実行されている環境に基づいて自動的にインベントリを作成します。事前定義されたコンポーネント セットのログを収集する場合は、setup.json ファイルを作成し、そのファイルを入力として SoS に渡すことができます。サンプルの JSON ファイルを SDDC Manager アプライアンス の /opt/vmware/sddc-support/setup.sample.json で入手できます。 |
--log-folder LOGFOLDER |
ログ ディレクトリの名前を指定します。 |
--log-dir LOGDIR |
ログを保存するディレクトリを指定します。 |
--enable-stats |
SoS 実行統計の収集を有効にします。 |
--debug-mode |
SoS ユーティリティをデバッグ モードで実行します。 |
--zip |
出力用の圧縮された tar ファイルを作成します。 |
--short |
障害と警告についてのみ詳細な健全性結果を表示します。 |
--domain-name DOMAINNAME |
SoS 操作を実行するワークロード ドメインの名前を指定します。 すべてのワークロード ドメインで操作を実行するには、
注：
--domain-name フラグとワークロード ドメイン名を省略すると、管理ドメインのみで SoS 操作が実行されます。
|
--clusternames CLUSTERNAMES |
ESXi およびワークロード管理 (WCP) ログを収集するワークロード ドメインに関連付けられている vSphere クラスタ名を指定します。 vSphere クラスタのカンマ区切りのリストを入力します。たとえば、
注：
--domain-name ALL を指定すると、 |
--skip-known-host-check |
ホストの SSL サムプリントについて指定されているチェックを既知のホストでスキップします。 |
--include-free-hosts |
使用中の ESXi ホストに加えて、使用されていない ESXi ホストのログを収集します。 |
--include-precheck-report |
このオプションにより、LCM アップグレードの事前チェックが実行され、LCM アップグレードの事前チェックの実行レポートを SoS 健全性チェック操作に含めます。 |
SoS ユーティリティの VMware Cloud Foundation サマリ オプション
sudo /opt/vmware/sddc-support/sos --option-nameプロンプトが表示されたら、 vcf パスワードを入力します。
| オプション | 説明 |
|---|---|
--get-vcf-summary |
CEIP、ワークロード ドメイン、vSphere クラスタ、ESXi ホスト、ライセンス、ネットワーク プール、SDDC Manager、および VCF サービスなど、VMware Cloud Foundation システムに関する情報を返します。 |
--get-vcf-tasks-summary |
タスクの作成時刻やタスクのステータスなど、VMware Cloud Foundation のタスクに関する情報を返します。 |
--get-vcf-services-summary |
SDDC Manager のアップタイムと VMware Cloud Foundation サービス（LCM など）の開始および停止に関する情報を返します。 |
SoS ユーティリティの修正オプション
./sos --option-name
修正オプションでは、ワークロード ドメインを指定しない場合、コマンドは管理ドメインのみに影響します。
| オプション | 説明 |
|---|---|
|
|
指定されたワークロード ドメインのすべて ESXi ノードに SSH を適用します。
|
|
|
指定されたワークロード ドメインのすべて ESXi ノードで SSH を無効にします。
|
|
|
指定されたワークロード ドメインの vCenter Server で SSH を適用します。
|
|
|
指定されたワークロード ドメインの vCenter Server で SSH を無効にします。
|
|
|
指定されたワークロード ドメインのすべて ESXi ノードで通常ロックダウン モードを適用します。
|
|
|
指定されたワークロード ドメインの ESXi ノードで通常ロックダウン モードを無効にします。
|
--ondemand-service ONDEMANDSERVICE |
特定のワークロード ドメインの ESXi ホスト、vCenter Server、または SDDC Manager エンティティでコマンドを実行します。--domain-name DOMAINNAME を使用してワークロード ドメインを指定します。ONDEMANDSERVICE を .yml 入力ファイルへのパスに置き換えます（サンプル ファイルは /opt/vmware/sddc-support/ondemand_command_sample.yml にあります）。
注意: このオプションを使用する前に、Broadcom サポートにご連絡ください。
|
--ondemand-service JSON file path |
このフラグを含めると、ワークロード ドメイン内のすべての ESXi ホストでコマンドを JSON 形式で実行できます。たとえば、/opt/vmware/sddc-support/<JSON ファイル名> とします。 |
--refresh-ssh-keys |
SSH キーを更新します。 |
SoS ユーティリティの健全性チェック オプション
sudo /opt/vmware/sddc-support/sos --option-nameプロンプトが表示されたら、 vcf パスワードを入力します。
緑色のステータスは健全性が正常、黄色は注意が必要という警告、赤色（重大）はコンポーネントに緊急対応が必要ということを示します。
| オプション | 説明 |
|---|---|
--health-check |
使用可能なすべての健全性チェックを実行します。 --run-vsan-checks と組み合わせることができます。例：
sudo /opt/vmware/sddc-support/sos --health-check --run-vsan-checks |
--connectivity-health |
SDDC リソース（NSX Manager、ESXi ホスト、vCenter Server など）の接続チェックと検証を実行します。このチェックでは、SDDC リソースの ping ステータス チェック、SSH 接続ステータス チェック、および API 接続チェックを実行します。 |
--services-health |
サービスの健全性チェックを実行して、SDDC Manager や vCenter Server 内でサービス（ライフサイクル管理サーバなど）が実行されているかどうかを確認します。 |
--compute-health |
ESXi ホストのライセンス、ディスク ストレージ、ディスク パーティション、健全性ステータスなどのコンピューティングの健全性チェックを実行します。 |
--storage-health |
ESXi ホストおよび vSphere クラスタの vSAN ディスクの健全性チェックを実行します。 --run-vsan-checks と組み合わせることができます。例：
sudo /opt/vmware/sddc-support/sos --storage-health --run-vsan-checks |
--run-vsan-checks |
このオプションは単独で実行することはできず、--health-check または --storage-health と組み合わせる必要があります。仮想マシン作成テストを実行し、vSAN クラスタの健全性を確認します。このテストを実行すると、vSAN クラスタの各ホストに仮想マシンが作成されます。このテストでは、仮想マシンの作成と削除が行われます。仮想マシンの作成タスクと削除タスクが成功した場合は、vSAN クラスタ コンポーネントが正常に動作しており、クラスタが機能しているものと想定します。
注： ネットワーク トラフィックが作成され、vSAN ワークロードに影響するため、本番環境ではプロアクティブ テストを実行しないでください。
|
--ntp-health |
コンポーネントの時刻が SDDC Manager アプライアンスの NTP サーバと同期されているかを確認します。また、ESXi ホストのハードウェアとソフトウェアのタイムスタンプが SDDC Manager アプライアンスの時刻と 5 分以内の誤差であることも確認されます。 |
--dns-health |
正引きおよび逆引きの DNS の健全性チェックを実行します。 |
--general-health |
ESXi のエラー ダンプを確認し、NSX Manager とクラスタのステータスを取得します。 |
--certificate-health |
コンポーネント証明書の有効性と有効期限を確認します。
|
--get-host-ips |
ESXi ホストのホスト名と IP アドレスを返します。 |
--get-inventory-info |
vCenter Server、NSX、SDDC Manager、ESXi ホストなどの VMware Cloud Foundation コンポーネントのインベントリの詳細を返します。必要に応じて、すべてのワークロード ドメインの詳細を返すフラグ |
--password-health |
VMware Cloud Foundation コンポーネント間のパスワードのステータスをチェックします。VCF によって管理されるパスワードを含むコンポーネント、パスワードが最後に変更された日付、パスワードの有効期限、有効期限までの日数が一覧表示されます。
|
--hardware-compatibility-report |
ESXi ホストおよび vSAN デバイスを検証し、互換性レポートをエクスポートします。 |
--version-health |
この操作により、BOM コンポーネント（vCenter Server、NSX、ESXi、SDDC Manager）のバージョンがチェックされます。SDDC Manager インベントリ、実際にインストールされている BOM コンポーネントのバージョン、および BOM コンポーネントのバージョンを比較して、ドリフトを検出します。 |
--json-output-dir JSONDIR |
健全性チェックの結果を JSON ファイルとして、指定されたディレクトリ JSONDIR に出力します。 |
健全性チェック コマンドの例：
- 管理ドメインでのみパスワードの健全性を確認します。
./sos --password-health
- すべてのワークロード ドメインの接続の健全性を確認します。
./sos --connectivity-health --domain-name ALL
- sfo-w01 という名前のワークロード ドメインの DNS 健全性を確認します。
./sos --dns-health --domain-name sfo-w01
