Product Documentation

Upgrade XenDesktop 7

Apr 26, 2015
Review the following information before upgrading XenDesktop 7:
  • Existing Sites — You must use the procedure known as an in-place upgrade to upgrade to XenDesktop 7.1 or 7.5.
  • VDAs — You cannot upgrade Virtual Desktop Agents running on Windows XP or Windows Vista to version 7.1 Virtual Delivery Agents. You must upgrade these VDAs to the Windows XP or Windows Vista version provided by the installer, or upgrade them to Version 5.6 Feature Pack 1.
  • Microsoft System Center Virtual Machine Manager (VMM) — XenDesktop 7.1 and 7.5 support VMM 2012, VMM 2012 SP1, and VMM 2012 R2.

When you run the installer AutoSelect, the wizard checks whether certain Site components (such as the Delivery Controllers, Director, and VDAs), need to be upgraded. If you opt not to upgrade some components during this process, when you run Studio, it performs a component check and notifies you when components need to be upgraded. You cannot proceed to manage your Site until you upgrade these components.

Important: Back up your Databases as described in How to backup and Restore your XenDesktop Database before performing any upgrade procedures.

Upgrade Site with components deployed on different machines

The following figure shows the high-level processes involved when upgrading a XenDesktop 7 to XenDesktop 7.x in which Studio components are deployed on different machines.

Perform the upgrade procedures in the following order.

Check the licenses

Make sure that your Subscription Advantage date for licenses is no earlier than 2013.0522.

Upgrade StoreFront

If StoreFront is deployed on a separate machine, follow the steps described in Upgrade StoreFront.

Upgrade Director

If Director is deployed on a separate machine, follow the steps described in Upgrade core components.

Upgrade Provisioning Services

If you are using Provisioning Services, follow the procedures described in Upgrading Provisioning Services.

Manual upgrade for VDAs on physical machines

When upgrading version 7 or version 7.1 VDA that are installed on a physical machine (including Remote PC Access) to version 7.5 VDAs, you must start the upgrade from the command line using the following parameter:

/EXCLUDE "Personal vDisk","Machine Identity Service"

The following example shows a physical VDA manual upgrade.

  1. If you are using physical installation media, insert it into the DVD drive. If you are using a network share, mount the media as a network drive. This example assumes that the installation media is in the D drive.
  2. Open a command prompt window.
  3. Enter:
    D:\x64\XenDesktop Setup\XenDesktopVdaSetup.exe /EXCLUDE 
    "Personal vDisk","Machine Identity Service" 
    

    Your VDA upgrade will now launch and complete as described in Upgrade the Virtual Delivery Agent.

Upgrade the Virtual Delivery Agent

For Remote PC Access deployments, Citrix recommends that you upgrade a VDA in a remote PC using a command-line method. For detailed information, see Install using the command line.

  1. Log on to the server using a local administrator account and run the installer by inserting the media or mounting the ISO drive for this release, and double-clicking AutoSelect.
  2. On the Welcome page, click Start. The wizard detects what components need to be upgraded and displays the Upgrade options page, activating the components you can upgrade.
  3. On the Upgrade options page, select:
    • Virtual Delivery Agent for Windows Desktop OS for Desktop OS, and earlier XenDesktop versions
    • Virtual Delivery Agent for Windows Server OS for Server OS
  4. On the Firewall page review the default ports and configure firewall rules.
  5. On the Summary review the prerequisites to be installed and the components to be upgraded then click Upgrade.
  6. On the Finish Upgrade page one of the following messages appears upon completion:
    • Success — Upgrade successful appears when the upgrade completes without errors.
    • Failed — The Upgrade failed appears with a list of failed components. Click Why did this fail to review what you must do to fix the problem. Other components that installed successfully are retained; you do not need to reinstall them.
  7. Click Finish to complete the upgrade.

Upgrade Delivery Controllers

Citrix recommends that you upgrade Delivery Controllers as follows:
  1. Upgrade half of your Site's Delivery Controllers.
  2. Use the upgraded version of Studio to perform the Site upgrade as described in Upgrade core components.
  3. Upgrade your remaining Delivery Controllers.

Upgrade Databases using Studio

Use Studio to upgrade the Database.

Automatically upgrade Databases

  1. Start Studio. The wizard detects what components need to be upgraded and displays the Mandatory upgrade page.
  2. Select Start the Site upgrade automatically.
  3. At the prompt, select I am ready to upgrade.

    The wizard displays the upgrade progress. After the upgrade completes, the wizard performs tests. This takes several minutes.

  4. At the Site Upgrade Complete window, you can optionally view a data migration report and then click Finish.
  5. At the Upgrade successful page, click Finish upgrade and return to the Site overview.

