Product Documentation


Jan 11, 2018

The appliance periodically checks for upgrades from the Layering management console. After downloading the package, Citrix App Layering appliance, also known as Enterprise Layer Manager (ELM), verifies the package and extracts the files. After extracting the package, you receive a message that an upgrade is ready to install. The appliance downloads an upgrade automatically, but does not install the upgrade. 

When you log on, you can install the upgrade by clicking Start Upgrade in the notification message. You can also select System tab > Manage Appliance > Upgrade.


Periodically, the appliance checks to see if an upgrade is available. The following sections walk you through common scenarios.


If the download fails, check the logs for the error.

An update is not available
Nothing happens. The appliance checks for an upgrade at the next scheduled interval.

An update is available, but a network file share is not configured
You receive notification that an upgrade is available. Configure a network file share before downloading and applying the upgrade.

An update is available
The Download Upgrade Media job started, and it is visible in the task list. The upgrade downloads to the configured network file share. When the upgrade is available, all users receive a notification that the software is available for installation. However, only administrators can install the upgrade. 

If an error occurs, the update fails and you receive an error message.


If a job fails, the appliance tries to install the update at the next check interval regardless of whether you resolved the problem.

Another update is found before a previously downloaded one is installed
The new upgrade downloads and then becomes the available upgrade.


Verify that you configured a network file share. You can confirm the share by logging on to the management appliance, navigating to System > Settings and Configuration, and finding the network file share setting. After ensuring you configured the file share, you can upgrade the appliance. 

Back up the appliance

Take a snapshot or checkpoint of the appliance before you install the upgrade.

Download packages

You can also download the upgrade package by using either of the following methods:

After you extract the files from the Zip folder, there are three files:

  • The software upgrade file (.vhd) that updates the appliance.
  • The Agent installation file (.exe) that allows you to run PowerShell scripts. The Agent is required if you use Citrix Provisioning Services.
  • The OS machine tools file (.exe)

You can use the Agent upgrade to bring either of these installations current:

  • The Agent on Provisioning Services servers.
  • When a connector needs to run Powershell scripts.

To download the upgrade package from the Citrix website

  1. In a web browser, log on to Citrix. com.
  2. At the top of the page, click Downloads.
  3. On the Downloads page, select Citrix App Layering from the list.
  4. On the Citrix App Layering page, click Citrix App Layering <versionNumber>.
  5. Under For an existing deployment, download the upgrade package, click Download File for your version.
    The file downloads to the local machine.

Load the App Layering upgrade

  1. Navigate to the .zip file and extract the files.
  2. Copy the upgrade to the servers where you install the appliance software, Agent, or machine OS tools.
  3. Log on to the management console, select System and then click Upgrade to start the Upgrade Wizard.
  4. On the Upgrade Disk Details tab, click Browse.
  5. Navigate to the upgrade file, and click Choose.
  6. Verify the upgrade path, and click Upgrade. The upgrade process starts and opens a status page in the browser.
  7. When the upgrade is complete, the status changes to Upgrade Status: Complete. Refresh the webpage to return to the management console.
  8. Verify that the upgrade was successful by clicking the About link in the management console to confirm the version number. 

Upgrade the App Layering agent

When you use Provisioning Services or elastic layers, the agent is required.

To upgrade the App Layering Agent

  1. Uninstall the previous version of the App Layering Agent from the servers where they are installed.
  2. Copy the App Layering Agent upgrade file to the Provisioning Service servers where you install the agent.
  3. Double-click the upgrade file, and follow the instructions for upgrading the App Layering Agent.

Create a Cloud Connector for accessing the management console in Citrix Cloud (Labs)

If you want to access the management console in Citrix Cloud, install a Cloud Connector.

To install a Cloud Connector

  1. Log on to the Citrix Cloud. A Citrix App Layering tile appears at the bottom of the page.
  2. On the Citrix App Layering tile, click Request Trial, and check your email for a message from Citrix Cloud.
  3. In the message you received, click Sign In. You return to Citrix Cloud.
  4. Click Manage on the App Layering tile. The Citrix App Layering page opens.
  5. Read the Overview. When ready, click Get Started to open the Getting Started tab.
  6. In step 1, click Get Cloud Connector.
    For instructions, click the Documentation link.
  7. Use the documentation to install a Cloud Connector, then return to the Getting Started tab.
  8. In step 4, the Documentation link opens the instructions for logging in. 
  9. Click Log into Appliance. The Manage tab opens. Follow the instructions to access the appliance. 

Known issues

The following are known issues when you access the management console in Citrix Cloud.

  • Accessing the console. Accessing the console in Citrix Cloud can take up to one minute. Each time you log on, you must type the IP address again.
  • Session time-out error. If you see a session time-out error, click within the window and press Control-R to refresh.
  • Hidden controls and tabs.
    • Expanding menu. Near the top of the page, there is an expandable menu where you can access Citrix Receiver and other options. Click the Citrix Receiver icon to expand the menu.
    • Browser tab bar. Toward the bottom of the page, hover over the black bar. A browser tab bar opens. Each page that is open appears as a tab in the black bar. For example, when you open the documentation, you can use the browser tab bar to return to the management console.
  • Remember Me feature. The Remember Me feature does not save your user name.
  • Session time-out. A system settings time-out longer than 10 minutes is not honored.
  • Uploads. Upload layer and image icons, and certificates when you access the management console in a web browser, rather than Citrix Cloud.
  • Export Log Files requires Email Send Option. When you export App Layering log files, you must select the Email option on the Send Options tab. You cannot download the logs by using Citrix Cloud.
  • vSphere packaging links during layer creation. In the management console taskbar, the vSphere packaging links are broken.
  • Copy and paste. Use the Citrix Receiver clipboard to copy and paste. Copy and paste between the Citrix Receiver window and the local clipboard does not work.
  • Access on tablets and phones. The management console is available from a web browser on a computer only.