Citrix Provisioning – Create Devices

Last Modified: Apr 19, 2024 @ 4:39 am


This article applies to all 7.x versions of Citrix Provisioning, including 2402, LTSR 2203 CU4, LTSR 1912 CU8, and LTSR 7.15.45 (aka LTSR 7.15 CU9).

ūüí° ¬†= Recently Updated

Change Log

Target Device Template – vSphere

The hardware of the additional target devices must match the original virtual machine so that the drivers contained in the vDisk continue to function. The easiest way to preserve the hardware configuration is to clone the original virtual machine.

  1. Shut down the original virtual machine.
  2. Edit the Settings of the virtual machine and make sure there is a blank, formatted cache disk.
  3. Citrix Provisioning 2311 and newer only support UEFI. See Converting BIOS vDisks to UEFI at Citrix Docs.
  4. In the vSphere Client, right-click the original virtual machine, expand Clone, and click Clone to Template. The new machine must be a Template and not a regular virtual machine.
  5. In the Select a name and folder page, enter a name for the template, and click Next.
  6. In the Select a compute resource page, select the cluster and click Next.
  7. In the Select storage page, select a datastore for the template and click Next. Note: if you use the Citrix Provisioning wizards to create Target Devices, the new machines will be created on the same datastore as this template.
  8. In the Ready to complete page, click Finish.

Target Device Template – Hyper-V

If you store the template in the library then you might see the issue described in CTX128750 Hyper-V Synthetic Network Interface Card Reinitializes on New Target Devices. The article recommends cloning a real VM instead of a template VM but this might not work for Citrix Provisioning Citrix Virtual Desktops Setup Wizard.

  1. Edit the Properties of the original virtual machine and make sure there is a blank, formatted cache disk.
  2. Right-click the original virtual machine, expand Create and click Create VM Template.
  3. Click Yes to acknowledge that the source virtual machine will be destroyed.
  4. In the VM Template Identity page, give the template a name and click Next.
  5. In the Configure Hardware page, click Next.
  6. In the Configure Operating System page, select None ‚Äď customization not required, and click Next. There is no need to run SysPrep.
  7. In the Select Library Server page, select a library server, and click Next.
  8. In the Select Path page, click Browse to select a share, and click Next.
  9. In the Summary page, click Create.

Citrix Virtual Desktops Setup Wizard

The easiest way to create a bunch of Target Devices is to use the Citrix Virtual Desktops Setup Wizard that is built into the Citrix Provisioning Console. This wizard used to be named XenDesktop Setup Wizard.

If you prefer to script much of this wizard, see:

