Migrieren einer Bereitstellung in die Cloud

Eine On-Premises-Bereitstellung von Citrix Virtual Apps and Desktops können Sie jetzt ganz oder teilweise nach Citrix Virtual Apps and Desktop Service migrieren.

Citrix Automated Configuration Tool (Vorschau)

Mit dem Citrix Automated Configuration Tool können Sie die Migration einer On-Premises-Bereitstellung von Citrix Virtual Apps and Desktops nach Citrix Virtual Apps and Desktops Service automatisieren.

Das Tool exportiert die On-Premises-Konfiguration in YML-Dateien, die dann optional (zum Testen der Migration) bearbeitet und in Citrix Virtual Apps and Desktops Service importiert werden können.

Voraussetzungen für die Migration Ihrer Konfiguration

  • Führen Sie einen Herunterladen und installieren des Citrix Automated Configuration Tools aus.
  • Exportieren der Citrix Virtual Apps and Desktops-Konfiguration:
    • Aktuelle Version von Citrix Virtual Apps and Desktops und unmittelbare Vorgängerversion oder Citrix Virtual Apps and Desktops/XenApp und XenDesktop LTSR: alle Versionen
    • Ein On-Premises-Desktop Delivery Controller und mindestens ein On-Premises-VDA
    • Eine Maschine mit .NET Framework 4.7.2 oder höher
    • Eine Maschine mit dem Citrix PowerShell-SDK (dieses wird automatisch auf dem Desktop Delivery Controller installiert). (Zur Ausführung auf einer anderen Maschine muss diese zur Domäne gehören und Citrix Studio installiert werden, da damit die richtigen PowerShell-Snap-Ins installiert werden. Das Citrix Studio-Installationsprogramm ist auf dem Citrix Virtual Apps and Desktops-Installationsmedium.)
  • Zum Importieren der Konfiguration in Citrix Virtual Apps and Desktops Service:
    • Eine Maschine mit Zugriff auf Citrix Cloud.
    • Citrix Virtual Apps and Desktops Service mit einem aktiven Ressourcenstandort und installiertem Connector; es muss derselben Domäne angehören wie die On-Premises-Bereitstellung.

Bekannte Einschränkungen

  • Hostverbindungen werden nicht vollständig unterstützt. Die Unterstützung von Hostverbindungen muss mithilfe eines Parameters in der Datei CustomerInfo.yml aktiviert werden. Weitere Informationen finden Sie unter Hostverbindungen.
  • Mit Maschinenerstellungsdienste bereitgestellte Maschinenkataloge werden derzeit nicht unterstützt.
  • Dateitypzuordnungen werden nur importiert, wenn ein vorläufig oder definitiv registrierter VDA vorhanden ist.
  • Symbole werden nicht auf Maschinen oder Desktops angewendet.

Unterstützte Objekte für die Migration

Die folgenden Komponenten werden vom Citrix Automated Configuration Tool unterstützt und bei dem automatisierten Prozess migriert.

  • Tags
  • Hostverbindungen
    • Ein einzelner Ressourcenpool
    • Admin-Geltungsbereiche
  • Maschinenkataloge
    • Admin-Geltungsbereiche
    • Maschinen
    • Remote-PC-Zugriff, physisch, gepoolt, bereitgestellt (außer MCS), zugewiesen
  • Bereitstellungsgruppen
    • Zugriffsrichtlinie
    • Admin-Geltungsbereiche
    • Anwendungszugriffsrichtlinie
    • Zuweisungsrichtlinie
    • Anspruch-/Desktoprichtlinie
    • Energiezeitpläne
    • Sitzungsfortbestehen
    • Vorabstart von Sitzungen
    • Neustartzeitpläne
    • Tags
  • Anwendungsgruppen
    • Admin-Geltungsbereiche
  • Anwendungen
    • Anwendungsordner
    • Symbole
    • Anwendungen
    • Per Broker konfigurierte FTAs
    • Tags
  • Gruppenrichtlinien

Exportieren der On-Premises-Konfiguration von Citrix Virtual Apps and Desktops

  1. Installieren Sie das Citrix Automated Configuration Tool.
  2. Klicken Sie auf das Symbol für Automatisches Konfigurieren. Ein PowerShell Fenster wird angezeigt.
  3. Führen Sie den folgenden Befehl aus, um einen Basisexport durchzuführen.

Export-CvadAcToFile –All $true

Hinweis:

Beschreibungen weiterer verfügbarer Befehle finden Sie unter hier.

Nach der ersten Ausführung eines Cmdlets wird ein Exportordner mit den YML-Konfigurationsdateien und Protokollen erstellt. Der Ordner ist in %HOMEPATH%\Documents\Citrix\AutoConfig.

Bei Auftreten von Fehlern oder Ausnahmen konsultieren Sie den Abschnitt Fixups in der Protokolldatei. Weitere Informationen zu den Protokollen und deren Inhalt finden Sie unter Protokolle.

Importieren der Konfiguration in Citrix Virtual Apps and Desktops Service

Wichtig

  • Sie müssen eine CustomerInfo.yml-Datei mit Ihrer Kunden-ID, Client-ID und dem geheimen Schlüssel haben. Informationen zum Abrufen der Kunden- und Client-ID und des geheimen Schlüssels finden Sie unter Generieren der Kunden-ID, der Client-ID und des geheimen Schlüssels. Weitere Informationen zum Einfügen dieser Informationen in die Datei CustomerInfo.yml finden Sie unter Datei mit Kundeninformationen.
  • Die Datei ZoneMapping.yml muss Informationen zur Zuordung der On-Premises-Zone zu den Ressourcenstandorten in der Cloud enthalten. Weitere Informationen über die Zuordnung von Zonen finden Sie unter Zonenzuordnungsdatei.
  • Wenn Sie einen Provisioning Service-Katalog oder Hostverbindungen haben, müssen Sie die entsprechenden Informationen in HostSecurity.yml und CvadAcSecurity.yml eingeben.

