Citrix Virtual Apps and Desktops Service

Cmdlets der automatischen Konfiguration

Auf dieser Seite werden alle Cmdlets und Parameter aufgeführt, die von der automatischen Konfiguration unterstützt werden.

Alle Cmdlets übernehmen Parameter mit einem der folgenden Typen.

  • Zeichenfolge
  • Liste von Zeichenfolgen
  • Boolesch: $true oder $false
  • SwitchParameter: Vorhandensein des Parameters bedeutet $true, Fehlen des Parameters bedeutet $false

Hinweis:

Die SwitchParameter-Methode wird für die Auswahl von “true” oder “false” bevorzugt, aber aufgrund von Legacyproblemen werden im Tool immer noch boolesche Werte verwendet.

In der folgenden Tabelle sind alle Cmdlets zusammengefasst. In den einzelnen Abschnitten erfahren Sie, von welchen Parametern die Cmdlets jeweils unterstützt werden.

Kategorie Cmdlet Beschreibung
Migration von On-Premises in die Cloud Export-CvadAcToFile Exportiert On-Premises-Dateien in YAML-Dateien.
  Import-CvadAcToSite Importiert YAML-Dateien in die Cloud. Unterstützt Erstellungs-, Aktualisierungs- und Löschvorgänge.
  Merge-CvadAcToSite Importiert YAML-Dateien in die Cloud. Unterstützt Erstellungs- und Aktualisierungsvorgänge.
  New-CvadAcToSite Importiert YAML-Dateien in die Cloud. Unterstützt Erstellungs- und Aktualisierungsvorgänge.
  Sync-CvadAcToSite Exportiert und importiert in einem Schritt.
  Granulare Migration Verwenden Sie für Komponenten Parameter mit obigen Befehlen. Beispiele: MachineCatalogs, Tags. Verwenden Sie für Komponentennamen Parameter mit obigen Befehlen. Beispiele: IncludeByName, ExcludeByName. Selektive Migration von nur Komponenten oder Komponentennamen
Cloud zu Cloud-Cmdlets Backup-CvadAcToFile Sichert die gesamte Konfiguration von Ihrer Cloudsite.
  Restore-CvadAcToSite Stellt Backup-YAML-Dateien auf der Cloudsite wieder her. Diese Cloudsite kann dieselbe sein wie die Quellcloudsite oder eine andere.
  Remove-CvadAcFromSite Entfernt Komponentenelemente aus der Cloud.
  Granulare Migration Verwenden Sie für Komponenten Parameter mit obigen Befehlen. Beispiele: MachineCatalogs, Tags. Verwenden Sie für Komponentennamen Parameter mit obigen Befehlen. Beispiele: IncludeByName, ExcludeByName. Selektive Migration von nur Komponenten oder Komponentennamen
Andere grundlegende Cmdlets Compare-CvadAcToSite Vergleicht die On-Premises-YML-Dateien mit der Cloudkonfiguration.
Voraussetzungsbezogene Cmdlets New-CvadAcCustomerInfoFile Erstellt eine Kundeninformationsdatei.
  Set-CvadAcCustomerInfoFile Aktualisiert eine bestehende Kundeninformationsdatei.
Cmdlets für Support und Problembehandlung New-CvadAcZipInfoForSupport Komprimiert alle Protokoll- und YML-Dateien in einer ZIP-Datei zur Übermittlung an Citrix für Supportmaßnahmen.
  Get-CvadAcStatus Wird verwendet, um Konnektivität zu testen und sicherzustellen, dass alle Voraussetzungen erfüllt sind. Gibt Informationen über das Tool wie Versionsnummer und Konnektivität sowie Cloud- und Connectorstatus zurück.
  Test-CvadAcConnectionWithSite Testet Verbindung mit der Cloudsite.
  Find-CvadAcConnector Sucht vorhandene Connectors und ermittelt deren Ausführungszustand.
  Get-CvadAcCustomerSites Gibt die Liste aller Kundensites zurück.
  New-CvadAcTemplateToFile Erstellt eine Vorlagendatei für ausgewählte Komponenten.
  Show-CvadAcDocument Zeigt diese Dokumentation im Standardbrowser an.
  Find-CvadAcInFile Durchsucht YAML-Komponentendateien nach Elementen, die einem oder mehreren Namen entsprechen, die Platzhalter enthalten können.
Cmdlets für die Siteaktivierung Set-CvadAcSiteActiveStateOnPrem Legt den Status der On-Premises-Site auf aktiv oder inaktiv fest.
  Set-CvadAcSiteActiveStateCloud Legt den Status der Cloudsite auf aktiv oder inaktiv fest.
Cmdlets für das Zusammenführen mehrerer On-Premises-Sites New-CvadAcSiteMergingInfo Erstellt ein Präfix-/Suffix-Infoset zum Zusammenführen von Sites.
  Set-CvadAcSiteMergingInfo Aktualisiert das Präfix-/Suffix-Infoset zur Sitezusammenführung.
  Remove-CvadAcSiteMergingInfo Entfernt das Präfix-/Suffix-Infoset zur Sitezusammenführung.

