Product Documentation

Get started with the XenDesktop SDK

Mar 23, 2015

These documents explain how to use the SDK in your XenDesktop deployment. The recommended procedure for creating a script is described; you can use this procedure as the basis for creating scripts for other purposes. Examples of typical use cases are also provided.

Creating a script

To create a script, perform the following steps:

  1. Use the Citrix Studio console to perform the operation that you want to script; for example, to create a catalog for a set of Machine Creation Services Machines.
  2. Collect the log of SDK operations that Studio made to perform the task.
  3. Review the script to understand what each part is doing. This will help you with the customization of your own script. For more information, see the example use case which explains in detail what the script is doing.
  4. Convert and adapt the Studio script fragment to turn it into a script that is more consumable. To do this:
    • Use variables. Some cmdlets take parameters, such as TaskId. However, it may not be clear where the value used in these parameters comes from because Studio uses values from the result objects from earlier cmdlets.
    • Remove any commands that are not required.
    • Add some steps into a loop so that these can be easily controlled. For example, add machine creation into a loop so that the number of machines being created can be controlled.


Note: When creating a script, to ensure you always get the latest enhancements and fixes, Citrix recommends you follow the procedure described above rather than copying and pasting the example scripts.
Examples Description
Create catalog Script: create a catalog for a set of Machine Creation Services (MCS) machines
Example: Create and configure a host Script: create and configure a host
Example: Create a PvD Desktop Script: create a Delivery Group containing Personal vDisk (PvD) desktops
Example: Get load balancing information Display load index values for Server OS Machines