Ausführen eines Basisimports

  1. Klicken Sie auf das Symbol für Automatisches Konfigurieren. Ein PowerShell Fenster wird angezeigt.
  2. Führen Sie den folgenden Befehl aus, um einen Basisimport durchzuführen.

Merge-CvadAcToSite -All $true

Hinweis:

Beschreibungen weiterer verfügbarer Befehle finden Sie unter hier.

Überprüfen Sie den erwarteten Zustand gegen den neuen aktuellen Zustand. Wenn Sie einen Merge-Import durchführen, muss der erwartete Zustand eine Teilmenge des neuen aktuellen Zustands sein, damit der Import erfolgreich ist.

Nach der Ausführung eines Cmdlets wird ein Exportordner mit den YML-Konfigurationsdateien und Protokollen erstellt. Der Ordner ist in %HOMEPATH%\Documents\Citrix\AutoConfig.

Bei Auftreten von Fehlern oder Ausnahmen konsultieren Sie den Abschnitt Fixups in der Protokolldatei. Weitere Informationen zu den Protokollen und deren Inhalt finden Sie unter Protokolle.

Importreihenfolge und Komponentenabhängigkeit

Die folgenden Komponenten können in den Befehlen Export, Import, Merge, New, Sync und Restore ausgewählt werden. Sie werden in der Importreihenfolge aufgeführt. Das Importieren in einer anderen Reihenfolge kann zu Fehlern bezüglich Abhängigkeiten und einem Fehlschlagen des Imports führen.

  1. Tags
  2. Hostverbindungen
  3. Maschinenkataloge
  4. Bereitstellungsgruppen
  5. Anwendungsgruppen
  6. Anwendungen
  7. Gruppenrichtlinien

Die Komponenten müssen in einer Reihenfolge importiert werden, in der Abhängigkeiten in der benötigten Reihenfolge erstellt werden. Das Citrix Automated Configuration Tool bringt Komponenten beim Importieren, Zusammenführen und Wiederherstellen mehrerer Komponenten in einer einzigen Cmdlet-Ausführung in die richtige Reihenfolge.

Beim Importieren einzelner Komponenten mit mehreren Befehlen müssen die Komponenten in die richtige Reihenfolge der Abhängigkeiten gebracht werden.

Wenn eine vollständige Sitekonfiguration erfolgreich importiert wurde, können für Updates individuelle Importvorgänge erfolgen.

Generieren der Kunden-ID, der Client-ID und des geheimen Schlüssels

Mit dem nachfolgenden Verfahren können Sie die Client-ID und den geheimen Schlüssel erstellen, die zum Importieren der Konfiguration in Citrix Cloud erforderlich sind.

  1. Melden Sie sich bei Ihrem Citrix Cloud-Konto an und wählen Sie den Kunden aus.

    Kunden-ID, Abbildung 1

  2. Klicken Sie auf das Hamburger-Menü und wählen Sie die Option Identitäts- und Zugriffsverwaltung.

    Kunden-ID, Abbildung 2

  3. Klicken Sie auf der Seite Identitäts- und Zugriffsverwaltung auf API-Zugriff.

    Kunden-ID, Abbildung 3

  4. Geben Sie einen Namen in das Feld ein. Dieser Name wird zur Unterscheidung zwischen mehreren Client-IDs und geheimen Schlüsseln verwendet. Klicken Sie auf Client erstellen, um die Client-ID und den geheimen Schlüssel zu erstellen.

    Kunden-ID, Abbildung 4

  5. Wenn Sie die Client-ID und den geheimen Schlüssel erstellt haben, wird das folgende Dialogfeld angezeigt. Kopieren Sie beide Werte an einen sicheren Speicherort oder laden Sie die CSV-Datei herunter, die diese Informationen enthält.

    Kunden-ID, Abbildung 5

  6. Die Client-ID und der geheime Schlüssel werden erfolgreich erstellt.

    Kunden-ID, Abbildung 6

Speichern Sie diese Werte an einem sicheren Ort und teilen Sie sie nur mit vertrauenswürdigen Personen im Unternehmen, die Zugriff auf das Tool oder auf die Cloud-Rest-APIs benötigen. Die Client-ID und der geheime Schlüssel laufen nicht ab. Werden sie kompromittiert, entfernen Sie sie sofort mit dem Papierkorb-Symbol und erstellen Sie neue.

Hinweis:

Der geheime Schlüssel kann nicht wiederhergestellt werden, wenn er verloren geht oder vergessen wird. Er muss zusammen mit der Client-ID und neu erstellt werden.

Datei mit Kundeninformationen

Die Verwendung der Datei CustomerInfo.yml macht das Hinzufügen von Kundeninformationen als Cmdlet-Parameter überflüssig. Jede Kundeninformation kann per Cmdlet-Parameter überschrieben werden.

Sie können die Datei CustomerInfo.yml mithilfe des Cmdlets Set-CvadAcCustomerInfoFile aktualisieren.

Hinweis:

Das Cmdlet ändert nur die Kunden-ID, die Client-ID oder den geheimen Schlüssel.

Set-CvadAcCustomerInfoFile -ClientId C80487EE-7113-49F8-85DD-2CFE30CC398E

Nachfolgend sehen Sie das Beispiel einer CustomerInfo.yml-Datei.

---
#  Created/Updated on 2020/01/29 16:46:47
CustomerId: "markhof123"
CustomerId: "markhof123"
ClientId: "6713FEA6-46CC-4F8A-BC71-539F2DDK5384"
Secret: "TwBLaaabbbaaaaaaaaaaw=="
LogFileName: "CitrixLog"
Environment: Production
AltRootUrl: ""
StopOnError: False
AlternateFolder: ""
Locale: "en-us"
Editor: “C:\Program Files\Notepad++\notepad++.exe”
Confirm: True
DisplayLog: True