Weitere Informationen zu Parametern und deren Verwendung finden Sie unter Parameter für granulare Migration.

Grundlegende Cmdlets

On-Premises-zu-Cloud-Cmdlets

  • Export-CvadAcToFile: Exportiert On-Premises-Dateien in YAML-Dateien.

    Exportiert die Konfiguration aus Ihrem On-Premises-Setup. Dabei handelt es sich um den standardmäßigen Export mit der automatischen Konfiguration. Es werden keine Änderungen an der On-Premises-Sitekonfiguration vorgenommen. Die exportierten Dateien werden im Verzeichnis %HOMEPATH%\Documents\Citrix\AutoConfig in einem eindeutig Export benannten Unterordner abgelegt. Der Ordner %HOMEPATH%\Documents\Citrix\AutoConfig enthält immer die neueste exportierte On-Premises-Sitekonfiguration.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    TargetFolder Gibt den Exportzielordner an.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    AdminAddress Gibt das DNS oder die IP-Adresse des Delivery Controllers an, wenn der Export nicht auf dem Delivery Controller ausgeführt wird.   Zeichenfolge
    CheckUserAndMachines Überprüft, ob Benutzer und Maschinen in Active Directory sind. Nicht in Active Directory enthaltene Benutzer und Maschinen können zu Importfehlern führen.   $true oder $false
    ZipResults Komprimiert Backup von YAML-Dateien in einer einzigen ZIP-Datei. Die Datei befindet sich im selben Ordner wie die gesicherten YAML-Dateien und hat denselben Namen wie der Ordner.   SwitchParameter

    Gibt zurück:

Zum Importieren von Daten in die Cloud gibt es drei Möglichkeiten. Das Ausführen bestimmter Cmdlets 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
Cmdlet Hinzufügen Aktualisieren Löschen
Importieren X X X
Merge X X  
Neu X    
  • Import-CvadAcToSite: Importiert YAML-Dateien in die Cloud. Unterstützt Erstellungs-, Aktualisierungs- und Löschvorgänge.

    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. Importierte Sitekonfigurationsdateien stammen aus %HOMEPATH%\Documents\Citrix\AutoConfig. Mit Vorsicht verwenden!

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SourceFolder Identifiziert einen Ersatzstammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false
    Merge Fügt bei Einstellung auf $true der Cloudsite nur Komponenten hinzu. Es werden keine Komponenten entfernt. Legen Sie $false fest, um Komponenten zu entfernen.   $true oder $false
    AddOnly Fügt bei Einstellung auf $true nur neue Komponenten hinzu, vorhandene Komponenten werden nicht aktualisiert oder gelöscht. Legen Sie $false fest, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter auf $true festgelegt ist.   $true oder $false
    MergePolicies Führt Richtlinieneinstellungen und Filter zusammen. Das Zusammenführen erfolgt nur, wenn eine importierte Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis der Zusammenführung von Richtlinien ist, dass die Cloud-DDC-Richtlinien die Einstellungen und Filter enthalten, die bereits vorhanden waren, sowie alle neuen Einstellungen und Filter, die importiert werden. Wenn Konflikte zwischen Einstellungen und Filtern auftreten, haben die importierten Werte Vorrang.   SwitchParameter

    Gibt zurück:

  • Merge-CvadAcToSite: Importiert YAML-Dateien in die Cloud. Unterstützt Erstellungs- und Aktualisierungsvorgänge.

    Führt die On-Premises-Dateien in der Cloud zusammen, Komponenten in der Cloud oder On-Premises-Site werden jedoch nicht gelöscht. 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 der automatischen Konfiguration. Zusammengeführte Sitekonfigurationsdateien stammen aus %HOMEPATH%\Documents\Citrix\AutoConfig.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SourceFolder Identifiziert einen Ersatzstammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false
    Merge Fügt bei Einstellung auf $true der Cloudsite nur Komponenten hinzu. Es werden keine Komponenten entfernt. Legen Sie $false fest, um Komponenten zu entfernen.   $true oder $false
    AddOnly Fügt bei Einstellung auf $true nur neue Komponenten hinzu, vorhandene Komponenten werden nicht aktualisiert oder gelöscht. Legen Sie $false fest, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter auf $true festgelegt ist.   $true oder $false
    MergePolicies Führt Richtlinieneinstellungen und Filter zusammen. Das Zusammenführen erfolgt nur, wenn eine importierte Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis der Zusammenführung von Richtlinien ist, dass die Cloud-DDC-Richtlinien die Einstellungen und Filter enthalten, die bereits vorhanden waren, sowie alle neuen Einstellungen und Filter, die importiert werden. Wenn Konflikte zwischen Einstellungen und Filtern auftreten, haben die importierten Werte Vorrang.   SwitchParameter

    Gibt zurück:

  • New-CvadAcToSite: Importiert YAML-Dateien in die Cloud. Unterstützt Erstellungs- und Aktualisierungsvorgänge.

    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.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SourceFolder Identifiziert einen Ersatzstammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false

    Gibt zurück:

  • Sync-CvadAcToSite: Exportiert und importiert in einem Schritt.

    Die Synchronisierung führt Export und Import in einem Schritt durch. Verwenden Sie den Parameter SourceTargetFolder, um den Export-/Importzielordner anzugeben.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SourceTargetFolder Gibt den Export-/Importzielordner an.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    AdminAddress Gibt das DNS oder die IP-Adresse des Delivery Controllers an, wenn der Export nicht auf dem Delivery Controller ausgeführt wird.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false
    Merge Fügt bei Einstellung auf $true der Cloudsite nur Komponenten hinzu. Es werden keine Komponenten entfernt. Legen Sie $false fest, um Komponenten zu entfernen.   $true oder $false
    AddOnly Fügt bei Einstellung auf $true nur neue Komponenten hinzu, vorhandene Komponenten werden nicht aktualisiert oder gelöscht. Legen Sie $false fest, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter auf $true festgelegt ist.   $true oder $false
    MergePolicies Führt Richtlinieneinstellungen und Filter zusammen. Das Zusammenführen erfolgt nur, wenn eine importierte Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis der Zusammenführung von Richtlinien ist, dass die Cloud-DDC-Richtlinien die Einstellungen und Filter enthalten, die bereits vorhanden waren, sowie alle neuen Einstellungen und Filter, die importiert werden. Wenn Konflikte zwischen Einstellungen und Filtern auftreten, haben die importierten Werte Vorrang.   SwitchParameter

    Gibt zurück:

