Cmdlets des automatisierten Konfigurationstools für die Migration

Diese Seite listet alle Cmdlets und Parameter auf, die vom Tool für Migrationsanwendungsfälle unterstützt werden.

Alle Cmdlets verwenden Parameter, die einen der folgenden Typen aufweisen.

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

Hinweis:

SwitchParameter ist die bevorzugte Methode für True- oder False-Auswahlen, aber Booleans werden im Tool aufgrund von Legacy-Problemen immer noch verwendet.

Die folgende Tabelle ist eine Zusammenfassung aller Cmdlets. In jedem einzelnen Abschnitt erfahren Sie, welche Parameter jedes Cmdlet unterstützt.

Weitere Informationen zu Parametern und deren Verwendung finden Sie unter Granular migration parameters.

Grundlegende Cmdlets

On-Premises zu Cloud-Cmdlets

• Export-CvadAcToFile – Exportieren Sie On-Premises-Dateien in YAML-Dateien.

  Exportiert die Konfiguration aus Ihrer On-Premises-Einrichtung. Dies ist der Standardexportvorgang für die automatisierte Konfiguration. Es werden keine Änderungen an der On-Premises-Sitekonfiguration vorgenommen. Exportierte Dateien werden im Verzeichnis %HOMEPATH%\Documents\Citrix\AutoConfig in einem eindeutig benannten Unterordner Export abgelegt. Der Ordner %HOMEPATH%\Documents\Citrix\AutoConfig enthält immer die zuletzt exportierte On-Premises-Sitekonfiguration.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Migrate by components		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen		Liste von Zeichenfolgen
  TargetFolder	Gibt den Exportzielordner an.		Zeichenfolge
  Locale	Gibt die Sprache des menschenlesbaren Textes an, der exportiert werden kann.		Zeichenfolge
  Quiet	Protokollierung auf der Konsole unterdrücken.		SwitchParameter
  AdminAddress	Gibt die DNS- oder 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 vorhanden sind. Benutzer und Maschinen, die nicht in Active Directory vorhanden sind, können zu Importfehlern führen.		$true oder $false
  ZipResults	Komprimiert gesicherte YAML-Dateien in eine einzelne 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

Es gibt drei Möglichkeiten, Daten in die Cloud zu importieren. Das Ausführen spezifischer Cmdlets kann zu einer der drei folgenden Aktionskombinationen auf der Cloud-Site 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 lokalen Dateien in die Cloud. Dieser Befehl stellt sicher, dass der Endzustand der Cloud mit dem lokalen Zustand identisch ist. Diese Option löscht alle in der Cloud vorhandenen Änderungen. Importierte Standortkonfigurationsdateien stammen aus %HOMEPATH%\Documents\Citrix\AutoConfig. Mit Vorsicht verwenden.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter.		SwitchParameters
  SourceFolder	Identifiziert einen Ersatz-Stammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.		Zeichenfolge
  Locale	Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.		String
  Quiet	Unterdrückt die Protokollierung in der 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 nur Komponenten zur Cloud-Site hinzugefügt. Komponenten werden nicht entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, vorhandene 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	Zusammenführen von Richtlinieneinstellungen und Filtern. Das Zusammenführen erfolgt nur, wenn eine importierte Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis des Zusammenführens von Richtlinien ist, dass die Cloud-DDC-Richtlinien die bereits vorhandenen Einstellungen und Filter zusätzlich zu allen neu importierten Einstellungen und Filtern enthalten. Beachten Sie, dass bei Kollisionen von Einstellungen und Filtern die importierten Werte Vorrang haben.		SwitchParameter
  OnErrorAction	Siehe OnErrorAction-Parameter.		String

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

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

  Führt die lokalen Dateien mit der Cloud zusammen, löscht aber keine Komponenten in der Cloud oder am lokalen Standort. Dadurch bleiben bereits in der Cloud vorgenommene Änderungen erhalten. Wenn eine Komponente in Citrix Cloud mit demselben Namen existiert, kann dieser Befehl diese Komponente ändern. Dies ist der Standardimportvorgang für die automatisierte Konfiguration. Zusammengeführte Standortkonfigurationsdateien stammen aus %HOMEPATH%\Documents\Citrix\AutoConfig.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter.		SwitchParameters
  SourceFolder	Identifiziert einen Ersatz-Stammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.		Zeichenfolge
  Locale	Gibt die Sprache des exportierbaren, menschenlesbaren Texts an.		Zeichenfolge
  Quiet	Protokollierung in der Konsole unterdrücken.		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 nur Komponenten zur Cloud-Site hinzugefügt. Komponenten werden nicht entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, vorhandene 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	Richtlinieneinstellungen und Filter zusammenführen. Das Zusammenführen erfolgt nur, wenn eine importierte Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis des Zusammenführens von Richtlinien ist, dass die Cloud-DDC-Richtlinien die bereits vorhandenen Einstellungen und Filter zusätzlich zu allen neu importierten Einstellungen und Filtern enthalten. Beachten Sie, dass bei Kollisionen von Einstellungen und Filtern die importierten Werte Vorrang haben.		SwitchParameter
  OnErrorAction	Siehe OnErrorAction parameter.		String

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

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

  Importiert die lokale Standortkonfiguration in die Cloud, fügt aber nur neue Komponenten hinzu. Vorhandene Cloud-Standortkomponenten werden weder aktualisiert noch gelöscht. Verwenden Sie diesen Befehl, wenn Ihre vorhandenen Cloud-Standortkomponenten unverändert bleiben müssen.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren.		Switch-Parameter
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Parameter für den Cloud-Zugriff	Siehe Parameter für den Cloud-Zugriff.		Switch-Parameter
  SourceFolder	Identifiziert einen Ersatz-Stammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.		Zeichenfolge
  Locale	Gibt die Sprache des exportierbaren, menschenlesbaren Textes an.		Zeichenfolge
  Quiet	Unterdrückt die Protokollierung in der Konsole.		Switch-Parameter
  DisplayLog	Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  OnErrorAction	Siehe OnErrorAction parameter.		Zeichenfolge

  Rückgabe:

  • Siehe Cmdlet return values