Zonenzuordnungsdatei

Die On-Premises-Zone entspricht dem Cloudressourcenstandort. Im Gegensatz zu anderen Sitekomponenten können Sie die On-Premises-Zone nicht automatisch in einen Cloudressourcenstandort importieren. Sie muss über die Datei ZoneMapping.yml zugeordnet werden. Importfehler können auftreten, wenn der Zonenname nicht mit dem Namen eines bestehenden Ressourcenstandorts übereinstimmt.

Die Datei ZoneMapping.yml wird nach dem Exportieren der lokalen Konfiguration und vor deren Import in die Cloud manuell erstellt und muss in %HOMEPATH%\Documents\Citrix\ AutoConfig sein. Die YML-Datei beinhaltet ein Wörterbuch mit dem Zonennamen als Schlüssel und dem Ressourcennamen als Wert.

Ein Beispiel:

---

Primary: "My Primary Resource Location"
Zone2: "Second Resource Location"

Hinweis:

Ein Leerzeichen muss zwischen dem Doppelpunkt und dem Namen des Ressourcenstandorts stehen.

Wird die Datei ZoneMapping.yml nicht gefunden oder ist die korrekte Zuordnung nicht vorhanden und die Cloudsite hat nur eine Zone, wird diese Zone automatisch für die Zuordnung zu allen On-Premises-Zonen verwendet.

Cmdlets des Citrix Automated Configuration Tools

Cmdlets der Siteverwaltung

  • Export-CvadAcToFile - Exportiert die Konfiguration aus Ihrem On-Premises-Setup. Dabei handelt es sich um den standardmäßigen Export mit dem Citrix Automated Configuration Tool.
  • Merge-CvadAcToSite: Führt die On-Premises-Dateien in die Cloud zusammen, löscht jedoch keine Komponenten in der Cloud. Dadurch bleiben in der Cloud bereits vorgenommene Änderungen erhalten. Gibt es in Citrix Cloud eine Komponente mit demselben Namen, kann sie durch den Befehl geändert werden. Dabei handelt es sich um den standardmäßigen Import mit dem Citrix Automated Configuration Tool.
  • Import-CvadAcToSite: Importiert alle On-Premises-Dateien in die Cloud. Der Befehl stellt sicher, dass der Endstatus in der Cloud dem On-Premises-Status entspricht. Mit dieser Option werden alle Änderungen in der Cloud gelöscht. Mit Vorsicht verwenden!
  • New-CvadAcToSite: Importiert die On-Premises-Konfiguration in die Cloud, wobei nur neue Komponenten hinzugefügt werden. Vorhandene Cloud-Sitekomponenten werden weder aktualisiert noch gelöscht. Verwenden Sie diesen Befehl, wenn die vorhandenen Cloud-Sitekomponenten unverändert bleiben müssen.
  • Sync-CvadAcToSite: Exportiert und importiert in einem Schritt.
  • Restore-CvadAcToSite: Stellt die Cloud-Site wieder auf die vorherige Konfiguration zurück. Importierte Dateien werden aus dem im Parameter -RestoreFolder angegebenen Ordner bezogen. Dies kann zur Wiederherstellung der vorherigen Konfiguration oder für die Notfallwiederherstellung der Cloud-Site verwendet werden.
  • Backup-CvadAcToFile: Exportiert die Cloudkonfiguration in YML-Dateien. Das Backup kann zur Wiederherstellung der vorherigen Konfiguration oder für die Notfallwiederherstellung verwendet werden.
  • Compare-CvadAcToSite: Vergleicht die On-Premises-YML-Dateien mit der Cloudkonfiguration.
  • Remove-CvadAcFromSite: Kann die gesamte Site zurücksetzen oder Elemente aus einer Komponente entfernen (z. B. einen Maschinenkatalog aus der Liste der Kataloge). In Kombination mit dem Parameter IncludeByName können so Elemente selektiv entfernt werden.

Granulare Cmdlet-Parameter für die Migration

Alle Cmdlets, die in ToSite, ToFile oder FromSite enden, ermöglichen die Auswahl einer oder mehrerer Komponenten für Aktionen. Die Parameter gestatten mehr Granularität zur selektiven Migration von Komponenten. Sie treffen über eine oder mehrere true/false-Optionen eine Auswahl.

Hinweis:

Die Auswahl All bewirkt, dass die anderen Parameter ignoriert werden. Die Option All wird automatisch verwendet, wenn keine Komponenten ausgewählt sind.

  • All
  • Tags
  • MachineCatalogs
  • DeliveryGroups
  • ApplicationGroups
  • Applications
  • GroupPolicies
  • IncludeByName und ExcludeByName: Weitere Informationen siehe unten.

Ein- und Ausschließen

Die Parameter IncludeByName und ExcludeByName und ermöglichen das Ein- und Ausschließen von Elementen in Cmdlets nach Namen. In den unterstützten Cmdlets kann jeweils nur eine Komponente (z. B. Bereitstellungsgruppen) ausgewählt werden. Wenn sich ein Komponentenelement in beiden Bereichen befindet, setzt das Ausschließen alle anderen Parameter außer Kraft und im Abschnitt “Fixups” der Protokolldatei werden die ausgeschlossene Komponente und das ausgeschlossene Element aufgeführt.

Beim Ein- und Ausschließen unterstützte Cmdlets:

  • Export-CvadAcToFile
  • Import-CvadAcToSite
  • Merge-CvadAcToSite
  • New-CvadAcToSite
  • Restore-CvadAcToSite
  • Sync-CvadAcSiteToSite
  • Compare-CvadAcToSite
  • Remove-CvadAcFromSite

IncludeByName und ExcludeByName akzeptieren eine Liste mit Elementen. Die Name können einen oder mehrere Platzhalter enthalten. Zwei Arten von Platzhaltern werden unterstützt.

  • Entspricht einer beliebigen Anzahl von Zeichen
  • Entspricht einem Zeichen