Cloud zu Cloud-Cmdlets

  • Backup-CvadAcToFile: Sichert die gesamte Konfiguration von Ihrer Cloudsite.

    Exportiert die Cloudkonfiguration in YML-Dateien. Dieses Backup kann bei einem Backup- und Wiederherstellungsprozess zur Wiederherstellung verlorener Komponenten genutzt werden.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    TargetFolder Gibt den Exportzielordner an.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false
    ZipResults Komprimiert Backup von YAML-Dateien in einer einzigen ZIP-Datei. Die Datei befindet sich im selben Ordner wie die gesicherten YAML-Dateien und hat denselben Namen wie der Ordner.   SwitchParameter

    Gibt zurück:

  • Restore-CvadAcToSite: Stellt Backup-YAML-Dateien auf der Cloudsite wieder her. Diese Cloudsite kann dieselbe sein wie die Quellcloudsite oder eine andere.

    Stellt die Cloudsite wieder auf die vorherige Konfiguration zurück. Importierte Dateien werden aus dem Ordner bezogen, der mit dem Parameter -RestoreFolder angegeben wurde, der den Ordner mit den YML-Dateien zur Wiederherstellung auf der Cloudsite identifiziert. Es muss sich um eine vollständig qualifizierte Ordnerangabe handeln. Dieses Cmdlet kann zum Zurücksetzen auf die vorherige Konfiguration oder für ein Backup und Wiederherstellen der Cloudsite verwendet werden. Dieser Befehl dient zum Hinzufügen, Löschen und Aktualisieren Ihrer Cloudsite.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    RestoreFolder Identifiziert den Ordner mit den YML-Dateien zur Wiederherstellung in die Cloudsite. Es muss sich um eine vollständig qualifizierte Ordnerangabe handeln.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false
    Merge Fügt bei Einstellung auf $true der Cloudsite nur Komponenten hinzu. Es werden keine Komponenten entfernt. Legen Sie $false fest, um Komponenten zu entfernen.   $true oder $false
    AddOnly Fügt bei Einstellung auf $true nur neue Komponenten hinzu, vorhandene Komponenten werden nicht aktualisiert oder gelöscht. Legen Sie $false fest, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter auf $true festgelegt ist.   $true oder $false
    MergePolicies Führt Richtlinieneinstellungen und Filter zusammen. Das Zusammenführen erfolgt nur, wenn eine importierte Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis der Zusammenführung von Richtlinien ist, dass die Cloud-DDC-Richtlinien die Einstellungen und Filter enthalten, die bereits vorhanden waren, sowie alle neuen Einstellungen und Filter, die importiert werden. Wenn Konflikte zwischen Einstellungen und Filtern auftreten, haben die importierten Werte Vorrang.   SwitchParameter

    Gibt zurück:

  • Remove-CvadAcFromSite: Entfernt Komponentenelemente aus der Cloud.

    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.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false

    Gibt zurück:

