Several SDKs and APIs are available with this release.
XenApp and XenDesktop SDK: The XenApp and XenDesktop SDK is based on a number of Microsoft Windows PowerShell version 3.0 snap-ins that allow you to perform the same tasks as you would with the Citrix Studio console as well as tasks you cannot do with Studio alone.
For more information, see Citrix Developer.
Citrix Group Policy 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 the Group Policy SDK section below for more information.
Monitor Service OData API: You can use the Monitor Service OData API to:
For details, see the Monitor Service OData API articles.
Beginning with version 7.x, XenApp and XenDesktop share a unified architecture and management: the FlexCast Management Architecture. This means that XenApp provides many features previously only available in XenDesktop; elements of the SDK that relate to common features therefore apply equally to both XenApp and XenDesktop, even though the commands themselves refer only to XenDesktop.
If you are familiar with the XenDesktop 5 SDK, the following list summarizes the differences in 7.x versions of the XenApp and XenDesktop SDK.
Caution: Backwards compatibility with XenDesktop 5 catalog types has been maintained where possible and practicable. However, when writing new scripts, do not use catalog types; instead, specify catalogs with individual properties.
Caution: Backwards compatibility with XenDesktop 5 has been maintained where possible and practicable. However, when writing new scripts, do not use the Desktop object; instead, specify Session and Machine objects.
There are differences between the SDK and the Studio console in terms of policy rules. Entitlement and assignment policy rules are independent entities in the SDK; in the console, these entities are not visible as they are seamlessly merged with the Delivery Group. Also, access policy rules are less restrictive in the 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:
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:
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 <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.