Beispiel zum Zusammenführen aller Bereitstellungsgruppen, deren Namen mit DgSite1 beginnen und Home2 enthalten:

Merge-CvadAcToSite –DeliveryGroups $true –IncludeByName DgSite1*,*Home2*

IncludeByName und ExcludeByName akzeptieren auch eine Datei mit einer Liste von Elementen, von denen jedes explizit oder mit Platzhaltern angegeben werden kann. Jedes Element muss auf einer eigenen Zeile stehen. Bei Elementnamen werden führende und nachgestellte Leerzeichen gelöscht. Dem Dateinamen muss das @-Zeichen in einfachen Anführungszeichen vorangestellt werden (eine PowerShell-Anforderung, damit das @-Zeichen nicht neu interpretiert wird). Zusätzlich zum Mischen mit Elementnamen können mehrere Dateien aufgelistet werden.

Migrationsmodus-Parameter

Die Cmdlets zur Änderung der Cloudsitekonfiguration (Import, Restore, Merge, New und Sync) unterstützen folgende Parameter zur Erweiterung der Flexibilität.

  • CheckMode: Führt den Importvorgang OHNE Änderungen durch. Alle erwarteten Änderungen werden vor dem Import gemeldet. Sie können den Import vor dessen Ausführung mit diesen Befehl testen.
  • Merge: Führt die Dateidaten in die Cloud zusammen, löscht jedoch keine Komponenten. Hinweis: Diese Option ist standardmäßig im Cmdlet Merge aktiviert, in Import und Sync ist sie optional.
  • AddOnly: Fügt nur Komponenten hinzu. Vorhandene Komponenten werden nicht aktualisiert oder gelöscht. AddOnly ist bei allen Cmdlets optional mit Ausnahme von New, wo es standardmäßig aktiviert ist.
  • BackupFirst: Sichert den Cloudinhalt in YML-Dateien, bevor die Cloudkonfiguration geändert wird. Diese Option ist standardmäßig aktiviert.
  • Confirm: Bei Festlegen auf “true” wird eine Bestätigung zum Ändern der Konfiguration der Cloudsite angefordert. Das Cmdlet Remove zeigt aufgrund seiner destruktiven Wirkung eine Aufforderung an. Legen Sie es auf “false” fest, wenn keine Eingabeaufforderung gewünscht wird (z. B. bei Ausführung in einem Skript). Confirm ist standardmäßig auf “true” festgelegt.
  • AdminAddress: Wird für Cmdlets zum Exportieren unterstützt und kann auf beliebige Desktop Delivery Controller zum Exportieren abzielen. Die benötigten Citrix PowerShell-SDKs müssen auf der Maschine installiert sein, auf der das Citrix Automated Configuration Tool ausgeführt wird (siehe Voraussetzungen für die Migration Ihrer Konfiguration). Hostverbindungen können nicht exportiert werden, wenn das Tool auf einer anderen Maschine als einem Desktop Delivery Controller ausgeführt wird.
  • CheckAllMachines: Prüft, ob alle Maschinen in Maschinenkatalogen in Active Directory vorhanden sind. Ist eine Maschine nicht vorhanden, wird sie aus dem Maschinenkatalog entfernt und ein entsprechender Eintrag wird dem Abschnitt “Fixups” in der Protokolldatei hinzugefügt. So werden Fehler beim Hinzufügen von Maschinenkatalogen aufgrund nicht vorhandener Maschinen vermieden. CheckAllMachines ist standardmäßig auf “true” festgelegt.

Parameter für den Cloudzugriff

Alle Cmdlets, die auf die Cloud zugreifen (Cmdlets, die in ToSite oder FromSite enden), unterstützen folgende zusätzliche Parameter.

Hinweis:

Diese Parameter werden nicht benötigt, wenn sie der Datei CustomerInfo.yml hinzugefügt werden.

  • CustomerId: Die Kunden-ID wird in den Rest-APIs verwendet und ist für den Zugriff auf alle Rest-APIs erforderlich. Die Kunden-ID finden Sie in Citrix Cloud. Weitere Informationen finden Sie unter Generieren der Kunden-ID, der Client-ID und des geheimen Schlüssels.
  • ClientId: Die auf der Website Citrix Cloud Identity and Access Management erstellte Client-ID. Er ist zum Abrufen des Bearertokens erforderlich, das zur Authentifizierung bei allen Rest-APIs benötigt wird. Weitere Informationen finden Sie unter Generieren der Kunden-ID, der Client-ID und des geheimen Schlüssels.
  • Secret: Der auf der Website Citrix Cloud Identity and Access Management erstellte geheime Schlüssel. Er ist zum Abrufen des Bearertokens erforderlich, das zur Authentifizierung bei allen Rest-APIs benötigt wird. Weitere Informationen finden Sie unter Generieren der Kunden-ID, der Client-ID und des geheimen Schlüssels.
  • CustomerInfoFileSpec: Die Dateispezifikation, die auf eine Kundeninformationsdatei verweist, um den Standardspeicherort und den Standardnamen außer Kraft zu setzen.