Andere grundlegende Cmdlets

  • Compare-CvadAcToSite: Vergleicht die lokalen YML-Dateien mit der Cloud-Konfiguration und erstellt einen Bericht über Änderungen, die von dem Cmdlet Import, Merge oder Restore ausgeführt wurden.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    Filtern nach Objektnamen Siehe Filtern nach Objektnamen   Liste von Zeichenfolgen
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SourceFolder Identifiziert einen Ersatzstammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.   Zeichenfolge
    Locale Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true oder $false
    Merge Fügt bei Einstellung auf $true der Cloudsite nur Komponenten hinzu. Es werden keine Komponenten entfernt. Legen Sie $false fest, um Komponenten zu entfernen.   $true oder $false
    AddOnly Fügt bei Einstellung auf $true nur neue Komponenten hinzu, vorhandene Komponenten werden nicht aktualisiert oder gelöscht. Legen Sie $false fest, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter auf $true festgelegt ist.   $true oder $false

    Gibt zurück:

Parameter für die granulare Migration

Migrieren nach Komponenten

Die folgenden Komponenten können mit den entsprechenden Cmdlets angegeben werden. Die Option All wird automatisch ausgewählt, wenn keine Komponentenparameter angegeben werden.

  • All
  • Tags
  • AdminRolesScopes
  • MachineCatalogs
  • StoreFronts
  • DeliveryGroups
  • ApplicationGroups
  • Applications
  • GroupPolicies

Filtern nach Objektnamen

Migration nach Komponentennamen

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.

IncludeByName und ExcludeByName akzeptieren eine Liste mit Elementen. Die Name können einen oder mehrere Platzhalter enthalten. Zwei Arten von Platzhaltern werden unterstützt. Die Liste der Komponentenelemente muss in einfache Anführungszeichen gesetzt werden, wenn ein Elementname Sonderzeichen enthält.

  • * entspricht einer beliebigen Anzahl von Zeichen
  • ? Entspricht einem Zeichen

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.

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

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

Nach Bereitstellungsgruppennamen

ByDeliveryGroupName filtert nach Bereitstellungsgruppennamen für Anwendungen und Anwendungsgruppen. Dieser Parameter ist immer eine Aufnahmeliste, deren Einträge basierend auf ihrer Bereitstellungsgruppenzuordnung berücksichtigt werden.

ByDeliveryGroupName erfasst eine Liste von Bereitstellungsgruppennamen. Die Name können einen oder mehrere Platzhalter enthalten. Zwei Arten von Platzhaltern werden unterstützt.

  • * entspricht einer beliebigen Anzahl von Zeichen
  • ? entspricht einem einzelnen Zeichen

Im folgenden Beispiel werden alle Anwendungen zusammengeführt, die auf alle Bereitstellungsgruppennamen verweisen, die mit EastDg beginnen.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Deaktivierte ausschließen

ExcludeDisabled schließt alle deaktivierten Anwendungen und Anwendungsgruppen vom Import aus. ExcludeDisabled ist standardmäßig auf false festgelegt, d. h. alle Anwendungen und Anwendungsgruppen werden unabhängig vom Aktivierungsstatus importiert.

Nach Maschinenname

ByMachineName filtert nach dem Maschinennamen für Maschinenkataloge und Bereitstellungsgruppen. Dieser Parameter ist immer eine Aufnahmeliste, deren Einträge basierend auf ihrer Maschinennamenzuordnung berücksichtigt werden.

ByMachineName akzeptiert eine Liste von Maschinennamen, die einen oder mehrere Platzhalter enthalten können. Zwei Arten von Platzhaltern werden unterstützt.

  • * entspricht einer beliebigen Anzahl von Zeichen
  • ? entspricht einem einzelnen Zeichen

Wird beim Exportieren oder Importieren unter Verwendung von ByMachineName und eines Maschinennamenfilters keine Maschine im Maschinenkatalog oder in der Bereitstellungsgruppe gefunden, wird der Maschinenkatalog bzw. die Bereitstellungsgruppe vom Export oder Import ausgeschlossen.

Hinweis:

Bei Verwendung von ByMachineName in einem Import-Cmdlet wird MergeMachines auf $true festgelegt.

Zusammenführen von Maschinen

Wird MergeMachines auf $true festgelegt, werden Maschinen dem Maschinenkatalog oder der Bereitstellungsgruppe nur hinzugefügt. Es werden keine Maschinen entfernt, sodass inkrementelle Hinzufügungen möglich sind.

MergeMachines ist standardmäßig “false”, d. h. Maschinen werden entfernt, wenn sie nicht in der YML-Datei des Maschinenkatalogs oder der Bereitstellungsgruppe sind. MergeMachines wird bei Verwendung von ByMachineName auf $true festgelegt, kann aber durch Festlegen von MergeMachines auf “false” außer Kraft gesetzt werden.

