Applets de commande de l’outil de configuration automatisée

Cette page répertorie tous les applets de commande et paramètres pris en charge par l’outil.

Toutes les applets de commande acceptent des paramètres de l’un des types suivants.

• Chaîne
• Liste des chaînes
• Booléen : $true ou $false
• SwitchParameter : la présence du paramètre signifie $true ; l’absence du paramètre signifie $false

Remarque :

SwitchParameter est la méthode préférée pour les sélections true ou false, mais les booléens sont toujours utilisés dans l’outil en raison de problèmes hérités.

Le tableau suivant récapitule toutes les applets de commande. Consultez chaque section pour connaître les paramètres pris en charge par chaque applet de commande.

Pour plus d’informations sur les paramètres et leur utilisation, consultez la rubrique Paramètres de migration granulaire.

Applets de commande de base

Applets de commande site vers cloud

• Export-CvadAcToFile - Exporte les fichiers locaux vers des fichiers YAML.

  Exporte la configuration à partir de votre configuration locale. Il s’agit de l’opération d’exportation par défaut pour l’outil de configuration automatisée. Aucune modification n’est apportée à la configuration du site local. Les fichiers exportés sont placés dans le répertoire %CHEMINDEBASE%\Documents\Citrix\AutoConfig dans un sous-dossier Export à nom unique. Le dossier %HOMEPATH%\Documents\Citrix\AutoConfig contient toujours la dernière configuration de site local exportée.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets		Liste des chaînes
  TargetFolder	Spécifie le dossier de destination de l’exportation.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  AdminAddress	Spécifie le DNS ou l’adresse IP du Delivery Controller lorsque l’exportation n’est pas exécutée sur le Delivery Controller.		Chaîne
  CheckUserAndMachines	Vérifie si les utilisateurs et les machines sont dans Active Directory. Les utilisateurs et les machines qui ne sont pas dans Active Directory peuvent entraîner des échecs d’importation.		$true ou $false
  ZipResults	Compresse les fichiers YAML de sauvegarde en un seul fichier zip. Le fichier se trouve dans le même dossier que les fichiers YAML sauvegardés et porte le même nom que le dossier.		SwitchParameter

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

Il existe trois façons d’importer des données dans le cloud. L’exécution d’applets de commande spécifiques peut entraîner l’une des trois combinaisons d’actions sur le site cloud :

• Ajouter, mettre à jour et supprimer
• Ajouter et mettre à jour uniquement
• Ajouter uniquement

• Import-CvadAcToSite - Importe les fichiers YAML dans le cloud. Prend en charge les opérations de création, de mise à jour et de suppression

  Importe tous les fichiers locaux dans le cloud. Cette commande garantit que l’état final du cloud est identique à l’état local. Cette option supprime toutes les modifications qui existent dans le cloud. Les fichiers de configuration de site importés proviennent de %CHEMINDEBASE%\Documents\Citrix\AutoConfig. Utilisez cette commande avec prudence.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants.		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets.		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud.		SwitchParameters
  SourceFolder	Identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  Merge	Lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.		$true ou $false
  AddOnly	Lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.		$true ou $false
  MergePolicies	Fusionne les paramètres de stratégie et les filtres. La fusion se produit uniquement lorsqu’une stratégie en cours d’importation existe déjà dans le DDC cloud. Après la fusion des stratégies, les stratégies DDC cloud contiennent les paramètres et filtres qu’elles avaient déjà, en plus de tous les nouveaux paramètres et filtres importés. Notez que, en cas de collisions de paramètres et de filtres, les valeurs importées sont prioritaires.		SwitchParameter
  OnErrorAction	Voir Paramètre OnErrorAction.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Merge-CvadAcToSite - Importe les fichiers YAML dans le cloud. Prend en charge les opérations de création et de mise à jour

  Fusionne les fichiers locaux dans le cloud, mais ne supprime aucun composant dans le cloud ou sur site. Cela préserve les modifications déjà apportées dans le cloud. Si un composant portant le même nom existe dans Citrix Cloud, cette commande peut modifier ce composant. Il s’agit de l’opération d’importation par défaut pour l’outil de configuration automatisée. Les fichiers de configuration de site fusionnés proviennent de %CHEMINDEBASE%\Documents\Citrix\AutoConfig.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants.		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets.		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud.		SwitchParameters
  SourceFolder	Identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  Merge	Lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.		$true ou $false
  AddOnly	Lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.		$true ou $false
  MergePolicies	Fusionne les paramètres de stratégie et les filtres. La fusion se produit uniquement lorsqu’une stratégie en cours d’importation existe déjà dans le DDC cloud. Après la fusion des stratégies, les stratégies DDC cloud contiennent les paramètres et filtres qu’elles avaient déjà, en plus de tous les nouveaux paramètres et filtres importés. Notez que, en cas de collisions de paramètres et de filtres, les valeurs importées sont prioritaires.		SwitchParameter
  OnErrorAction	Voir Paramètre OnErrorAction.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• New-CvadAcToSite - Importe les fichiers YAML dans le cloud. Prend en charge les opérations de création et de mise à jour

  Importe la configuration de site locale dans le cloud, mais ajoute uniquement les nouveaux composants. Les composants de site cloud existants ne sont ni mis à jour ni supprimés. Utilisez cette commande si les composants de site cloud existants doivent rester inchangés.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants.		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets.		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud.		SwitchParameters
  SourceFolder	Identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  OnErrorAction	Voir Paramètre OnErrorAction.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Sync-CvadAcToSite - Exporte et importe en une seule étape.

  Sync effectue à la fois une exportation et une importation en une seule étape. Utilisez le paramètre SourceTargetFolder pour spécifier le dossier de destination d’exportation/importation.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  SourceTargetFolder	Spécifie le dossier de destination de l’exportation/importation.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  AdminAddress	Spécifie le DNS ou l’adresse IP du Delivery Controller lorsque l’exportation n’est pas exécutée sur le Delivery Controller.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  Merge	Lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.		$true ou $false
  AddOnly	Lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.		$true ou $false
  MergePolicies	Fusionne les paramètres de stratégie et les filtres. La fusion se produit uniquement lorsqu’une stratégie en cours d’importation existe déjà dans le DDC cloud. Après la fusion des stratégies, les stratégies DDC cloud contiennent les paramètres et filtres qu’elles avaient déjà, en plus de tous les nouveaux paramètres et filtres importés. Notez que, en cas de collisions de paramètres et de filtres, les valeurs importées sont prioritaires.		SwitchParameter

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

