Using PuTTY to capture serial-line logs from ESX/ESXi hosts

Products

• VMware vSphere ESXi

Issue/Introduction

This article describes a method to capture logs from ESX/ESXi hosts via a serial port using the third-party software PuTTY.

Note: VMware does not endorse or recommend any particular third party utility.

This article assumes:

• The ESX/ESXi host is properly configured to send logs to the serial port. For more information, see Enabling serial-line logging for an ESX and ESXi host (1003900).
• PuTTY is installed and working on a Windows computer.
• The ESX/ESXi host's serial communications port is connected to the computer running PuTTY using a serial null-modem cable.

Resolution

PuTTY can be configured to capture log text arriving on a serial port and to record it to files on the disk.

To configure PuTTY to capture logs:

1. Download PuTTY from http://www.chiark.greenend.org.uk/~sgtatham/putty/.
   
   Note: The preceding link was correct as of February 25, 2011. If you find the link is broken, provide feedback and a VMware employee will update the link.
   
   
2. Open PuTTY.
3. Select the Connection Type Serial.
4. Enter COM1 or COM2 in the Serial Line field, depending on which serial port is connected.
5. Enter a serial baud rate to match the ESX/ESXi host. By default, ESX/ESXi use a serial baud rate of 115200.
6. Under Session in the left pane, select Logging.
7. Under Session logging, select the All session output option.
8. Specify a file name to record to the disk. Putty provides advanced options for automatically creating filenames. For more information on using the log file name options, see the PuTTY documentation.
   
   Note: The preceding link was correct as of February 25, 2011. If you find the link is broken, provide feedback and a VMware employee will update the link.
   
   
9. Click Open. PuTTY opens a terminal window. The logs received on the serial port are displayed on the screen and are written to the log file configured in Step 8.
   
   Note: To stop capturing logs, close the PuTTY window.

Additional Information

THE CONTENT OF THIS ARTICLE IS PROVIDED "AS-IS," AND TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, VMWARE DISCLAIMS ALL OTHER REPRESENTATIONS AND WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS CONTENT, INCLUDING THEIR FITNESS FOR A PARTICULAR PURPOSE, THEIR MERCHANTABILITY, OR THEIR NONINFRINGEMENT. VMWARE SHALL NOT BE LIABLE FOR ANY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE USE OF THIS CONTENT, INCLUDING DIRECT, INDIRECT, CONSEQUENTIAL DAMAGES, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF VMWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Enabling serial-line logging for an ESXi/ESXi host