Cmdlets des automatisierten Konfigurationstools für die Migration

Auf dieser Seite sind alle Cmdlets und Parameter aufgeführt, die vom Tool für Migrationsanwendungsfälle unterstützt werden.

Alle Cmdlets übernehmen Parameter mit einem der folgenden Typen.

• Zeichenfolge
• Liste von Zeichenfolgen
• Boolean: $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.

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

Grundlegende Cmdlets

On-Premises-zu-Cloud-Cmdlets

• Export-CvadActoFile — Exportieren Sie lokale 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		SwitchParameters
  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:

  • Siehe Cmdlet-Rückgabewerte

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

• 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.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff.		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  Merge	Wenn auf $true gesetzt, werden der Cloudsite nur Komponenten hinzugefügt. Es werden keine Komponenten entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, bestehende Komponenten werden nicht aktualisiert oder gelöscht. Auf $false setzen, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter $true 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 beim Zusammenführen 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
  OnErrorAction	Siehe Parameter “OnErrorAction”.		Zeichenfolge

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• 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.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff.		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  Merge	Wenn auf $true gesetzt, werden der Cloudsite nur Komponenten hinzugefügt. Es werden keine Komponenten entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, bestehende Komponenten werden nicht aktualisiert oder gelöscht. Auf $false setzen, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter $true 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 beim Zusammenführen 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
  OnErrorAction	Siehe Parameter “OnErrorAction”.		Zeichenfolge

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• Merge-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.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff.		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  OnErrorAction	Siehe Parameter “OnErrorAction”.		Zeichenfolge

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• Merge-CvadAcToSite - Export und Import in einem Schritt.

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

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Migrieren nach Komponenten	Siehe Migrieren nach Komponenten		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen		Liste von Zeichenfolgen
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  Merge	Wenn auf $true gesetzt, werden der Cloudsite nur Komponenten hinzugefügt. Es werden keine Komponenten entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, bestehende Komponenten werden nicht aktualisiert oder gelöscht. Auf $false setzen, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter $true 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 beim Zusammenführen 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:

  • Siehe Cmdlet-Rückgabewerte

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		SwitchParameters
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff		SwitchParameters
  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. Auf $false setzen, 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:

  • Siehe Cmdlet-Rückgabewerte

• 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 stammen aus dem Ordner, der mit dem Parameter -RestoreFolder angegeben wurde. Dieser identifiziert den Ordner, der die auf der Cloudsite wiederherzustellenden .yml-Dateien enthält. 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.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff.		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  Merge	Wenn auf $true gesetzt, werden der Cloudsite nur Komponenten hinzugefügt. Es werden keine Komponenten entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, bestehende Komponenten werden nicht aktualisiert oder gelöscht. Auf $false setzen, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter $true 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 beim Zusammenführen 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
  OnErrorAction	Siehe Parameter “OnErrorAction”.		Zeichenfolge

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• Remove-CvadAcFromSite — Komponentenmitglieder aus der Cloud entfernen.

  Kann die gesamte Site zurücksetzen oder Elemente aus einer Komponente entfernen (z. B. einen Maschinenkatalog aus der Liste der Kataloge). Dies kann in Verbindung mit dem IncludeByName-Parameter verwendet werden, um bestimmte Mitglieder selektiv zu entfernen.

  Parameter:

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

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

Andere grundlegende Cmdlets

• Compare-CvadAcToSite — Vergleicht die lokalen .yml-Dateien mit der Cloudkonfiguration und erstellt einen Bericht über Änderungen, die mit den Cmdlets Import, Merge oder Restore vorgenommen wurden.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Migrieren nach Komponenten	Siehe Migrieren nach Komponenten.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff.		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  Merge	Wenn auf $true gesetzt, werden der Cloudsite nur Komponenten hinzugefügt. Es werden keine Komponenten entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, bestehende Komponenten werden nicht aktualisiert oder gelöscht. Auf $false setzen, um Aktualisierungen und Löschungen zuzulassen. Merge wird ignoriert, wenn dieser Parameter $true ist.		$true oder $false
  OnErrorAction	Siehe Parameter “OnErrorAction”.		Zeichenfolge

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

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 sind. Um Fehler zu vermeiden, empfehlen wir, die Komponenten in der folgenden Reihenfolge zu migrieren:

• All
• Tags
• AdminRoles
• AdminScopes
• HostConnections
• MachineCatalogs
• StoreFront
• DeliveryGroups
• ApplicationGroups
• ApplicationFolders
• Anwendungen
• GroupPolicies
• UserZonePreference

Filtern nach Objektnamen

