This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Citrix Virtual Apps and Desktops 2402 SDK
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 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 Windows PowerShell.
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 (Citrix Virtual Apps and Desktops snap-ins are version 2.).
For example, type:
Add-PSSnapin Citrix.ADIdentity.Admin.V2To 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.
Documentation notes
- In this API documentation, some property types are marked with a question mark (?). This notation indicates that those data types are nullable.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.