Product Documentation

SDKs und APIs

Aug 17, 2016

Das aktuelle Release enthält mehrere SDKs und APIs.

SDK für XenApp und XenDesktop: Dieses basiert auf zahlreichen Microsoft Windows PowerShell 3.0-Snap-Ins, mit dem Sie die gleichen Tasks wie mit der Citrix Studio-Konsole und andere Tasks ausführen können, die in Studio allein nicht möglich sind.

Weitere Informationen finden Sie unter Citrix Developer.

Citrix Group Policy SDK: Mit diesem SDK können Sie Einstellungen und Filter für Gruppenrichtlinien anzeigen und konfigurieren. Es verwendet einen PowerShell-Anbieter, um einen virtuellen Datenträger zu erstellen, der mit den Maschinen- und Benutzereinstellungen und -filtern übereinstimmt. Der Anbieter wird als Erweiterung zu New-PSDrive angezeigt. Für die Verwendung des Group Policy SDKs muss Studio oder das XenApp- bzw. XenDesktop-SDK installiert sein. Weitere Informationen finden Sie Abschnitt Group Policy SDK weiter unten.

Überwachungsdienst-OData-API: Diese API können Sie für Folgendes verwenden:

  • Analysieren historischer Trends für die Planung
  • Durchführen einer eingehenden Problembehandlung bei Verbindungs- und Maschinenfehlern
  • Extrahieren von Informationen für die Eingabe in andere Tools und Prozesse, z. B. wenn PowerPivot-Tabellen in Microsoft Excel für die Anzeige von Daten auf verschiedene Weise verwendet werden
  • Erstellen einer benutzerdefinierten Benutzeroberfläche auf der Basis der von der API bereitgestellten Daten

Weitere Informationen finden Sie in den Artikeln zur Überwachungsdienst-OData-API.

XenApp- und XenDesktop-SDK

Ab Version 7.x bieten XenApp und XenDesktop mit FlexCast Management Architecture eine einheitliche Architektur und Verwaltung. Daher stehen nun in XenApp viele Features bereit, die es zuvor nur in XenDesktop gab. Elemente des SDKs für gemeinsame Features gelten also nun sowohl für XenApp als auch für XenDesktop, selbst wenn die Befehle sich nur auf XenDesktop beziehen.

Unterschiede zwischen den SDKs von XenDesktop 5 und XenDesktop 7

In der folgenden Liste werden die Unterschiede zwischen Version 5 und 7.x des SDKs für XenApp und XenDesktop aufgeführt.

  • Neues High-Level-SDK: XenDesktop 7 umfasst ein neues High-Level-SDK, mit dem Sie schnell und mühelos ein Skript erstellen und die Siteerstellung und -wartung automatisieren. Das High-Level-SDK isoliert Sie von der Komplexität der Low-Level-SDKs, sodass Sie für das Erstellen einer neuen Site nur zwei Cmdlets ausführen müssen.
  • Neue Low-Level-SDKs: Einzelne Low-Level-SDKs werden für die neuen XenDesktop 7-Dienste bereitgestellt, u. a. ein dediziertes und verbessertes SDK für den Dienst für die delegierte Administration (DAS), das vorher Teil des Broker-SDKs in XenDesktop 5 war. Es gibt auch SDKs für neue Features, u. a. Überwachungsdienst, Umgebungstest und Konfigurationsprotokollierung.
  • Kataloge und Bereitstellungsgruppen für Windows-Serverbetriebssystemmaschine: Mit dem XenDesktop 7-SDK stellen Sie kostengünstig Anwendungen und Desktops bereit, die auf Serverbetriebssystemen gehostet werden.
  • Anwendungen für Desktopbetriebssystemmaschinen: Anwendungen für Desktopbetriebssystemmaschinen haben sich auf SDK-Ebene wesentlich geändert. Wenn Sie vorhandene Skripts für die Ausführung von Anwendungen auf Desktopbetriebssystemen haben, müssen Sie diese Skripts für XenDesktop 7 aktualisieren, da es fast keine Rückwärtskompatibilität gibt.
  • Anwenden von Einstellungen auf Maschinen in Bereitstellungsgruppen: In XenDesktop 7 können Sie mit Konfigurationsslots Einstellungen auf Maschinen in einer bestimmten Bereitstellungsgruppe statt auf alle Maschinen in einer Site anwenden. So können Sie für eine bestimmte Bereitstellungsgruppe konfigurieren, welche Einstellungen für diese Gruppe gelten. Zahlreiche vordefinierte Konfigurationsslots werden bereitgestellt, die unterschiedliche Typen von Einstellungen enthalten, u. a. Einstellungen für StoreFront-Adressen, die mit Speicherorten von Receiver- oder App-V-Veröffentlichungserver verwendet werden. Eine Sammlung von Einstellungen kann sich nur auf eine bestimmte Bereitstellungsgruppe auswirken, und eine andere Sammlung von Einstellungen von dem gleichen Slot wirkt sich auf eine andere Bereitstellungsgruppe aus. Sie können Namen verwenden, die für Ihre Bereitstellung geeignet sind, z. B. "Vertriebsabteilungsrichtlinie".
  • Ersetzte Katalogtypen: In XenDesktop 7 wurden Katalogtypen durch Kataloge mit individuellen Eigenschaften ersetzt. Für die Rückwärtskompatibilität können Sie weiterhin vorhandene Skripts nutzen, die Katalogtypen verwenden, z. B. ein Image (gepoolt) und Thin Clone (dediziert) usw., intern werden diese jedoch in Gruppen von Eigenschaften konvertiert.

    Achtung: Die Rückwärtskompatibilität mit XenDesktop 5-Katalogtypen wurde beibehalten, wenn es praktikabel war. Verwenden Sie beim Schreiben neuer Skripts jedoch keine Katalogtypen sondern geben Sie Kataloge mit individuellen Eigenschaften an.

  • Ersetztes Desktopobjekte: In XenDesktop 5 ist das Desktopobjekt einer der Haupttypen des SDK-Objekts, das in Broker-SDK-Skripts verwendet wird. Das Desktopobjekt beschreibt sowohl die Maschine als auch die Sitzung auf der Maschine. In XenDesktop 7 wird dieses Objekt durch das Sitzungsobjekt und das Maschinenobjekt ersetzt, die beide erweitert wurden und jetzt die Funktion des Desktopobjekts übernehmen. Für die Rückwärtskompatibilität können Sie jedoch weiterhin vorhandene Skripts verwenden, die das Desktopobjekt nutzen.

    Achtung: Die Rückwärtskompatibilität mit XenDesktop 5 wurde beibehalten, wenn es praktikabel war. Verwenden Sie beim Schreiben neuer Skripts jedoch nicht das Desktopobjekt, sondern geben Sie Sitzungs- und Maschinenobjekte an.