Voraussetzungsbezogene Cmdlets

  • New-CvadAcCustomerInfoFile - Erstellt eine Datei mit Kundeninformationen. Standardmäßig ist diese unter %HOMEPATH%\Documents\Citrix\AutoConfig.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    CustomerId ID des Kunden. x Zeichenfolge
    ClientId Client-ID des Kunden, die in Citrix Cloud erstellt wurde. Bei Verwendung dieses Parameters müssen “CustomerId” und “Secret” angegeben werden. Bedingt Zeichenfolge
    Secret Geheimer Schlüssel des Kunden, der in Citrix Cloud erstellt wurde. Bei Verwendung dieses Parameters müssen “CustomerId” und “ClientId” angegeben werden. Bedingt Zeichenfolge
    Environment Production-, ProductionGov- oder ProductionJP-Umgebung.   Enumeration
    LogFileName Ändert das Protokolldateipräfix “CitrixLog” in ein anderes Präfix.   Zeichenfolge
    AltRootUrl Nur unter Anleitung von Citrix verwenden.   Zeichenfolge
    StopOnError Stoppt den Vorgang nach dem ersten Fehler.   $true oder $false
    TargetFolder Verwendet anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig den angegebenen Ordner als Stammordner.   Zeichenfolge
    Locale Verwendet das angegebene Gebietsschema anstelle des vom System, auf dem das Tool ausgeführt wird, abgeleiteten Gebietsschemas.   Zeichenfolge
    Editor Verwendet den angegebenen Editor zum Anzeigen des Protokolls nach Abschluss jedes Cmdlets. Notepad.exe ist der Standardeditor. Der Parameter muss die vollständig qualifizierte Dateiangabe für den Editor enthalten und darf ansonsten keinen Einstellung enthalten.   Zeichenfolge
    SecurityCsvFileSpec Die vollständig qualifizierte Dateispezifikation, die auf die von Citrix Identitäts- und Zugriffsverwaltung heruntergeladene Datei “SecurityClient.csv” verweist. Bei Verwendung dieses Parameters muss die “CustomerId” angegeben werden.   Zeichenfolge

    Gibt zurück:

  • Set-CvadAcCustomerInfoFile: Aktualisiert eine bestehende Kundeninformationsdatei. Nur die im Cmdlet angegebenen Parameter werden geändert. Alle nicht angegebenen Parameterwerte bleiben in der Datei “CustomerInfo.yml” unverändert.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    CustomerId ID des Kunden.   Zeichenfolge
    ClientId Client-ID des Kunden, die in Citrix Cloud erstellt wurde.   Zeichenfolge
    Secret Geheimer Schlüssel des Kunden, der in Citrix Cloud erstellt wurde.   Zeichenfolge
    Environment Production-, ProductionGov- oder ProductionJP-Umgebung.   Enumeration
    LogFileName Ändert das Protokolldateipräfix “CitrixLog” in ein anderes Präfix.   Zeichenfolge
    StopOnError Stoppt den Vorgang nach dem ersten Fehler.   $true oder $false
    TargetFolder Verwendet anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig den angegebenen Ordner als Stammordner.   Zeichenfolge
    Locale Verwendet das angegebene Gebietsschema anstelle des vom System, auf dem das Tool ausgeführt wird, abgeleiteten Gebietsschemas.   Zeichenfolge
    Editor Verwendet den angegebenen Editor zum Anzeigen des Protokolls nach Abschluss jedes Cmdlets. Notepad.exe ist der Standardeditor. Der Parameter muss die vollständig qualifizierte Dateiangabe für den Editor enthalten und darf ansonsten keinen Einstellung enthalten.   Zeichenfolge
    SecurityCsvFileSpec Die vollständig qualifizierte Dateispezifikation, die auf die von Citrix Identitäts- und Zugriffsverwaltung heruntergeladene Datei “SecurityClient.csv” verweist. Bei Verwendung dieses Parameters muss die “CustomerId” angegeben werden.   Zeichenfolge

    Gibt zurück:

Voraussetzungsbezogene Parameter

Zusammen mit den Parametern mit Cloudzugriff können die folgenden Parameter mit den voraussetzungsbezogenen Cmdlets verwendet werden:

  • Environment: Production- oder ProductionGov-Umgebung.
  • LogFileName: Ändern des Protokolldateipräfixes “CitrixLog” in ein anderes Präfix.
  • StopOnError: Stoppt den Vorgang nach dem ersten Fehler.
  • AlternateRootFolder: Verwendet anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig den angegebenen Ordner als Stammordner.
  • Locale: Verwendet das angegebene Gebietsschema anstelle des vom System, auf dem das Tool ausgeführt wird, abgeleiteten Gebietsschemas.
  • Editor: Verwendet den angegebenen Editor zum Anzeigen des Protokolls nach Abschluss jedes Cmdlets. Notepad.exe ist der Standardeditor. Der Parameter muss die vollständig qualifizierte Dateiangabe für den Editor enthalten und darf ansonsten keinen Einstellung enthalten.

