Product Documentation

Citrix MCS in XenServer

May 30, 2018

The XenServer Connector Configuration contains the information that allows the Citrix App Layering appliance to publish Layered Images to Machine Creation Services (MCS) in your XenServer environment. The information includes user credentials and storage location.

To publish Layered Images, use the MCS for XenServer Connector Configuration. In the Connector Configuration wizard, ensure that you configure a virtual machine template. Then, the Layered Image you publish is in a ready-to-use virtual machine, the image is shut down and a snapshot taken.You can use the virtual machine in your XenServer environment without further modifications.

Each Connector Configuration is set to publish Layered Images to a specific storage location in your environment. If you publish to multiple locations, you might need more than one MCS Connector Configuration.You can also publish each Layered Image to a location convenient to the system you provision with the published image.

Notes:

This Connector Configuration is for publishing Layered Images. You cannot package Layers in the MCS environment. For packaging Layers, use a XenServer Connector Configuration.

A Personal vDiskis not supported for MCS. The published desktop images are non-persistent. You can only use aPersonal vDiskwhen you publish to Citrix Provisioning Services.

Before you start

You can use your XenServer environment for creating Layers, and for publishing Layered Images. Each Connector Configuration accesses a specific storage location in your XenServer environment. You might need more than one XenServer Connector Configuration to access the correct location for each purpose. Further, you can publish each Layered Image to a location convenient to the system where you provision the published image.

XenServer uses a pod-like architecture where you interact with individual servers or clusters of servers, instead of a central management server. You manage the pods by using command-line access or GUI management software such as XenCenter. Install XenCenter on your desktop and then you can connect individually to each standalone host or to clusters of hosts.

Using the App Layering Service for the first time

If you want to create layers by using a XenServer virtual machine, you need a XenServer Connector within App Layering.When publishing Layered Images to XenServer, you need a Connector Configuration for each of your publishing locations as well.

You select a Connector Configuration in the wizards Create Layer and Publish Layered Image. If you need a Connector Configuration for the task, you can create one. To do so, click New on the Connector tab in thewizard.

Required information for XenServer Connector Configuration settings

In the XenServer Connector Configuration wizard,you can browse for the XenCenter server, data store, and host to use for a new configuration.

Important:

The fields are case-sensitive. Any values that you type manually must match the case of the object in XenServer, or the validation fails.

  • Configuration name - The name for the connector configuration.
  • XenServer address - The name of the XenServer host with which the appliance integrates.
  • User name and password - The credentials for the account that the appliance uses to connect to XenServer.
  • Use Secured Protocol - The default setting that allows SSL encryption for the API connection traffic between the Connector and Citrix XenServer.
  • Allow Certificate Errors - Enables the system to ignore certificate errors. By default, this setting is disabled.
  • Template - The virtual machine template that you can use for cloning. The list of choices includes custom virtual machine templates only, rather than actual virtual machines or any of the built-in templates. The selected template cannot have any disksattachedand must have at least one network card attached. If the template does not have these items, an error appears when trying to validate or save the configuration.
  • Storage Repository - The storage repository for the uploaded disk. The list is filtered to show repositories that can contain virtual hard disks (VHDs). ISO repositories are filtered out.
  • Use HTTPS for File Transfers - Encrypts the image file transfers. HTTPS is selected by default for uploads and downloads. You can clear the check box for increased performance.

Virtual Machine Organization

You can organize XenServer virtual machines by folder or by tag. These organizational tools are optional when creating and managing virtual machines through XenCenter or other tools.XenServer Connector Configurations do not allow you to specify folders or tags. Virtual machines created by the XenServer Connector, both Packaging Machines, and published Layered Image can use both organizational tools.

Tags

If the template specified in the XenServer connector configuration contains tags, the tags carry over to any virtual machine cloned from that template. Therefore, all packaging virtual machines or published layered images receive the same tags that are in the template. Additionally, the XenServer Connector adds three tags.

  • Unidesk - Lists all virtual machines created by the XenServer Connector regardless of their purpose or image.
  • Purpose Tag - Tags all packaging machines with App Layering Packaging Machine. Tags all published layered image virtual machines with App Layering Published Images.
  • Image/Layer Name - Provides a tag on all packaging machines with the layer name for the layer from which they generate. Tags all published layered images with the template image name.