Support und Problembehandlung bei Cmdlets

  • Find-CvadAcConnector: Sucht vorhandene Connectors und ermittelt deren Ausführungszustand. Das Cmdlet verwendet Informationen aus der YML-Datei mit den Kundeninformationen oder aus dem Kunden-ID-Parameter zur Suche der Connectors des Kunden.
  • Test-CvadAcConnectionWithSite: Testet die Verbindung mit der Cloudsite. Das Cmdlet verwendet die Cloudzugriffsparameter oder die YML-Datei mit den Kundeninformationen zum Angeben der Kundenverbindungsinformationen.
  • Initialize-CvadAcToSite: Setzt die Cloudsite auf den Standardzustand zurück. Mit Vorsicht verwenden!
  • Get-CvadAcCustomerSites: Gibt die Liste aller Kundensites zurück. Das Cmdlet verwendet die Cloudzugriffsparameter oder die YML-Datei mit den Kundeninformationen zum Angeben der Kundenverbindungsinformationen.
  • New-CvadAcTemplateToFile: Erstellt eine Vorlagendatei für ausgewählte Komponenten zur manuellen Erstellung einer Importdatei.
  • Get-CvadAcStatus: Gibt Informationen über das Tool und die Umgebung zurück, in der es ausgeführt wird: Toolversion, ob der Benutzer Siteadministrator-Berechtigung für den Export hat, ob Kunden-ID, Client-ID und geheimer Schlüssel vorhanden sind, ob die Kommunikation mit der Site möglich ist und ob ein oder mehrere Connectors vorhanden sind.

Parameter zur Protokollanzeige

Die Cmdlets Export, Import, Sync, Restore, Backup, Compare und Remove zeigen nach Abschluss des Vorgangs die Protokolldatei an. Sie können die Anzeige unterdrücken, indem Sie den Parameter -DisplayLog auf $false einstellen. Notepad.exe wird standardmäßig zur Anzeige des Protokolls verwendet. Sie können in der Datei CustomerInfo.yml einen anderen Editor angeben.

Editor: C:\Program Files\Notepad++\notepad++.exe

Abgeleitete Zustände nach Befehl

Ein abgeleiteter Zustand kann zu einer von drei Aktionskombinationen in der Cloudsite führen:

  • Hinzufügen, Aktualisieren und Löschen
  • Nur Hinzufügen und Aktualisieren
  • Nur Hinzufügen

Die folgende Tabelle zeigt den abgeleiteten Zustand für jedes Cmdlet und optionale Parameter zum Ändern von dessen Verhalten.

Befehl Hinzufügen, Aktualisieren, Löschen Hinzufügen, Aktualisieren Add
Importieren -Merge $false Standard -AddOnly $true
Merge Nicht zutreffend Standard -AddOnly $true
Neu Nicht zutreffend Nicht zutreffend Standard
Synchronisieren -Merge $false Standard -AddOnly $true
Wiederherstellen -Merge $false Standard -AddOnly $true

Cmdlet-Rückgabewerte

ActionResult

Alle Cmdlets geben den folgenden Wert zurück.

public class ActionResult
{
    public bool                         Overall_Success;
    public Dictionary<string, string>   Individual_Success;
    public object                       CustomResult;
}

Overall_Success gibt einen einzelnen Booleschen Wert zurück, der den Gesamterfolg des Cmdlets für alle ausgewählten Komponenten anzeigt: true = erfolgreich, false = nicht erfolgreich.

Individual_Success gibt einen von drei Werten für jede Hauptkomponente zurück. Das Ergebnis kann Success, Failure oder Skipped lauten. Skipped bedeutet, dass eine Komponente nicht zur Ausführung durch das Cmdlet ausgewählt wurde.

CustomResult ist Cmdlet-spezifisch.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File und Remove geben die folgenden CustomResult-Informationen in einer EvaluationResultData-Instanz zurück.

Hinweis:

Die Cmdlets Export und Template geben kein CustomResult zurück.

    public class EvaluationResultData
    {
        public Dictionary<string, Dictionary<string, ActionResultValues >> EvaluationResults;
        public int                  Added;
        public int                  Updated;
        public int                  Deleted;
        public int                  NoChange;
        public int                  TotalChanged;
        public EvaluationResults     OverallResult;
        public string               CloudBackupFolder;
        public string               SourceBackupFolder;
    }
    Where:
    public enum ActionResultValues
    {
        Add,
        Update,
        Delete,
        Identical,
        DoNothing
    }
    public enum EvaluationResults
    {
        Success,
        Failure,
        Skipped
    }

EvaluationResults zeigt eine Liste mit einem Eintrag pro ausgewählter Komponente an. Der Schlüssel ist der Komponentenname und der Wert eine Liste jedes Komponentenelements und der an diesem ausgeführten Aktion. Die Aktion ist einer der ActionResultValues-Werte.

Added, Updated, Deleted und NoChange entsprechen der Gesamtzahl der hinzugefügten, aktualisierten, gelöschten und nicht geänderten Komponentenelemente (in der hier angegebenen Reihenfolge).

TotalChanged ist die Summe von Added, Updated und Deleted.

OverallResult ist ein Boolescher Wert, der das Ergebnis des Cmdlets beschreibt. “True” bedeutet Erfolg für alle Komponenten, “false” zeigt einen Fehler bei der Verarbeitung mindestens einer Komponente an.

CloudBackupFolder ist die vollqualifizierte Dateispezifikation des Backups der Cloudsite-Konfiguration, die vor Ausführung des Cmdlets erstellt wurde.

SourceBackupFolder ist die vollqualifizierte Dateispezifikation des Backups der Quelldatei, die nach Ausführung des Cmdlets erstellt wurde. Standardmäßig sind diese Dateien unter %HOMEPATH%\Documents\Citrix\AutoConfig.

Hilfe

PowerShell-Hilfe ist für jedes Cmdlet verfügbar. Sie enthält eine kurze Erläuterung des Cmdlets und eine Dokumentation aller Parameter. Um auf die Hilfe für ein Cmdlet zuzugreifen, geben Sie vor dem Cmdlet Get-Help ein.

Get-Help Import-CvadAcToSite

Ordner, Backups und Protokollierung

Das Citrix Automated Configuration Tool initialisiert, aktualisiert und sichert die Cloudsite-Konfiguration. Die Verwendung im Laufe der Zeit kann zu vielen Konfigurationsänderungen bei der Cloudsite führen. Zur Vereinfachung der langfristigen Verwendung speichert das Tool den Änderungsverlauf und bietet eine Methode zum Wiederherstellen früherer Zustände.

Ordner

Standard-Stammordner