Applets de commande cloud vers cloud

• Backup-CvadAcToFile - Sauvegarde toute la configuration de votre site cloud.

  Exporte votre configuration cloud vers des fichiers .yml. Cette sauvegarde peut être utilisée dans un processus de sauvegarde et de restauration pour restaurer des composants perdus.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants		SwitchParameters
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  TargetFolder	Spécifie le dossier de destination de l’exportation.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  ZipResults	Compresse les fichiers YAML de sauvegarde en un seul fichier zip. Le fichier se trouve dans le même dossier que les fichiers YAML sauvegardés et porte le même nom que le dossier.		SwitchParameter

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Restore-CvadAcToSite - Restaure les fichiers YAML de sauvegarde sur le site cloud. Ce site cloud peut être identique au site cloud source ou différent.

  Restaure la configuration précédente du site cloud. Les fichiers importés proviennent du dossier spécifié à l’aide du paramètre -RestoreFolder, qui identifie le dossier contenant les fichiers .yml à restaurer sur le site cloud. La spécification du dossier doit être complète. Cette applet de commande peut être utilisée pour revenir à votre configuration précédente ou pour sauvegarder et restaurer votre site cloud. Cette commande peut ajouter, supprimer et mettre à jour votre site cloud.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants.		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets.		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud.		SwitchParameters
  RestoreFolder	Identifie le dossier contenant les fichiers .yml à restaurer sur le site cloud. La spécification du dossier doit être complète.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  Merge	Lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.		$true ou $false
  AddOnly	Lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.		$true ou $false
  MergePolicies	Fusionne les paramètres de stratégie et les filtres. La fusion se produit uniquement lorsqu’une stratégie en cours d’importation existe déjà dans le DDC cloud. Après la fusion des stratégies, les stratégies DDC cloud contiennent les paramètres et filtres qu’elles avaient déjà, en plus de tous les nouveaux paramètres et filtres importés. Notez que, en cas de collisions de paramètres et de filtres, les valeurs importées sont prioritaires.		SwitchParameter
  OnErrorAction	Voir Paramètre OnErrorAction.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Remove-CvadAcFromSite - Supprime des membres de composants du cloud.

  Permet de réinitialiser l’intégralité du site ou de supprimer des éléments d’un composant (par exemple, supprimer un catalogue de machines de la liste des catalogues). Cette commande peut être utilisée lorsqu’elle est couplée avec le paramètre IncludeByName pour supprimer sélectivement des membres spécifiques.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

Autres applets de commande de base

