XenServer VM Tools for Windows

XenServer VM Tools for Windows (formerly Citrix VM Tools) provide high performance I/O services without the overhead of traditional device emulation. XenServer VM Tools for Windows consist of I/O drivers (also known as paravirtualized drivers or PV drivers) and the Management Agent.

XenServer VM Tools for Windows must be installed on each Windows VM for the VM to have a fully supported configuration. A VM functions without them, but performance is hampered.

The version of the XenServer VM Tools for Windows is updated independently of the version of Citrix Hypervisor. Ensure that your XenServer VM Tools for Windows are regularly updated to the latest version, both in your VMs and in any templates that you use to create your VMs. For more information about the latest version of the tools, see Updates to XenServer VM Tools for Windows or What’s new.

Install XenServer VM Tools

Note:

To install XenServer VM Tools for Windows on a Windows VM, the VM must be running the Microsoft .NET Framework Version 4.0 or later.

Before you install the XenServer VM Tools for Windows, ensure that your VM is configured to receive the I/O drivers from Windows Update. Windows Update is the recommended way to receive updates to the I/O drivers. However, if Windows Update is not an available option for your VM, you can also receive updates to the I/O drivers through the Management Agent or update the drivers manually. For more information, see Update the I/O drivers.

To install XenServer VM Tools for Windows:

1. We recommend that you snapshot your VM before installing or updating the XenServer VM Tools.

2. Download the XenServer VM Tools for Windows file from the Citrix Hypervisor downloads page.

   1. Log in to your Citrix account to access the downloadable files.
   2. Expand the product sections on the Citrix Hypervisor downloads page and click into any supported version of Citrix Hypervisor.

   3. On the product page, go to the Citrix Hypervisor Main Components section.

      The XenServer VM Tools for Windows are available in a 32-bit and a 64-bit version.

   4. Download the MSI file and verify your download against the provided SHA256 value.

3. Copy the file to your Windows VM or to a shared drive that the Windows VM can access.

4. Run the managementagentxXX.msi file to begin XenServer VM Tools installation.

   Msiexec.exe /package managementagentxXX.msi
   

5. Follow the prompts in the installer.

   • Follow the instructions on the wizard to accept the license agreement and choose a destination folder.

   • Customize the settings on the Installation and Updates Settings page. The Citrix Hypervisor Windows Management Agent Setup wizard displays the recommended settings. By default, the wizard displays the following settings:

     • Install I/O Drivers Now
     • Allow automatic management agent updates
     • Disallow automatic I/O drivers updates by the management agent
     • Send anonymous usage information to Citrix

     If you do not want to allow the automatic updating of the Management Agent, select Disallow automatic management agent updates from the list.

     If you would like to allow the Management Agent to update the I/O drivers automatically, select Allow automatic I/O driver updates by the management agent. However, we recommend that you use Windows Update to update the I/O drivers, not the Management Agent.

     Note:

     If you have chosen to receive I/O driver updates through the Windows Update mechanism, do not allow the Management Agent to update the I/O drivers automatically.

     If you do not want to share anonymous usage information with Citrix, clear the Send anonymous usage information to Citrix check box. The information transmitted to Citrix contains the UUID of the VM requesting the update. No other information relating to the VM is collected or transmitted to Citrix.

   • Click Next and then Install to begin the XenServer VM Tools for Windows installation process.

6. Restart the VM when prompted to complete the installation process.

Note:

The XenServer VM Tools for Windows can request to restart with /quiet /norestart or /quiet /forcerestart specified after the VM has already been restarted once as part of the installation.

I/O drivers are automatically installed on a Windows VM that can receive updates from Windows Update. However, we recommend that you install the XenServer VM Tools for Windows to install the Management Agent, and to maintain a supported configuration.

Customers who install the XenServer VM Tools for Windows or the Management Agent through RDP might not see the restart prompt as it only appears on the Windows console session. To ensure that you restart your VM (if necessary) and to get your VM to an optimized state, specify the force restart option in RDP. The force restart option restarts the VM only if it is required to get the VM to an optimized state.

Silent installation

To install the XenServer VM Tools for Windows silently and to prevent the system from rebooting, run the following command:

