Citrix Virtual Apps and Desktops

SDKs and APIs

Several SDKs and APIs are available with this release. For details, see Developer Documentation. From there, you can access programming information for:

  • Delivery Controller
  • Monitor Service OData
  • StoreFront

The Citrix Group Policy SDK allows you to display and configure Group Policy settings and filters. It 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. See Group Policy SDK for more information.

Delivery Controller SDK

The SDK comprises several PowerShell snap-ins that are installed automatically when you install a Delivery Controller or Studio.

Permissions: 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.

To 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 more information about PowerShell execution policy, see the Microsoft documentation.


    The current SDK installs as both a PowerShell snap-in and a PowerShell module.

    With the addition of the module functionality, you can use this SDK’s cmdlets without a preceding Add-PSSnapin (or asnp) cmdlet.

    For associated components’ SDKs (such as Citrix Licensing, Citrix Provisioning, and StoreFront) that install only as a snap-in, using their cmdlets still requires a preceding Add-PSSnapin (or asnp).

    If you want to use this SDK through the snap-in, continue with the next step.

  3. Add the snap-ins you require into the PowerShell environment using the Add -PSSnapin cmdlet in the Windows PowerShell console.

    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-ins, type Add-PSSnapin Citrix.ADIdentity.Admin.V2. To import all of the cmdlets, type: Add-PSSnapin Citrix.*.Admin.V*

After adding the snap-ins, you can access the cmdlets and their associated help.

To see the current Citrix Virtual Apps and Desktops PowerShell cmdlet help:

  1. From the PowerShell console, add the Citrix snap-ins: Add –PSSnapin Citrix.*.Admin.V*.
  2. Follow the instructions in The Windows PowerShell ISE.

Group Policy SDK

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

To add the Group Policy SDK, 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