Do the following to launch the Citrix Virtual Desktops Setup Wizard:

  1. The Citrix Virtual Desktops Setup Wizard uses the Hosting Resources defined in Citrix Studio, so configure Citrix Studio > Configuration > Hosting with destination datastores and networks for the new Target Devices. For maximum control over datastore placement, create a separate Hosting Resource per datastore.
  2. Make sure the Template Target Device is on the same datastore that you want the new Target Devices to be stored on.
  3. If Hyper-V, make sure the VMM Console is installed on the same machine as the Citrix Provisioning Console.
  4. In the Citrix Provisioning Console, right-click the site, and click Citrix Virtual Desktops Setup Wizard.
  5. In the Welcome to Citrix Virtual Desktops page, click Next.
  6. In the Citrix Virtual Desktops Controller page, choose Customer-Managed Control Plane, enter the name of a Delivery Controller, and click Next.
  7. In the Citrix Virtual Desktops Host Resources page, select a hosting resource. This list comes from the Hosting Resources created inside Studio. Click Next.
  8. Use a service account to login to vCenter or SCVMM when prompted. Citrix Provisioning might use these credentials later to power manage the target devices.
  9. If you see a message about no available templates, then you need to move your virtual machine template to this datastore.
  10. In the Template page, select the Target Device template, and click Next.
  11. In the Citrix Virtual Desktops Host Resources Network page, select a network and click Next.
  12. In the vDisk page, select the Standard Image vDisk and click Next.
  13. In the Catalog page, enter a name for a new catalog, and click Next. Or you can add machines to an existing catalog.
  14. In the Operating System page, make your selection, and click Next.
  15. If you selected Single-session OS, then in the User Experience page, select random or static, and click Next.
  16. In the Virtual machines page:
    1. Enter the number of machines you want to create.
    2. Enter the number of vCPUs for each new virtual machine. For RDSH, you usually add between 4 and 8 vCPUs.
    3. Enter the amount of Memory for each new virtual machine.
      • To accommodate the Citrix Provisioning vDisk memory cache, add 256 MB (virtual desktop) or 4 GB of RAM (Remote Desktop Session Host) to the¬†Memory. See Citrix Blog Post Size Matters: PVS RAM Cache Overflow Sizing for more information.
    4. Specify the size of the cache disk: 20-40 GB for session hosts, or 5-10 GB for virtual desktops.
      • Any disks attached to the template will be ignored/discarded. To keep the disk in the template, see¬†CTX237313¬†PVS XDSW retain template disks.
    5. Select BDM disk or PXE boot.
      1. For PXE boot, the Target Devices must be on the same VLAN as the Provisioning servers.
      2. BDM disk burns the boot image into the new virtual machine’s disk. BDM Disk supports target devices on a different subnet than the Provisioning servers. Make sure the Target Device VM template does not have any Boot ISOs configured.
  17. Click Next.
  18. In the Active Directory page, PVS 2308 and newer let you create computer accounts in untrusted domains. Click Next. 
  19. In the Active Directory accounts and location page
    1. Select an OU.
    2. Enter a naming pattern for the new machines. Use ## to represent numbering.
    3. Select a Starting Index.
  20. Click Next.
  21. In the Citrix Provisioning server information page, PVS 2308 and newer let you enter boot addresses that work for UEFI targets. Choose or enter your boot PVS servers and click Next.
  22. In the Summary page, click Finish to start creating the machines. The wizard will power on the machines so it can format the cache disk.
  23. Then click Done.
  24. In Citrix Provisioning Console, if you go to Farm > Sites > mySite > Hosts, you’ll see the Hosting Resource used by the Wizard. If you open the Properties of the Hosting Resource…
  25. On the Credentials tab, you can see the credentials you used when running the wizard. You will probably want to change these to a service account.
  26. In Citrix Studio, you’ll see a new machine catalog.
  27. The Citrix Provisioning Citrix Virtual Desktops Setup Wizard seems to ignore zones, so you’ll have to move it to the correct zone manually.
  28. Create a new Delivery Group or add the machines to an existing Delivery Group.

Target Device Power Operation

If you used the Citrix Virtual Desktops Setup Wizard to create Target Devices, then the Target Devices are linked to a hosting connection and can be powered on from the Citrix Provisioning Console by right clicking the device and clicking Boot.

Target Devices created by the Citrix Virtual Desktops Setup Wizard have a VirtualHostingPoolId, which corresponds to the hosting connection listed under Sites > MySite > Hosts. When powering on the VM, Citrix Provisioning searches for a VM with the same name as the Target Device.

Boot Disk Manager (BDM) Partition Update

During Citrix Provisioning Citrix Virtual Desktops Setup Wizard, you can configure the Target Devices to use a BDM Partition to boot from Citrix Provisioning servers. This partition contains the IP addresses of the Citrix Provisioning servers. Prior to Citrix Provisioning 7.9, it was not possible to change the BDM Partition configuration.

In Citrix Provisioning 7.9 and newer, it is now possible to update the BDM Partition with the latest bootstrap info:

  1. In Citrix Provisioning Console, go to MyFarm > Sites > MySite > Servers, right-click each Citrix Provisioning server, and click Configure Bootstrap. Update the list of Citrix Provisioning servers.
  2. Make sure the Target Devices are powered off.
  3. Go to MyFarm > Sites > MySite > Device Collections, right-click a collection created by the Citrix Virtual Desktops Setup Wizard, expand Target Device, and click Update BDM Partitions.
  4. Citrix Provisioning 2311 and newer let you specify the Boot Servers.
  5. Click Update Devices.
  6. Click Close when done.