Msiexec.exe /package managementagentx86.msi /quiet /norestart
Msiexec.exe /package managementagentx64.msi /quiet /norestart
<!--NeedCopy-->

A non-interactive, but non-silent installation can be obtained by running:

Msiexec.exe managementagentx86.msi /passive
Msiexec.exe managementagentx64.msi /passive
<!--NeedCopy-->

To customize the installation settings, use the following parameters with the silent installation commands:

For example, to do a silent install of the tools that does not allow future automatic management agent updates and does not send anonymous information to Citrix, run one of the following commands:

Msiexec.exe /package managementagentx86.msi ALLOWAUTOUPDATE=NO IDENTIFYAUTOUPDATE=NO /quiet /norestart
Msiexec.exe /package managementagentx64.msi ALLOWAUTOUPDATE=NO IDENTIFYAUTOUPDATE=NO /quiet /norestart
<!--NeedCopy-->

For interactive, silent, and passive installations, following the next system restart there might be several automated reboots before the XenServer VM Tools for Windows are fully installed. This behavior is also the case for installations with the /norestart flag specified. However, for installations where the /norestart flag is provided, the initial restart might be manually initiated.

The XenServer VM Tools for Windows are installed by default in the C:\Program Files\Citrix\XenTools directory on the VM.

Notes:

• To install XenServer VM Tools for Windows on a Windows VM, the VM must be running the Microsoft .NET Framework Version 4.0 or later.
• The /quiet parameter applies to the installation dialogs only, but not to the device driver installation. When the /quiet parameter is specified, the device driver installation requests permission to reboot if necessary.
  • When /quiet /norestart is specified, the system doesn’t reboot after the entire tools installation is complete. This behavior is independent of what the user specifies in the reboot dialog.
  • When /quiet /forcerestart is specified, the system reboots after the entire tools installation is complete. This behavior is independent of what the user specifies in the reboot dialog.
  • When the device driver installation requests permission to reboot, a tools installation with the quiet parameter specified can still be in progress. Use the Task Manager to confirm whether the installer is still running.

Warning:

Installing or upgrading the XenServer VM Tools for Windows can cause the friendly name and identifier of some network adapters to change. Any software which is configured to use a particular adapter might have to be reconfigured following XenServer VM Tools for Windows installation or upgrade.

Update XenServer VM Tools for Windows

Citrix Hypervisor has a simpler mechanism to update I/O drivers (PV drivers) and the Management Agent automatically for Windows VMs. This mechanism enables customers to install updates as they become available.

Ensure that your XenServer VM Tools for Windows are regularly updated to the latest version, both in your VMs and in any templates that you use to create your VMs.

We recommend that you snapshot your VM before installing or updating the XenServer VM Tools.

Important:

If you are currently using the 8.2.x.x drivers or earlier and want to use the Management Agent MSI file to update to the latest version of the drivers, you must use Device Manager to uninstall the 8.2.x.x drivers from your VM before installing these drivers. If you do not complete this step, the MSI install process fails.

We recommend using the following settings for updating the different components of the XenServer VM Tools for Windows:

1. Set the value of the following registry key to a REG_DWORD value of ‘3’: HKLM\System\CurrentControlSet\services\xenbus_monitor\Parameters\Autoreboot
2. Ensure that your VM is configured to receive I/O drivers from Windows Update.
3. Configure the Management Agent to automatically update itself.

The Virtualization state section on a VM’s General tab in XenCenter specifies whether the VM can receive updates from Windows Update. You can enable I/O driver updates through Windows Update when selecting a VM template in the New VM wizard in XenCenter. For details on enabling I/O driver updates through Windows Update, see Overview of VM creation steps. If you do not want to receive I/O driver updates from Windows Update, disable Windows Update on your VM, or specify a group policy.

Important:

Ensure that all requested VM restarts are completed as part of the update. Multiple restarts might be required. If all requested restarts are not completed, this might result in unexpected behavior.

The following sections contain information about automatically updating the Management Agent and the I/O drivers.

Update the Management Agent

