Product Documentation

SDKs and APIs

Aug 10, 2017

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

  • Delivery Controller
  • Monitor Service OData API
  • StoreFront SDK

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 XenApp and XenDesktop SDK must be installed. See Group Policy SDK for more information.

Delivery Controller SDK

The SDK comprises of a number of PowerShell snap-ins installed automatically by the installation wizard when you install the Delivery Controller or Studio component.

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 XenApp or XenDesktop to be installed, Citrix recommends that for normal operation, you create Citrix administrators with the appropriate rights, rather than use the local administrators account. If you are running Windows Server 2008 R2, you must run the shell or script as a Citrix administrator, and not as a member of the local administrators group.

To access and run the cmdlets:

  1. Start a shell in PowerShell 3.0: 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.
  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; XenDesktop 7 snap-ins are version 2. For example, to install XenDesktop 7 snap-ins, type Add-PSSnapin Citrix.ADIdentity.Admin.V2). To import all the cmdlets, type: Add-PSSnapin Citrix.*.Admin.V*

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

NOTE: To see the current XenApp and XenDesktop PowerShell cmdlet help:

  1. From the PowerShell console, add the Citrix snap-ins: Add –PSSnapin Citrix.*.Admin.V*.
  2. Follow the instructions in PowerShell Integrated Scripting Environment (ISE).

Group Policy SDK

To use the Group Policy SDK, either Studio or the XenApp and XenDesktop 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 <stringwhere the Controller string is the fully qualified domain name of a Controller in the Site you want to connect to and load settings from.