Alle Vorgänge des Citrix Automated Configuration Tools werden im Stammordner oder einem seiner Unterordner ausgeführt. Der Stammordner ist in %HOMEPATH%\Documents\Citrix\AutoConfig.

Exportieren

Alle exportierten Dateien werden zur Gewährleistung der Benutzerfreundlichkeit und zur Bewahrung eines Exportverlaufs in zwei Ordnern gespeichert. Exporte werden immer im Stammordner gespeichert. Kopien werden in dem Unterordner Export mit dem Datum und der Uhrzeit des Exports gespeichert.

Der Stammordner enthält immer die zuletzt exportierte On-Premises-Sitekonfiguration. Jeder Export-Unterordner enthält den zu dem angegebenen Datum und der angegebenen Uhrzeit erfolgten Export, wodurch ein Exportverlauf bereitgestellt wird. Sie können die Cloudsite unter Verwendung eines beliebigen Export-Unterordners konfigurieren. Exportunterordner werden vom Citrix Automated Configuration Tool weder gelöscht oder geändert.

Importieren, Zusammenführen, Synchronisieren, Vergleichen

Die Vorgänge Import, Merge und Compare erfolgen immer mit Quelldateien im Stammordner. Jeder Vorgang führt zur Erstellung eines Unterordners, in den Dateien aus dem Stammordner kopiert werden, sodass ein Verlauf der Quelldateien der Cloudsite-Änderungen entsteht.

Jeder Unterordner kann zum Konfigurieren der Cloudsite verwendet werden. Exportunterordner werden vom Citrix Automated Configuration Tool weder gelöscht oder geändert.

Wiederherstellen

Der Restore-Vorgang verwendet einen bestehenden Unterordner zum Konfigurieren der Cloudsite. Der Quellordner wird mit dem erforderlichen Parameter -RestoreFolder angegeben. Im Gegensatz zu anderen Befehlen wird kein Unterordner erstellt, da der Restore-Vorgang einen bestehenden Unterordner verwendet. Als Wiederherstellungsordner kann der Stammordner verwendet werden, doch auch er muss im -RestoreFolder-Parameter angegeben werden.

Backup

Backups der Cloudsite-Konfiguration werden immer in einem Unterordner namens Backup mit Datum und Zeitpunkt des Backups gespeichert. Exportunterordner werden vom Citrix Automated Configuration Tool weder gelöscht oder geändert.

Sie können mit den Backups einzelne Komponenten oder die gesamte Konfiguration wiederherstellen. Verwenden Sie zum Wiederherstellen der gesamten Bereitstellungsgruppen- und Maschinenkatalogkomponenten folgendes Cmdlet:

Restore-CvadAcToSite -RestoreFrom %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss -DeliveryGroups $true -MachineCatalogs $true

Hinweis:

Die Informationen zur Backupdatei im obigen Cmdlet basieren auf Ihren eigenen Backups.

Verwenden Sie zum Wiederherstellen der gesamten Cloudsite-Konfiguration folgendes Cmdlet:

Restore-CvadAcToSite -RestoreFrom %HOMEPATH%\Documents\Citrix\AutoConfig/Backup_yyyy_mm_dd_hh_mm_ss

Hinweis:

Die Informationen zur Backupdatei im obigen Cmdlet basieren auf Ihren eigenen Backups.

Ändern des Standardstammordners

Die Vorgänge Export, Import, Merge, Sync und Compare können bei Verwendung des Parameters –AlternateFolder den Stammordner ändern. Die Erstellung und Verwaltung vorgangsbezogener Unterordner ist weiterhin wie oben beschrieben.

In Unterordner kopierte Dateien

Mit Ausnahme der Folgenden werden alle Dateien mit der Erweiterung “yml” in Vorgangsunterordner kopiert:

  • CustomerInfo.yml
  • ZoneMapping.yml
  • HostSecurity.yml

Automatisierte, ausfallsichere Cloudsite-Backups

Vor dem Ausführen von Vorgängen, die die Konfiguration ändern, wird ein Backup der Cloudsite-Konfiguration vorgenommen. Dies betrifft die Parameter Import, Merge, Sync und Restore. Das Backup ist immer in einem Unterordner des zum Vorgang gehörenden Unterordners.

Bei Restore ist der Backupordner ein Unterordner des im Parameter -RestoreFrom angegebenen Ordners.

Logging

Beim Ausführen eines Cmdlets wird immer eine Protokolldatei erstellt und der Master-Verlaufsprotokolldatei ein Eintrag hinzugefügt. Alle Vorgangsprotokolldateien werden in einem Backupordner gespeichert. Alle Protokolldateinamen beginnen mit “CitrixLog”, gefolgt von dem Vorgang der automatischen Konfiguration und dem Datum und der Uhrzeit der Cmdlet-Ausführung. Protokolle werden nicht automatisch gelöscht.

Das Master-Verlaufsprotokoll ist in %HOMEPATH%\Documents\Citrix\AutoConfig (Dateiname History.Log). Jede Cmdlet-Ausführung wird im Master-Verlaufsprotokoll mit Datum, Vorgang, Ergebnis, Backup und Protokolldatei-Speicherorten eingetragen.

Die Protokollierung

Jede Protokolldatei enthält Folgendes:

  • Name des Vorgangs und ob der Prüfmodus aktiviert ist
  • Datum und Uhrzeit des Starts und Endes
  • Einträge für die Aktionen an jeder Komponente und Erfolgs-/Fehlermeldung
  • Zusammenfassung der durchgeführten Aktionen, einschließlich Anzahl erstellter Objekte
  • Gegebenenfalls Empfehlungen für Fixes
  • Gegebenenfalls Speicherort des Backupordners
  • Speicherort des Master-Verlaufsprotokolls
  • Dauer

Diagnosedateien

