Product Documentation

Citrix PVS connector configuration

Jan 11, 2018

A Citrix Provisioning Services (PVS) Connector Configuration contains the credentials and storage location the appliance needs to connect to PVS, and it identifies the properties to be associated with the vDisk.

Each Connector Configuration is set up to access a storage location via a specific account. For more about Connectors and Connector Configurations, see Add a Connector Configuration.


When you create an Image Template for publishing Layered Images to your PVS environment, you also create a PVS Connector Configuration. To create a PVS connector configuration you need a PVS account and account information.

 PVS must be running as a domain account

For the App Layering service to work correctly with PVS, the PVS services must be running as a domain account. This is because domain accounts have permissions to access the PVS store and the local system account does not.

If your PVS server is configured to use the local system account, which is the default setting, you can change the account by running the PVS configuration tool. This tool gives you an option to run as local system or use a domain account. Choose a domain account.

PVS server and account information

For the App Layering service to access the location in your PVS environment where you want to publish a Layered Image, you need to supply the credentials and location in a PVS Connector Configuration.

The information you need for the PVS Connector Configuration includes.

  • Name - A useful name to help identify and keep track of this connector configuration.
  • Console - The name of the PVS server on which the Unidesk agent is deployed. This is the server to which the vDisk will be published.
  • Domain User - User name of a domain account that has permission to manage PVS. This account is used by the agent to run PVS Powershell commands. This account must have Read/Write access to the PVS store for writing the published vDisk.
  • Password - Password for the domain user account.
  • Site Name - Name of the Site this vDisk is to be a member of.
  • Store Name - Name of the Store that this vDisk is a member of.
  • Write Cache - When a new Disk is being created, this value sets the Write Cache type of the new Disk. Possible values include:

    • Cache on Server
    • Cache on Server, Persistent
    • Cache in Device RAM
    • Cache in Device RAM with Overflow on Hard Disk
    • Cache on Device Hard Drive

    When choosing a Write Cache option, consult the PVS documentation to ensure that the PVS servers and target devices that use this vDisk are properly configured for the type you select.

  • License Mode - Sets the Windows License Mode to:
    • KMS - Key Management Service
    • MAK - Multiple Activation Keys
    • None
  • Enable Active Directory machine account password management - Enables Active Directory (AD) password management. The default value is Enabled.
  • Enable Load Balancing - Enables load balancing. for the streaming of the vDisk
  • Enable Printer Management - When enabled, invalid printers will be deleted from the Device.

Create a new Connector Configuration for PVS

If you don't yet have a Connector Configuration that includes the PVS server information and credentials for the server where the Layered Image will be published, add one now.

To add a new Connector Configuration:

  1. In the Publish Layered Image wizard, click the Connector tab.
  2. Below the list of Connector Configurations, click the New button. This opens a small dialog box.
  3. Select the Connector Type for the platform and location where you are publishing the Layered Image. Then click New to open the Connector Configuration page.
  4. Complete the fields on the Connector Configuration page. For guidance, see the above field definitions.
  5. Click the TEST button to verify that the appliance can access the location specified using the credentials supplied.
  6. Click SAVE. The new Connector Configuration should now be listed on the Connector tab.

Script Configuration (Optional, Advanced feature)

When creating a new Connector Configuration, you can configure an optional Powershell script on any Windows machine running an App Layering Agent—the same agent used on the Provisioning Services server. These scripts must be stored on the same machine that the Agent is installed on, and will only run after a successful deployment of a Layered Image. Some preset variables enable scripts to be reusable with different template images and different connector configurations. These variables also contain information needed to identify the virtual machine created as part of the published layered image in Provisioning Services.

Execution of these scripts will not affect the outcome of the publish job, and progress of commands executed in the script will not be visible. The Provisioning Services connector logs contain the output of the script after it runs.

Configure a Script (Remember, this is optional)

If you want a script to run each time a Layered Image is published, complete these steps using the values described in the sections that follow.

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

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

  2. If the Navigation menu on the left is not open, select it and click Script Configuration to open the Script Path page.

  3. Complete the required fields using the values detailed herein, and click Save.

Script Configuration fields

  • Enable script - Select this check box to enable the remaining fields. This allows you to enter a script that will be executed each time a Layered Image is published.
  • Script Agent - The agent machine where the scripts will be located and executed from.
  • Username (optional) - The username to impersonate when running the script. This can be used to ensure the script runs in the context of a user that has the needed rights/permissions to perform the operations in the script.
  • Password (optional) - The password for the specified username.
  • Path - A full path and filename on the agent machine where the script file resides.

Other Script Configuration values

PowerShell variables

When the script is run, the following variables are set and can be used in the PowerShell script:

Value Applies to connector types Value determined by which code Description



Common code

The name of the connector configuration that the script configuration is associated with.



Common code

The name of the layered image template that was used to build or publish the layer image.



Common code

  • Windows7
  • Windows764
  • Windows200864
  • Windows201264
  • Windows10
  • Windows1064



Provisioning Services

The internal id for the virtual disk (vDisk).

User Impersonation

The Agent, which runs as a service on a Windows machine, runs under either the local system account or the network account. Either of these accounts may have some special privileges, but they often are restricted when it comes to executing specific commands or seeing files in the file system. Therefore, the App Layering service gives you the option of adding a domain user and password that can be used to "impersonate" a user. This means that the script can be executed as if that user had logged onto the system so that any commands or data will be accessible subject to those user rights and permissions. If no user name or password is entered, the script executes using the account under which the service is configured to run.

Script Execution Policy

Script execution policy requirements are generally up to you. If you intend to run unsigned scripts, you must configure the execution policy to one of the more lenient policies. However, if you sign your own scripts accordingly, you can choose to use a more restrictive execution policy.