• Compare-CvadAcToSite - compare les fichiers .yml locaux avec la configuration cloud, produisant un rapport sur les modifications apportées par une applet de commande Import, Merge ou Restore.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants.		SwitchParameters
  Filtrage par noms d’objets	Voir Filtrage par noms d’objets.		Liste des chaînes
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud.		SwitchParameters
  SourceFolder	Identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig.		Chaîne
  Locale	Spécifie la langue du texte lisible qui peut être exporté.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true ou $false
  Merge	Lorsque cette valeur est définie sur $true, ajoute uniquement des composants au site cloud. Les composants ne sont pas supprimés. Définissez sur $false pour supprimer des composants.		$true ou $false
  AddOnly	Lorsque cette option est définie sur $true, ajoute uniquement les nouveaux composants, ne met pas à jour ou ne supprime pas les composants existants. Définissez sur $false pour autoriser les mises à jour et les suppressions. Merge est ignoré lorsque ce paramètre est $true.		$true ou $false
  OnErrorAction	Voir Paramètre OnErrorAction.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

Paramètres de migration granulaire

Migrer par composants

Les composants suivants peuvent être spécifiés avec les applets de commande appropriées. L’option All est automatiquement sélectionnée lorsqu’aucun paramètre de composant n’est spécifié. Pour éviter les erreurs, nous vous recommandons de migrer les composants dans l’ordre suivant :

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

Filtrage par noms d’objets

Migrer par noms de composants

Les paramètres IncludeByName et ExcludeByName permettent d’inclure et d’exclure des membres de composants dans les applets de commande par nom. Il n’est possible de choisir qu’un seul composant (par exemple, les groupes de mise à disposition) à la fois dans les applets de commande prises en charge. Si un membre de composant se trouve dans les deux zones, l’exclusion a priorité sur tout autre paramètre et une entrée est ajoutée à la liste de correction du journal, identifiant le nom du membre (et du composant) qui a été exclu.

IncludeByName et ExcludeByName acceptent une liste des noms de membres de composants. Les noms peuvent contenir un ou plusieurs caractères génériques. Deux types de caractères génériques sont pris en charge. La liste des noms de membres de composants doit être placée entre guillemets simples lorsqu’un nom contient des caractères spéciaux.

• * correspond à n’importe quel nombre de caractères
• ? Correspond à un seul caractère

IncludeByName et ExcludeByName peuvent également accepter un fichier contenant une liste de membres où chaque membre peut être explicite ou contenir des caractères génériques. Chaque ligne du fichier peut contenir un membre. Les espaces de début et de fin sont retirés du nom du membre. Le nom de fichier doit être précédé du signe @ et être entouré de guillemets simples (une exigence PowerShell pour que le @ ne soit pas réinterprété). Plusieurs fichiers peuvent être répertoriés en plus d’être mélangés avec des noms de membres.

Exemple de fusion de tous les groupes de mise à disposition dont les noms commencent par DgSite1 et contiennent Home2 :

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

Par nom du groupe de mise à disposition

ByDeliveryGroupName filtre par nom du groupe de mise à disposition pour les applications et les groupes d’applications. Ce paramètre est toujours une liste d’inclusion identifiant les membres à inclure en fonction de leur association de groupe de mise à disposition.

ByDeliveryGroupName accepte une liste des noms de groupe de mise à disposition. Les noms peuvent contenir un ou plusieurs caractères génériques. Deux types de caractères génériques sont pris en charge.

• * correspond à n’importe quel nombre de caractères
• ? correspond à un seul caractère

L’exemple suivant fusionne toutes les applications qui font référence à tous les noms de groupe de mise à disposition commençant par EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Exclude Disabled

ExcludeDisabled filtre des opérations d’importation toutes les applications et les groupes d’applications qui sont désactivés. ExcludeDisabled est false par défaut, ce qui signifie que toutes les applications et tous les groupes d’applications sont importés quel que soit leur état activé.

Par nom de machine

ByMachineName filtre par le nom de la machine pour les catalogues de machines et les groupes de mise à disposition. Ce paramètre est toujours une liste d’inclusion identifiant les membres à inclure en fonction de leur association de nom de machine.

ByMachineName accepte une liste de noms de machines où les noms peuvent contenir un ou plusieurs caractères génériques. Deux types de caractères génériques sont pris en charge.

• * correspond à n’importe quel nombre de caractères
• ? correspond à un seul caractère

