Product Documentation

Migrate

May 03, 2015

You can transfer data and settings from a XenDesktop 4 farm to a XenDesktop 7.x Site using the Migration Tool, which includes the following components:

  • The Export Tool, XdExport, to export XenDesktop 4 farm data.
  • An XML editor to review and edit the XML file, whose default name is XdSettings.xml.
  • The Import Tool, XdImport, that imports the data by running the PowerShell script Import-XdSettings.ps1.

To successfully use the Migration Tool, both deployments must have the same:

  • Hypervisor version (for example, XenServer 6.2)
  • Active Directory environment

XenApp Restrictions

  • You cannot migrate earlier XenApp versions to the current version
  • You cannot migrate XenApp farms to XenDesktop
  • You cannot migrate XenDesktop 4 to XenApp

Prerequisites

Perform the following tasks before migration:

  • Make sure that you understand which data can be exported and imported, and how this applies to your own deployment. Information on which types of data are exported and imported is available at Data import and export details.
  • Citrix strongly recommends that you manually back up the Site Database, so that you can restore it if any issues are discovered.
  • Set up a XenDesktop 7.x Site, including its database. For full details of database requirements, see Database requirements.
  • To migrate from XenDesktop 4 to XenDesktop 7.x, all VDAs must be at a XenDesktop 5.x level so that they are compatible with both XenDesktop 4 and XenDesktop 7.x controllers. Once the controller infrastructure is fully running XenDesktop 7.x, Windows 7 VDAs can be upgraded to XenDesktop 7.x. For specific information see Migration examples.

The following figure summarizes the migration process.

Migration steps

  1. In the Desktop Studio console on the XenDesktop 4 Controller, put all machines you want to export into maintenance mode.
  2. Export data and settings from your XenDesktop 4 farm to an XML file using the export tool. To do this, see Export from a XenDesktop 4 farm.
  3. Edit the XML file so that it contains only the data and settings you want to import into your XenDesktop 7.x Site. For further details of how to edit the XML file, see Edit the Migration Tool XML file.
  4. Import the data and settings from the XML file to your XenDesktop 7.x Site. To use the import tool to complete this step, see Import XenDesktop 4 data.
  5. To make additional changes, repeat steps 4 and 5. After making changes, you may want to import additional desktops into existing desktop groups. To do so, use the Mergedesktops option as described in Import XenDesktop 4 data.
  6. Complete the post-migration tasks described in Post-migration tasks.

For migration examples, see Migration examples.

New concepts and features

Compared to XenDesktop 4, this release has many new features and introduces new concepts. For new concepts, terminology, and system requirements, see About XenDesktop.

Migration examples

Example 1: Single large scale XenDesktop 4 farm to a XenDesktop 7 Site

In this example, the entire XenDesktop 4 farm is upgraded to XenDesktop 7.

Starting conditions

A XenDesktop 4 farm is in use. The XenDesktop 4 farm has 50 desktop groups, where each group contains an average 100 desktops in it. The XenDesktop 4 desktops are provided through Provisioning Services (PVS), and the machines are running on VMware ESX hypervisors. The VDA software installed on all the VMs is the XenDesktop 4 VDA software.

Migration steps

  1. Upgrade all XenDesktop 4 VDAs to XenDesktop 5.6 Feature Pack 1 VDA software. Doing so allows the VDAs to register with both the XenDesktop 4 controller and the XenDesktop 7 Delivery Controller.
  2. Make sure that all users log off the existing XenDesktop 4 farm.
  3. Make sure that all these machines are in maintenance mode.
  4. Run the export tool (XdExport) on the existing XenDesktop 4 farm.
  5. Install XenDesktop 7.
    1. Perform the XenDesktop 7 Site configuration using Studio. Select the Deployment Wizard Full Production Site mode.
    2. Upgrade the Provisioning Services (PVS) server and PVS agents if PVS is part of the deployment.
    3. Upgrade the License Server (and associated licenses).
  6. Unzip the Import Tool (XdImport) to a local directory on the XenDesktop 7 Delivery Controller.
  7. Copy the XML file (XdSettings.xml) generated in Step 3 by the Export Tool to the local directory.
  8. From the PowerShell pane of the Studio root node on the XenDesktop 7 Site, start a PowerShell session.
  9. Run the Import Tool (XdImport) passing the credentials of the associated hypervisors, and the path of the XML file.
  10. Manually recreate Administrator settings through Studio's Administrator node, as described in Administrators.
  11. Modify the imported desktops to use registry-based Controller discovery; and point them to the new XenDesktop 7 Delivery Controller.
  12. For VDAs running on Windows 7, Citrix recommends that you upgrade those VDAs to use the XenDesktop 7 Desktop OS VDA. Doing so provides access to all XenDesktop 7 features.

    After upgrading VDA software to XenDesktop 7 for machines in a catalog or Delivery Group, upgrade the catalog and Delivery Groups as described in Upgrade a machine catalog and Upgrade a Delivery Group.

  13. Remove the Delivery Groups from maintenance mode.
  14. Configure StoreFront to provide the desktops formerly provided through Web Interface. For information about installing and configuring StoreFront, see To install and set up StoreFront.