• Sync-CvadAcToSite – Export und Import in einem Schritt.

  Sync führt sowohl einen Export als auch einen Import in einem Schritt aus. Verwenden Sie den Parameter SourceTargetFolder, um den Zielordner für Export/Import anzugeben.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Migrate by components		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen		Liste von Zeichenfolgen
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter		SwitchParameters
  SourceTargetFolder	Gibt den Zielordner für den Export/Import an.		String
  Locale	Gibt die Sprache des exportierbaren, menschenlesbaren Textes an.		String
  AdminAddress	Gibt die DNS- oder IP-Adresse des Delivery Controllers an, wenn der Export nicht auf dem Delivery Controller ausgeführt wird.		String
  Quiet	Unterdrückt die Protokollierung in der 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 nur Komponenten zur Cloud-Site hinzugefügt. Komponenten werden nicht entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, vorhandene 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	Zusammenführen von Richtlinieneinstellungen und Filtern. Das Zusammenführen erfolgt nur, wenn eine zu importierende Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis des Zusammenführens von Richtlinien ist, dass die Cloud-DDC-Richtlinien die bereits vorhandenen Einstellungen und Filter zusätzlich zu allen neu importierten Einstellungen und Filtern enthalten. Beachten Sie, dass bei Kollisionen von Einstellungen und Filtern die importierten Werte Vorrang haben.		SwitchParameter

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

Cloud-zu-Cloud-Cmdlets

• Backup-CvadAcToFile – Sichert die gesamte Konfiguration von Ihrer Cloud-Site.

  Exportiert Ihre Cloud-Konfiguration in .yml-Dateien. Diese Sicherung kann in einem Sicherungs- und Wiederherstellungsprozess verwendet werden, um verlorene Komponenten wiederherzustellen.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Migration nach Komponenten	Siehe Migration nach Komponenten		SwitchParameters
  Cloud-Zugriffsparameter	Siehe Parameter für den Cloud-Zugriff		SwitchParameters
  TargetFolder	Gibt den Exportzielordner an.		String
  Locale	Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.		String
  Quiet	Protokollierung in der Konsole unterdrücken.		SwitchParameter
  DisplayLog	Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true oder $false
  ZipResults	Zips sichert 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

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

• Restore-CvadAcToSite - Stellt gesicherte YAML-Dateien auf der Cloud-Site wieder her. Diese Cloud-Site kann dieselbe oder eine andere als die Quell-Cloud-Site sein.

  Stellt die Cloud-Site auf die vorherige Konfiguration wieder her. Importierte Dateien stammen aus dem Ordner, der mit dem Parameter -RestoreFolder angegeben wurde. Dieser identifiziert den Ordner, der die .yml-Dateien enthält, die auf der Cloud-Site wiederhergestellt werden sollen. Dies muss eine vollständig qualifizierte Ordnerspezifikation sein. Dieses Cmdlet kann verwendet werden, um zu Ihrer vorherigen Konfiguration zurückzukehren oder um Ihre Cloud-Site zu sichern und wiederherzustellen. Dieser Befehl kann Ihre Cloud-Site hinzufügen, löschen und aktualisieren.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter.		SwitchParameters
  RestoreFolder	Identifiziert den Ordner, der die .yml-Dateien enthält, die auf der Cloud-Site wiederhergestellt werden sollen. Dies muss eine vollständig qualifizierte Ordnerspezifikation sein.		String
  Locale	Gibt die Sprache des menschenlesbaren Textes an, der exportiert werden kann.		String
  Quiet	Protokollierung auf der Konsole unterdrücken.		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 nur Komponenten zur Cloud-Site hinzugefügt. Komponenten werden nicht entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, vorhandene 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	Richtlinieneinstellungen und Filter zusammenführen. Das Zusammenführen erfolgt nur, wenn eine zu importierende Richtlinie bereits im Cloud-DDC vorhanden ist. Das Ergebnis des Zusammenführens von Richtlinien ist, dass die Cloud-DDC-Richtlinien die bereits vorhandenen Einstellungen und Filter zusätzlich zu allen neuen zu importierenden Einstellungen und Filtern enthalten. Beachten Sie, dass bei Kollisionen von Einstellungen und Filtern die importierten Werte Vorrang haben.		SwitchParameter
  OnErrorAction	Siehe OnErrorAction-Parameter.		String

  Gibt zurück:

  • Siehe Cmdlet-Rückgabewerte