Lors de l’exportation ou de l’importation, si l’utilisation de ByMachineName et d’un filtre de nom de machine ne renvoie aucune machine dans le catalogue de machines ou le groupe de mise à disposition, le catalogue de machines ou le groupe de mise à disposition est exclu de l’exportation ou de l’importation.

Remarque :

Si ByMachineName est utilisé dans une applet de commande de tout type d’importation, MergeMachines est défini sur $true.

Fusionner des machines

MergeMachines, si défini sur $true, indique à l’opération d’importation d’ajouter des machines uniquement au catalogue de machines ou au groupe de mise à disposition. Les machines ne sont pas retirées, ce qui permet des ajouts incrémentiels.

MergeMachines se règle sur false par défaut, ce qui signifie que les machines sont supprimées si elles ne sont pas présentes dans le fichier .yml du catalogue de machines ou du groupe de mise à disposition. MergeMachines est défini sur $true lorsque ByMachineName est utilisé mais peut être remplacé en définissant MergeMachines sur false.

Applets de commande liées aux conditions préalables

• New-CvadAcCustomerInfoFile - Crée un fichier d’informations client. Par défaut, le fichier d’informations client se trouve sous %HOMEPATH%\Documents\Citrix\AutoConfig.

  Paramètres :

  Nom	Description	Requis ?	Type
  CustomerId	ID du client.	x	Chaîne
  ClientId	ID client créé sur Citrix Cloud. CustomerId et Secret doivent être spécifiés lors de l’utilisation de ce paramètre.	Conditionnellement	Chaîne
  Secret	Clé secrète du client créée sur Citrix Cloud. CustomerId et ClientId doivent être spécifiés lors de l’utilisation de ce paramètre.	Conditionnellement	Chaîne
  Environment	Environnement Production, ProductionGov ou ProductionJP.		Énumération
  LogFileName	Remplace le préfixe du fichier journal de CitrixLog par autre chose.		Chaîne
  AltRootUrl	À utiliser uniquement sous la direction de Citrix.		Chaîne
  StopOnError	Arrête l’opération lors de la première erreur.		$true ou $false
  TargetFolder	Utilise le dossier spécifié comme dossier racine au lieu de %HOMEPATH%\Documents\Citrix\AutoConfig.		Chaîne
  Locale	Utilise les paramètres régionaux spécifiés au lieu des paramètres régionaux dérivés du système sur lequel l’outil est exécuté.		Chaîne
  Editor	Utilise l’éditeur spécifié pour afficher le journal à la fin de chaque applet de commande. Notepad.exe est l’éditeur par défaut. Ce paramètre doit inclure la spécification complète du fichier à l’éditeur et l’éditeur doit prendre la spécification du fichier journal comme seul paramètre.		Chaîne
  SecurityCsvFileSpec	Spécification de fichier complète pointant vers le fichier SecurityClient.csv téléchargé à partir de Gestion des identités et des accès Citrix. CustomerID doit être spécifié lors de l’utilisation de ce paramètre.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Set-CvadAcCustomerInfoFile - Met à jour un fichier d’informations client existant. Seuls les paramètres spécifiés par l’applet de commande sont modifiés. Toutes les valeurs de paramètres non spécifiées dans le fichier CustomerInfo.yml restent inchangées.

  Paramètres :

  Nom	Description	Requis ?	Type
  CustomerId	ID du client.		Chaîne
  ClientId	ID client créé sur Citrix Cloud.		Chaîne
  Secret	Clé secrète du client créée sur Citrix Cloud.		Chaîne
  Environment	Environnement Production, ProductionGov ou ProductionJP.		Énumération
  LogFileName	Remplace le préfixe du fichier journal de CitrixLog par autre chose.		Chaîne
  StopOnError	Arrête l’opération lors de la première erreur.		$true ou $false
  TargetFolder	Utilise le dossier spécifié comme dossier racine au lieu de %HOMEPATH%\Documents\Citrix\AutoConfig.		Chaîne
  Locale	Utilise les paramètres régionaux spécifiés au lieu des paramètres régionaux dérivés du système sur lequel l’outil est exécuté.		Chaîne
  Editor	Utilise l’éditeur spécifié pour afficher le journal à la fin de chaque applet de commande. Notepad.exe est l’éditeur par défaut. Ce paramètre doit inclure la spécification complète du fichier à l’éditeur et l’éditeur doit prendre la spécification du fichier journal comme seul paramètre.		Chaîne
  SecurityCsvFileSpec	Spécification de fichier complète pointant vers le fichier SecurityClient.csv téléchargé à partir de Gestion des identités et des accès Citrix. CustomerID doit être spécifié lors de l’utilisation de ce paramètre.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

