SDK y API

Last published : Nov 13, 2026
Varias SDK y API están disponibles con esta versión. Para acceder a las SDK y API, vaya a Cree cualquier cosa con Citrix. Desde allí, seleccione Citrix Workspace para acceder a la información de programación de Citrix Virtual Apps and Desktops y sus componentes relacionados.
Nota:
El SDK de Citrix Virtual Apps and Desktops™ y el SDK de Citrix Group Policy se pueden instalar como un módulo o un complemento. Varias SDK de componentes (como Citrix Licensing, Citrix Provisioning y StoreFront) se instalan utilizando solo un complemento.
Este producto es compatible con las versiones 3 a 5 de PowerShell.

SDK de Citrix Virtual Apps and Desktops™

Este SDK se instala automáticamente como un módulo de PowerShell al instalar un Delivery Controller™ o Studio. Esto le permite usar los cmdlets de este SDK sin tener que agregar complementos. (Las instrucciones se proporcionan a continuación si elige instalar este SDK como un complemento).

Permisos

Debe ejecutar el shell o el script utilizando una identidad que tenga derechos de administración de Citrix. Aunque los miembros del grupo de administradores locales en el Controller tienen automáticamente privilegios administrativos completos para permitir la instalación de Citrix Virtual Apps o Citrix Virtual Desktops™, Citrix recomienda que, para el funcionamiento normal, cree administradores de Citrix con los derechos apropiados, en lugar de usar la cuenta de administradores locales.

Acceder y ejecutar los cmdlets

  1. Inicie un shell en PowerShell: Abra Studio, seleccione la pestaña PowerShell y, a continuación, haga clic en Launch PowerShell.
  2. Para usar los cmdlets del SDK dentro de los scripts, establezca la política de ejecución en PowerShell. Para obtener información sobre la política de ejecución de PowerShell, consulte la documentación de Microsoft.
  3. Si desea utilizar el complemento (en lugar del módulo), agregue el complemento mediante el cmdlet Add-PSSnapin (o asnp).
    V1 y V2 denotan la versión del complemento. Los complementos de XenDesktop 5 son la versión 1. Los complementos de Citrix Virtual Apps and Desktops y las versiones anteriores de XenDesktop 7 son la versión 2. Por ejemplo, para instalar el complemento de Citrix Virtual Apps and Desktops, escriba Add-PSSnapin Citrix.ADIdentity.Admin.V2. Para importar todos los cmdlets, escriba: Add-PSSnapin Citrix.*.Admin.V*
Ahora puede usar los cmdlets y los archivos de ayuda.

SDK de Group Policy

El SDK de Citrix Group Policy le permite mostrar y configurar los ajustes y filtros de Group Policy. Este SDK utiliza un proveedor de PowerShell para crear una unidad virtual que corresponde a la configuración y los filtros de la máquina y del usuario. El proveedor aparece como una extensión de New-PSDrive.
Para usar el SDK de Group Policy, debe tener instalado Studio o el SDK de Citrix Virtual Apps and Desktops.
El proveedor de PowerShell de directivas de grupo de Citrix está disponible como módulo o como complemento.
  • Para usar el módulo, no se necesita ningún trabajo adicional.
  • Para agregar el complemento, escriba Add-PSSnapin citrix.common.grouppolicy.
Para acceder a la ayuda, escriba: help New-PSDrive -path localgpo:/.
Para crear una unidad virtual y cargarla con la configuración, escriba New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string>, donde la cadena Controller es el nombre de dominio completo de un Controller en el sitio al que desea conectarse y desde el que desea cargar la configuración.

API REST de Citrix Virtual Apps and Desktops

Con las API REST de Citrix Virtual Apps and Desktops, puede automatizar la administración de recursos dentro de una implementación de Citrix Virtual Apps and Desktops.
Las API REST de Citrix Virtual Apps and Desktops están disponibles en <https://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/docs/citrix-virtual-apps-and-desktops-apis>. Las API que no son aplicables a Citrix Virtual Apps and Desktops se marcan en consecuencia. Siga las instrucciones allí para configurar el acceso al servicio API y usar las API para administrar y optimizar sus recursos.

OData del servicio Monitor

La API de Monitor permite el acceso a los datos del servicio Monitor mediante la versión 3 o 4 de la API de OData. Puede crear paneles de supervisión e informes personalizados basados en los datos consultados del servicio Monitor. OData V.4 se basa en la API web de ASP.NET y admite consultas de agregación.
Para obtener más información, consulte la API OData del servicio Monitor.