Cmdlets für Support und Problembehandlung

  • New-CvadAcZipInfoForSupport: Komprimiert alle Protokoll- und YML-Dateien in einer ZIP-Datei zur Übermittlung an Citrix für Supportmaßnahmen. Vertrauliche Kundendaten (CustomerInfo.yml und CvadAcSecurity.yml) sind nicht in der ZIP-Datei enthalten. Die Datei Icon.yml ist aufgrund ihrer Größe ebenfalls ausgeschlossen. Die ZIP-Datei wird in %HOMEPATH%\Documents\Citrix\AutoConfig gespeichert und erhält den Namen CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip (mit Datums- und Zeitstempel). Diese ZIP-Datei kann auch als Backup dienen.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    TargetFolder Gibt einen Zielordner zum Erstellen und Speichern der ZIP-Datei an.   Zeichenfolge
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter

    Gibt zurück:

    • Die ZIP-Datei mit Namen und Pfad wird in der Eingabeaufforderung angezeigt.
  • Get-CvadAcStatus: Wird verwendet, um Konnektivität zu testen und sicherzustellen, dass alle Voraussetzungen erfüllt sind. Gibt Informationen über das Tool wie Versionsnummer und Konnektivität sowie Cloud- und Connectorstatus zurück.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SiteId Identifiziert die Site, mit der eine Verbindung hergestellt werden soll.   Zeichenfolge
    AdminAddress DNS oder IP-Adresse des On-Premises-Delivery Controllers, der zur Überprüfung der Administrator-Zugriffsebene verwendet wird. Dies ist erforderlich, wenn das Tool nicht auf einem Delivery Controller ausgeführt wird.   Zeichenfolge

    Gibt zurück:

    • Zeigt die Ergebnisse für jedes Element an.
  • Test-CvadAcConnectionWithSite: Test der Verbindung mit der Cloudsite. Das Cmdlet verwendet die Cloudzugriffsparameter oder die Datei CustomerInfo.yml zum Angeben der Kundenverbindungsinformationen.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter

    Gibt zurück:

    • Die Testergebnisse werden auf der Befehlszeile angezeigt.
  • Find-CvadAcConnector: Sucht vorhandene Connectors und ermittelt deren Ausführungszustand. Das Cmdlet verwendet Informationen aus der Datei “CustomerInfo.yml” oder aus dem Kunden-ID-Parameter zur Suche der Connectors des Kunden.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    CustomerInfoFileSpec Die Dateispezifikation, die auf eine Kundeninformationsdatei verweist, um den Standardspeicherort und den Standardnamen außer Kraft zu setzen. Dieser Parameter wird ignoriert, wenn der Parameter CustomerId angegeben wird.   Zeichenfolge
    CustomerId Die ID des Kunden. Dieser Parameter setzt den entsprechenden Wert in der Datei “CustomerInfo.yml” außer Kraft.   Zeichenfolge

    Gibt zurück:

    • Die Ergebnisse werden auf der Befehlszeile angezeigt.
  • Get-CvadAcCustomerSites: Gibt die Liste aller Kundensites zurück. Das Cmdlet verwendet die Cloudzugriffsparameter oder die Datei CustomerInfo.yml zum Angeben der Kundenverbindungsinformationen.

    Parameter:

    Gibt zurück:

    • Zeigt die Liste der gefundenen Kundensite-IDs an.
  • New-CvadAcTemplateToFile: Erstellt eine Vorlagendatei für ausgewählte Komponenten zur manuellen Erstellung einer Importdatei.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten   SwitchParameter
    TargetFolder Gibt den Exportzielordner an.   Zeichenfolge

    Gibt zurück:

  • Show-CvadAcDocument: Zeigt diese Dokumentation im Standardbrowser an.

    Parameter:

    • Keine.

    Gibt zurück:

    • Zeigt diese Webseite im Standardbrowser an.
  • Find-CvadAcInFile: Durchsucht YAML-Komponentendateien nach Elementen, die einem oder mehreren Namen entsprechen, die Platzhalter enthalten können. Das Ergebnis ist ein Bericht über gefundene Elemente. “Find in File” kann jeweils nur eine Komponente durchsuchen. “Find in File” durchsucht alle YAML-Dateien im aktuellen Ordner und allen Unterordnern. Verwenden Sie FindSourceFolder, um die Anzahl der zu durchsuchenden Dateien zu begrenzen.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Migrieren nach Komponenten Siehe Migrieren nach Komponenten. Hinweis: Der Wert -All ist nicht gültig.   SwitchParameter
    IncludeByName Eine Liste der Bereitstellungsgruppen, die eingeschlossen werden sollen, wenn die Site auf aktiv festgelegt wird. Die Platzhalter * und ? werden in Namen unterstützt.   Liste von Zeichenfolgen
    Unique Meldet nur eindeutig gefundene Elemente.   SwitchParameter
    IncludeYaml Schließt die elementspezifische YAML ein.   SwitchParameter
    FindSourceFolder Der Ordner, in dem mit der Suche begonnen wird.   Zeichenfolge
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   SwitchParameter
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter

    Gibt zurück:

    • Erstellt einen Bericht mit gefundenen Elementen für die angegebene Komponente.

Cmdlets für die Siteaktivierung