Paramètres liés aux conditions préalables

Outre les paramètres d’accès au cloud, les paramètres suivants peuvent être utilisés avec les applets de commande liées aux conditions préalables :

• Environment - environnement Production ou ProductionGov.
• LogFileName - remplace le préfixe du fichier journal de CitrixLog par autre chose.
• StopOnError - arrête l’opération lors de la première erreur.
• AlternateRootFolder - utilise le dossier spécifié comme dossier racine au lieu de %HOMEPATH%\Documents\Citrix\AutoConfig.
• Locale - utilise les paramètres régionaux spécifiés au lieu des paramètres régionaux dérivés du système sur lequel l’outil est exécuté.
• Editor - utilise l’éditeur spécifié pour afficher le journal à la fin de chaque applet de commande. Notepad.exe est l’éditeur par défaut. Ce paramètre doit inclure la spécification complète du fichier à l’éditeur et l’éditeur doit prendre la spécification du fichier journal comme seul paramètre.

Applets de commande de support et de dépannage

• New-CvadAcZipInfoForSupport - Zippe tous les fichiers journaux et .yml dans un seul fichier zip à envoyer à Citrix pour obtenir de l’assistance. Les informations sensibles du client (CustomerInfo.yml et CvadAcSecurity.yml) ne sont pas incluses dans le zip. Le fichier Icon.yml est également exclu en raison de sa taille. Le fichier zip est placé dans %HOMEPATH%\Documents\Citrix\AutoConfig et nommé CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip, en fonction de la date et de l’horodatage. Ce fichier zip peut également servir de sauvegarde.

  Paramètres :

  Nom	Description	Requis ?	Type
  TargetFolder	Spécifie un dossier cible dans lequel créer et enregistrer le fichier zip.		Chaîne
  Quiet	Supprime la journalisation sur la console.		SwitchParameter

  Renvoie :

  • Le fichier Zip avec le nom et l’emplacement du fichier zip est affiché sur l’invite de commandes.

• Get-CvadAcStatus - Permet de tester la connectivité et de s’assurer que toutes les conditions préalables sont remplies. Renvoie des informations sur l’outil, telles que le numéro de version et la connectivité avec le cloud et l’état du connecteur.

  Paramètres :

  Nom	Description	Requis ?	Type
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  SiteId	Identifie le site auquel se connecter.		Chaîne
  AdminAddress	Adresse DNS ou l’adresse IP du Delivery Controller local utilisé pour vérifier le niveau d’accès des administrateurs. Cette opération est requise si l’outil n’est pas exécuté sur un Delivery Controller.		Chaîne

  Renvoie :

  • Affiche les résultats pour chaque élément.

• Test-CvadAcConnectionWithSite - Teste la connexion avec le site cloud pour vérifier que la connexion de communication fonctionne. Cette applet de commande utilise les paramètres d’accès au cloud ou le fichier CustomerInfo.yml pour spécifier les informations de connexion du client.

  Paramètres :

  Nom	Description	Requis ?	Type
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  Quiet	Supprime la journalisation sur la console.		SwitchParameter

  Renvoie :

  • Les résultats des tests sont affichés sur la ligne de commande.

• Find-CvadAcConnector - Localise les connecteurs existants et détermine leur état d’exécution. Cette applet de commande utilise les informations du fichier CustomerInfo.yml ou du paramètre CustomerID pour localiser les connecteurs du client.

  Paramètres :

  Nom	Description	Requis ?	Type
  CustomerInfoFileSpec	Spécification de fichier pointant vers un fichier d’informations client pour remplacer l’emplacement et le nom par défaut. Ce paramètre est ignoré lorsque le paramètre CustomerId est fourni.		Chaîne
  CustomerId	ID du client. Ce paramètre remplace la même valeur dans le fichier CustomerInfo.yml.		Chaîne

  Renvoie :

  • Les résultats sont affichés sur la ligne de commande.

• Get-CvadAcCustomerSites - Renvoie la liste de tous les sites clients. Cette applet de commande utilise les paramètres d’accès au cloud ou le fichier CustomerInfo.yml pour spécifier les informations de connexion du client.

  Paramètres :

  • Voir Paramètres d’accès au cloud

  Renvoie :

  • Affiche la liste des ID de site client trouvés.

• New-CvadAcTemplateToFile - Crée un fichier modèle pour les composants sélectionnés, ce qui vous permet de créer manuellement un fichier d’importation.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants		SwitchParameters
  TargetFolder	Spécifie le dossier de destination de l’exportation.		Chaîne

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Show-CvadAcDocument - Affiche cette documentation dans le navigateur par défaut.

  Paramètres :

  • Aucune.

  Renvoie :

  • Affichez cette page Web dans le navigateur Web par défaut.

