Product Documentation

Upgrade Profile Management

Mar 21, 2017
This topic provides guidance on upgrading your Profile Management deployment by using Active Directory.
Important: It is important that you follow the order of the steps in this upgrade process. Upgrade the software on all computers only after adding the new .adm or .admx file to Group Policy. If you upgrade beforehand, log files might be stored in two locations (one containing log files for the old version and the other for the new version). This consideration particularly affects XenDesktop deployments.

It is also important to perform upgrades during a scheduled maintenance period or at a time when Active Directory replication allows the changes to propagate through your deployment. Typically, this can take up to 24 hours.

The upgrade process involves:

  1. Creating a new Group Policy Object (GPO) and adding the new .adm or .admx file to the new GPO

- or -

Upgrading an existing .adm or .admx file as described in Step 1 below

      2. Upgrading the .msi file on all computers as described in Step 2 below

      3. Applying the GPO.

To upgrade an existing .adm file

If any earlier version of the Profile Management .adm file already exists in Group Policy, you can upgrade it by using this procedure. All policy settings in the earlier version are preserved when you upgrade. For more information, see A new .adm or .admx file is released with a new version of the software. What do I do?.

  1. On the domain controller, do one of the following:
    • Import the existing .adm file. The file is located in the GPO_Templates folder in the download package.
    • Copy the .admx file from the GPO_Templates folder in the download package to the C:\Windows\PolicyDefinitions folder and copy the .adml file to the C:\Windows\PolicyDefinitions\<localized folder>. For example, on English operating systems, <localized folder> is en-US.
  2. On the computer you use to configure Profile Management, open Active Directory Users and Computers.
  3. In the Group Policy Object Editor, right-click Administrative Templates and select Add/Remove Templates.
  4. Select the existing version of the Profile Management .adm file (for example, ctxprofile5.4.1), click Remove and then Close. The Administrative Templates\Citrix folder is deleted.
  5. Right-click Administrative Templates and select Add/Remove Templates again.
  6. Click Add, browse to the location of the new version of the .adm or .admx file (for example, ctxprofile5.5.0), select it, and click Close. The new file is imported but the old settings are retained.

To upgrade the .msi file

Citrix recommends that you install the same version of Profile Management on all user devices and that you add the .adm or .admx file of that same version to each Group Policy Object on all domain controllers. Doing so prevents corruption of profile data, which might result when different user store structures (from different versions) exist.

Citrix recommends that you upgrade all computers to the latest version of Profile Management before enabling any new setting. To check whether a setting is new in the version you are using, see Profile Management Policies.

  1. Ensure that all users are logged off from the computers you want to upgrade.
  2. Install the new version of Profile Management over the existing version by running the .msi file on each computer. For more information, see Install and set up Profile Management.

To upgrade the .ini file

If you edited the .ini file in an earlier version of Profile Management and upgrade to a newer version, the software detects that the file was edited and, by default, does not overwrite it. If you want to preserve your .ini file settings but also make use of the new settings in the newer version, you must do one of the following:
  • Manually add the new settings from the .ini file of the newer version to your existing, edited .ini file.
  • Save a copy of the existing, edited version's .ini file, use the OVERWRITEINIFILES=yes command-line option to force an overwrite of the file during the upgrade and add your saved settings to the upgraded .ini file. For example:

msiexec /i <path to the MSI file> /quiet [INSTALLDIR=<installation directory>] [OVERWRITEINIFILES=yes] [INSTALLPOLICYINIFILES=no]


To configure Profile Management policy through HDX, you must:

  • upgrade your Delivery Controller(s). The reason is that HDX reads the Profile Management policy settings from the UserProfileManager_PowerShellSnapIn.msi file present in the XenApp and XenDesktop layout image-full\x64\Citrix Desktop Delivery Controller.
  • upgrade your VDAs so as to get the latest version of Profile Management.