Weitere Informationen zum Aktivieren von Sites und zur Verwendung dieser Cmdlets finden Sie unter Aktivieren der Sites.

  • Set-CvadAcSiteActiveStateOnPrem: Legt den Status der On-Premises-Site auf aktiv oder inaktiv fest.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SiteActive Legt, wenn vorhanden, die On-Premises-Site auf aktiv fest und beendet den Wartungsmodus für alle Bereitstellungsgruppen. Wenn dieser Parameter nicht vorhanden ist, wird der Wartungsmodus für alle Bereitstellungsgruppen aktiviert.   SwitchParameter
    IncludeByName Eine Liste der Bereitstellungsgruppen, die eingeschlossen werden sollen, wenn die Site auf aktiv festgelegt wird. Die Platzhalter * und ? werden in Namen unterstützt.   Liste von Zeichenfolgen
    ExcludeByName Eine Liste der Bereitstellungsgruppen, die ausgeschlossen werden sollen, wenn die Site auf aktiv festgelegt wird. Die Platzhalter * und ? werden in Namen unterstützt.   Liste von Zeichenfolgen
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true or $false

    Gibt zurück:

  • Set-CvadAcSiteActiveStateCloud: Legt den Status der Cloudsite auf aktiv oder inaktiv fest.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    Parameter mit Cloudzugriff Siehe Parameter mit Cloudzugriff   SwitchParameter
    SiteActive Legt, wenn vorhanden, die On-Premises-Site auf aktiv fest und beendet den Wartungsmodus für alle Bereitstellungsgruppen. Wenn dieser Parameter nicht vorhanden ist, wird der Wartungsmodus für alle Bereitstellungsgruppen aktiviert.   SwitchParameter
    IncludeByName Eine Liste der Bereitstellungsgruppen, die eingeschlossen werden sollen, wenn die Site auf aktiv festgelegt wird. Die Platzhalter * und ? werden in Namen unterstützt.   Liste von Zeichenfolgen
    ExcludeByName Eine Liste der Bereitstellungsgruppen, die ausgeschlossen werden sollen, wenn die Site auf aktiv festgelegt wird. Die Platzhalter * und ? werden in Namen unterstützt.   Liste von Zeichenfolgen
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter
    DisplayLog Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Legen Sie den Parameter auf $false fest, um die Protokollanzeige zu unterdrücken.   $true or $false

    Gibt zurück:

Cmdlets für das Zusammenführen mehrerer On-Premises-Sites

Weitere Informationen zum Zusammenführen von Sites mithilfe dieser Cmdlets finden Sie unter Zusammenführen mehrerer Sites.

  • New-CvadAcSiteMergingInfo erstellt ein Präfix-/Suffix-Infoset zum Zusammenführen von Websites. Zu Beginn müssen nicht alle Präfixe oder Suffixe bekannt sein. Sie können mithilfe von Set-CvadAcSiteMergingInfo oder durch manuelles Bearbeiten der Datei SiteMerging.yml aktualisiert werden. Parameter:

    Name Beschreibung Erforderlich? Typ
    SiteName Identifiziert das Präfix-/Suffix-Infoset einer spezifischen Site. Eine Übereinstimmung mit dem Namen der Site ist möglich, aber nicht notwendig. x Zeichenfolge
    Parameter zur Sitezusammenführung Siehe Parameter zur Sitezusammenführung   SwitchParameter
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter

    Gibt zurück:

  • Set-CvadAcSiteMergingInfo aktualisiert das Präfix-/Suffix-Infoset zur Sitezusammenführung.

    Parameter:

    Name Beschreibung Erforderlich? Typ
    SiteName Identifiziert das Präfix-/Suffix-Infoset einer spezifischen Site. Eine Übereinstimmung mit dem Namen der Site ist möglich, aber nicht notwendig. x Zeichenfolge
    Parameter zur Sitezusammenführung Siehe Parameter zur Sitezusammenführung   SwitchParameter
    Quiet Unterdrückt die Protokollierung an die Konsole.   SwitchParameter

    Gibt zurück:

  • Remove-CvadAcSiteMergingInfo entfernt das Präfix-/Suffix-Infoset zur Sitezusammenführung.

    Parameter:

    • SiteName: Identifiziert die Sitepräfixe und -suffixe. Dies ist eine erforderliche Zeichenfolge.

    Gibt zurück:

Parameter zur Sitezusammenführung

