Product Documentation

Upgrade

Jan 11, 2018

Automatic updates of available package downloads

Citrix App Layering appliance, also known as Enterprise Layer Manager (ELM), automatically downloads upgrades, but the upgrades are not automatically installed. Instead, you are notified that an upgrade is available.

The appliance periodically checks for upgrades, and when one is found, downloads the package, verifies it, and extracts the files. Once the package is extracted, you are alerted that there is an upgrade ready.

If you log into the Management Console as Administrator, you can apply an upgrade either by clicking the Start Upgrade button on the notification, or by selecting System tab > Manage Appliance > Upgrade.

Notifications

Periodically, the appliance asks api.unidesk.com if an upgrade is available. The following sections walk you through common scenarios.

Note: If the appliance cannot access api.unidesk.com, auto-downloading will not work. The user will not see any error. However, there will be a note in the log that the check failed.

If an update is not available...
Nothing happens. Another check will be made at the next scheduled interval.

If an update is available, but there is no network file share configured...
The user will receive a pop-up (see below) to let them know there is an upgrade available, and that the administrator needs to finish configuring a network file share before it can be downloaded and applied.

If an update is available...
The Download Upgrade Media job is started, and it is visible in the task list. This job is responsible for:

  • Downloading the upgrade to local storage.
  • Ensuring the checksum of the successfully downloaded upgrade package is correct.
  • Extracting the downloaded upgrade package to the configured Network File Share. The download is extracted to the appliance's File Share:
    Location: NetworkFileShare\AppLayeringVersion
    Example: \\MyServer\AppLayeringFileShare\4.0.8
  • If extraction is successful, the next time any user logs in they will be notified that an upgrade is available.

If at any time during this process an error is encountered that requires Administrator intervention (out of space on local storage, out of space on the network file share, invalid file found, etc.) the job will fail with an appropriate error.

Note: If a job fails it will be retried at the next check interval regardless of whether the Administrator has resolved the fixed.

If another update is found before a previously downloaded one is installed...
The new upgrade will be downloaded (see above) and once successfully completed it will become the Upgrade Available.

If one upgrade is downloading when another is made available...
The running download will be aborted and a new download (as above) will be started. In this case, all files related to the in-progress download will be deleted.

User notification when an upgrade is available

When logging in every user will receive a notification that an upgrade is available. However, only an Administrator will be able to run the upgrade.

Prerequisites

Verify that a Network File Share has been configured. You can confirm that this has been done by logging into the Management Appliance, selecting System > Settings and Configuration, and finding the Network File Share setting. If the file share has been configured, you can upgrade the appliance. 

Download packages

Platform Package Files Included

Citrix XenServer

app_layering_upgrade_xenserver_pkg_4.x.x.zip

upgrade_xenserver_elm_4.x.x.xx.vhd

Microsoft Azure

app_layering_upgrade_azure_pkg_4.x.x.zip

upgrade_azure_elm_4.x.x.xx.vhd

Microsoft Hyper-V

app_layering_upgrade_hyperv_pkg_4.x.x.zip

upgrade_hyperv_elm_4.x.x.xx.vhd

VMware vSphere

app_layering_upgrade_pkg_4.x.x.zip

upgrade_vmware_elm_4.x.x.xx.vhd
app_layering_agent_installer.exe

Note: An Agent upgrade is only required if you've installed the agent for your implementation, for example, if you are using PVS, or Connector Scripts.

Back up the appliance

Take a snapshot or checkpoint of the appliance.

Download the upgrade media to the network file share

The App layering 4 upgrade files include both the Appliance and Agent upgrades. The Agent upgrade can be used to bring either or both of these installations up to date:

  • The agent on PVS servers.
  • Servers where Layered Images are enabled for Elastic Layers.

To download the upgrade package:

  1. In a network browser, navigate to the App Layering Download page, and sign in.
  2. Download the App Layering Upgrade package for your platform to the \Upgrade folder on the Network File Share.
  3. Unzip the package in \Upgrade.
  4. Copy the Agent upgrade to the server(s) where the agent is installed, and refer to Upgrade the App Layering Agent below.

Load the App Layering upgrade

  1. Log into the Management Console, select System and click the Upgrade action to launch the Upgrade Wizard.
  2. On the Upgrade Disk Details tab, click Browse.
  3. Navigate to the upgrade file, and click Choose.
  4. Verify the Upgrade path, and click Upgrade. This starts the upgrade process, and opens a status page in the browser.
  5. Once the upgrade has completed, the status changes to "Upgrade Status: Complete."
  6. Refresh the Web page to return to the UMC.
  7. 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 using PVS 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 server(s) where they are installed.
  2. Make sure that you have copied the App Layering Agent Upgrade file to the PVS server(s) where the agent is installed.
  3. Double-click the Agent upgrade file, and follow the instructions for upgrading the Agent.

Create a Cloud Connector for accessing the Management Console via Citrix Cloud (Labs)

If you want to access the Management Console via the Citrix Cloud, install a Cloud Connector as described here. For known issues when accessing the Management Console via the Cloud, see the list of issues below.

  1. Log in to the Citrix Cloud. A Citrix App Layering tile should be displayed 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 the Sign In button. This returns you to the Cloud.
  4. Click Manage on the App Layering tile. The Citrix App Layering page is displayed.
  5. Get familiar with the service by reading the Overview. When ready, click the Get Started button to open the Getting Started tab.
  6. Under Step 1, click the Get Cloud Connector button, and for instructions click the Documentation link.
  7. Use the Connector documentation to install a Cloud Connector, then return to the Getting Started tab.
  8. Under Step 4, the Documentation link opens the instructions for logging in. 
  9. Click the Log into Appliance button. This opens the Manage tab. Follow the instructions to access the appliance. 

Known issues

As a Labs feature, you may encounter a few behaviors that are either not optimal or not yet implemented.

  • Accessing the console. Accessing the console via the Cloud in can take up to one minute. As the console is being launched, the page is white. And every time you log in, you must re-enter the IP address.
  • Session timeout error. If you see a session timeout 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 Receiver and other options. Click the Receiver icon to expand the menu.
    • Browser tab bar. Toward the bottom of the page, hover over the black bar. A browser tab bar is revealed, where each page you have open is displayed in 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 Timeout. A System Settings Timeout longer than 10 minutes is currently not honored.
  • Uploads. Layer and Image Icons, and Certificates must be uploaded when accessing the Management Console via a web browser, rather than via the 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, as the logs cannot be downloaded via the cloud.
  • vSphere packaging links during Layer Creation. In the Management Console Taskbar, vSphere packaging links are broken.
  • Copy and Paste. Copy and Paste between the Receiver window and the local clipboard must be performed using the Receiver clipboard.
  • Access via Tablets and Phones. Tablet and phone usage is not supported. This is designed for the full browser experience.