If you are using XenCenter, you can view your virtual machines by tag by selectingOrganization Viewsand then selectingBy Tag.

Folder

By default, virtual machines created by the XenServer Connector are not placed in a folder. If the specified template is in a folder, the virtual machines that the Connector Configuration creates are in the same folder.All packaging virtual machines and published Layered Images are placed in that same folder. There are not separatefoldersfor packaging virtual machines or published Layered Images.

Machine Network Connectivity

When you create virtual machines with the XenServer Connector, the virtual network settings in the source template of the Connector Configuration carries over. An option is not available in the Connector Configuration UI to override the network settings.

The XenServer connector does not work correctly with XenServer clusters. If the host in the configuration is part of a cluster, you must specify the primary host for the connector to work.However, if the primary XenServer host fails and a new primary is elected, you must update the XenServer configuration.

Create a Connector Configuration

To type values:

  • Type the first three Connector fields manually. After validating the credentials in those fields, you can select values for the remaining fields from drop-down menus.
  • To type values manually, click to put the cursor in the field and type the value, making sure that the case matches the value in XenServer.
  • To select a value from a drop-down list, click once to put the cursor in the field. Then, click a second time to display the list of possible values.

To add a Connector Configuration

  1. In the wizard for creating a Layer or for adding a Layer Version, click the Connector tab.
  2. Under the list of Connector Configurations, click New. A dialog box opens.
  3. Select the Connector Type for the platform and location where you are creating the Layer or publishing the image.
  4. Click New to open the Connector Configuration page.
  5. Type the configuration Name, the XenServer Address, User Name, and Password. For guidance, see the previously described field definitions.
  6. Click CHECK CREDENTIALSunder the XenServer Configuration field,which enables theVirtual Machine Clone Settings field.
  7. Select the Virtual Machine Template.
  8. Select the Storage Repository and click TESTto verify that App Layering can access the location specified by using the supplied credentials.
  9. Click Save. The new Connector Configuration appears on the Connector page.

Script configuration (optional, advanced feature)

When you create a Connector Configuration, you can configure an optional PowerShell script to run on any Windows machine running an App Layering Agent. Store the scripts on the same machine on which you install the Agent. The script runs only after a successful deployment of a Layered Image.

Some preset variables are available to enable scripts to be reusable with different template images and different connector configurations.The variables contain the information to identify the virtual machine that is part of the published Layered Image in XenServer.

Running these scripts do not affect the outcome of the publish job, and the progress of commands run in the script are not visible. The XenServer connector logs contain the output of the script after it runs.

Configure a script (optional)

  1. Complete and save the Connector Configuration as previously described.

    Note:

    Before selecting the Script Configuration page, you must save (or discard) any edits to the Connector Configuration settings,

  2. In the leftNavigation menu, click Script Configuration to open the Script Path page.

  3. Complete the required fields by using the values in the table in the section “Other Script Configuration Valuesand then click Save.

Script Configuration fields

  • Enable script - Select this check box to enable the remaining fields. After enabling the script, you can choose the script that runs each time you publish a Layered Image.
  • Script Agent - The agent machine where the scripts are located and run from.
  • User name (optional) - The user name to impersonate when running the script.The name ensures the script runs with the required user rights and permissions to perform the operations in the script.
  • Password (optional) - The password for the specified user name.
  • Path - A full path and file name on the agent machine where the script file resides.

Other Script Configuration Values

When you run the script, it sets the following variables, which you can use in the PowerShell script:

Value Applies to connector types Value determined by which code Description
connectorCfgName All Common code The name of the connector configuration that is associated with the script configuration.
imageName All Common code The name of the layered image template that was used to build and publish the layered image.
osType All Common code The operating system type of the published layered image. It can be one of the following values: Windows7; Windows764; Windows200864; Windows201264; Windows10; Windows1064
virtualInfrastructureServer All XenServer connector code The XenServer host specified in the connector configuration.
vmName All XenServer connector code The name of the virtual machine that was created.
vmId All XenServer connector code The virtual machine UUID (same as vmUuid)
vmUuid All XenServer connector code The virtual machine UUID (same as vmId)

Definition Scope

When the script variable is set for all platform connector types, or when it is specific to a particular connector type.

Value Source

Determines if the variable value is common code or by connector-specific code.