Citrix Hypervisor enables you to update the Management Agent automatically on both new and existing Windows VMs. By default, Citrix Hypervisor allows the automatic updating of the Management Agent. However, it does not allow the Management Agent to update the I/O drivers automatically. You can customize the Management Agent update settings during XenServer VM Tools for Windows installation. The automatic updating of the Management Agent occurs seamlessly, and does not reboot your VM. In scenarios where a VM reboot is required, a message appears on the Console tab of the VM notifying users about the required action.

You can get the Management Agent updates automatically, provided:

• You are running Citrix Hypervisor 8.2 Premium Edition, or have access to Citrix Hypervisor through Citrix Virtual Apps and Desktops entitlement or Citrix DaaS entitlement.

• You have installed XenServer VM Tools for Windows issued with Citrix Hypervisor 7.0 or higher

• The Windows VM has access to the Internet

Manage Automatic Updates by using the CLI

Citrix Hypervisor enables you to use the command line to manage the automatic updating of the I/O drivers and the Management Agent. You can run msiexec.exe with the arguments listed in the following table to specify whether the I/O drivers and the Management Agent are automatically updated. For information about installing XenServer VM Tools for Windows by using msiexec.exe, see Silent installation.

Note:

For VMs managed using either PVS or MCS, automated updates are turned off automatically when the Citrix Virtual Desktops VDA is present and it reports that the machine is non-persistent.

For example:

msiexec.exe /i managementagentx64.msi ALLOWAUTOUPDATE=YES ALLOWDRIVERINSTALL=NO \
    ALLOWDRIVERUPDATE=NO IDENTIFYAUTOUPDATE=YES
<!--NeedCopy-->

Enable the Management Agent updates

To enable automatic updating of the Management Agent on a per-VM basis:

1. On the VM, open a command prompt as an administrator.

2. Run the following command:

   reg.exe ADD HKLM\SOFTWARE\Citrix\XenTools /t REG_DWORD /v DisableAutoUpdate /d 0
   <!--NeedCopy-->
   

To enable automatic updating of the Management Agent on a per-pool basis, run the following command in the host console:

xe pool-param-set uuid=pooluuid guest-agent-config:auto_update_enabled=true
<!--NeedCopy-->

Disable the Management Agent updates

To disable automatic updating of the Management Agent on a per-VM basis:

1. On the VM, open a command prompt as an administrator.

2. Run the following command:

   reg.exe ADD HKLM\SOFTWARE\Citrix\XenTools /t REG_DWORD /v DisableAutoUpdate /d 1
   <!--NeedCopy-->
   

To disable automatic updating of the Management Agent on a per-pool basis, run the following command in the host console:

xe pool-param-set uuid=pooluuid guest-agent-config:auto_update_enabled=false
<!--NeedCopy-->

Redirect the Management Agent updates

Citrix Hypervisor enables customers to redirect Management Agent updates to an internal web server before they are installed. This redirection allows customers to review the updates before they are automatically installed on the VM.

To redirect the Management Agent updates:

The Management Agent uses an updates file to get information about the available updates. The name of this updates file depends on the version of the Management Agent that you use:

• For Management Agent 9.2.1.35 and later use https://pvupdates.vmd.citrix.com/autoupdate.v1.json.
• For Management Agent 9.0.0.0 to 9.2.0.27 https://pvupdates.vmd.citrix.com/updates.v9.json.

Complete the following steps to redirect the Management Agent updates:

1. Download the updates file.

2. Download the Management Agent MSI files referenced in the updates file.

3. Upload the MSI files to an internal web server that your VMs can access.

4. Update the updates file to point to the MSI files on the internal web server.

5. Upload the updates file to the web server.

Automatic updates can also be redirected on a per-VM or a per-pool basis. To redirect updates on a per-VM basis:

1. On the VM, open a command prompt as an administrator.

2. Run the command

   reg.exe ADD HKLM\SOFTWARE\Citrix\XenTools /t REG_SZ /v update_url /d \
       url of the update file on the web server
   <!--NeedCopy-->
   

To redirect automatic updating of the Management Agent on a per-pool basis, run the following command:

xe pool-param-set uuid=pooluuid guest-agent-config:auto_update_url=url of the update file on the web server
<!--NeedCopy-->

