Citrix Virtual Apps and Desktops

SDKs and APIs

Several SDKs and APIs are available with this release. To access the SDKs and APIs, go to Build anything with Citrix. From there, select Citrix Workspace to access programming information for Citrix Virtual Apps and Desktops and its related components.


The Citrix Virtual Apps and Desktops SDK and the Citrix Group Policy SDK can be installed as a module or a snap-in. Several component SDKs (such as Citrix Licensing, Citrix Provisioning, and StoreFront) install using only a snap-in.

This product supports PowerShell versions 3 through 5.

Citrix Virtual Apps and Desktops SDK

This SDK installs automatically as a PowerShell module when you install a Delivery Controller or Studio. This enables you to use this SDK’s cmdlets without having to add snap-ins. (Instructions are provided below if you choose to install this SDK as a snap-in.)


You must run the shell or script using an identity that has Citrix administration rights. Although members of the local administrators group on the Controller automatically have full administrative privileges to allow Citrix Virtual Apps or Citrix Virtual Desktops to be installed, Citrix recommends that for normal operation, you create Citrix administrators with the appropriate rights, rather than use the local administrators account.

Access and run the cmdlets

  1. Start a shell in PowerShell: Open Studio, select the PowerShell tab, and then click Launch PowerShell.
  2. To use SDK cmdlets within scripts, set the execution policy in PowerShell. For information about PowerShell execution policy, see the Microsoft documentation.
  3. If you want to use the snap-in (rather than the module), add the snap-in using the Add-PSSnapin (or asnp) cmdlet.

    V1 and V2 denote the version of the snap-in. XenDesktop 5 snap-ins are version 1. Citrix Virtual Apps and Desktops, and earlier XenDesktop 7 version snap-ins are version 2. For example, to install Citrix Virtual Apps and Desktops snap-in, type Add-PSSnapin Citrix.ADIdentity.Admin.V2. To import all the cmdlets, type: Add-PSSnapin Citrix.*.Admin.V*

You can now use the cmdlets and help files.

Group Policy SDK

The Citrix Group Policy SDK enables you to display and configure Group Policy settings and filters. This SDK uses a PowerShell provider to create a virtual drive that corresponds to the machine and user settings and filters. The provider appears as an extension to New-PSDrive.

To use the Group Policy SDK, either Studio or the Citrix Virtual Apps and Desktops SDK must be installed.

The Citrix Group Policy PowerShell provider is available as a module or a snap-in.

  • To use the module, no additional work is needed.
  • To add the snap-in, type Add-PSSnapin citrix.common.grouppolicy.

To access help, type: help New-PSDrive -path localgpo:/.

To create a virtual drive and load it with settings, type New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string> where the Controller string is the fully qualified domain name of a Controller in the site you want to connect to and load settings from.

Monitor Service OData

The Monitor API allows access to the Monitor Service data using Version 3 or 4 of the OData API. You can create customized monitoring and reporting dashboards based on data queried from the Monitor Service data. OData V.4 is based on the ASP.NET Web API and supports aggregation queries.

For more information, see the Monitor Service OData API.

SDKs and APIs