Unterschiede zwischen Richtlinienregeln

Die Richtlinienregeln im SDK und der Studio-Konsole sind nicht identisch. Anspruchs- und Zuordnungsrichtlinienregeln sind unabhängige Entitäten im SDK, und in der Konsole. Diese Entitäten sind nicht sichtbar, da sie nahtlos mit der Bereitstellungsgruppe zusammengeführt werden. Weiterhin sind Richtlinienregeln im SDK weniger restriktiv.

Verwenden des SDKs

Das SDK enthält mehrere PowerShell-Snap-Ins, die automatisch vom Installationsassistenten installiert werden, wenn Sie den Delivery Controller oder Studio installieren.

Berechtigungen: Sie müssen die Shell oder das Skript mit einer ID ausführen, die über Citrix Administratorrechte verfügt. Obwohl die Mitglieder der lokalen Administratorgruppe auf dem Controller automatisch über Volladministratorprivilegien verfügen, um XenApp bzw. XenDesktop zu installieren, empfiehlt Citrix, dass Sie für den normalen Betrieb Citrix Administratoren mit den entsprechenden Rechten erstellen und nicht das lokale Administratorkonto verwenden. Wenn Sie Windows Server 2008 R2 ausführen, müssen Sie die Shell oder das Skript als Citrix Administrator und nicht als Mitglied der lokalen Administratorgruppe ausführen.

Zugreifen auf die Cmdlets:

  1. Starten einer Shell in PowerShell 3.0: Öffnen Sie Studio, wählen Sie die Registerkarte PowerShell und klicken Sie auf PowerShell starten.
  2. Legen Sie die Ausführungsrichtlinie in PowerShell fest, um SDK-Cmdlets in Skripts zu verwenden. Weitere Informationen zur PowerShell-Ausführungsrichtlinie finden Sie in der Dokumentation von Microsoft.
  3. Fügen Sie mit dem Cmdlet Add -PSSnapin in der Windows PowerShell-Konsole die Snap-Ins hinzu, die Sie in der PowerShell-Umgebung benötigen.

V1 und V2 beziehen sich auf die Version des Snap-Ins. (XenDesktop 5-Snap-Ins sind Version 1; XenDesktop 7-Snap-Ins sind Version 2. Zum Installieren von XenDesktop 7-Snap-Ins geben Sie beispielsweise "Add-PSSnapin Citrix.ADIdentity.Admin.V2" ein.) Geben Sie zum Importieren aller Cmdlets "Add-PSSnapin Citrix.*.Admin.V*" ein.

Nach dem Hinzufügen der Snap-Ins, können Sie auf die Cmdlets und die zugehörige Hilfe zugreifen.

Hinweis: Auf folgende Weise zeigen Sie die aktuelle XenApp- und XenDesktop-Hilfe zu PowerShell-Cmdlets an:

  1. Fügen Sie mit der PowerShell-Konsole folgende Citrix Snap-Ins hinzu: Add –PSSnapin Citrix.*.Admin.V*.
  2. Folgen Sie den Anweisungen in PowerShell Integrated Scripting Environment (ISE).

Group Policy SDKs

Für die Verwendung des Group Policy SDKs muss Studio oder das XenApp- bzw. XenDesktop-SDK installiert sein.

Zum Hinzufügen des Group Policy SDKs geben Sie Add-PSSnapin citrix.common.grouppolicy ein. (Zum Aufrufen der Hilfe geben Sie help New-PSDrive -path localgpo:/ ein.)

Zum Erstellen einer virtuellen Festplatte und Laden dieser Festplatte mit Einstellungen geben Sie Folgendes ein: New-PSDrive <Standardparameter> [-PSProvider] CitrixGroupPolicy -Controller <Zeichenfolge, wobei die Controller-Zeichenfolge der vollqualifizierte Domänenname eines Controllers in der Site ist, aus der die Einstellungen geladen werden sollen.