Die folgenden Parameter können beim Ausführen der Cmdlets zum Zusammenführen von Sites verwendet werden. Alle aufgelisteten Parameter sind Zeichenfolgen.

  • SiteName identifiziert das Präfix-/Suffix-Infoset einer spezifischen Site. Eine Übereinstimmung mit dem Namen der Site ist möglich, aber nicht notwendig. SiteName ist ein erforderlicher Parameter.
  • AdminScopedPrefix: das auf Administratorbereiche anzuwendende Präfix.
  • ApplicationPrefix: das auf Anwendungen anzuwendende Präfix.
  • ApplicationFolderPrefix: das auf Anwendungsordner anzuwendende Präfix. ApplicationFolderPrefix kann mit ApplicationFolderRoot kombiniert werden.
  • ApplicationFolderRoot: der neue Stammordner für Anwendungsordner. Hierdurch wird eine zusätzliche Ordnerhierarchie erstellt. ApplicationFolderRoot kann mit ApplicationFolderPrefix kombiniert werden.
  • ApplicationGroupPrefix: das auf Anwendungsgruppen anzuwendende Präfix.
  • ApplicationUserPrefix: das auf Anwendungsnamen, die für Benutzer angezeigt werden, anzuwendende Präfix.
  • ApplicationAdminPrefix: das auf Anwendungsnamen, die für Administratoren angezeigt werden, anzuwendende Präfix.
  • DeliveryGroupPrefix: das auf Bereitstellungsgruppen anzuwendende Präfix.
  • GroupPolicyPrefix: das auf Richtliniennamen anzuwendende Präfix.
  • HostConnectionPrefix: das auf Hostverbindungen anzuwendende Präfix.
  • MachineCatalogPrefix: das auf Maschinenkataloge anzuwendende Präfix.
  • StoreFrontPrefix: das auf StoreFront-Namen anzuwendende Präfix.
  • TagPrefix: das auf Tags anzuwendende Präfix.
  • AdminScopedSuffix: das auf Administratorbereiche anzuwendende Suffix.
  • ApplicationSuffix: das auf Anwendungen anzuwendende Suffix.
  • ApplicationFolderSuffix: das auf Anwendungsordner anzuwendende Suffix. ApplicationFolderSuffix kann mit ApplicationFolderRoot kombiniert werden.
  • ApplicationGroupSuffix: das auf Anwendungsgruppen anzuwendende Suffix.
  • ApplicationUserSuffix: das auf Anwendungsnamen, die für Benutzer angezeigt werden, anzuwendende Suffix.
  • ApplicationAdminSuffix: das auf Anwendungsnamen, die für Administratoren angezeigt werden, anzuwendende Suffix.
  • DeliveryGroupSuffix: das auf Bereitstellungsgruppen anzuwendende Suffix.
  • GroupPolicySuffix: das auf Richtliniennamen anzuwendende Suffix.
  • HostConnectionSuffix: das auf Hostverbindungen anzuwendende Suffix.
  • MachineCatalogSuffix: das auf Maschinenkataloge anzuwendende Suffix.
  • StoreFrontSuffix: das auf StoreFront-Namen anzuwendende Suffix.
  • TagSuffix: das auf Tags anzuwendende Suffix.
  • SiteRootFolder: der vollqualifizierte Ordnername für Exporte und Importe (lokaler Ordner oder Dateifreigabe).

Generische Parameter

Parameter mit Cloudzugriff

Alle Cmdlets, die auf die Cloud zugreifen, unterstützen folgende zusätzliche Parameter.

Hinweis:

Die Parameter “CustomerId”, “ClientId” und “Secret” können in die Datei “CustomerInfo.yml” eingefügt oder mit den folgenden Parametern im Cmdlet angegeben werden. Bei Angabe an beiden Stellen haben die Cmdlet-Parameter Vorrang.

  • 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.
  • ClientId: Die auf der Website Citrix Cloud Identity and Access Management erstellte clientID. Dies ist zum Abrufen des Bearertokens erforderlich, der zur Authentifizierung bei allen Rest-APIs benötigt wird.
  • Secret: Der auf der Website Citrix Cloud Identity and Access Management erstellte geheime Schlüssel. Dies ist zum Abrufen des Bearertokens erforderlich, der zur Authentifizierung bei allen Rest-APIs benötigt wird.
  • CustomerInfoFileSpec: Die Dateispezifikation, die auf eine Kundeninformationsdatei verweist, um den Standardspeicherort und den Standardnamen außer Kraft zu setzen.

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.
  • 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.
  • SecurityFileFolder: Dies ist der vollständig qualifizierte Name des Ordners mit der Datei “CustomerInfo.yml”, die auf einen lokalen Ordner oder eine Netzwerkfreigabe mit möglicher Authentifizierungskontrolle verweisen kann. Das Tool fordert nicht zur Eingabe von Anmeldeinformationen auf. Der Zugriff auf Ressourcen mit Authentifizierung muss vor dem Ausführen des Tools bereitgestellt werden.
  • SiteName gibt das Präfix und Suffix für die Sitezusammenführung beim Import an.
  • SiteActive gibt an, ob die importierte Site aktiv oder inaktiv ist. Standardmäßig ist dieser Parameter auf $false festgelegt und die importierte Site ist inaktiv.

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

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 für das Ausführen 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 geben die Gesamtzahl der hinzugefügten, aktualisierten, gelöschten und nicht geänderten Komponentenelemente an (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 zu PowerShell

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