Update the I/O drivers

You can update the I/O drivers through Windows Update or by using the Management Agent. The Virtualization state section on a VM’s General tab in XenCenter indicates if the VM is eligible to receive updates from Windows Update. Alternatively, you can turn off automatic updates and manually manage I/O driver updates.

Each I/O driver (such as xennet, xenvif, xenvbd, xeniface, and xenbus) has its own version. For details on the latest versions, see What’s New.

Enable I/O driver updates through Windows Update

To get I/O driver updates automatically from Microsoft Windows Update, the following conditions must be met:

• You are running Citrix Hypervisor 8.2 Premium Edition, or have access to Citrix Hypervisor through Citrix Virtual Apps and Desktops entitlement or Citrix DaaS entitlement.

• You have created a Windows VM using XenCenter issued with Citrix Hypervisor 8.2

• Windows Update is enabled on the VM.

• The VM has internet access or it can connect to a WSUS proxy server.

• You are not running the Core version of Windows Server, as Windows Server Core does not support using Windows Update to install or update the I/O drivers.

You can enable I/O driver updates through Windows Update when selecting a VM template in the New VM wizard in XenCenter. For details on enabling I/O driver updates through Windows Update, see Overview of VM creation steps.

If you do not want to receive I/O driver updates from Windows Update, disable Windows Update on your VM, or specify a group policy.

Disable I/O driver updates through Windows Update

You can disable I/O driver updates through Windows Update for both new and existing VMs:

• For new VMs: When creating a new VM using the New VM wizard in XenCenter, you can disable automatic I/O driver updates by setting a flag. This is particularly important for Citrix Provisioning targets or reset-on-boot machines, where disabling automatic updates ensures stability. For more information, see Overview of VM creation steps. For advanced users who prefer to manage these settings by using the command line, see Create a Windows VM by using the CLI.

• For existing VMs: If the VM is already deployed, you can disable I/O driver updates by configuring a group policy. This ensures that the VM does not receive automatic updates from Windows Update.

Set the Management Agent to update the I/O drivers

During the XenServer VM Tools for Windows installation, you can configure the Management Agent to automatically update the I/O drivers. For more information, see Install XenServer VM Tools for Windows.

If you want to enable this setting after completing the installation, follow these steps:

1. On the VM, open a command prompt as an administrator.

2. Run the following command to allow automatic I/O driver updates:

   reg.exe ADD HKLM\SOFTWARE\Citrix\XenTools\AutoUpdate /t REG_SZ /v \
       InstallDrivers /d YES
   <!--NeedCopy-->
   

Stop the Management Agent from updating the I/O drivers

To prevent the Management Agent from updating the I/O drivers, perform the following steps:

1. On the VM, open a command prompt as an administrator.

2. Run the following command:

   reg.exe ADD HKLM\SOFTWARE\Citrix\XenTools\AutoUpdate /t REG_SZ /v \
       InstallDrivers /d NO
   <!--NeedCopy-->
   

Automatic reboots

Ensure that all requested VM restarts are completed as part of the update. Multiple restarts might be required. If all requested restarts are not completed, you might see unexpected behavior.

You can set a registry key that specifies the maximum number of automatic reboots that are performed when you install the drivers through Device Manager or Windows Update. After you have installed the xenbus driver version 9.1.1.8 or later, the XenServer VM Tools for Windows use the guidance provided by this registry key. If you have an earlier version of xenbus, you might still experience unexpected behavior. If this occurs, reboot the VM from XenCenter.

To use this feature, we recommend that you set the following registry key as soon as possible: HKLM\System\CurrentControlSet\services\xenbus_monitor\Parameters\Autoreboot. The value of the registry key must be a positive integer. We recommend that you set the number of reboots in the registry key to 3.

When this registry key is set, the XenServer VM Tools for Windows perform as many reboots as are needed to complete the updates or the number of reboots specified by the registry key - whichever value is lower.

Before each reboot, Windows can display an alert for 60 seconds that warns of the upcoming reboot. You can dismiss the alert, but this action does not cancel the reboot. Because of this delay between the reboots, wait a few minutes after the initial reboot for the reboot cycle to complete.