• Find-CvadAcInFile - Recherche dans les recherches de fichier les fichiers YAML des composants à la recherche de membres correspondant à un ou plusieurs noms pouvant contenir des caractères génériques. Le résultat est un rapport des membres trouvés. La fonction de rechercher dans le fichier ne peut rechercher qu’un seul composant à la fois. La recherche dans le fichier recherche tous les fichiers YAML du dossier actuel et de tous les sous-dossiers. Utilisez FindSourceFolder pour limiter le nombre de fichiers à rechercher.

  Paramètres :

  Nom	Description	Requis ?	Type
  Migrer par composants	Voir Migrer par composants. Remarque : la valeur -All n’est pas valide.		SwitchParameters
  IncludeByName	Liste spécifiant les noms des groupes de mise à disposition à inclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.		Liste des chaînes
  Unique	Signale uniquement les membres trouvés uniques.		SwitchParameter
  IncludeYaml	Inclut le YAML spécifique au membre.		SwitchParameter
  FindSourceFolder	Dossier dans lequel commence la recherche.		Chaîne
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		SwitchParameter
  Quiet	Supprime la journalisation sur la console.		SwitchParameter

  Renvoie :

  • Crée un rapport contenant les membres trouvés pour le composant spécifié.

Applets de commande d’activation de site

Pour plus d’informations sur l’activation de sites et l’utilisation de ces applets de commande, consultez Activation de sites.

• Set-CvadAcSiteActiveStateOnPrem - Définit l’état du site local sur actif ou inactif.

  Paramètres :

  Nom	Description	Requis ?	Type
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  SiteActive	Lorsque ce paramètre est présent, définit le site local sur actif, supprimant ainsi le mode de maintenance de tous les groupes de mise à disposition. Lorsque ce paramètre n’est pas présent, le mode de maintenance est défini sur tous les groupes de mise à disposition.		SwitchParameter
  IncludeByName	Liste spécifiant les noms des groupes de mise à disposition à inclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.		Liste des chaînes
  ExcludeByName	Liste spécifiant les noms des groupes de mise à disposition à exclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.		Liste des chaînes
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true or $false

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

• Set-CvadAcSiteActiveStateCloud - Définit l’état du site cloud sur actif ou inactif.

  Paramètres :

  Nom	Description	Requis ?	Type
  Paramètres d’accès au cloud	Voir Paramètres d’accès au cloud		SwitchParameters
  SiteActive	Lorsque ce paramètre est présent, définit le site cloud sur actif, supprimant ainsi le mode de maintenance de tous les groupes de mise à disposition. Lorsque ce paramètre n’est pas présent, le mode de maintenance est défini sur tous les groupes de mise à disposition.		SwitchParameter
  IncludeByName	Liste spécifiant les noms des groupes de mise à disposition à inclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.		Liste des chaînes
  ExcludeByName	Liste spécifiant les noms des groupes de mise à disposition à exclure lors de la définition de l’état du site sur actif. Les caractères génériques ‘*’ et ‘?’ sont pris en charge dans les noms.		Liste des chaînes
  Quiet	Supprime la journalisation sur la console.		SwitchParameter
  DisplayLog	Affiche le fichier journal à la fin de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.		$true or $false

  Renvoie :

  • Voir Valeurs de retour de l’applet de commande

Fusion de plusieurs applets de commande de sites locaux

Pour plus d’informations sur la fusion de sites et l’utilisation de ces applets de commande, consultez la rubrique Fusion de plusieurs sites en un seul site.

• New-CvadAcSiteMergingInfo - crée un jeu d’informations préfixe/suffixe de fusion de site. Il n’est pas nécessaire de connaître tous les préfixes ou suffixes au début. Ils peuvent être mis à jour avec Set-CvadAcSiteMergingInfo ou en modifiant manuellement le fichier SiteMerging.yml. Paramètres :

  Nom	Description	Requis ?	Type
  SiteName	Nom utilisé pour identifier l’ensemble de préfixes/suffixes pour un site spécifique. Il peut correspondre au nom du site, mais ce n’est pas obligatoire.	x	Chaîne
  Paramètres de fusion de sites	Voir Paramètres de fusion de sites		SwitchParameters
  Quiet	Supprime la journalisation sur la console.		SwitchParameter

  Renvoie :

  • Aucun

