Citrix Virtual Apps and Desktops SDK

August 3, 2023

Contributed by:

Getting started with the SDK

To create a script,perform the following steps:

Use Citrix Studio to perform the operation that you want to script; for example, to create a catalog for a set of Machine Creation Services Machines.
Collect the log of SDK operations that Studio made to perform the task.
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.
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.

Examples

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
Example: 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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Getting started with the SDK

Examples

In this article