Search the VMware Knowledge Base (KB)
View by Article ID
“vm-support” command in ESX/ESXi to collect diagnostic information (1010705)
This article provides procedures for obtaining diagnostic information for a VMware ESXi/ESX host using the vm-support command line utility. For other methods of collecting the same information, see Collecting diagnostic information for VMware ESXi/ESX using the vSphere Client (653) and Collecting diagnostic information for VMware ESXi/ESX using the vSphere PowerCLI (1027932).
The diagnostic information obtained by using this article is uploaded to VMware Technical Support. To uniquely identify your information, use the Support Request (SR) number you receive when you create the new SR.
- For instructions on opening a support request, see How to File a Support Request.
- For instructions on uploading your support files, see Uploading diagnostic information to VMware (1008525).
- For instructions on obtaining diagnostic information for other VMware products, see Collecting diagnostic information for VMware products (1008524).
vm-supportutility is present on all versions of VMware ESXi/ESX, though some of the options available with the utility differ among versions.
Running vm-support in a console session on ESXi/ESX hostsThe traditional way of using the
vm-supportcommand-line utility produces a gzipped tarball (
.tgzfile) locally on the host. The resulting file can be copied off the host using FTP, SCP, or another method.
- Open a console to the ESX or ESXi host. For more information, see Unable to connect to an ESX host using Secure Shell (SSH) (1003807), Tech Support Mode for Emergency Support (1003677), or Using Tech Support Mode in ESXi 4.1 (1017910).
- Run the command:
Note: Additional options can be specified to customize the log bundle collection. Use the
vm-support -hcommand for a list of options available on a given version of ESXi/ESX.
- A compressed bundle of logs is produced and stored in a file with a
.tgzextension in one of these locations:
- The current working directory
- To export the log bundle to a shared vmfs datastore, use this command:
vm-support -f -w /vmfs/volumes/DATASTORE_NAME
-foption is not available in ESXi 5.x, ESXi/ESX 4.1 Update 3, and later.
- The log bundle is collected and downloaded to a client, upload the logs to the SFTP/FTP site. For more information, see Uploading diagnostic information to VMware (1008525).
Streaming vm-support output from an ESXi 5.x and 6.0 hostStarting with ESXi 5.0, the
vm-supportcommand-line utility supports streaming content to the standard output. This allows to send the content over an SSH connection without saving anything locally on the ESXi host.
- Enable SSH access to the ESXi shell. For more information, see Enable ESXi Shell and SSH Access with the Direct Console User Interface section in the vSphere Installation and Setup guide.
- Using a Linux or Posix client, such as the vSphere Management Assistant appliance, log in to the ESXi host and run the
vm-supportcommand with the streaming option enabled, specifying a new local file. A compressed bundle of logs is produced on the client at the specified location. For example:
ssh root@ESXHostnameOrIPAddress vm-support -s > vm-support-Hostname.tgz
Note: This requires you to enter a password for the root account, and cannot be used with lockdown mode.
- You can also direct the support log bundle to a desired datastore location using the same command (mentioning the destination path). For example:
ssh root@ESXHostnameOrIPAddress 'vm-support -s > /vmfs/volumes/datastorexxx/vm-support-Hostname.tgz'
- After the log bundle has been collected and downloaded to a client, upload the logs to the SFTP/FTP site. For more information, see Uploading diagnostic information to VMware (1008525).
HTTP-based download of vm-support output from an ESXi 5.x and 6.0 hostStarting with ESXi 5.0, the
vm-supportcommand-line utility can be invoked via HTTP. This allows you to download content using a web browser or a command line tool like
- Using any HTTP client, download the resource from:
For example, download the resource using the
wgetutility on a Linux or other Posix client, such as the vSphere Management Assistant appliance. A compressed bundle of logs is produced on the client at the specified location:
- After the log bundle is collected and downloaded to a client, upload the logs to the SFTP/FTP site. For more information, see Uploading diagnostic information to VMware (1008525).
vm-supportcommand-line utility for some versions of VMware ESX 2.x and 3.x. Ensure that the version of
vm-supporton each ESX host is up to date. The minimum version listed provides improvements required to protect the security of your data when providing support information to VMware. For more information about these security improvements, see Data Security Best Practices - SSL keys for communicating with Virtual Center and other applications (1008166).
Verifying the version of the vm-support utilityVerify that your version of
vm-supportis at least that listed for your version of ESXi/ESX:
- ESX Server 2.5.5 requires version 1.15 or higher
- ESX Server 3.0.x requires version 1.29 or higher
- ESXi/ESX Server 3.5 requires version 1.30 or higher
- ESXi/ESX Server 4.x requires version 1.29 or higher
- ESXi Server 5.x requires version 2.0 or higher
vm-supportcommand with no options and then cancel the collection, or run the command
vm-support --version. For example:
[user@esxhost]$ cd /tmp
VMware ESX Server Support Script 0.94
Preparing Files: |
[Ctrl+C to cancel]
[user@esxhost]$ vm-support --version
Updating the version of the vm-support utility on ESXTo update the
vm-supportutility on an ESX host:
- Open a console to the ESX host. For more information, see Unable to connect to an ESX host using Secure Shell (SSH) (1003807).
- Verify the version of the
- Make a backup of the existing
vm-supportutility using the command:
cp /usr/bin/vm-support /usr/bin/vm-support.old
- Download the appropriate file for your version of VMware ESX and place it in the
/tmp/directory in the service console of the ESX system.
Note: Read the Acceptance of Terms Notice before running this download.
Software Version Version Download Location md5sum ESX 2.5.5 1.15
ESX 3.0.1 1.29
ESX 3.0.2 1.29
ESX 3.0.3 1.29
ESX 3.5 1.30
ESXi/ESX 4.x 1.29 vm-support is up to date for ESXi/ESX 4, no updates are available. ESXi 5.x 2.0 vm-support is up to date for ESXi/ESX 5, no updates are available.
- Run this command to extract the archived file:
tar xvzf filename.tgz
- Verify that the MD5 sum of the
vm-supportfile in the attachment matches the value for your software version listed in the table above. For example:
- Copy the
vm-supportutility to the
/usr/bin/directory, replacing the original
Note: When running on an older version of ESX, the updated script might report errors about missing commands.
For more information, see Collecting performance snapshots using vm-support in ESX and ESXi (1967).
- Collecting diagnostic information for VMware vCenter Server and ESX/ESXi using the vSphere PowerCLI (1027932)
Request a Product Feature
To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.