Product Documentation

XenDesktop 5 upgrade components

Aug 14, 2014

Upgrade components

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

Depending on your Site, the procedures that you perform and the order in which you perform these procedures may vary.

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

Upgrade the License Server

Before upgrading the License Server, make sure the Subscription Advantage date for license files that is compatible with a supported edition of the product.

  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. Accept the license agreement.
  4. If the wizard detects an incompatible license server or license files, you are prompted to upgrade that license component. Upgrade the component and then run the installer again, as described in Upgrade core components.

Upgrade the Virtual Delivery Agent

You can only upgrade Desktop OS (Windows Desktop) Virtual Delivery Agents (VDAs) when upgrading from XenDesktop 5.x to XenDesktop 7.x.

For Remote PC Access deployments, Citrix recommends that you use the command line interface to upgrade the VDA in the PC .

Important: To upgrade a VDA 5.x version to the new version, Citrix recommends installing the new VDA on a clean machine image (this could also be an earlier golden image that does not contain a VDA). If that is not feasible, manually uninstall the 5.x VDA using the Windows feature for removing or changing programs, and then install the new VDA.

To install the new VDA, follow the guidance in the installation documentation.

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.
    Note: If the program detects the XenDesktop Express edition, you are prompted to obtain and install a license for a supported edition. You cannot continue the upgrade until you obtain and install a license for VDI, Enterprise, or Platinum edition before upgrading.
  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.
    Select Launch Studio to start Studio when the upgrade completes and click Finish.

Upgrade the Database using Studio

After upgrading the core components, use Studio to upgrade the Database.

Automatically upgrade the Database

  1. Start Studio. The wizard detects which 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. In the Site Upgrade Complete window, you can optionally view a data migration report and then click Finish.
  5. In the Upgrade successful page, click Finish upgrade and return to the Site overview.

Manually upgrade the Database

To minimize Site downtime during a manual upgrade, it is important that the Studio administrator coordinates closely with the database administrator. This process requires that you run a script that temporarily disables services while the manual upgrade scripts run. Ideally, immediately after these scripts complete, the Studio administrator should enable services and complete the upgrade using Studio.

A manual upgrade requires:
  • Compatible License Server and license files
  • Database backup
  • Running the generated scripts in the following order:
  1. DisableServices.ps1 — PowerShell script to be run by the Studio administrator on a Controller
  2. UpgradeDatabase.sql — SQL script run by the database administrator using a preferred tool (for example, SQL Server Management Studio)
  3. EnableServices.ps1 — PowerShell script to be run by the Studio administrator on a 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 XenDesktop 7.x version. Select the confirmation check box and click Continue.
  4. The wizard prompts you to back up 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 the remaining Delivery Controllers

Upgrade any additional Controllers in your Site.

  1. On the Common Tasks page click Upgrade remaining Delivery Controllers. A list of Controllers appears.
  2. Perform all the previously described tasks, starting with To upgrade core components on each Controller.
  3. When you have upgraded all Controllers, click I have upgraded remaining Delivery Controllers and click Finish.
  4. Close Studio and then reopen Studio to implement the changes.
  5. In the Site Configuration section of the Common Tasks page, select Perform registration. Registering the remaining Controllers makes the Controllers and their services available to the Site.