Notes:

This setting is required for headless servers with static IP addresses.

This automatic reboot feature only applies to updates to the Windows I/O drivers through Device Manager or Windows Update. If you are using the Management Agent installer to deploy your drivers, the installer disregards this registry key and manages the VM reboots according to its own settings.

If, after waiting for all reboots to complete, you still experience unexpected behavior, initiate a reboot of the VM from XenCenter to attempt to restore the configuration.

Setting automatic reboots using the command line

On your Windows VM, open a command prompt as Administrator and run the following command:

reg add HKLM\System\CurrentControlSet\Services\xenbus_monitor\Parameters /v Autoreboot /t REG_DWORD /d <number-of-reboots>
<!--NeedCopy-->

Alternatively, if your Windows VM is configured to allow remote access, you can run the following command from an Administrator command prompt on another system:

reg add \\<windows-name>\HKLM\System\CurrentControlSet\Services\xenbus_monitor\Parameters /v Autoreboot /t REG_DWORD /d <number-of-reboots>
<!--NeedCopy-->

For more information, see the reg add Windows command.

Setting automatic reboots using the Registry Editor

1. From the Windows Start menu, open the Registry Editor and navigate to the key: HKLM\System\CurrentControlSet\services\xenbus_monitor\Parameters​.
2. Create a new subkey of the type REG_DWORD with the name: Autoreboot.
3. Set the value of Autoreboot to an integer, for example, 3.

Other configuration and queries

Find the I/O driver version

To find out the version of the I/O drivers installed on the VM:

1. Navigate to C:\Windows\System32\drivers.

2. Locate the driver from the list.

3. Right-click the driver and select Properties and then Details.

   The File version field displays the version of the driver installed on the VM.

Find the Management Agent version

To find out the version of the Management Agent installed on the VM:

1. Navigate to C:\Program Files\Citrix\XenTools.

2. Right-click XenGuestAgent from the list and click Properties and then Details.

   The File version field displays the version of the Management Agent installed on the VM.

Configure anonymous usage information

During the XenServer VM Tools for Windows installation, you can specify whether you would like to send anonymous usage information to Cloud Software Group, Inc. If you would like to update this setting after completing the XenServer VM Tools for Windows installation process, perform the following steps:

1. On the VM, open a command prompt as an administrator.

2. Run the following command:

   reg.exe ADD HKLM\SOFTWARE\Citrix\XenTools\AutoUpdate REG_SZ /v \
       IDENTIFYAUTOUPDATE /d YES/NO
   <!--NeedCopy-->
   

Troubleshoot XenServer VM Tools for Windows

We provide a tool, xtbugtool, that captures diagnostic information for the XenServer VM Tools. For more information, see Troubleshoot VM problems.

Uninstall XenServer VM Tools for Windows

We don’t recommend removing the XenServer VM Tools from your Windows VMs. These tools are required for your Windows VMs to be fully supported. Removing them can cause unexpected behavior. Manually uninstall your XenServer VM Tools only as a last resort.

Standard uninstall

To do a standard uninstall of the XenServer VM Tools, you can use the Windows Add or Remove Programs feature:

1. Create a snapshot of the VM before you start.
2. In the Windows VM, go to Add or Remove Programs.
3. Select Citrix Hypervisor PV Tools and click Uninstall.
4. Reboot the VM.

The uninstall.exe command

Uninstalling the XenServer VM Tools by using the Windows Add or Remove Programs feature calls the <tools-install-directory>\uninstall.exe file to perform the uninstall actions. You can instead choose to call this command from a PowerShell terminal or a command prompt with administrator privileges.

1. Create a snapshot of the VM before you start.
2. As administrator, open a command prompt or PowerShell terminal.
3. Run the command <tools-install-directory>\uninstall.exe.
4. Reboot the VM.

Command options

The uninstall.exe command accepts the following parameters:

• help - Displays usage information for the command.
• log - Generates a log file that indicates what the command has done.
• verbose - Prints to the console what the command has done.
• disable - Disables drivers that were installed by the installer MSI.
• force-disable - Disables the drivers in all situations.
• hidden - Deletes hidden devices. These devices are unused and have been superseded, but might have left stale registry entries.
• cleanup - Removes old uninstallers from Add or Remove Programs. These uninstallers can include duplicate entries from older versions of the tools.
• purge - (9.3.1 and later) Resets the VM to a clean state as it was before any part of the XenServer VM Tools were installed. For more information, see Full uninstall of all XenServer VM Tools components.
• install - (9.3.1 and later) Installs the current set of I/O drivers and prompts for a VM reboot when required.
• reboot- Reboots the VM after all other command operations have completed.

Full uninstall of all XenServer VM Tools components

The latest version of XenServer VM Tools for Windows (9.3.1 and later) includes the command uninstall.exe purge. The purge option on the uninstall.exe application resets a VM to the state before any of the I/O drivers were installed. If you are experiencing issues when upgrading your tools to a newer version or need a clean state to install a later set of tools on your VM, use this utility.

1. Create a snapshot of the VM before you start.
2. As administrator, open a command prompt or PowerShell terminal.
3. Run the command <tools-install-directory>\uninstall.exe purge verbose
4. Reboot the VM.

After using this command, you do not need to perform any manual cleanup steps like you might have had to with previous versions of the XenServer VM Tools. All changes related to the XenServer VM Tools have been removed.

What does the purge option remove?

If you use the command uninstall.exe purge, all traces of the XenServer VM Tools are removed from your Windows VM. The list of actions taken by this command are as follows:

• Services:
  • Disables all XenServer VM Tools services, which prevents installed drivers and services from starting on reboot.
  • Stops any running XenServer VM Tools services.
• Drivers:
  • Uninstalls I/O drivers from all device nodes.
  • Uninstalls hidden devices. This action is the same as that performed the hidden command line option.
  • Uninstalls cached driver packages, which removes them from the driver store. As a result, the I/O drivers are not automatically reinstalled.
• Registry:
  • Removes stale registry information used by out of support versions of the drivers.
  • Deletes tools-related keys from HKLM\System\CurrentControlSet\Control\Class\...
  • Deletes tools-related keys from HKLM\System\CurrentControlSet\Services.
  • Deletes tools-related keys from HKLM\System\CurrentControlSet\Enum\...
• Files:
  • Deletes any XenServer VM Tools driver files from C:\Windows\System32 and C:\Windows\System32\drivers.
  • Deletes XenServer VM Tools INF files from C:\Windows\INF.
  • Deletes any stale files left by out of support versions of the tools from C:\Program Files\Citrix\XenTools.
• Other:
  • Deletes old entires in Add or Remove Programs. This action is the same as that performed the cleanup command line option.
  • Clears some of the InstallAgent’s stale state information.
  • Removes xenfilt.sys from upper-filters. This change prevents xenfilt.sys from loading on any driver nodes.
  • Removes the unplug keys, which causes the VM to revert to emulated devices on reboot.
  • Removes StorNvme’s StartOverride. This change forces stornvme.sys to start on boot and allows emulated NVMe (UEFI) boot devices to function.

What’s new

The version of the XenServer VM Tools for Windows is updated independently of the version of Citrix Hypervisor. Ensure that your XenServer VM Tools for Windows are regularly updated to the latest version, both in your VMs and in any templates that you use to create your VMs.

XenServer VM Tools for Windows 9.4.0

Released Oct 22, 2024

This set of tools contains the following component versions:

• Installer: 9.4.0
• Management Agent: 9.3.0.65
• xenbus: 9.1.9.105
• xeniface: 9.1.10.87
• xennet: 9.1.7.65
• xenvbd: 9.1.8.79
• xenvif: 9.1.12.101

Fixed issues in 9.4.0

This release contains fixes for the following issues:

• The XenServer VM Tools for Windows version is not correctly reported to XenServer due to the Management Agent checking the incorrect InstallStatus value in the registry.
• Due to an incomplete handling of StorNvme’s StartOverride registry keys, you might encounter a BSOD with the error “Inaccessible Boot Device” after rebooting your Windows VM during a XenServer VM Tools update through Windows Update.
• Sometimes, when updating XenServer VM Tools for Windows, the static IP settings are lost and the network settings change to use DHCP. This issue is resolved if you’re updating from version 9.3.3 or later (for example, from 9.4.0 to a newer version). However, if you’re updating from a version earlier than 9.3.3 (for example, from 9.3.2 to 9.4.0), the issue will occur once during the update, but it will not affect future updates. For more information, see the support article Static IP loss when updating to VM Tools for Windows 9.3.3 or earlier.

