Collecting diagnostic information for VMware Cloud Foundation for Service Providers

Products

• VMware Cloud Foundation

Issue/Introduction

This article provides procedures for obtaining diagnostic information for VMware Cloud Foundation for Service Providers.

VMware Technical Support routinely requests diagnostic information when a support request is handled. This diagnostic information contains product specific logs, configuration files, and data appropriate to the situation. The information is gathered using a specific script or tool for each product and can include a host support bundle from the ESXi host and vCenter Server support bundle. Data collected in a host support bundle may be considered sensitive. Additionally, as of vSphere 6.5, support bundles can include encrypted information from an ESXi host. For more information on what information is included in the support bundles, see Data collected when gathering diagnostic information from vSphere products.

Resolution

Collect diagnostic information for VMware Cloud Foundation for Service Providers from the Node Manager virtual machine.

 

To collect the diagnostic information:

1. Log in to the Node Manager virtual machine as the root user through SSH or console.
   
   Note: This virtual machine can be identified in the vSphere Client by its name: sddc-manager.
    
2. Run this command to generate the diagnostic bundle:
   
   /opt/vmware/sddc-support/sos
   
   Note: A progress indicator displays the overall progress and which logs have been collected. On completion, the system will output something similar to:
   
   Welcome to Supportability and Serviceability(SoS) utility!
Logs : /var/tmp/sos-2017-06-21-15-46-58-10974
Log file : /var/tmp/sos-2017-06-21-15-46-58-10974/sos.log
Log Collection completed successfully for : [SDDC-MANAGER, SDDC-CASSANDRA, PSC, ESX, NSX, vCenter Server, HEALTH-CHECK]
   
   
3. Verify that a folder containing the exported diagnostic logs is present in the /var/tmp folder:
   
   ls -lah /var/tmp/sos-$(date +%Y-%m-%d)*/
   
   Example output:
   
   total 2.3M
drwxr-xr-x 7 root root 4.0K Jun 21 15:47 .
drwxrwxrwt 4 root root 4.0K Jun 21 15:46 ..
drwxr-xr-x 2 root root 4.0K Jun 21 15:51 esx
-rw-r--r-- 1 root root 3.9K Jun 21 15:47 health-report.log
-rw-r--r-- 1 root root 11K Jun 21 15:47 health-results.json
drwxr-xr-x 2 root root 4.0K Jun 21 15:48 nsx
drwxr-xr-x 2 root root 4.0K Jun 21 15:49 psc
-rw-r--r-- 1 root root 1.9M Jun 21 15:46 sddc-201706211546.tgz
drwxr-xr-x 2 root root 4.0K Jun 21 15:47 sddc-cassandra
-rw-r--r-- 1 root root 262K Jun 21 15:51 sos.log
drwxr-xr-x 2 root root 4.0K Jun 21 15:48 vc
   
   
4. Create a compressed archive of the diagnostic bundle:
   
   tar -zcvf /var/tmp/$(ls -d /var/tmp/sos-$(date +%Y-%m-%d)* |awk -F/ '{print $4}').tgz /var/tmp/sos-$(date +%Y-%m-%d)*
   
   Note: Output should be similar to the following:
   
   
   /var/tmp/sos-2017-06-21-15-46-58-10974/

   /var/tmp/sos-2017-06-21-15-46-58-10974/nsx/

   /var/tmp/sos-2017-06-21-15-46-58-10974/nsx/VMware-NSX-Contoller-tech-support-10.0.0.6-controller-2.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/nsx/VMware-NSX-Contoller-tech-support-10.0.0.6-controller-3.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/nsx/VMware-NSX-Contoller-tech-support-10.0.0.6-controller-1.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/nsx/VMware-NSX-Manager-tech-support-nsxmanager.domain.local.tar.gz

   /var/tmp/sos-2017-06-21-15-46-58-10974/psc/

   /var/tmp/sos-2017-06-21-15-46-58-10974/psc/vm-support-psc-1.domain.local.tar.gz

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/SmartInfo-esxi-4.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/SmartInfo-esxi-1.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/esx-esxi-2.domain.local.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/vsan-health-esxi-3.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/esx-esxi-1.domain.local.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/esx-esxi-3.domain.local.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/vsan-health-esxi-4.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/vsan-health-esxi-1.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/SmartInfo-esxi-3.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/vsan-health-esxi-2.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/esx-esxi-4.domain.local.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/esx/SmartInfo-esxi-2.domain.local.txt

   /var/tmp/sos-2017-06-21-15-46-58-10974/sos.log

   /var/tmp/sos-2017-06-21-15-46-58-10974/vc/

   /var/tmp/sos-2017-06-21-15-46-58-10974/vc/vc-vcenter-1.domain.local-vm-support.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/sddc-cassandra/

   /var/tmp/sos-2017-06-21-15-46-58-10974/sddc-cassandra/cassandra-bundle.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/health-results.json

   /var/tmp/sos-2017-06-21-15-46-58-10974/sddc-201706211546.tgz

   /var/tmp/sos-2017-06-21-15-46-58-10974/health-report.log
5. Use a file transfer utility to copy the resultant /var/tmp/sos-date.tgz file from the Node Manager virtual machine to a system that can upload the file to VMware.
   
   Note: date is the actual date when the file is generated.

Additional Information

Additional parameters can be passed to the /opt/vmware/sddc-support/sos command to limit which logs are collected or to redirect the the collected logs to a location other than /var/tmp:

 

/opt/vmware/evosddc-support/sos -h

usage:

 

##################################################

# THIS IS THE EXTERNAL VERSION OF LOG COLLECTION #

##################################################

# specify options in the conventional GNU/POSIX syntax, "--" for long option

and "-" for short option

 

 

optional arguments:

-h, --help show this help message and exit

-v, --version displays SoS version

-l, --list list all supported log collection

 

Log Collections commands:

--log-folder LOGFOLDER

Name of the directory

--appliance-logs Collect logs from Appliances such as VC, PSC, NSX etc.

Do not club this option with --product-logs

--product-logs Collect logs from internal product such SDDC-Manager

and Cassandra. Do not club this option with

--appliance-logs

--no-esx-logs Do not collect esx host logs

--no-vc-logs Do not collect VC logs

--no-sddc-logs Do not collect SDDC-Manager logs

--no-cassandra-logs Do not collect Cassandra logs

--no-psc-logs Do not collect PSC logs

--no-nsx-logs Do not collect NSX logs

--no-cloud-builder-logs

Do not collect Cloud Builder logs

--no-cloud-builder-cassandra-logs

Do not collect Cassandra logs from Cloud Builder VM

--log-dir LOGDIR Dump logs to given directory

--dump-only-sddc-java-threads ONLYSDDCJAVATHREADS

Dump only SDDC-Manager Java threads, ignore other logs

(Collected default with entire sos logs)

--debug-mode Debug mode

--no-clean-old-logs Do not clean old log folder

--test Sanity test logs collected by verifying the files.

--no-health-check Skip Health Check executed as part of SoS log

collection

 

Health Check:

--health-check Perform all available Health Checks

--connectivity-health

Perform Connectivity Health Check

--services-health Perform Services Health Check

--compute-health Perform Compute Health Check