Diagnosedateien helfen bei der Ermittlung und Behebung von Problemen. Die folgenden Dateien werden erstellt, wenn der betreffende Vorgang ausgeführt wird. Sie sind in dem aktionsspezifischen Unterordner in %HOMEPATH%\Documents\Citrix\AutoConfig. Fügen Sie diese Dateien bei, wenn Sie Informationen für den Support zur Problembehebung bereitstellen.

Exportieren

PoshSdk_yyyy_mm_dd_hh_mm_ss.ps1

Diese Datei listet alle Broker-PowerShell-SDK-Aufrufe auf, die zum Exportieren der Sitekonfiguration ausgeführt wurden.

Import, Merge, Restore, Sync, Backup, Compare

Transaction_yyyy_mm_dd_hh_mm_ss.txt

Diese Datei dokumentiert jeden Rest API-Aufruf und zugehörige Informationen.

RestApiContent_yyyy_mm_dd_hh_mm_ss.txt

Diese Datei enthält den Inhalt für alle Add-, Update- und Delete-Rest APIs.

Weitere Informationen

Administrator-Geltungsbereiche

Der Export- und der Importvorgang unterstützen Administrator-Geltungsbereiche. Beim Importvorgang kann jedoch nur ein Bereich zugeordnet, nicht aber erstellt werden. Führen Sie die folgenden Schritte aus, um Administrator-Geltungsbereiche zu exportieren und in die Cloudsite zu importieren.

  1. Exportieren Sie die On-Premises-Site.
  2. Navigieren Sie im On-Premises-Citrix Studio zur Registerkarte Konfiguration > Administratoren > Geltungsbereiche und notieren Sie alle vorhandenen Bereiche. Die Zuordnungen müssen nicht notiert werden, da sie beim Importieren der Komponenten erstellt werden.
  3. Navigieren Sie in der Citrix Cloud-Vollkonfigurationskonsole zur Registerkarte Konfiguration > Administratoren > Geltungsbereiche und erstellen Sie manuell jeden im vorherigen Schritt notierten Bereich.
  4. Führen Sie an dem Export aus Schritt 1 ein Import, Merge, Restore, New oder Sync aus.
  5. Die manuell erstellten Bereiche werden den richtigen Komponenten zugeordnet.

Wenn die Administrator-Geltungsbereiche nicht zuerst manuell erstellt werden, werden sie beim Importieren aus den Komponenten entfernt. Nach dem manuellen Erstellen der Bereiche ordnet ein erneuter Import die Bereiche den Komponenten zu.

Hostverbindungen

Hostverbindungen und die zugehörigen Hypervisors können mit dem Tool exportiert und importiert werden. Diese Funktion muss jedoch manuell aktiviert werden und es sind spezifische Sicherheitsüberlegungen anzustellen.

Um den Export und Import von Hostverbindungen zu aktivieren, fügen Sie der Datei CustomerInfo.yml die folgende Zeile hinzu:

HostConnections: True

Hinweis:

Zwischen dem Doppelpunkt und “True” muss ein Leerzeichen stehen.

Das Hinzufügen eines Hypervisors zu einer Hostverbindung erfordert Hypervisortyp-spezifische Sicherheitsinformationen. Diese Informationen können aus Sicherheitsgründen nicht aus der On-Premises-Site exportiert werden. Sie müssen die Informationen manuell bereitstellen, damit das Citrix Automated Configuration Tool Hostverbindungen und Hypervisors in die Cloudsite importieren kann.

Beim Exportieren wird die Datei HostSecurity.yml in %HOMEPATH%\Documents\Citrix\AutoConfig erstellt. Sie enthält Platzhalter für jedes für den spezifischen Hypervisortyp benötigte Sicherheitselement. Sie müssen die Datei HostSecurity.yml vor dem Import in die Cloudsite aktualisieren. Administratorupdates werden über mehrere Exportvorgänge beibehalten und bei Bedarf neue Sicherheitsplatzhalter hinzugefügt. Sicherheitselemente werden nie entfernt.

---

HostConn1:
ConnectionType: XenServer
UserName: root
PasswordKey: rootPassword
HostCon2:
ConnectionType: AWS
ApiKey: 78AB6083-EF60-4D26-B2L5-BZ35X00DA5CH
SecretKey: TwBLaaaaaaaaaaaaaaaaaw==
Region: East

Hypervisor-spezifische Sicherheitsinformationen

Nachfolgend werden die für die einzelnen Hypervisortypen erforderlichen Sicherheitsinformationen aufgeführt.

  • XenServer, Hyper-V, VMware
    • Benutzername
    • Klartextkennwort
  • Microsoft Azure
    • Abonnement-ID
    • Anwendungs-ID
    • Anwendungsgeheimnis
  • Amazon Web Services
    • Dienstkonto-ID
    • Anwendungsgeheimnis
    • Region

Besondere Sicherheitsüberlegungen

Alle Sicherheitsinformationen werden als Klartext eingegeben. Die Hostverbindungen und die zugehörigen Hypervisoren können manuell über die Vollkonfigurationskonsole der Cloud erstellt werden. Die Namen von Hostverbindungen und Hypervisors müssen mit den On-Premises-Gegenstücken übereinstimmen, damit Maschinenkataloge, die die Hostverbindungen verwenden, erfolgreich importiert werden.

Unterstützung für PVS-Maschinenkataloge

Das Citrix Automated Configuration Tool unterstützt PVS-Maschinenkataloge, erfordert jedoch zusätzliche Sicherheitsinformationen, damit die Cloud den PVS-Server kontaktieren kann. Für jeden in den exportierten Maschinenkatalogen gefundenen PVS-Server wird in der Datei CvadAcSecurity.yml ein Eintrag erstellt.

Der PVS-Servereintrag enthält den auf PVS festgelegten Verbindungstyp, den PVS-Server-Benutzernamen mit dem Domänenpräfix und das Kennwort (alles in Klartext). Vorhandene PVS-Servereinträge werden bei aufeinanderfolgenden Exporten nicht überlagert oder entfernt.