Migration nach Komponentennamen

Die Parameter IncludeByName und ExcludeByName ermöglichen das Ein- und Ausschließen von Komponentenmitgliedern in Cmdlets anhand ihres Namens. 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 verwenden eine Liste von Komponentenelementnamen. 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 können auch eine Datei mit einer Liste von Mitgliedern annehmen, in der jedes Mitglied explizit sein oder Platzhalter enthalten 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.

Ein Beispiel für das Zusammenführen aller Bereitstellungsgruppen, deren Namen mit dgSite1 beginnen und Home2 enthalten, würde wie folgt lauten:

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

Nach Bereitstellungsgruppennamen

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

ByDeliveryGroupName verwendet 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 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 filtert alle Anwendungen und Anwendungsgruppen, die deaktiviert sind, aus Importvorgängen heraus. ExcludeDisabled ist standardmäßig auf false voreingestellt, was bedeutet, dass alle Anwendungen und Anwendungsgruppen unabhängig von ihrem Aktivierungsstatus importiert werden.

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 verwendet eine Liste von Maschinennamen, in denen jeder Name einen oder mehrere Platzhalter enthalten kann. Zwei Arten von Platzhaltern werden unterstützt.

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

Wenn ByMachineName beim Exportieren oder Importieren verwendet wird und ein Maschinennamenfilter dazu führt, dass keine Maschinen im Maschinenkatalog oder in der Bereitstellungsgruppe vorhanden sind, wird der Maschinenkatalog oder die Bereitstellungsgruppe vom Export oder Import ausgeschlossen.

Hinweis

Die Verwendung von ByMachineName in einem Cmdlet vom Typ Import führt dazu, dass MergeMachines auf $true gesetzt wird.

Zusammenführen von Maschinen

MergeMachines weist den Importvorgang an, Maschinen nur dem Maschinenkatalog oder der Bereitstellungsgruppe hinzuzufügen, wenn sie auf $true gesetzt ist. Es werden keine Maschinen entfernt, sodass inkrementelle Hinzufügungen möglich sind.

MergeMachines ist standardmäßig auf false gesetzt, was bedeutet, dass Maschinen entfernt werden, wenn sie nicht in der .yml-Datei des Maschinenkatalogs oder der Bereitstellungsgruppe enthalten sind. MergeMachines ist auf $true gesetzt, wenn ByMachineName verwendet wird, kann aber überschrieben werden, indem mergeMachines auf false gesetzt wird.

Voraussetzungsbezogene Cmdlets

• New-CvadAcCustomerInfoFile - erstellt eine Kundeninformationsdatei. 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	Verwenden Sie den angegebenen Ordner als Stammordner anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig.		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:

  • Siehe Cmdlet-Rückgabewerte

• 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	Verwenden Sie den angegebenen Ordner als Stammordner anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig.		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:

  • Siehe Cmdlet-Rückgabewerte

Voraussetzungsbezogene Parameter

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

• Environment — Produktions- oder ProductionGov-Umgebung.
• LogFileName — ändert das Protokolldateipräfix von CitrixLog in etwas anderes.
• StopOnError — stoppt den Vorgang beim ersten Fehler.
• AlternateRootFolder — verwendet den angegebenen Ordner als Stammordner anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig.
• Locale —verwendet die angegebene Locale anstelle des Gebietsschemas, das von dem System abgeleitet ist, auf dem das Tool ausgeführt wird.
• Editor — verwendet den angegebenen Editor, um das Protokoll nach Abschluss jedes Cmdlets anzuzeigen. 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 einzigen Zip-Datei, um sie zur Unterstützung an Citrix zu senden. 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 die 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		SwitchParameters
  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 — testet die Verbindung mit der Cloud-Site, um sicherzustellen, dass die Kommunikationsverbindung funktioniert. 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		SwitchParameters
  Quiet	Unterdrückt die Protokollierung an die Konsole.		SwitchParameter

  Gibt zurück:

  • Die Testergebnisse werden auf der Befehlszeile angezeigt.

• Find-cvadacConnector - findet vorhandene Konnektoren und bestimmt ihren Betriebszustand. 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 Kundenseiten zurück. Das Cmdlet verwendet die Cloudzugriffsparameter oder die Datei CustomerInfo.yml zum Angeben der Kundenverbindungsinformationen.

  Parameter:

  • Siehe Parameter mit Cloudzugriff

  Gibt zurück:

  • Zeigt die Liste der gefundenen Kundensite-IDs an.

