Product Documentation

SDK

Sep 29, 2015

Für XenApp und XenDesktop gibt es ein SDK, das auf zahlreichen Microsoft Windows PowerShell Version 3.0-Snap-Ins basiert, 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.

Ab Version 7.5 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.

Neu im XenApp- und XenDesktop 7.5-SDK

Das SDK wurde in diesem Release wie folgt erweitert:
  • Die PowerShell SDK-Cmdlets wurden erweitert, um Folgendes einzuschließen:
    • Die neuen unterstützten Hypervisortypen, einschließlich AWS und CloudPlatform
    • Unterstützung für Wake-On-LAN-Maschinen mit dem neuen Hypervisortyp "WakeOnLAN"
  • Mit den Erweiterungen zum SDK können Sie Eigenschaften speziell für Cloudbereitstellungen konfigurieren, etwa die Region für die Verbindung und Volumeservice, sowie Faktoren steuern, wie die Konfiguration der Cloudfirewall, um einen Netzwerkausgang von virtuellen privaten Clouds zuzulassen.
  • Im Zusammenhang mit der Unterstützung für Wake-On-LAN (WOL) können Kataloge für Remote-PC-Zugriff nun einer WOL-Hypervisiorverbindungsinstanz zugeordnet werden und jede Maschine kann maschinenspezifische Energieverwaltungsfunktionen berichten.

Hauptunterschiede zwischen dem SDK von XenDesktop 5 und XenDesktop 7

  • Neues SDK auf höherer Ebene: XenDesktop 7 stellt ein neues SDK auf höherer Ebene bereit, mit dem Sie schnell und mühelos ein Skript erstellen und die Siteerstellung und -wartung automatisieren. Das SDK auf höherer Ebene isoliert Sie von der Komplexität der SDKs auf niedrigerer Ebene, sodass Sie für das Erstellen einer neuen Site nur zwei Cmdlets ausführen müssen.
  • Neue SDKs auf niedriger Ebene: Einzelne SDKs auf niedriger Ebene 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 der 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 möglich und 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 möglich und 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 Controller oder Studio installieren.

So greifen Sie auf die Cmdlets zu:

  1. Starten Sie eine Shell in PowerShell 3.0.

    Klicken Sie zum Starten einer Shell über die Konsole auf Studio, wählen Sie die Registerkarte "PowerShell" aus und klicken Sie auf PowerShell starten.

    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 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 ausführen, müssen Sie die Shell oder das Skript als Citrix Administrator und nicht als Mitglied der lokalen Administratorgruppe ausführen.

  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 Befehl Add -PSSnapin in der Windows PowerShell-Konsole die Snap-Ins hinzu, die Sie in der PowerShell-Umgebung benötigen. V1 und V2 geben die Version des Snap-Ins an (XenDesktop 5-Snap-Ins sind Version 1; XenDesktop 7-Snap-Ins sind Version 2). Geben Sie zum Beispiel Folgendes ein:
    Add-PSSnapin Citrix.ADIdentity.Admin.V2

    Geben Sie zum Importieren aller Cmdlets Folgendes ein:

    Add-PSSnapin Citrix.*.Admin.V*

    Nach dem Import haben Sie Zugriff auf die Cmdlets und die zugehörige Hilfe.

Ein Beispiel eines typischen Anwendungsfalls finden Sie unter Erste Schritte mit dem SDK.

Tipp: Eine vollständige Liste der gesamten Hilfe für die Cmdlets finden Sie unter Hilfe zu PowerShell-Cmdlets.

Verwenden des Gruppenrichtlinien-SDKs

Mit dem Citrix Group Policy 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.

Hinzufügen des Group Policy SDKs

  1. Zum Hinzufügen des Gruppenrichtlinien-SDKs geben Sie Folgendes ein:
    Add-PSSnapin citrix.common.grouppolicy
  2. Geben Sie Folgendes ein, um auf die Hilfe zuzugreifen:
    help New-PSDrive -path localgpo:/

Verwenden des Group Policy SDKs

  1. Zum Erstellen eines virtuellen Laufwerks und zum Laden der Einstellungen geben Sie Folgendes ein:
    New-PSDrive  [-PSProvider] CitrixGroupPolicy -Controller 

    New-PSDrive [-PSProvider] CitrixGroupPolicy -Controller

    wobei -Controller der vollqualifizierte Domänenname eines Controllers in der Site ist, mit der Sie eine Verbindung herstellen und aus der Sie Einstellungen laden möchten.