Product Documentation


Jan 11, 2018

To start installing App Layering, you need the following:

Installation package

The installation package, citrix_app_layering_xenserver_4.x.x, includes:

File Description


OVA file for the appliance virtual machine


App Layering Agent installer


OS machine tools

Deploy the App Layering appliance

  1. Log on to the Citrix Cloud. Find the Citrix App Layering tile on the page and then click Request Trial.

  2. Check your email for a message from Citrix Cloud.

  3. In the email message, click Sign In. You return to

  4. Click Manage on the App Layering tile. The Citrix App Layering page opens.

  5. Read the Overview to become familiar with the service. When ready, click Get Started to open the Getting Started tab.

  6. Under Step 1, click Get Cloud Connector. For instructions, click Documentation.

  7. Use the Connector documentation to install a Cloud Connector, then return to the Getting Started tab.

  8. At the top of the page, select the hypervisor where you are deploying the App Layering service. This selection determines which platform-specific installation package is downloaded in Step 2.

  9. Under Step 2, click the Download for Hypervisor button to download the appliance installation package for your hypervisor.

  10. Under Step 3, right-click Instructions, open the page in a new browser tab, and select your hypervisor. The installation instructions for your hypervisor appear.

  11. Extract the download package, The files included are previously listed.

  12. Extract the xenserver_elm_4.x.x.x.ova file to a folder on your local drive.

  13. In your XenCenter client, select File > Import.

  14. In the wizard that opens, select the following values:
    • Import Source - Browse to the source on your local drive.
    • Location - Choose the XenServer where you want to deploy the appliance.
    • Storage - Use the default value to put storage disks on the Local XenServer Storage.
    • Networking - Select the correct network for your XenServer configuration.
    • Security - This tab is not available. Click Next.
    • OS Fixup Settings - Select Don't use Operating System Fixup.
    • Transfer VM Settings - Choose the correct network and choose DHCP.
    • Finish - Review your settings and then click Finish.
  15. Switch to Notification view and wait for the deployment to complete. The process can take 20–35 minutes.

  16. Switch to Infrastructure view.

  17. Rename your new appliance:

            a. Select your new appliance, which has the name


            b. Click Properties, and enter a new name and description for your new appliance.

            The new virtual machine has 8 GB of memory and 4 CPUs.

  1. Under Step 4, the Documentation link opens the instructions for logging in.

  2. Click Log into Appliance. The Manage tab opens. Follow the instructions to log on to the appliance.
    The installer prompts you for the credentials (address, user name, and password) for your App Layering appliance. 

  3. Type the IP address and logon for an administrator with permission to access the App Layering management console.

The first time you log onto the appliance you are required to change the App Layering administrator passwords, For details, see Change administrative passwords

Be sure to install the App Layering Agent, if your environment requires it. See the next section for details.

Install the App Layering Agent


The App Layering Agent is required for Provisioning Services and connector scripts.

The App Layering Agent enables the App Layering appliance, also known as Enterprise Layer Manager (ELM) or the App Layering packaging machine virtual machine to run PowerShell commands locally. If you supply the proper credentials, the agent can run PowerShell commands as a specific user.

The App Layering Agent is required in cases where one of your connector configurations starts a PowerShell script. The script includes connector configurations that you use to do the following.

  • Publish layered images to a provisioning system.
  • Package layers in your hypervisor environment.

The App Layering Agent installer prompts you to register the agent with an App Layering appliance. If you do not register the agent during installation, you can manually register it later. However, remember that the PowerShell scripts do not run until the agent is registered with the ELM.


Before you install the App Layering Agent, you must have the following requirements on the system where you are installing the App Layering Agent:

  • An account with administrator privileges
  • .NET 4.5
  • PowerShell 3.0 or greater
  • Windows PowerShell snap-in
    Before using the App Layering Agent on a Provisioning Services server, ensure that you installed the PowerShell snap-in.
    • For Provisioning Servers 7.7 and later, you must install the PowerShell snap-in Citrix.PVS.Snapin.dll.
    • For Provisioning Services 7.6 and Provisioning Services 7.1, you must install the McliPSSnapIn.dll. Use the installutil.exe to install the snap-in.

Example (7.6):
At a command prompt, type:

Change directory 复制

cd c:\program files\citrix\provisioning services console

At a command prompt, type this command and then press Enter:

Command 复制

"C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe" McliPSSnapIn.dll

Example (7.7):
At the command prompt, type: 

Change directory 复制

cd c:\program files\citrix\provisioning services console

At the command prompt, type this command and then press Enter:

Command 复制

"C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe" Citrix.PVS.snapin.dll

On Windows 2008 R2, you must also enable PowerShell remote commands. For background information, see the Microsoft article Enable-PSRemoting.

If your 2008 R2 OS does not have PowerShell remoting enabled, run the following PowerShell command on the Provisioning Services server:

Command 复制


If you previously installed the App Layering Agent, you can download updated versions from the Citrix downloads page. The App Layering Agent is a standalone installation package and is also included in the full App Layering software package.

To download the App Layering Agent

  1. Go to the Citrix home page and then click Sign in.
  2. Click Downloads and then select Citrix App Layering in the drop-down list.
  3. On the Citrix App Layering page, under Citrix App Layering 4.4 > Product Software, click Citrix App Layering 4.4.
  4. At the bottom of the page, click Tools.
  5. Under Citrix App Layering 4.4 Agent, click Download File.
    The file citrix_app_layering_agent_installer.exe downloads to your computer.

To install the App Layering Agent

Log on as an administrator to the system where you are installing the agent.

Copy the file citrix_app_layering_agent_installer.exe from your computer to the Provisioning Services server.

Run the installation program as an administrator. When prompted, type the path to the directory where you want to install the App Layering Agent. The default location is C:\\Program Files (x86)\Unidesk\Agent.

The App Layering Agent installer checks to ensure that all the prerequisites are present. If any prerequisites are missing, the installer notifies you and then exits without installing.

The installer prompts you for an Agent Port number. You can accept the default port number (8016). If the default port is in use, you can specify a different port number.

The installer prompts you for the credentials (address, user name, and password) for your App Layering appliance. Type the IP address and logon for an administrator with permission to access the App Layering management console.


If you don't register the App Layering appliance now, you can register the appliance later. For more information, see the procedure Register with the App Layering appliance manually.

Click Finish to exit the wizard.

Register the App Layering Agent manually

If you did not register the App Layering Agent with an App Layering appliance during installation, you can register it manually.

To register the App Layering Agent manually

Log on as an administrator to the server where you installed the App Layering Agent.

Open a command window (cmd.exe) as an administrator. Go to the directory where you installed the App Layering Agent. For example:

Change directory 复制

CD c:\\Program Files (x86)\Unidesk\Agent

Run the following command by using the IP address of the App Layering appliance where indicated:

Command 复制

Unidesk.Agent.Service.exe register /i /e:IP_address_of_ELM /u:Administrator

When prompted, type the password for an administrator with privileges. Ensure that the password is for the App Layering management console.

When registration is done, a message appears that informs you of the successful outcome. The App Layering Agent registration appears in the audit log for the management service.

If the process is not successful, review the log file at \Unidesk\Agent\Logs\unidesk.agent.log file in the App Layering Agent installation directory. You can also view Help for the App Layering Agent command-line options by running the following command:

Command 复制

Unidesk.Agent.Service.exe /?