---
Pvs1Server:
ConnectionType: PVS
UserName: xd1\administrator
Password: adminPassword

Hinweis:

Das Dienstkonto, mit dem das Tool ausgeführt wird, muss Volladministrator der Site und PVS-Administrator sein.

Automatisierung

Die Cmdlets des Citrix Automated Configuration Tools können ohne Administratoreingriff in Skripts ausgeführt werden. Eingabeaufforderungen und die Anzeige der Protokollergebnisse bei Abschluss des Cmdlets werden dann unterdrückt. Sie können für dieselbe Funktion auch Parameter über die Datei CustomerInfo.yml festlegen.

Fügen Sie den folgenden Parameter zu Cmdlets zur Cloudmodifizierung hinzu, um die Anzeige von Eingabeaufforderungen zu unterdrücken.

-Confirm $false

Fügen Sie den folgenden Parameter zu Cmdlets hinzu, um die Anzeige des Protokolls nach Abschluss des Cmdlets zu unterdrücken.

-DisplayLog $false

Alternativ können die folgenden Parameter in die Datei CustomerInfo.yml geschrieben werden.

Confirm: False

DisplayLog: False

Exportieren von anderen PCs als einem Desktop Delivery Controller

Das Citrix Automated Configuration Tool verwendet mehrere Citrix PowerShell-SDKs, um die Konfiguration der On-Premises-Site zu exportieren. Die SDKs werden automatisch auf dem Desktop Delivery Controller installiert, sodass das Tool ohne zusätzliche Aktionen auf diesem ausgeführt werden kann. Zur Ausführung des Tools auf Maschinen, die kein Desktop Delivery Controller sind, müssen Sie die benötigten Citrix PowerShell-SDKs installieren. Die SDKs ist gehören zu Citrix Studio, das vom Citrix Virtual Apps and Desktops-Installationsmedium installiert werden kann.

Hinweis:

Hostverbindungen können nicht von einer Maschine, die kein Desktop Delivery Controller ist, exportiert werden.

Das Citrix Automated Configuration Tool kann nicht auf dem Cloud Connector ausgeführt werden.

Problembehandlung und Empfehlungen

Cloudsite ist leer

Eine leere Site deutet darauf hin, dass der Import-/Merge-/Restore-Vorgang nicht einwandfrei ausgeführt wurde. Wurde ein solcher Vorgang versucht, überprüfen Sie das zugehörige Protokoll.

Cloudsite enthält mehr Elemente als erwartet

Dies kann passieren, wenn die Konfiguration der Cloudsite erweitert und ein Merge-Vorgang ausgeführt wurde. Es kann auch vorkommen, wenn die Konfiguration der Cloudsite Werte aufwies und beim Import/Merge/Restore Fehler auftreten. Versuchen Sie den Vorgang erneut.

Cloudsite enthält weniger Elemente als erwartet

Dies kann passieren, wenn die Cloudsite-Konfiguration erweitert und ein Import mit dem Parameter Merge = $false ausgeführt wurde, was zu einem identischen abgeleiteten Zustand führt. Ein Backup des ursprünglichen Zustands in dem Ordner Automated Fail-Safe-Cloud Site Backup gespeichert, der dem Importvorgang zugeordnet ist. Behebung:

  1. Stellen Sie das Automated Fail-Safe Cloud Site Backup mit “Restore” wieder her, und legen Sie dabei den Parameter “RestoreFolder” auf Automated Fail-Safe Cloud Site Backup fest.

  2. Verwenden Sie Merge anstelle von Import.

Nach dem Import erfolgte Änderungen der Cloudsite gehen verloren

Dies kann passieren, wenn ein Import mit dem –Merge-Parameter = $false ausgeführt wurde, was zu einem identischen abgeleiteten Zustand führt. Ein Backup des ursprünglichen Zustands in dem Ordner Automated Fail-Safe-Cloud Site Backup gespeichert, der dem Importvorgang zugeordnet ist. Behebung:

  1. Stellen Sie das Automated Fail-Safe Cloud Site Backup mit “Restore” wieder her, und legen Sie dabei den Parameter “RestoreFolder” auf Automated Fail-Safe Cloud Site Backup fest.

  2. Verwenden Sie Merge anstelle von Import.

Cloudsite stimmt nicht mit der aktuellen On-Premises-Site überein

Dies kann passieren, wenn ein Merge ausgeführt wurde, was zu einem zusammengeführten abgeleiteten Zustand führt, anstelle eines Import-Vorgangs mit dem Merge-Parameter = $false, was zu einem identischen abgeleiteten Zustand führt. Wiederholen Sie den Vorgang unter Verwendung von Import mit Parameter Merge = $false.

Empfehlungen

  • Führen Sie nicht mehrere Citrix Automated Configuration Tool-Instanzen gleichzeitig aus. Das Ausführen mehrerer Instanzen führt zu unvorhersehbaren Ergebnissen in der Cloudsite. Führen Sie in diesem Fall eine Instanz des Citrix Automated Configuration Tool noch einmal aus, um die Site in den erwarteten Zustand zu versetzen.
  • Arbeiten Sie nicht in Web Studio oder mit der Vollkonfigurationskonsole, während Sie das Citrix Automated Configuration Tool ausführen. Das Vornehmen von Änderungen in Web Studio oder der Vollkonfigurationskonsole während der Ausführung des Tools kann zu unvorhersehbaren Ergebnissen in der Cloudsite führen. Führen Sie in diesem Fall eine Instanz des Citrix Automated Configuration Tool noch einmal aus, um die Site in den erwarteten Zustand zu versetzen.
  • Überprüfen Sie immer visuell die Ergebnisse von Merge/Import/Restore in Web Studio oder der Vollkonfigurationskonsole, um sicherzustellen, dass die Cloudsite die Erwartungen erfüllt.