• Set-CvadAcSiteMergingInfo - met à jour un jeu d’informations préfixe/suffixe de fusion de site existant.

  Paramètres :

  Nom	Description	Requis ?	Type
  SiteName	Nom utilisé pour identifier l’ensemble de préfixes/suffixes pour un site spécifique. Il peut correspondre au nom du site, mais ce n’est pas obligatoire.	x	Chaîne
  Paramètres de fusion de sites	Voir Paramètres de fusion de sites		SwitchParameters
  Quiet	Supprime la journalisation sur la console.		SwitchParameter

  Renvoie :

  • Aucun

• Remove-CvadAcSiteMergingInfo - supprime un jeu d’informations préfixe/suffixe de fusion de site existant.

  Paramètres :

  • SiteName — Identifie l’ensemble des préfixes et suffixes de site. Il s’agit d’une chaîne de caractères qui est obligatoire.

  Renvoie :

  • Aucun

Paramètres de fusion de sites

Les paramètres suivants peuvent être utilisés lors de l’exécution des applets de commande de fusion de sites. Tous les paramètres répertoriés sont des chaînes.

• SiteName - nom utilisé pour identifier l’ensemble de préfixes/suffixes pour un site spécifique. Il peut correspondre au nom du site, mais ce n’est pas obligatoire. SiteName est un paramètre obligatoire.
• AdminScopedPrefix - préfixe à appliquer aux étendues administrateur.
• ApplicationPrefix - préfixe à appliquer aux applications.
• ApplicationFolderPrefix - préfixe à appliquer aux dossiers d’application ; ApplicationFolderPrefix peut être combiné avec ApplicationFolderRoot.
• ApplicationFolderRoot - nouveau dossier racine des dossiers d’application. Ce paramètre crée une hiérarchie de dossiers supplémentaire. ApplicationFolderRoot peut être combiné avec ApplicationFolderPrefix.
• ApplicationGroupPrefix - préfixe pour les groupes d’applications.
• ApplicationUserPrefix - préfixe à appliquer au nom de l’application que l’utilisateur voit.
• ApplicationAdminPrefix - préfixe à appliquer au nom de l’application que l’administrateur voit.
• DeliveryGroupPrefix - préfixe à appliquer aux groupes de mise à disposition.
• GroupPolicyPrefix - préfixe à appliquer aux noms de stratégie.
• HostConnectionPrefix - préfixe à appliquer aux connexions hôtes.
• MachineCatalogPrefix - préfixe à appliquer aux catalogues de machines.
• StoreFrontPrefix - préfixe à appliquer aux noms StoreFront.
• TagPrefix - préfixe à appliquer aux balises.
• AdminScopedSuffix - suffixe à appliquer aux étendues administrateur.
• ApplicationSuffix - suffixe à appliquer aux applications.
• ApplicationFolderSuffix - suffixe à appliquer aux dossiers d’application ; ApplicationFolderSuffix peut être combiné avec ApplicationFolderRoot.
• ApplicationGroupSuffix - suffixe pour les groupes d’applications.
• ApplicationUserSuffix - suffixe à appliquer au nom de l’application que l’utilisateur voit.
• ApplicationAdminSuffix - suffixe à appliquer au nom de l’application que l’administrateur voit.
• DeliveryGroupSuffix - suffixe à appliquer aux groupes de mise à disposition.
• GroupPolicySuffix - suffixe à appliquer aux noms de stratégie.
• HostConnectionSuffix - suffixe à appliquer aux connexions hôtes.
• MachineCatalogSuffix - suffixe à appliquer aux catalogues de machines.
• StoreFrontSuffix - suffixe à appliquer aux noms StoreFront.
• TagSuffix - suffixe à appliquer aux balises.
• SiteRootFolder - nom de dossier complet à utiliser pour les exportations et les importations ; il peut s’agir d’un dossier local ou d’un partage de fichiers.

Paramètres génériques

Paramètres d’accès au cloud

Toutes les applets de commande accédant au cloud prennent en charge les paramètres supplémentaires suivants.

Remarque :

CustomerID, ClientID et Secret peuvent être placés dans le fichier CustomerInfo.yml ou spécifiés avec l’applet de commande à l’aide des paramètres suivants. Lorsqu’ils sont spécifiés aux deux emplacements, les paramètres de l’applet de commande ont priorité.

