The App Layering upgrade process is partially automated. The appliance periodically checks for upgrades, and downloads available packages to your appliance. The appliance verifies the downloaded package, and extracts the files in the background.

When you next log in, a message indicates that an upgrade is ready to install. As an administrator, you can choose to:

  • Start Upgrade: Run the App Layering appliance software upgrade. (Administrators only.)
  • Remind Me Later: Wait seven days before reopening the message. Applies to individual users’ desktops.
  • Close: Dismisses the message, so you can manually start the upgrade later using System tab > Manage Appliance > Upgrade.

Only an administrator can run the upgrade. The Remind Me Later option lets users postpone the next upgrade message for seven days.

Notification when an upgrade is available

When an upgrade is available, every user receives a notification when they log in.

Notifications include:

  • If an update is not available: Nothing happens. Another check is made at the next scheduled interval.
  • If an update is available, but there is no network file share configured: The user receives a message that there is an upgrade available. It asks you to finish configuring the network file share.
  • If an update is available: A job is started to “Download Upgrade Media.” You can check for progress through the following tasks:
    • Downloading the upgrade media 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 requires Administrator intervention, the job fails with an error. For example:
        • Out of space on local storage.
        • Out of space on the network file share.
        • Invalid files found.


        If a job fails, it retries at the next check interval, regardless of whether the issue has been resolved.

  • If another update is found before a previously downloaded one is installed - The new upgrade is downloaded, and once successfully completed, becomes the “Upgrade Available.”
  • If one upgrade is downloading when another is made available - The running download is aborted and a new download is started. All files related to the in-progress download are deleted.

Before you start

  • Verify that a network file share has been configured. You can confirm the share by logging on to the 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.

Check for available upgrades (optional)

You usually don’t need to check for updates, since there are periodic checks. If you want to check anyway, here’s how.

  1. Log in as Administrator.

  2. Click the Start Upgrade button to open the Upgrade Wizard. The downloaded information is displayed in the Upgrade Disk field.


    As Administrator, you can select a different Upgrade Disk. You can also run the Upgrade “manually” by going to the System tab and selecting the Upgrade action as before. If an upgrade is available, the Upgrade Disk appears.

When a user who does not have administrator privileges logs in, the user cannot click the Start Upgrade button nor launch the Upgrade wizard.

Download and run the App Layering upgrade

If firewall requirements prevent automatic downloading, download the upgrade package from the Citrix download site. Copy the package to the network fileshare where the appliance can access it.

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

If you are upgrading from App Layering 18.12 or earlier

As of Release 18.12, the TEST and SAVE buttons check the VMware vSphere privileges. A pass means that the appliance has permissions to create, edit, and delete virtual machines.

If upgrading from release 18.12 or earlier, expect to set a few more permissions that are now required. Create another role and assign the permissions at the vCenter level.

Create another role

Because the Virtual Machine > Inventory > Remove permission must be assigned at the vCenter level, you must create another role.

  1. In the vSphere Client, navigate to Home > Administration > Roles.
  2. Click Add Role, and enter a name, for example: CALAdmin-vmremove.
  3. Add only Virtual Machine > Inventory > Remove. Everything else can remain read-only.
  4. In the vSphere Client, navigate to Home > Inventory > Hosts and Clusters.
  5. Select the vCenter Permissions tab, right-click, and select Add permission (or modify the permissions on an existing account).


    Make sure the account is the one that owns the Datacenter permissions set previously.

  6. Select the new CALAdmin-vmremove role you defined. Make sure the Propagate to Child Objects check box is selected and then click OK.


    You can set all permissions at the vCenter level, if your security policy allows it.

Enable the following permissions

Enable the following permissions:

  • Datastore > AllocateSpace
  • Datastore > Browse
  • Datastore > FileManagement
  • Folder > Create
  • Global > CancelTask
  • Host > Config > SystemManagement
  • Network > Assign
  • Resource > AssignVMToPool
  • System > Anonymous
  • System > Read
  • System > View
  • VApp > Export
  • VApp > Import
  • VirtualMachine > Config > AddExistingDisk
  • VirtualMachine > Config > AddNewDisk
  • VirtualMachine > Config > AddRemoveDevice
  • VirtualMachine > Config > Annotation
  • VirtualMachine > Config > CPUCount
  • VirtualMachine > Config > EditDevice
  • VirtualMachine > Config > Memory
  • VirtualMachine > Config > RemoveDisk
  • VirtualMachine > Config > Rename
  • VirtualMachine > Config > Resource
  • VirtualMachine > Config > Settings
  • VirtualMachine > Config > UpgradeVirtualHardware
  • VirtualMachine > Interact > ConsoleInteract
  • VirtualMachine > Interact > DeviceConnection
  • VirtualMachine > Interact > PowerOff
  • VirtualMachine > Interact > PowerOn
  • VirtualMachine > Interact > Reset
  • VirtualMachine > Interact > SetCDMedia
  • VirtualMachine > Interact > ToolsInstall
  • VirtualMachine > Inventory > Create
  • VirtualMachine > Inventory > CreateFromExisting
  • VirtualMachine > Inventory > Delete
  • VirtualMachine > Provisioning > Clone
  • VirtualMachine > Provisioning > CloneTemplate
  • VirtualMachine > State > CreateSnapshot

Disable the following settings

For your reference, be sure to disable the following settings:

  • VApp > ApplicationConfig
  • VirtualMachine > Config > AdvancedConfig
  • VirtualMachine > Config > ChangeTracking
  • VirtualMachine > Config > ManagedBy
  • VirtualMachine > Config > ResetGuestInfo
  • VirtualMachine > Config > SwapPlacement
  • VirtualMachine > Interact > AnswerQuestion
  • VirtualMachine > Interact > ConsoleInteract
  • VirtualMachine > Interact > Suspend
  • VirtualMachine > Inventory > Register
  • VirtualMachine > Inventory > Unregister
  • VirtualMachine > Provisioning > Customize
  • VirtualMachine > Provisioning > DeployTemplate
  • VirtualMachine > Provisioning > MarkAsTemplate
  • VirtualMachine > State > RemoveSnapshot

Upgrade the App Layering agent (if using the agent)

To upgrade the App Layering agent:

  1. Copy the agent upgrade file to the servers where the agent is installed.
  2. Double-click the agent upgrade file, and follow the instructions for upgrading the agent.

Roll out the upgrade

App Layering upgrades include driver updates, along with the new features and bug fixes documented in the What’s new.

Select each of your image templates, verify the settings, and use it to publish new versions of the layered images. Use the new images to provision your systems.

To roll out the upgrade:

  1. Log into the layering management console.
  2. Select the Images tab. Your image templates are displayed.
  3. If you want to verify or update a template’s settings, select the image template, and click Edit Template. Edit the settings and click Save Template and Publish on the last tab of the wizard.
  4. If the image template does not need editing, simply select the template, click Publish Layered Image on the action bar. In the wizard that opens, click Publish Layered Image.
  5. Once published, use the new layered images to provision your systems.