How to configure console access on XenServer or Citrix Hypervisor

How to configure console access on XenServer or Citrix Hypervisor

book

Article ID: CTX228930

calendar_today

Updated On:

Description

This article is for customers running Citrix Hypervisor or XenServer who want to configure serial console access to their XenServer hosts.

In some support cases, serial console access to the XenServer host is required for debug purposes. The serial connection is to use with HyperTerminal (or similar application) to collect XenServer logs. Therefore, when setting up a XenServer configuration, Citrix recommends customers to configure serial console access. When hosts do not have physical serial port (such as a Blade server) or where suitable physical infrastructure is not available, customers must investigate if an embedded management device, such as Dell DRAC or HP iLO can be configured.

This article describes how to set up a serial (null modem cable) connection.

Requirements

  • 9-Pin Serial Null Modem Cable.

  • Serial COM Port on a computer running appropriate software to connect to the serial port, for example Microsoft HyperTerminal.

  • Serial COM Port on a XenServer Host.

Or

  • A virtual serial port provided by a baseboard management controller such as Dell iDRAC or HP iLO.

  • A computer with appropriate software to connect to the virtual serial port, for example, for example ipmitool.


Instructions

This procedure describes how to set up a serial cable connection from a XenServer host for use with a computer running a terminal emulator - such as Microsoft's HyperTerminal. The HyperTerminal output is captured when an error is triggered by XenServer.

  1. If you are not using COM1 on your server, edit your grub.cfg file.
    • For legacy boot the grub.cfg file is located in the /boot/grub directory.
    • For UEFI boot the grub.cfg file is located in the /boot/efi/EFI/xenserver directory.
  2. Locate the following line:
    • serial --unit=0 --speed=115200
  3. Edit the value of --unit to be n-1, where <n> represents your COM port number: 
    • For example, to use COM2, set the value of --unit to be 1:
    • serial --unit=1 --speed=115200
  4. Locate the line in the menuentry 'XenServer (Serial)' section where the following text is displayed: 
    • com1=115200,8n1 console=com1,vga
  5. Replace com1 with com<n>, where <n> represents your COM port number.
  6. Start or reboot the XenServer host.
  7. From the grub menu, select XenServer (Serial).

XenServer starts with serial console support and customers can connect Microsoft's HyperTerminal (or a similar terminal emulator) to the serial console.

Issue/Introduction

This article is for customers running XenServer who want to configure serial console access to their XenServer hosts.

Additional Information