• CustomerId - ID client utilisé dans les API REST, requis pour accéder à toutes les API REST. Votre ID client se trouve dans Citrix Cloud.
• ClientId - ID client créé sur le site Web Gestion des identités et des accès de Citrix Cloud. Ceci est nécessaire pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest.
• Secret - clé secrète créée sur le site Web Gestion des identités et des accès de Citrix Cloud. Ceci est nécessaire pour obtenir le jeton de porteur requis pour l’authentification de toutes les API Rest.
• CustomerInfoFileSpec - spécification de fichier pointant vers un fichier d’informations client pour remplacer l’emplacement et le nom par défaut.

Paramètres des modes de migration

Les applets de commande modifiant la configuration du site cloud (Import, Restore, Merge, New et Sync) prennent en charge les paramètres supplémentaires suivants pour offrir une plus grande flexibilité.

• CheckMode - Effectue l’opération d’importation mais n’apporte aucune modification. Toutes les modifications attendues sont signalées avant la fin de l’importation. Vous pouvez utiliser cette commande pour tester votre importation avant de l’effectuer.
• BackupFirst - Sauvegarde le contenu du cloud dans des fichiers .yml avant de modifier la configuration du cloud. Cette option est activée par défaut.
• Confirm - Lorsque la valeur est true, invite les utilisateurs à confirmer qu’ils souhaitent apporter des modifications à la configuration du site cloud. L’applet de commande Remove affiche une invite en raison de sa nature destructrice. Définissez la valeur false si aucune invite n’est souhaitée, comme pour l’exécution dans des scripts automatisés. Confirm est true par défaut.
• SecurityFileFolder - dossier complet contenant le fichier CustomerInfo.yml qui peut pointer vers un dossier local ou un dossier de partage réseau sous contrôle d’authentification. L’outil ne demandera pas d’informations d’identification ; l’accès à la ressource contrôlée doit être obtenu avant d’exécuter l’outil.
• SiteName - spécifie le préfixe et le suffixe de fusion de sites à utiliser lors de l’importation.
• SiteActive - indique si le site importé est actif ou inactif. Par défaut, ce paramètre est défini sur $false, ce qui signifie que le site importé est inactif.

Paramètres d’affichage du journal

Les applets de commande Export, Import, Sync, Restore, Backup, Compare et Remove affichent le fichier du journal lorsque l’opération se termine. Vous pouvez supprimer l’affichage en définissant le paramètre -DisplayLog sur $false. Notepad.exe est utilisé par défaut pour afficher le fichier journal. Vous pouvez spécifier un éditeur différent dans le fichier CustomerInfo.yml.

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

Valeurs de retour de l’applet de commande

ActionResult

Toutes les applets de commande renvoient la valeur suivante.

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

Overall_Success renvoie un seul booléen indiquant le succès global de l’applet de commande sur tous les composants sélectionnés : true signifie succès et false signifie échec.

Individual_Success renvoie une ou trois valeurs pour chaque composant principal. Le résultat d’un composant peut être Success, Failure ou Skipped. Skipped indique que le composant n’a pas été sélectionné pour l’exécution par l’applet de commande.

CustomResult est spécifique à l’applet de commande.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File et Remove renvoient les informations de résultat personnalisées suivantes à une seule instance de EvaluationResultData.

Remarque :

Les applets de commande Export et Template ne renvoient pas de résultat personnalisé.

                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 affiche une liste avec une entrée par composant sélectionné. La clé est le nom du composant et la valeur est une liste de chaque membre de composant et de l’action effectuée sur ce membre. Les actions peuvent être l’une des valeurs ActionResultValues.

Added, Updated, Deleted et NoChange indiquent le nombre total de membres de composants ajoutés, mis à jour, supprimés ou sur lesquels aucune action n’a été effectuée, dans cet ordre.

TotalChanged est la somme de Added, Updated et Deleted.

OverallResult est un booléen unique indiquant le résultat de l’applet de commande. True indique le succès total de tous les composants et false indique l’échec du traitement d’un ou de plusieurs composants.

CloudBackupFolder est la spécification de fichier complète de la sauvegarde de la configuration du site cloud avant que l’applet de commande effectue des actions de modification du cloud.

SourceBackupFolder est la spécification de fichier complète de la sauvegarde du fichier source effectuée après la fin de l’applet de commande. Par défaut, ces fichiers se trouvent sous %HOMEPATH%\Documents\Citrix\AutoConfig.

Aide de PowerShell

L’aide de PowerShell est disponible pour chaque applet de commande. Tous les paramètres sont documentés avec chaque applet de commande et une brève explication de l’applet de commande est également proposée. Pour accéder à l’aide d’une applet de commande, tapez Get-Help devant l’applet de commande.

Get-Help Import-CvadAcToSite