Citrix Studio Catalog of Citrix Provisioning Machines

The easiest method to create Citrix Provisioning Target Device machines (i.e. VDAs) and add them to a Machine Catalog is to run the Citrix Virtual Desktops Setup Wizard.

If you’re not able to use the Citrix Virtual Desktops Setup Wizard for any reason, then you can manually create Citrix Provisioning Target Device machines or use the Streamed VM Setup Wizard. Once the machines are created in the Citrix Provisioning Console, you need to Export them to a Delivery Controller.

In Citrix Provisioning 1906 and newer, to add Target Devices to a Machine Catalog, Citrix recommends that you use the new Export Devices Wizard because it works with both on-premises CVAD and Citrix Cloud. Find the wizard by right-clicking the Site name. See Export Devices Wizard at Citrix Docs. The Export Wizard is very similar to the Citrix Virtual Desktops Setup Wizard.

For Citrix Provisioning 1903 and older, do the following:

  1. In Citrix Studio, create a new Catalog.
  2. On the Introduction page, click Next.
  3. In the Operating System page, make a selection that matches the vDisk, and click Next.
  4. In the Machine Management page, change the Deploy machines using selection to Citrix Provisioning, and click Next.
  5. In the Device Collection page, enter the Provisioning server name, and click Connect.
  6. Select the Citrix Provisioning Device Collection, and click Next.
  7. In the Devices page, review the list of machines that will be added to the catalog, and click Next.
  8. In the Summary page, give the Catalog a name, and click Finish. You can now add these machines to a Delivery Group.
  9. You can later add more machines to the Device Collection in the Citrix Provisioning Console.
  10. To add the new machines to Citrix Studio, right-click the existing Catalog, and click Add Machines.
  11. In the Device Collection page, click Connect.
  12. Select the Device Collection containing new machines and click Next.
  13. In the Devices page, review the list of new machines, and click Next.
  14. In the Summary page, click Finish. You can now add these new machines to a Delivery Group.

Write Cache Disk

Write Cache Drive Letter

If the Write Cache disk is not mounting with the correct drive letter, see CTX133476 Explaining and Troubleshooting WriteCache Disk Drive Letter Assignment

Write Cache File Name

Citrix Provisioning has had three different cache names:

  • .vdiskCache is Legacy Ardence format (5 .x and before not supported anymore, you can delete this if your target software is running latest, this cache was optimized for size)
  • .vdiskdif.vhd is legacy hard drive cache (6.0 and above local hard drive cache, used standard 1mb sector size and is larger than the legacy cache but worked better with storage and was incrementally faster than Legacy Ardence format)
  • vdiskdiff.vhdx is Ram cache with overflow (7.1.4 and above RAM cache with overflow, 2 mb sectors larger than vhd but much faster and more compatible with storage)

Write Cache Filling Up Cache Disk

The vdisk cache is basically a difference disk and only contains the blocks that are written to the system drive so you cannot mount it or read the file, it is just block data.  Use a tool like Process Monitor from Microsoft (used to be sysinternals) and monitor the system drive. Any write to the system drive is redirected by the Citrix Provisioning software to the cache file.  Make sure that any software that is installed on the target image does not have an auto update feature enabled, redirect all user data to a network share and educate your users to make sure they are not doing something that will fill up the cache like downloading a video to the local system drive.

Be aware that the RAM cache with overflow to hard drive can use more space on your local drive, it is important even in the older cache that you perform regular maintenance on your vdisks some recommendations:

  • Merge to a new base disk when you have created 5 or more versions
  • After every merge to the base disk, mount the new base disk and defrag the disk, this is important to reduce sectors used in the local cache, it is very important with the new RAM cache with overflow to local disk but it can have a very positive impact with the legacy local cache. Refer to for more information.