Example 2: Complete a XenDesktop 4 farm export with a partial import to XenDesktop 7.1 Site

This example shows a more commonly used method in which migration occurs in a number of steps, at each step migrating a subset of the remaining desktops needing migration.

Starting conditions

A XenDesktop 4 farm is in use, and an XenDesktop 7.1 Site has already been created and is in use. The XenDesktop 4 farm has 50 desktop groups, and each group contains an average 100 desktops. The XenDesktop 4 desktops are provided through PVS, and the machines are running on Citrix XenServer hypervisors. The version of VDA software installed on all XenDesktop 4 virtual machines is XenDesktop 4.

Migration steps
  1. Run the export tool on the existing XenDesktop 4 farm.
    1. Unzip the Export Tool (XdExport) on one of the Desktop Delivery controller machines in the farm.
    2. As a Citrix Administrator, run the Export Tool with no parameters.
  2. Copy and edit the resulting XML file so that it contains only the groups and desktops that you want to migrate.
  3. Make sure that all users on desktops to be migrated have logged off the existing farm.
  4. Make sure that all desktops that are to be migrated are in maintenance mode on XenDesktop 4.
  5. Unzip the Import Tool (XdImport) to a local directory on the XenDesktop 7.1 Delivery Controller.
  6. Copy the edited XML to the local directory.
  7. From the PowerShell pane of the Studio root node on the XenDesktop 7.1 Site, start a PowerShell session.
  8. Run the Import Tool (XdImport) passing the credentials of the associated hypervisors, and the path of the XML file.
  9. Manually recreate Administrator settings through Studio's Administrator node, as described in Administrators.
  10. Modify the imported desktops to use registry-based Controller discovery; and point them to the new XenDesktop 7.1 Delivery Controller.
  11. Upgrade all VDAs to the appropriate VDA software:
  12. Remove the Delivery Groups from maintenance mode.
  13. Configure StoreFront to provide the desktops formerly provided through Web Interface. For information about installing and configuring StoreFront, see To install and set up StoreFront.

XenDesktop 4 components that are not migrated

Not all XenDesktop 4 components are supported in this release. This table summarizes components that are not migrated.

Data type Notes

Virtual Delivery agent

Before a XenDesktop 7.x Delivery Controller can manage virtual desktops from XenDesktop 4, you must upgrade the VDAs to a minimum release of XenDesktop 5.x.

For information about upgrading VDAs, see Post-migration tasks.

Controllers

You must deploy new Controller servers. You cannot upgrade a XenDesktop 4 Controller to a XenDesktop 7.x Site.

XenDesktop 7.x Sites cannot join a XenDesktop 4 farm, and XenDesktop 4 Controllers cannot join a XenDesktop 7.x Site.

In addition, each version has different server requirements. XenDesktop 4 requires Microsoft Windows Server 2003, and XenDesktop 7.x requires Microsoft Windows Server 2008 R2 or Microsoft Windows Server 2012.

XenDesktop 7.1 and 7.5 also support Microsoft Windows Server 2012 R2.

Web Interface

Citrix recommends using StoreFront with XenDesktop 7.x. For information about installing and configuring StoreFront, see To install and set up StoreFront.

When the installation program detects Web Interface, it installs StoreFront, but does not remove Web Interface.

Active Directory Organizational Unit (OU) configuration

Sharing an Organizational Unit (OU) between two farms or two Sites, or a farm and a Site is not supported.

If you plan to configure the new Site to use Active Directory-based Controller discovery rather than the default registry-based Controller discovery, you must create a new OU to support it.

PortICAConfig XML file

If you have changed the default settings for this file you may need to configure these settings for the new Site through Group Policy Objects.

Configuration logging settings provided through XenDesktop 4 Service Pack 1

 

Provisioning services-related data

 

Applications

 

List of Controllers

 

NetScaler GateWay

 

Event log throttling settings