Page tree

CloudConnect Docs

Skip to end of metadata
Go to start of metadata

Upgrade a Citrix Server Configuration to the Latest CloudConnect Baseline

Last Updated:  

Background: CloudConnect periodically updates its Virtual Machine Template Images, including the preinstalled Citrix software components.  Customers need these updates or upgrades to receive bug fixes and the latest features, which improve the remote computing experience.  

Except for Microsoft Software components, which are updated based on your configuration preferences, the Citrix software and other core software components distributed by CloudConnect do not have an automatic or upgrade mechanism.  Additionally, upgrades can be invasive to end users, so it is important that they be rolled out as part of a planned per-organization process.

CloudConnect distributes Remote Desktop Services configuration updates and Citrix Server-Side software upgrades through CloudConnect's Desktop Host Configuration Utility.  To install the latest CloudConnect-supported upgrades for RDS and Citrix features, run the latest release of the Desktop Host Configuration Utility on the Virtual Machine Console of the Desktop Host that you would like to upgrade.  The Desktop Host Configuration Utility is made available as an ISO Image file in the vCloud Director Public Catalog.  The following procedure below details the full update process.

Process: Prior to beginning this procedure, make sure all Citrix or RDS Desktop Users are logged out of their Cloud Desktops.

Access the VM which you would like to Upgrade and open the 'Actions' drop-down menu.

Choose Create Snapshot.  This will create an instant rollback point if the Upgrade fails.

Make sure "Quiesce guest file system" is selected.  You do not need to Snapshot the memory of the virtual machine.

Do not proceed until you have verified that a snapshot has been created successfully, as shown here:

Once the snapshot has finished creating successfully, right click on the Virtual Machine you wish to upgrade and choose "Insert Media".

Click the Filter icon and search for "DesktopConfig".  Choose the most recent version of DesktopConfig.

Open the console to the virtual machine and sign in as a Domain Administrator.

Run the Desktop Config Media from the DVD Drive, visible in Windows Explorer.

Click OK at the Welcome Dialogue:

Note: You may be prompted to reboot the system and then rerun the Utility.  If that is the case, make sure you re-run the Utility after reboot.  Do not create a new snapshot before running the utility a second time.

Select the Active Directory Security Group or Groups whom you wish to authorize to access this system.  If you are unsure, check the Remote Desktop Users Local Security Group on the system.

Generally you will not change any of the Desktop Options as selected.  If you are using Citrix, leave "Use an Existing Remote Desktop Deployment" unchecked:

Choose "Keep AppLocker's existing configuration".

Make sure the box is checked to "Upgrade the Citrix Virtual Desktop Agent" if it is available.  Leave the other options checked by default.

If you see this prompt, there will be an additional reboot to your machine to complete this upgrade process.  DesktopConfig will save your settings and they will be imported upon next run.  After reboot, run the utility again.

After the reboot and running the utility again you will see this prompt again.  Click OK to continue.

DesktopConfig successfully loaded your configuration settings chosen previously.  Press OK to continue.

When prompted, restart the system:

Lastly, please eject the DesktopConfig media from the Virtual Machine once you are finished

Note:  It may take up to 10 minutes for users to be able to logon to their virtual desktops after the system reboots.  Once you have verified users are able to logon, remove the snapshot.  You may keep the snapshot for up to 24 hours.  However, user Desktop performance will degrade if the snapshot is held longer than 24 hours.

Applies to: Microsoft Windows Remote Desktop Services 2008R2, Microsoft Windows Remote Desktop Services 2012 R2, Microsoft Windows Remote Desktop Services 2016, Microsoft Windows Remote Desktop Services 2019, Citrix XenApp & XenDesktop 7.X, Citrix Apps & Desktops 1912

Additional Notes: 

If the Upgrade fails, take the following action:

1) Collect Logfiles located at C:\CloudConnect\DesktopConfig\

2) Open a Low Priority Support Ticket case with CloudConnect Technical Support, and attach your log files.

3) Rollback the upgrade by choosing "Revert To Snapshot" from the Virtual Machine's context menu.

4) Power On the Virtual Machine.

5) If users still cannot logon within 15 minutes of Powering On the Virtual machine after Reverting the Snapshot, escalate your Technical Support Request's Severity to Service Outage.

The CloudConnect Desktop Configuration Utility upgrades Remote Desktop Services and Citrix software components to the latest Cloudconnect-supported Configuration.  Desktop Configuration Utility does not upgrade the Windows Operating System.  For guidance on upgrading the Microsoft Windows Operating System in place, see CloudConnect Upgrade Preparation Utility.