Use the SoS tool to collect the logs for various software components in the environment. This Python tool resides in each SDDC Manager virtual machine in your Cloud Foundation environment.
About this task
After running the SoS tool, you can examine the resulting logs to troubleshoot issues, or provide to VMware Technical Support if requested. VMware Technical Support might request these logs to help resolve technical issues when you have submitted a support request. The diagnostic information collected using the SoS tool includes logs for the various VMware software components and software products deployed in your Cloud Foundation environment.
To collect the logs, run the SoS tool without specifying any component-specific options. To collect logs for a specific component, run the tool with the appropriate options. For a description of the SoS tool's options, see Supportability and Serviceability (SoS) Tool and Options.
You must have the root account credentials for the SDDC Manager instances in your Cloud Foundation environment. In each management domain, the SDDC Manager instance is the one whose virtual machine name starts with vrm. See Credentials for Logging In To the SDDC Manager (vrm) Virtual Machine.
When you run the tool from one rack and are collecting all logs for all racks, you must also provide the root account password for the other racks when prompted by the tool. If you want to collect logs only from a specific rack, you can run the tool using the
--rack rackname option to have the tool collect the logs only from that rack. See Supportability and Serviceability (SoS) Tool and Options for a description of that option.
Running the tool in the SDDC Manager instance that is assigned the VIP address is the best practice. You log in to that SDDC Manager instance using the root account credentials.
For a description of the VIP address and how to determine which SDDC Manager instance the VIP address is currently assigned to, see About the Primary Rack and the SDDC Manager Virtual IP Address.
- Using the root account, connect and log in, for example by SSH, to one of the SDDC Manager instances.
In a multirack environment, you can use any of the SDDC Manager instances in your installation's racks, although running the tool on the instance that has the VIP address is preferred. When you run the SoS tool from the SDDC Manager instance on one rack, the tool prompts for the root credentials for the instances on the other racks, collects log information from all of the racks, and writes the output to the filesystem of the instance where the command was initiated.
- Change to the /opt/vmware/evosddc-support directory.
- Depending on whether you have VDI workload domains in your environment, type the appropriate command to collect the logs and save to a named directory in the filesystem:
No VDI workload domains in the environment
./sos --log-dir named-output-dir
Where named-output-dir is the name of the directory to which you want to save the output files.
VDI workload domains in the environment
./sos --vdi-pass admin-password-for-VDI-environment-server-components --log-dir named-output-dir
Where admin-password-for-VDI-environment-server-components is the administrative account's password used by the server components in the VDI environment and named-output-dir is the name of the directory to which you want to save the output filesNote:
By default, before writing the output to the directory, the tool deletes the prior run's output files that might be present. If you want to retain the older output files, specify the
If you do not specify the
--log-diroption, the tool writes the output to the /var/tmp directory in the SDDC Manager VM where the command is run.
The tool displays
Welcome to SoS log collection utility!, the output directory, sos.log file location, and messages about the tool's progress, for example:
rack-1-vrm-1:/opt/vmware/evosddc-support # ./sos --log-dir /home/sos-logs --vdi-pass VDIadminpwd Welcome to SoS(Supportability and Serviceability) utility! Logs: /home/sos-logs/sos-2016-10-26-19-54-48-8666 Log file: /home/sos-logs/sos-2016-10-26-19-54-48-8666/sos.log Progress : 0%, Initiated log collection
If this is a multirack installation, you are prompted to enter the password for the SDDC Manager VM on each rack:
rack-1-vrm-1:/opt/vmware/evosddc-support # ./sos --log-dir /home/sos-logs Welcome to SoS(Supportability and Serviceability) utility! Please enter password for VRM (192.168.100.130):
The tool collects the log files from the various software components in all of the racks and writes the output to the directory named in the
--log-dir option. Inside that directory, the tool generates output in a specific directory structure.
The following example shows the output files to the rack-1 subdirectory level, for an installation consisting of one physical rack with six ESXi hosts, configured with a DNS subdomain of subdomain.example.com, and having one VDI workload domain. The SoS tool command was run on 1 November 2016. The command included the option
--log-dir /home/sos-logs to have the SoS tool write the output to the /home/sos-logs directory in the VRM VM's filesystem.
This example shows the results only down to the level of the rack-1 subdirectory. For details on the files the SoS tool creates in the output directories when collecting logs, see Component Log Files Collected By the SoS Tool.
/home/sos-logs sos-2016-11-01-21-22-46-17555 sos.log rack-1 esx hms N0_hms_logs_2016-11-01_09-25-22.zip #Directories with files, one per ESXi host N1_hms_logs_2016-11-01_09-25-35.zip N2_hms_logs_2016-11-01_09-25-38.zip N3_hms_logs_2016-11-01_09-25-29.zip N4_hms_logs_2016-11-01_09-25-23.zip N5_hms_logs_2016-11-01_09-25-29.zip loginsight loginsight-agent-rack-1-vc-1.subdomain.example.com-2016-11-01--21.31.26.zip #Directories with files, one per vCenter Server instance loginsight-agent-rack-1-vc-2.subdomain.example.com-2016-11-01--21.32.09.zip nsx psc switch vc vdi vrm.properties vrops 1,2,3-full-0.zip #Directory with files zk hms.tar.gz vrm-datetimestamp.tgz
When the environment has more than one rack, the output includes directories for each rack, according to the naming pattern rack-1, rack-2, rack-3, and so on. For details about the output files and directories the SoS tool typically creates, see Component Log Files Collected By the SoS Tool.
What to do next
Change to the output directory to examine the collected log files.