Product Documentation

SDK y API

Feb 14, 2017

Se ofrecen varios SDK y API en esta versión.

SDK de XenApp y XenDesktop. XenApp y XenDesktop ofrecen un SDK basado en una serie de complementos de Microsoft Windows PowerShell 3.0, que permiten realizar las mismas tareas que lleva a cabo en la consola de Citrix Studio, junto con tareas que no pueden realizarse únicamente con Studio.

Para obtener más información, consulte Citrix Developer.

SDK de directivas de grupo Citrix. Citrix Group Policy SDK permite mostrar y configurar los parámetros y los filtros de las 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 XenApp y XenDesktop. Consulte la siguiente sección Group Policy SDK para obtener más información.

API de protocolo OData para Monitor Service. Puede usar la API de protocolo OData para Monitor Service para:

  • Analizar tendencias históricas para planificaciones futuras
  • Realizar informes de error detallados sobre problemas de máquina y conexión
  • Extraer información para insertarla en otras herramientas y procesos; por ejemplo, mediante las tablas de PowerPivot de Microsoft Excel para mostrar los datos de diferentes formas
  • Generar una interfaz de usuario personalizada en la parte superior de los datos que proporciona la API

Para obtener más información, consulte los artículos de API de protocolo OData para Monitor Service.

SDK de XenApp y XenDesktop

A partir de la versión 7.x, XenApp y XenDesktop comparten una arquitectura y una administración unificadas: FlexCast Management Architecture. Esto significa que XenApp proporciona muchas de las características que antes estaban disponibles únicamente en XenDesktop; por lo tanto, los elementos del SDK relacionados con características comunes son aplicables igualmente para XenApp y para XenDesktop, aunque los comandos hagan referencia solo a XenDesktop.

Diferencias entre los SDK de XenDesktop 5 y XenDesktop 7

Si está familiarizado con el SDK de XenDesktop 5, en la lista siguiente se resumen las diferencias en las versiones 7.x del SDK de XenApp y XenDesktop. 

  • Nuevo SDK de alto nivel. XenDesktop 7 ofrece un nuevo SDK de alto nivel que le permite crear scripts y automatizar la creación y el mantenimiento del sitio de forma rápida y sencilla. El SDK de alto nivel le aísla de gran parte de la complejidad de los SDK de bajo nivel hasta el punto de poder crear un nuevo sitio simplemente mediante dos cmdlets.
  • Nuevos SDK de bajo nivel. Hay SDK individuales de bajo nivel para los nuevos servicios de XenDesktop 7, incluido un SDK dedicado y mejorado para Delegated Administration Service (DAS), que formaba parte del SDK del broker de XenDesktop 5. También hay más SDK para nuevas funciones, incluidos Monitor Service, Environment Test y Configuration Logging.
  • Grupos de entrega y catálogos de máquinas con sistema operativo de servidor Windows. No puede usar el SDK de XenDesktop 7 para entregar aplicaciones y escritorios rentables alojados en sistemas operativos de servidor.
  • Aplicaciones con sistema operativo de escritorio. Las aplicaciones con sistema operativo de escritorio han cambiado significativamente a nivel de SDK. Si dispone de scripts existentes para aplicaciones en ejecución en sistemas operativos de escritorio, tendrá que actualizarlos para XenDesktop 7 porque hay poca compatibilidad con versiones anteriores.
  • Aplicar configuración a las máquinas de los grupos de entrega. En XenDesktop 7, mediante las secciones de configuración, puede aplicar configuraciones en las máquinas de un grupo de entrega específico en lugar de hacerlo a todas las máquinas de un sitio. Esto le permite configurar, para un determinado grupo de entrega, los parámetros que se aplican a ese grupo. Hay una serie de secciones de configuración predefinidas que tienen diferentes tipos de configuración, como la configuración para las direcciones de StoreFront que usar con Receiver o las ubicaciones de los servidores de publicación App-V. Puede utilizar un conjunto de parámetros de una sección para que solo afecte a un determinado grupo de entrega y otro conjunto de parámetros de la misma sección para que afecte a otro grupo de entrega. Puede usar nombres adecuados para una implementación en concreto; por ejemplo, "Directiva del departamento de Ventas".
  • Tipos de catálogos reemplazados. En XenDesktop 7, los tipos de catálogos se han reemplazado por catálogos con propiedades individuales. Sin embargo, para la compatibilidad con versiones anteriores, puede usar scripts existentes que emplean tipos de catálogos, tales como una única imagen (agrupados) y "thin clone" (dedicados), etc., pero internamente se convierten en conjuntos de propiedades.

    Precaución: La compatibilidad con versiones anteriores de tipos de catálogos de XenDesktop 5 se ha mantenido siempre que ha sido posible y viable. Sin embargo, al escribir nuevos scripts, no use tipos de catálogos; en su lugar, especifique catálogos con propiedades individuales.

  • Objeto Desktop reemplazado. En XenDesktop 5, el objeto Desktop es uno de los tipos principales de objeto de SDK usado en scripts de SDK de broker. El objeto Desktop describe la máquina y la sesión en la máquina. En XenDesktop 7, este objeto se reemplaza por el objeto Session y el objeto Machine, los cuales ahora realizan el trabajo del objeto Desktop. Sin embargo, para la compatibilidad con versiones anteriores, aún puede usar scripts existentes que usen el objeto Desktop.

    Precaución: La compatibilidad de versiones anteriores con XenDesktop 5 se ha mantenido siempre que ha sido posible y viable. Sin embargo, al escribir nuevos scripts, no use el objeto Desktop; en su lugar, especifique los objetos Session y Machine.

Diferencias en las reglas de directivas

Existen diferencias entre el SDK y la consola de Studio en cuanto a las reglas de directivas. Las reglas de directivas de concesión y asignación son entidades independientes en el SDK; en la consola, estas entidades no son visibles, ya que están perfectamente fusionadas con el grupo de entrega. Además, las reglas de directivas de acceso incluyen menos restricciones en SDK.

Uso de SDK

El SDK se compone de una serie de complementos de PowerShell que se instalan automáticamente mediante el asistente de instalación al instalar el Delivery Controller o el componente de 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 XenApp o XenDesktop, Citrix recomienda crear administradores Citrix con los derechos adecuados para un funcionamiento normal, en lugar de usar la cuenta de administradores locales. Si está en Windows Server 2008 R2, debe ejecutar el shell o el script como administrador Citrix, no como miembro del grupo de administradores locales.

Para acceder a los cmdlets y ejecutarlos:

  1. Inicie un shell en PowerShell 3.0. Abra Studio, seleccione la ficha PowerShell y, a continuación, haga clic en Iniciar PowerShell.
  2. Para utilizar los cmdlets del SDK en los 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.
  3. Agregue los complementos que necesite en el entorno de PowerShell con el cmdlet Add -PSSnapin en la consola de Windows PowerShell. 

V1 y V2 indican la versión del complemento (los complementos de XenDesktop 5 son la versión 1; los de XenDesktop 7 son la versión 2). Por ejemplo, para instalar los complementos de XenDesktop 7, 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.

NOTA: Para ver la ayuda de los cmdlets de PowerShell para XenApp y XenDesktop actuales:

  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 Windows PowerShell.

Group Policy SDK

Para utilizar Group Policy SDK, es necesario tener instalado Studio o el SDK de XenApp y XenDesktop.

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 "string" es el nombre de dominio completo de un Controller en el sitio al que quiere conectarse y del que quiere cargar la configuración.