Write Cache Size Monitoring

To view the size of Write Cache in RAM with overflow to disk, look in Task Manager for Nonpaged pool.

Citrix Blog Post Digging into PVS with PoolMon and WPA details how to use Windows Performance Analyzer to view Citrix Provisioning RAM cache and overflow.

Related Topics

154 thoughts on “Citrix Provisioning – Create Devices”

  1. hi on the section “Target Device Template ‚Äď Hyper-V” when trying to create a template so i can batch create a load of server 2022 UEFI machines (GEN2). it comes up with “sysprep Failed” despite i set the customisation to none. the only way currently i can create a load of machines is by cloning the build VM until i have the required amount of vm’s.

  2. Hi
    I am trying to rollout a Windows 11 target device from the template. When I rollout from the template, the VDI is created with only the Streaming NIC attached. It does not connect the Management NIC. Am I missing something here…

  3. Hi Carl, on the BDM partition – why would a device not show when selecting “Update BDM Partition”? When running it, the screen shows No devices to process.

  4. Hi,
    Quick question on whom/which process creates the BDM partition?
    I have a setup where I provision Xenapp Servers (Srv2019 VDA 2103.0.0.29045) on PVS ( with Xenserver 7.1CU2 on the hardware layer (because of Hardware limitations).
    At the moment I use PXE, but want to move to boot device manager. However when I use the wizard, and want to create the BDM partition automatically it fails with ‘cannot create BDM partition for device x’. Manually I can make it work by creating a vdisk and use BDM.exe on a server, and afterwards move it to the desired host, mounting it under /dev/xvda
    I’m just puzzled why it is not succeeding using the wizard.

    1. The wizard asks the hypervisor to power on the VM so it can create the partition, format the partition, populate the partition, and then shut down the VM.

  5. Unable to Update the recently created BDM file to an existing target device. I can utilize the newly created BDM iso if I spin up a new target device. The Target Device update BDM Screen Shows Success. But do not see the changes.

  6. Does Virtual Desktop Setup Wizard supports UEFI? I use Citrix hypervisor and i need to move all bios devices to UEFI. We use the BDM disk now from the wizard. Or do we need to use PXE now these days?

  7. I have a question about the Citrix Virtual Desktop Setup wizard in PVS.
    We have PVS 1912LTSRCU4 running and when I use the Citrix Virtual Desktop Setup wizard, at one point you get the option to “create a machine catalog” or “use an existing catalog”. When I choose for “use an existing catalog” I only get a list of 20 machine catalogs where I can choose from. We have much more machine catalogs so I cannot choose the right one because it is not in the list. Is this by design that 20 is the maximum that this wizard shows or is there another issue ?

  8. Excellent blog, thank you for your insights.

    I am currently running into an issue intermittently with Windows 10 (non-persistent) VDA deployed via PVS. Every few weeks i run into an issue where the VDAs do not boot up in a timely fashion. Typically, it would take a few seconds, but then @ times we run into 7-30 minute boot times on VDAs. The storage shows minimal IOPs and latency on deployment is extremely fast XIO array. Eventually they boot up, but we cannot seem to find the underlying issue of this intermittent boot up issue. Also @ times, we have migration stuck / failure issues when migrating to another cluster. But primarily our issue is with boot times. Any ideas of where we should be looking? Thanks in advance ūüôā

  9. Hi Carl, would you happen to know of any way to configure PVS to start an applicable naming scheme with 0 rather than 1? i.e. machine00,machine01,machine02 etc. etc.

    it would save a lot of effort rather than having to create the AD account manually, and import it as an existing account

      1. Thanks heaps for the quick response – probably a dumb question, but can Set-Acctidentitypool be used for machine catalogs created for use with PVS? It mostly seems to be referred to when using MCS.

  10. I’ve created at Win10 template, it’s in my one and only Datastore, I have a connection to vSphere in Studio and PVS Console but when I run Citrix Virtual Desktops Setup Wizard I receive “No Standard Image vDisk exists in this Site. You need at least one Standard Image vDisk to perform this action”

      1. Now I get this on the Esx Windows 10 vms when I try to boot them “efi system partition (esp) error: unsupported streaming aborted”

          1. From an ISO? I downloaded the Windows 10 iso from Mircrosoft site, then I installed a Windows 10 vm on ESX, cloned a template then used PVS to created a couple of machines with Citrix Virtual Desktops Setup Wizard. WIN10P01 and WIN10P02.
            Now I get the error on both of them whether I boot them from the PVS console or within VSphere console.
            And I chose BDM disk rather than PXE boot at some stage.

          2. Your BDM disk is an ISO? Did you use the PVS Boot Disk Creator to create the ISO? If so, there’s a checkbox on the first screen to create a UEFI ISO.

          3. If your machines can’t do PXE, then you need some other way of booting them. One option is to create an ISO and boot from the ISO. Another option is to use the Virtual Desktop Setup Wizard and burn the boot partition into the disk that is added to each machine. The BDM partition and the boot ISO are basically the same. I would hope that the wizard creates a UEFI BDM partition. But you can also try running Boot Device Manager to create a UEFI ISO and see if that works. You’ll need DHCP option 11 to specify the PVS Server IPs.

          4. It’s flakey as all fuck this shit isn’t it.
            I reckon even if I get it working a well directed fart would easily break it.

  11. Hi Carl,
    I have a full Citrix FARM 1912 CU1 with Provisionining
    When I try to use the Citrix Virtual Desktops Setup Wizard it returns error

    Unable to access the virtual machine configuration: Unable to access file [DataStoreName] FileName
    The file is present and the host have only local ssd not shared.

    Can you help me?
    I Open a ticket to citrix 2 days ago and no one contact me

  12. is there a way to use the same target names after i change the write cache size? basically i want to just change the write cache size and redeploy to my targets?

    1. Hi there, it depends on your configured write cache types and deployment. The value for write cache is defined during creation of new pvs target devices with the “XenDesktop Wizard” (now called “Wizard for Virtual Apps and Desktops”). I think you can’t change the write cache size for already created target devices cause of the local write cache disk which is assigned to the VM. I think you can delete your old target devices and create just new target devices with new write cache size and using their old names.

      I would try following steps (of course only for a single testing target device) to achieve your requirement:
      *1. delete your old target devices within your target device collection
      *2. delete the VM in your hypervisor management (Citrix Xencenter or VMware vSphere for example)
      *3. Create new target devices with your new write cache size. You can find the wizard context menu for Virtual Apps and Desktops by rightclicking the sites within pvs console
      *4. Give your new target devices their old names. Check also that machine account password (in AD DS) reset option is enabled. You can add also a name scheme with last digits or letters. You can also configure the amount of needed target devices.
      *5. When starting new created pvs target device, the new write cache disk will be initialized once. So the new write cache disk can be accessed by the OS, therefore the VM will be restarted automatically again on the first use.

  13. We don’t have DDC on-prem… so when running the XenDesktop Setup Wizard in PVS specify one of our local cloud connector servers. In 7.15 it worked like a charm.

    Now after upgrading to 1912, I get the error “FullAdmin or MachineAdmin Permission Required” when I try to run the setup wizard from PVS.

    Since the delivery controller is cloud, I’m not seeing how or where to grant this permission to my account or my PVS service account.. Can you give me a nudge in the right direction please?

        1. The PVS Config Wizard lets you specify the service account that is used to login to SQL and to run the PVS Services. The service account should be a local admin on the PVS server.

          The Citrix Virtual Apps and Desktops Setup wizard connects to Cloud Connector but you can enter your account instead of the service account.

          1. I normally run the PVS console under my own account, but I’ve also tried running PVS console under the service account and both methods produce the same result with the Virtual Desktops Setup Wizard.

            The service account we specified in the PVS config wizard is a local admin on all PVS servers. Does it need to be also on the Cloud Connectors?

Leave a Reply

Your email address will not be published. Required fields are marked *