• New-CvadAcTemplateToFile — erzeugt eine Vorlagendatei für ausgewählte Komponenten, sodass Sie manuell eine Importdatei erstellen können.

  Parameter:

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

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• Show-CvadAcDocument - zeigt diese Dokumentation im Standardbrowser an.

  Parameter:

  • Keine.

  Gibt zurück:

  • Zeigt diese Webseite im Standardbrowser an.

• Find-CvadAcInFile — findet bei der Dateisuche nach Komponenten-YAML-Dateien, die nach Mitgliedern suchen, 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 einzuschränken.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Migrieren nach Komponenten	Siehe Migrieren nach Komponenten. Hinweis: Der Wert -All ist nicht gültig.		SwitchParameters
  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. Auf $false setzen, 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 — setzt den Status der lokalen Site entweder auf aktiv oder inaktiv.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff		SwitchParameters
  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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true or $false

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• Set-CvadAcSiteActiveStateCloud — setzt den Status der Cloudsite auf aktiv oder inaktiv.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Parameter mit Cloudzugriff	Siehe Parameter mit Cloudzugriff		SwitchParameters
  SiteActive	Legt, wenn vorhanden, die Cloudsite 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. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true or $false

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

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

Weitere Informationen zum Zusammenführen von Sites mit diesen Cmdlets finden Sie unter Zusammenführen mehrerer Sites.

• New-CvadacSiteMergingInfo - Erzeugt einen Informationssatz zum Zusammenführen von Präfixen/Suffix-Informationen für Websites. Zu Beginn müssen nicht alle Präfixe oder Suffixe bekannt sein. Sie können mit 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		SwitchParameters
  Quiet	Unterdrückt die Protokollierung an die Konsole.		SwitchParameter

  Gibt zurück:

  • None

• Set-CvadAcSiteMergingInfo - aktualisiert einen bestehenden Informationssatz für die Zusammenführung von Präfix/Suffix-Informationen.

  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		SwitchParameters
  Quiet	Unterdrückt die Protokollierung an die Konsole.		SwitchParameter

  Gibt zurück:

  • None

• Remove-CvadAcSiteMergingInfo - entfernt einen vorhandenen Informationssatz für die Zusammenführung von Präfix/Suffix-Informationen.

  Parameter:

  • SiteName — identifiziert den Satz von Site-Präfixen und -Suffixen. Dies ist eine erforderliche Zeichenfolge.

  Gibt zurück:

  • None

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 — der Name, der verwendet wird, um die Gruppe von Präfixen/Suffixen für eine bestimmte Site zu identifizieren. Eine Übereinstimmung mit dem Namen der Site ist möglich, aber nicht notwendig. SiteName ist ein erforderlicher Parameter.
• AdminScopedPrefix — das Präfix, das auf Administratorbereiche angewendet werden soll.
• ApplicationPrefix — das Präfix, das auf Anwendungen angewendet werden soll.
• ApplicationFolderPrefix — das Präfix, das auf Anwendungsordner angewendet wird; ApplicationFolderPrefix kann mit ApplicationFolderRoot kombiniert werden.
• ApplicationFolderRoot — der neue Stammordner für Anwendungsordner. Dadurch wird eine zusätzliche Ordnerhierarchie erstellt. ApplicationFolderRoot kann mit ApplicationFolderPrefix kombiniert werden.
• ApplicationGroupPrefix — das Präfix für Anwendungsgruppen.
• ApplicationUserPrefix — das Präfix, das auf den Anwendungsnamen angewendet wird, den der Benutzer sieht.
• ApplicationAdminPrefix — das Präfix, das auf den Anwendungsnamen angewendet wird, den der Administrator sieht.
• DeliveryGroupPrefix — das Präfix, das auf Bereitstellungsgruppen angewendet werden soll.
• GroupPolicyPrefix — das Präfix, das auf Richtliniennamen angewendet wird.
• HostConnectionPrefix — das Präfix, das auf Hostverbindungen angewendet werden soll.
• MachineCatalogPrefix — das Präfix, das auf Maschinenkataloge angewendet werden soll.
• StoreFrontPrefix — das Präfix, das auf StoreFront-Namen angewendet werden soll.
• tagPrefix — das Präfix, das auf Tags angewendet werden soll.
• AdminScopedSuffix — das Suffix, das auf Administratorbereiche angewendet werden soll.
• ApplicationSuffix — das Suffix, das auf Anwendungen angewendet werden soll.
• ApplicationFolderSuffix – das Suffix, das auf Anwendungsordner angewendet werden soll; ApplicationFolderSuffix kann mit ApplicationFolderRoot kombiniert werden.
• ApplicationGroupSuffix – das Suffix für Anwendungsgruppen.
• ApplicationUserSuffix – das Suffix, das auf den Anwendungsnamen angewendet werden soll, den der Benutzer sieht.
• ApplicationAdminSuffix – das Suffix, das auf den Anwendungsnamen angewendet werden soll, den der Administrator sieht.
• DeliveryGroupSuffix – das Suffix, das auf Bereitstellungsgruppen angewendet werden soll.
• GroupPolicySuffix – das Suffix, das auf Richtliniennamen angewendet werden soll.
• HostConnectionSuffix – das Suffix, das auf Hostverbindungen angewendet werden soll.
• MachineCatalogSuffix – das Suffix, das auf Maschinenkataloge angewendet werden soll.
• StoreFrontSuffix – das Suffix, das auf StoreFront-Namen angewendet werden soll.
• tagSuffix – das Suffix, das auf Tags angewendet werden soll.
• SiteRootFolder – der vollqualifizierte Ordnername für Exporte und Importe; das kann ein lokaler Ordner oder eine Dateifreigabe sein.

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, die in den Rest-APIs verwendet wird und für den Zugriff auf alle Rest-APIs erforderlich ist. Die Kunden-ID finden Sie in Citrix Cloud.
• ClientID – die ClientID, die auf der Citrix Cloud Identity and Access Management-Website erstellt wurde. Dies ist zum Abrufen des Bearertokens erforderlich, der zur Authentifizierung bei allen Rest-APIs benötigt wird.
• Secret – der geheime Schlüssel, der auf der Citrix Cloud Identity and Access Management-Website erstellt wurde. 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 -namen zu überschreiben.

