XenServer 6.1.0 is supplied with two versions of the XenServer Tools (sometimes known as the Windows PV drivers). The standard version (as installed using the installwizard.msi wizard), and the legacy version (installed using the xenlegacy.exe wizard).
The standard XenServer Tools do not include support for Volume Shadow Copy Service (VSS) or Citrix Provisioning Services (PVS). For customers who wish to use VSS or PVS, the legacy XenServer Tools must be used.
This document contains procedures on how to install the legacy XenServer Tools and procedures for switching between the standard and legacy XenServer Tools. This includes the following scenarios:
- Installing the legacy XenServer Tools on a new VM.
- Installing the legacy XenServer Tools on a VM which already has the standard XenServer Tools installed.
This document also describes how to reinstall the standard XenServer Tools having previously uninstalled them.
WARNING: Customers should take great care when carrying out these instructions. Failure to do so may result in unbootable VMs.
Administrative access to a XenServer host console either directly, through SSH, or by using the Console tab in XenCenter and administrative console access to the VM.
Note: During this procedure, network access to the VM may be lost temporarily.
The standard XenServer Tools do not support VSS which is used for quiesced snapshots. Additionally, these Tools contain a known issue, where PVS delivered VMs are unable to identify their resident host. This means that customers using XenServer Platinum Licensing are unable to license their PVS VMs.
Installing legacy XenServer Tools
Before installing the legacy XenServer Tools, customers who have already installed the standard XenServer Tools must remove them:
Removing the standard XenServer Tools
- In the VM, click the Start button, point to Control Panel, select Programs and then Programs and Features.
- Select each of the following programs, and then click Uninstall:
- Windows Driver Package – Citrix Systems Inc. (xenbus) System
- Windows Driver Package – Citrix Systems Inc. (xennet) Net
- Windows Driver Package – Citrix Systems Inc. (xenvif) System
- Windows Driver Package – Citrix Systems Inc. (xeniface) System
- Windows Driver Package – Citrix Systems Inc. (xenvbd) SCSIAdapter
- Citrix XenServer Tools Installer
- Citrix XenServer Windows Guest Agent
Note: When uninstalling the Windows driver packages, a Remove Driver warning dialog box will be displayed. Click Yes to this dialog.
Installing legacy XenServer Tools
Before the legacy Tools can be installed, the VM metadata must be switched to a state that is compatible with them. To do this, execute the following commands on the XenServer host console:
- Run the following command to find the VM UUID:
This returns a list of all VMs, note the UUID of the VM.
- Set the state of the VM to be compatible with the legacy tools by running the following command:
xe vm-param-set uuid=
- Reboot the VM.
The VM is now in a state compatible for use with the legacy XenServer Tools.
- Ensure xs-tools.iso is mounted in the VM’s virtual CD/DVD drive.
- In Windows Explorer, navigate to the XenServer Tools CD. Select it, right-click and from the shortcut menu, select Open. This displays the contents of the CD.
- Double click xenlegacy.exe.
- Follow the on-screen instructions, rebooting the VM when prompted.
To reinstall the standard XenServer Tools
Customers who wish to return to using the standard tools should carry out the steps in the procedure below.
WARNING: This procedure should only be used after following the uninstall procedure above. Carrying out the procedure below before manually removing the standard tools may result in the VM becoming unbootable.
Note: Failure to follow the procedure below may result in the XenServer Tools installer hanging, this can be resolved by cancelling the installation and following the procedure.
- Ensure that the xs-tools.iso is mounted in the VM’s virtual CD/DVD drive.
- In Windows Explorer, navigate to the XenServer Tools CD. Select it, right-click and from the shortcut menu, select Open.This displays the contents of the CD.
- Depending on your operating system type, right-click on citrixxendriversx86.msi or citrixxendriversx64.msi and from the shortcut menu, click Uninstall.
- Double click on installwizard.msi, and follow the on-screen instructions, allowing the VM to reboot automatically.
If the XenServer Tools Installation Wizard hangs, customers should carry out the following steps:
- Cancel the XenServer Tools Installation wizard.
- Open the Windows Device Manager, and find the devices under Other devices. For each device:
- Right click on the device, and from the short-cut menu, select Update Driver Softwareâ¦. This displays the Update Driver Software Window.
- Select Search automatically for updated driver software.
- At the next prompt, select Don’t search online.
- This installs the Citrix driver. When the installation has completed, click Close, and if prompted restart the VM. Repeat this procedure for the other devices in the Other Devices list.
- When the VM restartrs, in Windows Explorer, navigate to the XenServer Tools CD. Select it, right-click and from the shortcut menu, selectOpen. This displays the contents of the CD.
- Double-click on installwizard.msi. This displays the XenServer Tools Installation Wizard, click Remove.
- When the uninstallation has completed, click Install tools.
The XenServer Tools should now display as Optimized in the VM’s General tab in XenCenter.