Known issues in 9.4.0

This release contains the following known issues:

• If you rely on the Management Agent for automatic updates, you must manually update to version 9.4.0 or later, as 9.3.3 does not automatically update to 9.4.0 due to certificate checking issues. To resolve this, manually install XenServer VM Tools for Windows 9.4.0 or a newer version on each VM.

• On a Windows VM, after you have installed the version 9.x XenServer VM Tools for Windows, you might see both the previous and the latest version of the tools or management agent listed in your Installed Programs:

  • (PREVIOUS) Citrix XenServer Windows Management Agent
  • (LATEST) Citrix Hypervisor PV Tools

  The previous version of the management agent is not active and does not interfere with the operation of the latest version. We advise that you do not manually uninstall Citrix XenServer Windows Management Agent because this can disable the xenbus driver and cause the VM to revert to emulated devices.

Earlier releases

9.3.3

Released Jun 04, 2024

This set of tools contains the following component versions:

• Installer: 9.3.3
• Management Agent: 9.2.3.60
• xenbus: 9.1.8.88
• xeniface: 9.1.9.78
• xennet: 9.1.6.60
• xenvbd: 9.1.7.66
• xenvif: 9.1.11.92

This release contains fixes for the following issues:

• Sometimes, the Management Agent can crash with a ManagementException when the VM is under heavy load.
• On Windows 2022 Servers, a single vCPU can consume 100% CPU. As a result, the server becomes unresponsive.
• Windows VMs hosted in a pool that uses OpenVSwitch networking and VLAN tagged ethernet frames can have inconsistent network connectivity.

9.3.2

Released Nov 27, 2023

This release rebrands the Citrix VM Tools to XenServer VM Tools.

This set of tools contains the following component versions:

• Installer: 9.3.2
• Management Agent: 9.2.2.435
• xenbus: 9.1.7.80
• xeniface: 9.1.8.69
• xennet: 9.1.5.51
• xenvbd: 9.1.6.58
• xenvif: 9.1.10.83

This release includes the following improvements:

• Improvements to the uninstall.exe command.
• Changes to enable some Windows VMs to use up to 64 vCPUs where your version of XenServer and the Windows operating system support it.

This release contains fixes for the following issues:

• Sometimes, when installing the XenServer VM Tools, a non-fatal error can cause the installation to fail.

9.3.1

Released Jan 25, 2023

This set of tools contains the following component versions:

• Installer: 9.3.1
• Management Agent: 9.2.1.35
• xenbus: 9.1.5.54
• xeniface: 9.1.5.42
• xennet: 9.1.3.34
• xenvbd: 9.1.4.37
• xenvif: 9.1.8.58

This release includes the following improvements:

• Improvements to the uninstall.exe utility, including the purge parameter. For more information, see Uninstall XenServer VM Tools for Windows.
• General improvements to the XenServer VM Tools installer.
• General improvements to string handling of registry keys.

This release contains fixes for the following issues:

• Sometimes, when the XenServer VM Tools are updated through Windows Update, the static IP settings are lost and the network settings change to use DHCP.
• On Windows VMs, the grant tables can easily become exhausted. When this occurs, read and write requests could fail or additional VIFs are not enabled correctly and fail to start.
• On rare occasions, when upgrading the XenServer VM Tools for Windows, the existing Management Agent can fail to shutdown and prevent the upgrade from succeeding.
• On a Windows VM, you might see both the previous and the latest version of the tools or management agent listed in your Installed Programs.
  • (PREVIOUS) Citrix XenServer Windows Management Agent
  • (LATEST) Citrix Hypervisor PV Tools.

9.3.0

Released Jul 26, 2022

This set of tools contains the following component versions:

• Installer: 9.3.0
• Management Agent: 9.2.0.27
• xenbus: 9.1.4.49
• xeniface: 9.1.4.34
• xennet: 9.1.3.34
• xenvbd: 9.1.3.33
• xenvif: 9.1.6.52

This release includes the following improvements:

• General improvements to the XenServer VM Tools installer.

This release contains fixes for the following issues:

• Security software was blocking secondary disks that are marked as removable from being exposed to the OS, as a data-exfiltration prevention measure. This update enables you to flag a VBD as non-removable and have this correctly exposed through the OS.
• On a Windows VM, sometimes the IP address of an SR-IOV VIF is not visible in XenCenter.

9.2.3

Released Apr 28, 2022

This set of tools contains the following component versions:

• Installer: 9.2.3
• Management Agent: 9.1.1.13
• xenbus: 9.1.3.30
• xeniface: 9.1.4.34
• xennet:
  • 9.1.1.8 (for Windows Server 2012 and Windows Server 2012 R2)
  • 9.1.2.23 (for all other supported Windows operating systems)
• xenvbd: 9.1.2.20
• xenvif: 9.1.5.48

This release contains fixes for the following issues:

• In XenServer VM Tools for Windows version 9.2.2, time sync options are not available.
• A race condition can cause Windows VMs to show a blue screen error after live migration on Citrix Hypervisor 8.2 Cumulative Update 1.
• Windows VMs that have version 9.2.1 or 9.2.2 of the XenServer VM Tools installed and that are PVS targets can sometimes freeze with a black screen. The message “Guest Rx stalled” is present in the dom0 kernel logs. This issue more often occurs on pool masters than on other pool members.
• On Windows VM with more than 8 vCPUs, Receive Side Scaling might not work because the xenvif driver fails to set up the indirection table.

9.2.2

Released Jan 14, 2022

This set of tools contains the following component versions:

• Installer: 9.2.2
• Management Agent: 9.1.1.13
• xenbus: 9.1.3.30
• xeniface: 9.1.2.22
• xennet:
  • 9.1.1.8 (for Windows Server 2012 and Windows Server 2012 R2)
  • 9.1.2.23 (for all other supported Windows operating systems)
• xenvbd: 9.1.2.20
• xenvif: 9.1.3.31

This release contains fixes for the following issues:

• During update of the tools, the xenbus driver can prompt a reboot before driver installation is complete. Accepting the reboot can cause a blue screen error in your Windows VM.
• When compressing collected diagnostic information, the xt-bugtool diagnostics tool times out after 20s. This behavior can result in the diagnostics zip file not being correctly created.
• VNC clipboard sharing doesn’t work.
• The previous versions of the drivers were not released through Windows Update.

9.2.1

Released Jun 24, 2021

This set of tools contains the following component versions:

• Installer: 9.2.1
• Management Agent: 9.1.0.10
• xenbus: 9.1.2.14
• xeniface: 9.1.1.11
• xennet: 9.1.1.8
• xenvbd: 9.1.1.8
• xenvif: 9.1.2.16

Note:

This set of drivers was not provided through Windows Update.

This release contains fixes for the following issues:

• In some cases, the Laptop/Slate state of the VM cannot be changed.
• After a VM is restarted it can sometimes begin to send excessive log messages to the daemon.log file.
• A race condition in driver load dependencies after an OS upgrade can prevent the XenServer VM Tools from being upgraded.
• A storage error can cause Windows VMs to crash.
• Sometimes the IP address of an SR-IOV VIF is not visible in XenCenter. To fix the issue, restart the management agent from within the VM’s Service Manager.
• Under high network and system load, and low resources, VMs can experience bugchecks in both Citrix and third party drivers, typically with code IRQL_NOT_LESS_OR_EQUAL. This fix improves network buffering to prevent these bugchecks.
• Upgrading the Windows I/O drivers can cause UEFI VMs to fail to boot, reporting “0xC000000E. A required device isn’t connected or can’t be accessed.””
• An issue can occur when installing the XenServer VM Tools after uninstalling a previous version of the XenServer VM Tools that returns the following error message: “This Device cannot start (code 10) (Operation failed) The requested operation was unsuccessful”.