Migrationsmodus-Parameter

Cmdlets, die die Cloudsitekonfiguration (Import, Restore, Merge, New und Sync) ändern, unterstützen die folgenden zusätzlichen Parameter, um zusätzliche Flexibilität zu bieten.

• CheckMode – führt den Importvorgang aus, nimmt aber keine Änderungen vor. 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 – wenn true, werden Benutzer aufgefordert, zu bestätigen, dass sie Änderungen an der Cloudsitekonfiguration vornehmen möchten. Das Cmdlet Remove zeigt aufgrund seines destruktiven Charakters eine Eingabeaufforderung an. Auf “false” setzen, wenn keine Aufforderung gewünscht wird, z. B. bei der Ausführung in automatisierten Skripten. Confirm ist standardmäßig auf true gesetzt.
• SecurityFileFolder – der vollqualifizierte Ordner, der die CustomerInfo.yml-Datei enthält, die möglicherweise auf einen lokalen Ordner oder einen Netzwerkfreigabeordner verweist, der möglicherweise unter Authentifizierungskontrolle steht. 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 das Suffix für die Zusammenführung von Websites an, die beim Import verwendet werden sollen.
• SiteActive – gibt an, ob die importierte Site aktiv oder inaktiv ist. Standardmäßig ist dieser Parameter auf $false gesetzt, was bedeutet, dass die importierte Site inaktiv ist.

Parameter zur Protokollanzeige

Die Cmdlets Export, Import, Sync, Restore, Backup, Compare und Remove zeigen die Protokolldatei an, wenn der Vorgang abgeschlossen ist. Sie können die Anzeige unterdrücken, indem Sie den Parameter -DisplayLog auf $false setzen. 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 in allen ausgewählten Komponenten anzeigt: true bedeutet erfolgreich und false bedeutet erfolglos.

Individual_Success gibt einen oder drei Werte 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 cmdletspezifisch.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File und Remove gibt die folgenden benutzerdefinierten Ergebnisinformationen an eine einzelne Instanz von EvaluationResultData zurück.

Hinweis

Die Cmdlets Cmdlets Export und Template geben kein benutzerdefiniertes Ergebnis 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ählte Komponente an. Der Schlüssel ist der Komponentenname und der Wert eine Liste jedes Komponentenelements und der an diesem ausgeführten Aktion. Bei Aktionen kann es sich um einen der ActionResultValues-Werte handeln.

Added, Updated, Deleted und NoChange geben an, dass die Gesamtzahl der hinzugefügten, aktualisierten, gelöschten oder aktionslosen Komponentenmitglieder in dieser Reihenfolge ist.

TotalChanged ist die Summe von Added, Updated und Deleted.

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

CloudBackupFolder ist die vollqualifizierte Dateispezifikation der Cloud-Site-Konfigurationssicherung vor dem Cmdlet, das cloudmodifizierende Aktionen ausführt.

SourceBackupFolder ist die vollqualifizierte Dateispezifikation der Quelldateisicherung, die nach Abschluss 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 Get-Help vor dem Cmdlet ein.

Get-Help Import-CvadAcToSite