Product Documentation


Jan 11, 2018

Before you start

To get started in Azure, you need:

  • An Azure subscription
  • A Virtual Network in Azure. Your deployment in Azure can operate in a point-to-site or site-to-site Virtual Network.

Note: If you have not already set up a connection to an Azure Virtual Network, see Get started with Azure for more information.

  • The storage and Azure requirements listed here
  • Azure Powershell v3 installed in the storage location where you want to install the App Layering appliance (Enterprise Layer Manager)

Installation package

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

File Description

VHD file for the appliance VM


Installation Script


App Layering Agent installer


Azure Credentials Tool


OS Machine Tools


App Layering Template

Installation script

The installation script included in the installation package does the following. It:

  • Copies the included VHD to the Azure location you specify.
  • Creates a virtual machine in Azure using the VHD,
  • Attaches the repository disk.
  • Boots the Azure appliance.

When you run the script:

  • IMPORTANT: Be sure to note the Resource group location you select, as you will need this information later. For more information about resource groups, refer to Using the Azure Portal to manage your Azure resources.
  • When selecting a virtual machine size, it is strongly recommended that you create a D3 Standard machine.
  • The name you specify for the new virtual machine must comply with Azure naming conventions.
  • Select a Virtual Network in which HTTP port: 80 is accessible (Public IP can be disabled).
  • On the Monitoring Diagnostics entry, select Disabled.

Deploy the App Layering appliance

  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

  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. 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 the hypervisor you have selected.

  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 are displayed.

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

  12. Extract the Azure_4.x.x zip file to a folder on your local drive.

  13. Open an Azure Powershell window.

  14. Execute the AzureELMDeploymentV2.ps1 script and answer the prompts. The script copies the VHD to the Azure location of your choice, and attaches the repository disk. It then boots the appliance. If the script fails, check the values to make sure that the values are correct for your environment.

  15. Back in the Cloud, under Step 4, the Documentation link opens the instructions for logging in. (The link below opens the same article.)

  16. Click the Log into Appliance button. This opens the Manage tab. Follow the instructions (link below) to log into the appliance.

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 (required for PVS and Connector Scripts)

The App Layering Agent enables the App Layering appliance or a Unidesk Packaging Machine VM 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 launches a PowerShell script. This includes Connector Configurations you use to:

  • 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 a App Layering appliance. If you do not register the agent during installation, you can manually register it later. However, keep in mind that the PowerShell scripts will 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
  • PowerShell Snap-in
    Before using the App Layering Agent on a PVS server you must ensure the PowerShell Snap-in is installed. This is a manual step.
    • For PVS 7.7 and later, you must install the Powershell Snap-in Citrix.PVS.Snapin.dll.
    • For PVS 7.6 and PVS 7.1, you must install McliPSSnapIn.dll. Use the installutil.exe to install the Snap-in.

Example (7.6):
From a command prompt, go to: c:\program files\citrix\provisioning services console
Run this command: "C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe" McliPSSnapIn.dll

Example (7.7):
From a command prompt, go to: c:\program files\citrix\provisioning services console
Run this 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 this Microsoft article:

If your 2008 R2 OS does not have PowerShell remoting enabled, run the following PowerShell command on the PVS server: Enable-PSRemoting  

Install the App Layering Agent

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

  2. Download the App Layering Agent from the installation page.

  3. Copy the citrix_applayering_agent_installer.exe file from the App Layering Agent folder to a convenient location on the PVS server.

  4. Run the citrix_applayering_agent_installer.exe as Administrator, and when prompted, enter the path to the directory where you want to install the App Layering Agent. The default location is C:\\Program Files (x86)\Citrix\Agent.

    The App Layering Agent installer checks to see if all Prerequisites are present. If any prerequisites are missing, the installer reports this and exits without installing.

  5. The installer prompts you for an Agent Port number. You can accept the default port number (8016) or specify a different one if the default port is already in use.

  6. The installer prompts you for the credentials (addressusername, and password) for your App Layering appliance. Register the App Layering Agent with the appliance by entering the IP address and login credentials for a Management Console user on the appliance with Administrator privileges, (for example, the credentials you use to log into the Management Console).

    Note: If the App Layering appliance is not available yet or you choose not to register with it now, you can manually register at a later time using the procedure described in Register with the App Layering appliance manually below.

  7. Click Finish to exit the wizard.

The App Layering Agent registration appears in the Audit log for the Management Service in the Management Console.

Register with the App Layering appliance manually

If the App Layering Agent was not registered with a App Layering appliance during installation, you can register it later by using the following procedure.

To manually register the App Layering Agent with the appliance:

  1. As an administrator, log in to the server where you installed the App Layering Agent.

  2. Open a command window (cmd.exe) as administrator and navigate to the directory where the App Layering Agent is installed. (The default location is C:\\Program Files (x86)\Citrix\Agent.)

  3. Run the following command, using the IP address of the appliance where indicated:

    Citrix.AppLayering.Agent.Service.exe register /i /e:IP_address_of_appliance /u:Administrator

  4. When prompted, enter the password for a user who has Administrator privileges in the Management Console on the appliance.

  5. When the registration process completes, a message appears informing you of the successful outcome. The App Layering Agent registration appears in the Management Console Audit log for the Management Service.

If the process does not succeed, examine the \Citrix\Agent\Logs\applayering.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: Citrix.AppLayering.Agent.Service.exe /?.