Manually upgrade Databases

To minimize Site down time when performing a manual upgrade, it is important that the XenDesktop Administrator closely coordinates with the Database Administrator. This process requires that you run a script that temporarily disables Xendesktop Services while the manual upgrade scripts are run by the Database Administrator using a preferred tool (for example, SQL Server Management Studio). Ideally, immediately after these scripts complete, the XenDesktop Administrator should enable XenDesktop Services and complete the upgrade using Studio.

Manual upgrade requires:

  • Backing up the databases
  • Running the generated scripts in the following order:
  1. DisableServices.ps1 — PowerShell script to be run by the XenDesktop administrator on an XenDesktop Controller.
  2. UpgradeSiteDatabase.sql — SQL script run where the Site databases resides
  3. UpgradeMonitorDatabase.sql — SQL script run where the Monitor databases resides.
  4. UpgradeLoggingDatabase.sql — SQL script run where the Logging database resides.
    Note: You should only run this script if the Logging database changes. For example, run it after applying a hotfix.
  5. EnableServices.ps1 — PowerShell script to be run by the XenDesktop administrator on an XenDesktop Controller.

To upgrade manually

  1. Start Studio. The wizard detects what components need to be upgraded and displays the Mandatory upgrade page.
  2. Select Manually upgrade this site.
  3. The wizard checks for License Server compatibility. Make sure your License Server and license files are compatible with your version of XenDesktop 7.x. Select the confirmation check box and click Continue.
  4. The wizard prompts you to backup the Database. When you have done so, select the confirmation check box and click Continue.
    • The wizard generates the manual upgrade scripts that you must run and displays them in a window
    • The Mandatory Upgrade page changes to display a checklist of the manual upgrade steps
  5. Make sure you have completed the checklist tasks and click Finish upgrade and return to Common Tasks.

Upgrade core components

The installer automatically upgrades core components such as Delivery Controllers, Studio, and Director if they were previously installed.

  1. Log on to the server using a local administrator account and run the installer by inserting the media or mounting the ISO drive for this release, and double-clicking AutoSelect.
  2. On the Welcome page, click Start. The wizard detects what components need to be upgraded and displays the Upgrade options page, activating the components you can upgrade.
  3. Click Delivery Controller.
  4. Accept the license agreement.
  5. Review the upgrade steps, click I'm ready to continue and click Next.
  6. On the Core Components page review the components available for upgrade.
  7. On the Firewall page review the default ports and configure firewall rules.
  8. On the Upgrade page review the prerequisites to be installed and the components to be upgraded and then click Upgrade.
  9. On the Finish Upgrade page one of the following messages appears upon completion:
    • Success — Upgrade successful appears when the upgrade completes without errors.
    • Failed — The Upgrade failed appears with a list of failed components. Click Why did this fail to review what you must do to fix the problem. Other components that installed successfully are retained; you do not need to reinstall them.
  10. Click Finish to complete the upgrade.
  11. After completing the XenDesktop upgrade, upgrade machine catalogs as described in Upgrade a machine catalog and Delivery Groups as described in Upgrade a Delivery Group.

Upgrade a Site with components deployed on the same machine

The following figure shows the high-level processes involved when upgrading a Site in which all components are deployed on the same machine.

Upgrade XD7 on a single machine

Perform the upgrade procedures in the following order:

  1. Make sure that your Subscription Advantage date for licenses is no earlier than 2013.0522.
  2. Back up the Controller databases as described in How to backup and Restore your XenDesktop Database.
  3. Optionally back up templates and upgrade Hypervisor.
  4. Upgrade PVS servers and agents as described in Upgrade Provisioning Services.
  5. Upgrade the core components as described in Upgrade core components.
  6. Upgrade VDAs as described in Upgrade the Virtual Delivery Agent.
  7. Upgrade the Database using Studio as described in Upgrade Databases using Studio.
  8. Upgrade the remaining Delivery Controllers.
  9. After completing the XenDesktop upgrade, upgrade machine catalogs as described in Upgrade a machine catalog and Delivery Groups as described in Upgrade a Delivery Group.

Post upgrade processes

After the upgrade and data migration is complete, you can run environment and configuration tests to make sure that the Site is in functional order.

To test the upgraded site, select Test Site in the Site Configuration pane of the Studio Common Tasks page.