Citrix Virtual Apps and Desktops SDK

Citrix Virtual Apps and Desktops 2103 SDK

June 19, 2023

Contributed by:

Note:

Citrix Virtual Apps and Desktops was formerly XenApp and XenDesktop.

The new product and component names stem from the expanding Citrix portfolio and cloud strategy. Implementing this transition in our products and their documentation is an ongoing process. Your patience during this transition is appreciated. For more detail about our new names, see https://www.citrix.com/about/citrix-product-guide/.

Citrix Virtual Apps and Desktops provide an SDK based on a number of Microsoft Windows PowerShell version 3.0 cmdlets that allows you to perform the same tasks as you would with the Citrix Studio console, together with tasks you cannot do with Studio alone.

Differences in policy rules

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.

Use the SDK

The SDK comprises of a number of PowerShell cmdlets packaged both as modules and snap-ins. These are installed automatically by the installation wizard when you install the Controller or Studio components.

To access and run the cmdlets:

Start a shell in PowerShell 3.0.

To start a shell from the console, click Studio, select the PowerShell tab, and click on Launch PowerShell.

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 and 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 use SDK cmdlets within scripts, set the execution policy in PowerShell. For more information about PowerShell execution policy, see your Microsoft documentation.
To use this SDK through the snap-ins, add the snap-ins you require into the PowerShell environment using the Add-PSSnapin command in the Windows PowerShell console. This step is unnecessary if you want to use the cmdlets in this SDK through the modules.

V1 and V2 denote the version of the snap-in (XenDesktop 7 snap-ins are version 2.).

For example, type:

Add-PSSnapin Citrix.ADIdentity.Admin.V2

To import all the cmdlets, type:

Add-PSSnapin Citrix.\*.Admin.V\*

After importing, you have access to the cmdlets and their associated help.

For an example of a typical use case, see Get started with the SDK.

Group Policy SDK usage

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.

Adding the Group Policy SDK

To add the Group Policy SDK, type: Add-PSSnapin citrix.common.grouppolicy
To access help, type: help New-PSDrive -path localgpo:/

Using the Group Policy SDK

To create a virtual drive and load it with settings, type:

New-PSDrive &lt;Standard Parameters&gt; \[-PSProvider\]
CitrixGroupPolicy *-Controller* &lt;string&gt;
<!--NeedCopy-->

**New-PSDrive &lt;Standard Parameters&gt; \[-PSProvider\]
CitrixGroupPolicy ***-Controller*** &lt;string&gt;**
<!--NeedCopy-->

where -Controller is the fully qualified domain name of a controller in the site you want to connect to and load settings from.

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

Citrix Virtual Apps and Desktops 2103 SDK

June 19, 2023

Contributed by:

June 19, 2023

Contributed by:

Citrix Virtual Apps and Desktops 2103 SDK

Differences in policy rules

Use the SDK

Group Policy SDK usage

Adding the Group Policy SDK

Using the Group Policy SDK

In this article