vm-support

Section: User Commands (1)
Index Return to Main Contents

BSD mandoc
VMnix  

NAME

vm-support - Script for gathering debugging information.  

SYNOPSIS

vm-support OPTIONS  

COPYRIGHT

VMware ESX Server is Copyright 2004-2006 VMware, Inc. All rights reserved.  

DESCRIPTION

vm-support is script creates a tar archive containing debugging information about the server. vm-support has three main uses: gathering general debugging information, gathering performance information, gathering information about a specific virtual machine. A gzipped tar archive containing the gathered data is created in the current directory. The resulting tar archive will be named esx-{date}.{PID}.tgz.

 

GENERAL OPTIONS


-n

   Causes all core files to be left out of the tar archive.  Mutually 
   exclusive with the -a option.

-N

   Causes all service console core files to be left out of the tar 
   archive.  Mutually exclusive with the -a option.  

-a

   Causes all core files to be included -- even those from previous 
   invocations of this script.  Mutually exclusive with the -n and 
   -N options.

-q

   Makes vm-support run in quiet mode. Suppresses some of the less 
   pertinent printouts.

-w

   Sets the working directory used for the output files. This is the 
   directory where vm-support will save the final tar archive. If this
   option is not specified, the working directory will be the directory
   from which vm-support is run. Note: Using a working directory on the 
   VMFS is normally disallowed.

-f

   Allows you to force vm-support to use a VMFS working directory.

-l

   Prints the list of files that are being collected.

-h

   Prints a friendly help message.

 

PERFORMANCE OPTIONS

-s

   Takes performance snapshots in addition to normal debugging 
   information.  Mutually exclusive with the -S option.

-S

   Takes only performance snapshots.  Mutually exclusive with 
   the -s option.

-d seconds

   Duration of snapshot.  Default 300 seconds.

-i seconds

   Time in seconds to sleep between each snapshot.  Default: autodetect.

 

VIRTUAL MACHINE OPTIONS

-x

   Lists available virtual machines and corresponding world ids for 
   use with the -X options.

-X world id

   Takes only debugging information for the specified world. Will
   generate core files for the virtual machine associated with the
   specified world.

-Z world id

   Takes only debugging information for the specified world. Will
   generate core files for the virtual machine associated with the
   specified world. Will also suspend the VM and add the VM's 
   memory state to the support file.

 

EXAMPLES

vm-support


    Gathers general debugging information.

vm-support -S


   Takes performance snapshots, at the default interval for the default 
   duration.

vm-support -s -i 10 -d 600


   Gathers general debugging information and takes a perforamance 
   snapshot every 10 seconds for 10 minutes.

vm-support -x


   Lists the running virtual machines for use with vm-support -X.

vm-support -X 314
   
   Gathers only virtual machine specific debugging information for the 
   virtual machine 314.

 

TROUBLESHOOTING


   Make sure there is enough disk space in the current directory.  
   Temporary files created during the running of vm-support quite 
   large.


   If vm-support never completes check for dead or not responding nfs or 
   smbfs mounts.


 

Index

NAME
SYNOPSIS
COPYRIGHT
DESCRIPTION
GENERAL OPTIONS
PERFORMANCE OPTIONS
VIRTUAL MACHINE OPTIONS
EXAMPLES
TROUBLESHOOTING