SDK y API

Se ofrecen varios SDK y API en esta versión. Para obtener información detallada, consulte documentación para desarrolladores. Desde allí, puede acceder a información de programación de:

  • Delivery Controller
  • OData de Monitor Service
  • StoreFront

Citrix Group Policy SDK permite visualizar y configurar los filtros y las configuraciones de directivas de grupo. Utiliza un proveedor de PowerShell para crear una unidad virtual que corresponda a la máquina, configuraciones de usuario y filtros. El proveedor aparece como una extensión de New-PSDrive. Para utilizar Group Policy SDK, es necesario tener instalado Studio o el SDK de Citrix Virtual Apps and Desktops. Consulte Group Policy SDK para obtener más información.

Delivery Controller SDK

El SDK se compone de una serie de complementos de PowerShell que se instalan automáticamente al instalar el Delivery Controller o Studio.

Permisos: Debe ejecutar el shell o el script mediante una identidad que posea derechos de administración de Citrix. Si bien los miembros del grupo de administradores locales del Controller disponen automáticamente de privilegios administrativos totales para permitir la instalación de Citrix Virtual Apps o Citrix Virtual Desktops, Citrix recomienda crear administradores Citrix con los derechos adecuados para un funcionamiento normal, en lugar de usar la cuenta de administradores locales.

Para acceder a los cmdlets y ejecutarlos:

  1. Inicie un shell en PowerShell: Abra Studio, seleccione la ficha PowerShell y, a continuación, haga clic en Iniciar PowerShell.
  2. Para utilizar los cmdlets del SDK en scripts, configure la directiva de ejecución en PowerShell. Para obtener más información acerca de la directiva de ejecución de PowerShell, consulte la documentación de Microsoft.

    Nota:

    El SDK actual se instala como complemento de PowerShell y como módulo de PowerShell.

    Con la incorporación de la funcionalidad de módulos, puede utilizar los cmdlets de este SDK sin un cmdlet Add-PSSnapin (o asnp) que los preceda.

    Para los SDK de componentes asociados (como Citrix Licensing, Citrix Provisioning y StoreFront) que se instalan solo como un complemento, el uso de sus cmdlets todavía requiere Add-PSSnapin (o asnp) que los preceda.

    Si quiere utilizar este SDK a través del complemento, continúe en el siguiente paso.

  3. Agregue los complementos que necesite en el entorno de PowerShell con el Add -PSSnapincmdlet Add -PSSnapin en la consola de Windows PowerShell.

    V1 y V2 indican la versión del complemento. Los complementos de XenDesktop 5 son de la versión 1. Citrix Virtual Apps and Desktops y los complementos de versiones anteriores a XenDesktop 7 son de la versión 2. Por ejemplo, para instalar los complementos de Citrix Virtual Apps and Desktops, escriba Add-PSSnapin Citrix.ADIdentity.Admin.V2. Para importar todos los cmdlets, escriba: Add-PSSnapin Citrix.*.Admin.V*

Después de agregar los complementos, puede acceder a los cmdlets y a la ayuda asociada.

Para ver la ayuda de los cmdlets actuales de PowerShell para Citrix Virtual Apps and Desktops:

  1. Desde la consola de PowerShell, agregue los complementos de Citrix: Add –PSSnapin Citrix.*.Admin.V*
  2. Siga las instrucciones indicadas en Entorno de scripting integrado (ISE) de PowerShell.

Group Policy SDK

Para utilizar Group Policy SDK, es necesario tener instalado Studio o el SDK de Citrix Virtual Apps and Desktops.

Para agregar Group Policy SDK, 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 de Controller es el nombre de dominio completo de un Controller en el sitio al que quiere conectarse y del que quiere cargar la configuración.

OData de Monitor Service

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