• Remove-CvadAcFromSite – Entfernt Komponentenmitglieder aus der Cloud.

  Kann die gesamte Site zurücksetzen oder Mitgliedselemente aus einer Komponente entfernen (Zum Beispiel das Entfernen eines Maschinenkatalogs 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
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen		Liste von Zeichenfolgen
  Cloud-Zugriffsparameter	Siehe Cloud-accessing parameters		SwitchParameters
  Quiet	Protokollierung in der Konsole unterdrücken.		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 return values

Weitere grundlegende Cmdlets

• Compare-CvadAcToSite – Vergleicht die lokalen .yml-Dateien mit der Cloud-Konfiguration und erstellt einen Bericht über Änderungen, die von einem Import-, Merge- oder Restore-Cmdlet vorgenommen wurden.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren.		SwitchParameters
  Filtern nach Objektnamen	Siehe Filtern nach Objektnamen.		Liste von Zeichenfolgen
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter.		SwitchParameters
  SourceFolder	Identifiziert einen Ersatz-Stammordner für %HOMEPATH%\Documents\Citrix\AutoConfig.		Zeichenfolge
  Locale	Gibt die Sprache des menschenlesbaren Texts an, der exportiert werden kann.		String
  Quiet	Protokollierung auf der Konsole unterdrücken.		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 nur Komponenten zur Cloud-Site hinzugefügt. Komponenten werden nicht entfernt. Auf $false setzen, um Komponenten zu entfernen.		$true oder $false
  AddOnly	Wenn auf $true gesetzt, werden nur neue Komponenten hinzugefügt, vorhandene 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 OnErrorAction-Parameter.		Zeichenfolge

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

Granulare Migrationsparameter

Migration nach Komponenten

Die folgenden Komponenten können mit unterstützenden Cmdlets angegeben werden. Die Option All wird automatisch ausgewählt, wenn keine Komponentenparameter angegeben sind. Um Fehler zu vermeiden, empfehlen wir Ihnen, Komponenten in der folgenden Reihenfolge zu migrieren:

• All
• Tags
• AdminRoles
• AdminScopes
• HostConnections
• MachineCatalogs
• StoreFronts
• DeliveryGroups
• ApplicationGroups
• ApplicationFolders
• Applications
• GroupPolicies
• UserZonePreference

Filtern nach Objektnamen

Migration nach Komponentennamen

Die Parameter IncludeByName und ExcludeByName ermöglichen das Ein- und Ausschließen von Komponentenmitgliedern in Cmdlets nach Namen. In jedem der unterstützten Cmdlets kann jeweils nur eine Komponente (z. B. Bereitstellungsgruppen) ausgewählt werden. Wenn ein Komponentenmitglied in beiden Bereichen vorhanden ist, überschreibt der Ausschluss jeden anderen Parameter, und ein Eintrag wird in der Protokollkorrekturliste vorgenommen, der die ausgeschlossene Komponente und den Mitgliedsnamen identifiziert.

IncludeByName und ExcludeByName akzeptieren eine Liste von Komponentennamen. Jeder Name kann ein oder mehrere Platzhalter enthalten. Es werden zwei Arten von Platzhaltern unterstützt. Die Liste der Komponentennamen muss in einfache Anführungszeichen gesetzt werden, wenn ein Mitgliedsname Sonderzeichen enthält.

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

IncludeByName und ExcludeByName können auch eine Datei mit einer Liste von Mitgliedern akzeptieren, wobei jedes Mitglied explizit sein oder Platzhalter enthalten kann. Jede Zeile in der Datei kann ein Mitglied enthalten. Führende und nachgestellte Leerzeichen werden vom Mitgliedsnamen entfernt. Der Dateiname muss mit dem Zeichen @ beginnen und in einfache Anführungszeichen gesetzt werden (eine PowerShell-Anforderung, damit das @ nicht neu interpretiert wird). Es können mehrere Dateien aufgelistet werden, zusätzlich zur Mischung mit Mitgliedsnamen.

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

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

Nach Bereitstellungsgruppenname

ByDeliveryGroupName filtert nach dem Namen der Bereitstellungsgruppe für Anwendungen und Anwendungsgruppen. Dieser Parameter ist immer eine Inklusionsliste, die Mitglieder identifiziert, die basierend auf ihrer Zugehörigkeit zur Bereitstellungsgruppe eingeschlossen werden sollen.

ByDeliveryGroupName nimmt eine Liste von Bereitstellungsgruppennamen entgegen. Jeder Name kann ein oder mehrere Platzhalter enthalten. Zwei Arten von Platzhaltern werden unterstützt.

• * stimmt mit einer beliebigen Anzahl von Zeichen überein
• ? stimmt mit einem einzelnen Zeichen überein

Das folgende Beispiel führt alle Anwendungen zusammen, die auf alle Bereitstellungsgruppennamen verweisen, die mit EastDg beginnen.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Deaktivierte ausschließen

ExcludeDisabled filtert bei Importvorgängen alle deaktivierten Anwendungen und Anwendungsgruppen heraus. ExcludeDisabled ist standardmäßig auf false eingestellt, was bedeutet, dass alle Anwendungen und Anwendungsgruppen unabhängig von ihrem aktivierten Zustand importiert werden.

Nach Maschinenname

ByMachineName filtert nach dem Maschinennamen für Maschinenkataloge und Bereitstellungsgruppen. Dieser Parameter ist immer eine Inklusionsliste, die Mitglieder identifiziert, die basierend auf ihrer Maschinennamenzuordnung eingeschlossen werden sollen.

ByMachineName nimmt eine Liste von Maschinennamen entgegen, wobei jeder Name ein oder mehrere Platzhalter enthalten kann. Zwei Arten von Platzhaltern werden unterstützt.

• * stimmt mit einer beliebigen Anzahl von Zeichen überein
• ? stimmt mit einem einzelnen Zeichen überein

Wenn beim Exportieren oder Importieren und Verwenden von ByMachineName ein Maschinenname-Filter 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 jedem Import-Cmdlet führt dazu, dass MergeMachines auf $true gesetzt wird.

Computer zusammenführen

MergeMachines weist, wenn auf $true gesetzt, den Importvorgang an, Computer nur zum Maschinenkatalog oder zur Bereitstellungsgruppe hinzuzufügen. Computer werden nicht entfernt, was inkrementelle additive Vorgänge ermöglicht.

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

Cmdlets für Voraussetzungen

• New-CvadAcCustomerInfoFile – Erstellen Sie eine Kundeninformationsdatei. Standardmäßig befindet sich die Kundeninformationsdatei unter %HOMEPATH%\Documents\Citrix\AutoConfig.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  CustomerId	Kunden-ID.	x	String
  ClientId	Kunden-Client-ID, die in Citrix Cloud erstellt wurde. Die CustomerId und Secret müssen bei Verwendung dieses Parameters angegeben werden.	Bedingt	String
  Secret	Geheimer Kundenschlüssel, der in Citrix Cloud erstellt wurde. Die CustomerId und ClientId müssen bei Verwendung dieses Parameters angegeben werden.	Bedingt	String
  Environment	Production-, ProductionGov- oder ProductionJP-Umgebung.		Aufzählung
  LogFileName	Ändern Sie das Protokolldateipräfix von CitrixLog in etwas anderes.		String
  AltRootUrl	Nur unter Anleitung von Citrix verwenden.		String
  StopOnError	Stoppt den Vorgang beim ersten Fehler.		$true oder $false
  TargetFolder	Verwenden Sie den angegebenen Ordner als Stammordner anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig.		String
  Locale	Verwenden Sie das angegebene Gebietsschema anstelle des Gebietsschemas, das vom System abgeleitet wird, auf dem das Tool ausgeführt wird.		String
  Editor	Verwenden Sie den angegebenen Editor, um das Protokoll nach Abschluss jedes Cmdlets anzuzeigen. Notepad.exe ist der Standardeditor. Dieser Parameter muss die vollständig qualifizierte Dateispezifikation für den Editor enthalten, und der Editor muss die Protokolldateispezifikation als einzigen Parameter akzeptieren.		String
  SecurityCsvFileSpec	Die vollständig qualifizierte Dateispezifikation, die auf die von Citrix Identity and Access Management heruntergeladene Datei SecurityClient.csv verweist. Die CustomerId muss bei Verwendung dieses Parameters angegeben werden.		Zeichenfolge

  Rückgabewert:

  • Siehe Cmdlet-Rückgabewerte

• Set-CvadAcCustomerInfoFile – Aktualisiert eine vorhandene Kundeninformationsdatei. Es werden nur die vom Cmdlet angegebenen Parameter geändert. Alle nicht angegebenen Parameterwerte in der Datei CustomerInfo.yml bleiben unverändert.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  CustomerId	Kunden-ID.		Zeichenfolge
  ClientId	Client-ID des Kunden, die in Citrix Cloud erstellt wurde.		String
  Secret	Geheimer Schlüssel des Kunden, der in Citrix Cloud erstellt wurde.		String
  Environment	Produktions-, ProductionGov- oder ProductionJP-Umgebung.		Enumeration
  LogFileName	Ändert das Protokolldateipräfix von CitrixLog in etwas anderes.		String
  StopOnError	Stoppt den Vorgang beim ersten Fehler.		$true oder $false
  TargetFolder	Verwenden Sie den angegebenen Ordner als Stammordner anstelle von %HOMEPATH%\Documents\Citrix\AutoConfig.		String
  Locale	Verwenden Sie das angegebene Gebietsschema anstelle des Gebietsschemas, das vom System abgeleitet wird, auf dem das Tool ausgeführt wird.		String
  Editor	Verwenden Sie den angegebenen Editor, um das Protokoll nach Abschluss jedes Cmdlets anzuzeigen. Notepad.exe ist der Standardeditor. Dieser Parameter muss die vollständig qualifizierte Dateispezifikation für den Editor enthalten, und der Editor muss die Protokolldateispezifikation als einzigen Parameter akzeptieren.		String
  SecurityCsvFileSpec	Die vollständig qualifizierte Dateispezifikation, die auf die von Citrix Identity and Access Management heruntergeladene Datei SecurityClient.csv verweist. Die CustomerId muss bei Verwendung dieses Parameters angegeben werden.		String

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

Voraussetzungsbezogene Parameter

Zusammen mit den Cloud-Zugriffsparametern können die folgenden Parameter mit den Cmdlets für Voraussetzungen 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 das angegebene Gebietsschema anstelle des Gebietsschemas, das vom System abgeleitet wird, 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. Dieser Parameter muss die vollständig qualifizierte Dateispezifikation für den Editor enthalten, und der Editor muss die Protokolldateispezifikation als einzigen Parameter akzeptieren.

Support- und Fehlerbehebungs-Cmdlets

• New-CvadAcZipInfoForSupport – Zippt alle Protokoll- und .yml-Dateien in einer einzigen Zip-Datei, um sie zur Unterstützung an Citrix zu senden. Kundenspezifische Informationen (CustomerInfo.yml und CvadAcSecurity.yml) sind nicht in der Zip-Datei enthalten. Die Datei Icon.yml wird aufgrund ihrer Größe ebenfalls ausgeschlossen. Die Zip-Datei wird in %HOMEPATH%\Documents\Citrix\AutoConfig abgelegt und basierend auf Datum und Zeitstempel als CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip benannt. Diese Zip-Datei kann auch als Sicherung dienen.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  TargetFolder	Gibt einen Zielordner an, in dem die Zip-Datei erstellt und gespeichert werden soll.		Zeichenfolge
  Quiet	Protokollierung in der Konsole unterdrücken.		SwitchParameter

  Rückgabe:

  • Die Zip-Datei mit dem Zip-Dateinamen und -Speicherort 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 zurück, wie z. B. Versionsnummer, Konnektivität mit der Cloud und den Connector-Status.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Parameter für den Cloud-Zugriff	Siehe Parameter für den Cloud-Zugriff		SwitchParameters
  SiteId	Identifiziert die Site, mit der eine Verbindung hergestellt werden soll.		String
  AdminAddress	Dies ist die DNS- oder IP-Adresse des lokalen Delivery Controllers, der zur Überprüfung der Zugriffsebene der Administratoren verwendet wird. Dies ist erforderlich, wenn das Tool nicht auf einem Delivery Controller ausgeführt wird.		String

  Rückgabe:

  • Zeigt die Ergebnisse für jedes Element an.

• Test-CvadAcConnectionWithSite – Testen Sie die Verbindung mit der Cloud-Site, um zu überprüfen, ob die Kommunikationsverbindung funktioniert. Dieses Cmdlet verwendet die Cloud-Zugriffsparameter oder die Datei CustomerInfo.yml, um die Kundenverbindungsinformationen anzugeben.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter		Switch-Parameter
  Quiet	Protokollierung in der Konsole unterdrücken.		Switch-Parameter

  Rückgabe:

  • Testergebnisse werden in der Befehlszeile angezeigt.

• Find-CvadAcConnector – Sucht vorhandene Konnektoren und ermittelt deren Ausführungsstatus. Dieses Cmdlet verwendet Informationen aus der Datei CustomerInfo.yml oder dem Kunden-ID-Parameter, um die Konnektoren des Kunden zu finden.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  CustomerInfoFileSpec	Die Dateispezifikation, die auf eine Kundeninformationsdatei verweist, um den Standardspeicherort und -namen zu überschreiben. Dieser Parameter wird ignoriert, wenn der Parameter CustomerId angegeben wird.		String
  CustomerId	Die Kunden-ID. Dieser Parameter überschreibt denselben Wert in der Datei CustomerInfo.yml.		String

  Rückgabe:

  • Die Ergebnisse werden in der Befehlszeile angezeigt.

• Get-CvadAcCustomerSites – Gibt die Liste aller Kunden-Sites zurück. Dieses Cmdlet verwendet die Cloud-Zugriffsparameter oder die Datei CustomerInfo.yml, um die Verbindungsinformationen des Kunden anzugeben.

  Parameter:

  • Siehe Cloud-Zugriffsparameter

  Rückgabe:

  • Zeigt eine Liste der gefundenen Kunden-Site-IDs an.

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

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren		SwitchParameters
  TargetFolder	Gibt den Exportzielordner an.		String

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

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

  Parameter:

  • Keine.

  Rückgabe:

  • Diese Webseite im Standard-Webbrowser anzeigen.

• Find-CvadAcInFile – Die Dateisuche durchsucht YAML-Komponentendateien nach Elementen, die einem oder mehreren Namen entsprechen, die Platzhalter enthalten können. Das Ergebnis ist ein Bericht über gefundene Elemente. Die Dateisuche kann immer nur eine Komponente gleichzeitig durchsuchen. Die Dateisuche durchsucht alle YAML-Dateien im aktuellen Ordner und in allen Unterordnern. Verwenden Sie FindSourceFolder, um die Anzahl der zu durchsuchenden Dateien zu begrenzen.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Nach Komponenten migrieren	Siehe Nach Komponenten migrieren. Hinweis: Der Wert -All ist ungültig.		SwitchParameters
  IncludeByName	Eine Liste, die die Namen der Bereitstellungsgruppen angibt, die beim Festlegen des aktiven Zustands der Site auf „aktiv“ berücksichtigt werden sollen. Die Platzhalter „*“ und „?“ werden in Namen unterstützt.		Liste von Zeichenfolgen
  Unique	Nur eindeutig gefundene Mitglieder melden.		SwitchParameter
  IncludeYaml	Fügen Sie die mitgliederspezifische YAML-Datei ein.		SwitchParameter
  FindSourceFolder	Der Ordner, in dem die Suche beginnt.		String
  DisplayLog	Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		SwitchParameter
  Quiet	Protokollierung in der Konsole unterdrücken.		SwitchParameter

  Rückgabe:

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

Cmdlets zur Site-Aktivierung

Weitere Informationen zur Aktivierung von Sites und zur Verwendung dieser Cmdlets finden Sie unter Sites aktivieren.

• Set-CvadAcSiteActiveStateOnPrem – Legt den Status der lokalen Site entweder auf aktiv oder inaktiv fest.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter		SwitchParameters
  SiteActive	Wenn vorhanden, wird die lokale Site auf aktiv gesetzt, wodurch der Wartungsmodus von allen Bereitstellungsgruppen entfernt wird. Wenn dieser Parameter nicht vorhanden ist, wird der Wartungsmodus für alle Bereitstellungsgruppen festgelegt.		SwitchParameter
  IncludeByName	Eine Liste, die die Namen der Bereitstellungsgruppen angibt, die beim Festlegen des aktiven Status der Site auf aktiv berücksichtigt werden sollen. Die Platzhalter „*“ und „?“ werden in Namen unterstützt.		Liste von Zeichenfolgen
  ExcludeByName	Eine Liste, die die Namen der Bereitstellungsgruppen angibt, die ausgeschlossen werden sollen, wenn der aktive Status der Site auf aktiv gesetzt wird. Die Platzhalter „*“ und „?“ werden in Namen unterstützt.		Liste von Zeichenfolgen
  Quiet	Protokollierung in der Konsole unterdrücken.		SwitchParameter
  DisplayLog	Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true or $false

  Rückgabewert:

  • Siehe Cmdlet-Rückgabewerte

• Set-CvadAcSiteActiveStateCloud – Legt den Cloud-Site-Status entweder auf aktiv oder inaktiv fest.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  Cloud-Zugriffsparameter	Siehe Cloud-Zugriffsparameter		SwitchParameters
  SiteActive	Wenn vorhanden, wird die Cloud-Site aktiviert und der Wartungsmodus von allen Bereitstellungsgruppen entfernt. Wenn dieser Parameter nicht vorhanden ist, wird der Wartungsmodus für alle Bereitstellungsgruppen festgelegt.		SwitchParameter
  IncludeByName	Eine Liste, die die Namen der Bereitstellungsgruppen angibt, die beim Aktivieren des Site-Aktivstatus berücksichtigt werden sollen. Die Platzhalter „*“ und „?“ werden in Namen unterstützt.		Liste von Zeichenfolgen
  ExcludeByName	Eine Liste, die die Namen der Bereitstellungsgruppen angibt, die beim Aktivieren des Site-Aktivstatus ausgeschlossen werden sollen. Die Platzhalter „*“ und „?“ werden in Namen unterstützt.		Liste von Zeichenfolgen
  Quiet	Protokollierung in der Konsole unterdrücken.		SwitchParameter
  DisplayLog	Zeigt die Protokolldatei nach Abschluss des Cmdlets an. Auf $false setzen, um die Protokollanzeige zu unterdrücken.		$true or $false

  Rückgabe:

  • Siehe Cmdlet-Rückgabewerte

Cmdlets zum Zusammenführen mehrerer lokaler Sites

Weitere Informationen zum Zusammenführen von Sites und zur Verwendung dieser Cmdlets finden Sie unter Mehrere Sites zu einer einzigen Site zusammenführen.

• New-CvadAcSiteMergingInfo – Erstellt einen Informationssatz für Präfixe/Suffixe zum Zusammenführen von Sites. Es ist nicht erforderlich, alle Präfixe oder Suffixe von Anfang an zu kennen. Sie können mit Set-CvadAcSiteMergingInfo oder durch manuelles Bearbeiten der Datei SiteMerging.yml aktualisiert werden. Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  SiteName	Der Name, der zur Identifizierung des Satzes von Präfixen/Suffixen für eine bestimmte Site verwendet wird. Er kann mit dem Namen der tatsächlichen Site übereinstimmen, muss es aber nicht.	x	String
  Parameter zur Site-Zusammenführung	Siehe Parameter zur Site-Zusammenführung		SwitchParameters
  Quiet	Protokollierung in der Konsole unterdrücken.		SwitchParameter

  Rückgabe:

  • Keine

• Set-CvadAcSiteMergingInfo – Aktualisiert einen vorhandenen Informationssatz für Präfixe/Suffixe zur Site-Zusammenführung.

  Parameter:

  Name	Beschreibung	Erforderlich?	Typ
  SiteName	Der Name, der zur Identifizierung des Satzes von Präfixen/Suffixen für eine bestimmte Site verwendet wird. Er kann mit dem Namen der tatsächlichen Site übereinstimmen, muss es aber nicht.	x	String
  Parameter für die Site-Zusammenführung	Siehe Parameter für die Site-Zusammenführung		Switch-Parameter
  Quiet	Unterdrückt die Protokollierung in der Konsole.		Switch-Parameter

  Rückgabe:

  • Keine

• Remove-CvadAcSiteMergingInfo – Entfernt einen vorhandenen Satz von Präfix-/Suffix-Informationen zur Site-Zusammenführung.

  Parameter:

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

  Rückgabe:

  • Keine

Parameter für das Zusammenführen von Sites

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

• SiteName – der Name, der verwendet wird, um den Satz von Präfixen/Suffixen für eine bestimmte Site zu identifizieren. Er kann mit dem Namen der tatsächlichen Site übereinstimmen, muss es aber nicht. 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 werden soll; ApplicationFolderPrefix kann mit ApplicationFolderRoot kombiniert werden.
• ApplicationFolderRoot – der neue Stammordner für Anwendungsordner. Dies erstellt eine zusätzliche Ordnerhierarchie. ApplicationFolderRoot kann mit ApplicationFolderPrefix kombiniert werden.
• ApplicationGroupPrefix – das Präfix für Anwendungsgruppen.
• ApplicationUserPrefix – das Präfix, das auf den Anwendungsnamen angewendet werden soll, den der Benutzer sieht.
• ApplicationAdminPrefix – das Präfix, das auf den Anwendungsnamen angewendet werden soll, den der Administrator sieht.
• DeliveryGroupPrefix – das Präfix, das auf Bereitstellungsgruppen angewendet werden soll.
• GroupPolicyPrefix – das Präfix, das auf Richtliniennamen angewendet werden soll.
• 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 vollständig qualifizierte Ordnername, der für Exporte und Importe verwendet werden soll; dies kann ein lokaler Ordner oder eine Dateifreigabe sein.

Generische Parameter

Parameter für den Cloud-Zugriff

Alle Cmdlets, die auf die Cloud zugreifen, unterstützen die folgenden zusätzlichen Parameter.

Hinweis:

Die CustomerId, ClientId und Secret können in der Datei CustomerInfo.yml abgelegt oder mit dem Cmdlet unter Verwendung der folgenden Parameter angegeben werden. Wenn sie an beiden Stellen angegeben werden, 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. Ihre Kunden-ID finden Sie in Citrix Cloud.
• ClientId – Die Client-ID, die auf der Citrix Cloud Identity and Access Management-Website erstellt wurde. Diese ist erforderlich, um das Bearer-Token für die Authentifizierung aller Rest-APIs zu erhalten.
• Secret – Der geheime Schlüssel, der auf der Citrix Cloud Identity and Access Management-Website erstellt wurde. Dieser ist erforderlich, um das Bearer-Token für die Authentifizierung aller Rest-APIs zu erhalten.
• CustomerInfoFileSpec – Die Dateispezifikation, die auf eine Kundeninformationsdatei verweist, um den Standardspeicherort und -namen zu überschreiben.

Parameter für den Migrationsmodus

Cmdlets, die die Cloud-Site-Konfiguration ändern (Import, Restore, Merge, New und Sync), unterstützen die folgenden zusätzlichen Parameter, um weitere Flexibilität zu bieten.

• CheckMode – Führt den Importvorgang aus, nimmt aber keine Änderungen vor. Alle erwarteten Änderungen werden vor Abschluss des Imports gemeldet. Sie können diesen Befehl verwenden, um Ihren Import vorab zu testen.
• BackupFirst – Sichert die Cloud-Inhalte in .yml-Dateien, bevor die Cloud-Konfiguration geändert wird. Dies ist standardmäßig aktiviert.
• Confirm – Wenn auf „true“ gesetzt, werden Benutzer aufgefordert zu bestätigen, dass sie Änderungen an der Cloud-Site-Konfiguration vornehmen möchten. Das Cmdlet Remove zeigt aufgrund seiner destruktiven Natur eine Eingabeaufforderung an. Setzen Sie es auf „false“, wenn keine Eingabeaufforderung gewünscht ist, z. B. bei der Ausführung in automatisierten Skripten. Confirm ist standardmäßig auf „true“ gesetzt.
• SecurityFileFolder – Dies ist der vollständig qualifizierte Ordner, der die Datei CustomerInfo.yml enthält, die auf einen lokalen Ordner oder einen Netzwerkfreigabeordner verweisen kann, der möglicherweise einer Authentifizierungskontrolle unterliegt. Das Tool fordert keine Anmeldeinformationen an; der Zugriff auf die kontrollierte Ressource muss vor dem Ausführen des Tools erlangt werden.
• SiteName – Gibt den für den Import zu verwendenden Präfix- und Suffixsatz für die Site-Zusammenführung an.
• 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 für die 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 zum Anzeigen der Protokolldatei verwendet. Sie können einen anderen Editor in der Datei CustomerInfo.yml 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 über alle ausgewählten Komponenten hinweg anzeigt: „true“ bedeutet erfolgreich und „false“ bedeutet nicht erfolgreich.

Individual_Success gibt einen oder drei Werte für jede Hauptkomponente zurück. Das Ergebnis einer Komponente kann Erfolg, Fehler oder Übersprungen sein. Übersprungen bedeutet, dass die Komponente nicht zur Ausführung durch das Cmdlet ausgewählt wurde.

CustomResult ist cmdlet-spezifisch.

CustomResult

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

Hinweis:

Die 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ählter Komponente an. Der Schlüssel ist der Komponentenname, und der Wert ist eine Liste jedes Komponentenmitglieds und der für dieses Komponentenmitglied ausgeführten Aktion. Aktionen können einer der ActionResultValues-Werte sein.

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

TotalChanged ist die Summe von Added, Updated und Deleted.

OverallResult ist ein einzelner boolescher Wert, der das Ergebnis des Cmdlets angibt. True bedeutet vollständigen Erfolg bei allen Komponenten, und False bedeutet einen Fehler bei der Verarbeitung einer oder mehrerer Komponenten.

CloudBackupFolder ist die vollständig qualifizierte Dateispezifikation des Cloud-Site-Konfigurations-Backups, bevor das Cmdlet cloudmodifizierende Aktionen ausführt.

SourceBackupFolder ist die vollständig qualifizierte Dateispezifikation des Quell-Dateibackups, das nach Abschluss des Cmdlets erstellt wurde. Standardmäßig befinden sich diese Dateien unter %HOMEPATH%\Documents\Citrix\AutoConfig.

PowerShell-Hilfe

Die PowerShell-Hilfe ist für jedes Cmdlet verfügbar. Alle Parameter sind bei jedem Cmdlet zusammen mit einer kurzen Erläuterung des Cmdlets dokumentiert. Um die Hilfe für ein Cmdlet aufzurufen, geben Sie Get-Help vor dem Cmdlet ein.

Get-Help Import-CvadAcToSite