Citrix DaaS™

Applets de commande de l’outil de configuration automatisée pour la migration

Cette page répertorie toutes les applets de commande et tous les paramètres pris en charge par l’outil pour les cas d’utilisation de migration.

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

  • Chaîne
  • Liste de 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 vrai ou faux, mais les booléens sont toujours utilisés dans l’outil en raison de problèmes d’héritage.

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

|Catégorie|Applet de commande|Description| |—|—|—| |[Migration de l’environnement local vers le cloud](#on-premises-to-cloud-cmdlets)|Export-CvadAcToFile|Exporte les fichiers locaux vers des fichiers YAML.| |^^|Import-CvadAcToSite|Importe les fichiers YAML vers le cloud. Prend en charge les opérations de création, de mise à jour et de suppression.| |^^|Merge-CvadAcToSite|Importe les fichiers YAML vers le cloud. Prend en charge les opérations de création et de mise à jour.| |^^|New-CvadAcToSite|Importe les fichiers YAML vers le cloud. Prend en charge les opérations de création et de mise à jour.| |^^|Sync-CvadAcToSite|Exporte et importe en une seule étape.| |^^|*Migration granulaire* Pour les composants, utilisez les paramètres avec les commandes ci-dessus. Exemples : MachineCatalogs, Tags. Pour les noms de composants, utilisez les paramètres avec les commandes ci-dessus. Exemples : IncludeByName, ExcludeByName.|Migre sélectivement uniquement les composants ou les noms de composants| |[Applets de commande de migration de cloud à cloud](#cloud-to-cloud-cmdlets)|Backup-CvadAcToFile|Sauvegarde toute la configuration de votre site cloud.| |^^|Restore-CvadAcToSite|Restaure les fichiers YAML de sauvegarde sur le site cloud. Ce site cloud peut être identique ou différent du site cloud source.| |^^|Remove-CvadAcFromSite|Supprime les membres du composant du cloud.| |^^|*Migration granulaire* Pour les composants, utilisez les paramètres avec les commandes ci-dessus. Exemples : MachineCatalogs, Tags. Pour les noms de composants, utilisez les paramètres avec les commandes ci-dessus. Exemples : IncludeByName, ExcludeByName.|Migre sélectivement uniquement les composants ou les noms de composants| |[Autres applets de commande de base](#other-basic-cmdlets)|Compare-CvadAcToSite|Compare les fichiers .yml locaux avec la configuration cloud.| |[Applets de commande liées aux prérequis](#prerequisites-related-cmdlets)|New-CvadAcCustomerInfoFile|Crée un fichier d’informations client.| |^^|Set-CvadAcCustomerInfoFile|Met à jour un fichier d’informations client existant.| |[Applets de commande de support et de dépannage](#support-and-troubleshooting-cmdlets)|New-CvadAcZipInfoForSupport|Compresse tous les fichiers journaux et .yml dans un seul fichier zip à envoyer à Citrix® pour le support.| |^^|Get-CvadAcStatus|Permet de tester la connectivité et de s’assurer que tous les prérequis sont remplis. Renvoie des informations sur l’outil, telles que le numéro de version et la connectivité avec le cloud et l’état du connecteur.| |^^|Test-CvadAcConnectionWithSite|Teste la connexion avec le site cloud.| |^^|Find-CvadAcConnector|Localise les connecteurs existants et détermine leur état d’exécution.| |^^|Get-CvadAcCustomerSites|Renvoie la liste de tous les sites clients.| |^^|New-CvadAcTemplateToFile|Crée un fichier de modèle pour les composants sélectionnés.| |^^|Show-CvadAcDocument|Affiche cette documentation dans le navigateur par défaut.| |^^|Find-CvadAcInFile|La recherche dans le fichier recherche dans les fichiers YAML de composants les membres correspondant à un ou plusieurs noms pouvant contenir des caractères génériques.| |[Applets de commande d’activation de site](#site-activation-cmdlets)|Set-CvadAcSiteActiveStateOnPrem|Définit l’état du site local sur actif ou inactif.| |^^|Set-CvadAcSiteActiveStateCloud|Définit l’état du site cloud sur actif ou inactif.| |[Applets de commande de fusion de plusieurs sites locaux](#merging-multiple-on-premises-sites-cmdlets)|New-CvadAcSiteMergingInfo|Crée un ensemble d’informations de préfixe/suffixe de fusion de site.| |^^|Set-CvadAcSiteMergingInfo|Met à jour un ensemble d’informations de préfixe/suffixe de fusion de site existant.| |^^|Remove-CvadAcSiteMergingInfo|Supprime un ensemble d’informations de préfixe/suffixe de fusion de site existant.|

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

Applets de commande de base

Applets de commande de l’environnement local vers le cloud

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

    Exporte la configuration de votre installation locale. Il s’agit de l’opération d’exportation par défaut pour la 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 %HOMEPATH%\Documents\Citrix\AutoConfig dans un sous-dossier Export nommé de manière unique. Le dossier %HOMEPATH%\Documents\Citrix\AutoConfig contient toujours la dernière configuration de site local exportée.

    Paramètres :

|Nom|Description|Obligatoire ?|Type|
|---|---|---|---|
|Migrer par composants|Consultez \[Migrer par composants]\(#migrate-by-components).\||SwitchParameters|
|Filtrage par noms d’objets|Consultez \[Filtrage par noms d’objets]\(#filtering-by-object-names).\||Liste de chaînes|
|`TargetFolder`|Spécifie le dossier de destination de l’exportation.\||Chaîne|
|`Locale`|Spécifie la langue du texte lisible par l’homme qui peut être exporté.\||Chaîne|
|`Quiet`|Supprime la journalisation dans la console.\||SwitchParameter|
|`AdminAddress`|Spécifie l’adresse DNS ou 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 se trouvent dans Active Directory. Les utilisateurs et les machines qui ne se trouvent pas dans Active Directory peuvent entraîner des échecs d’importation.\||`$true` ou `$false`|
|`ZipResults`|Compresse les fichiers YAML de sauvegarde dans 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| <!--- table-end --->

Renvoie :

-  Consultez [Valeurs de retour des applets de commande](#cmdlet-return-values)

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

| Applet de commande | Ajouter | Mettre à jour | Supprimer | | — |— | — | — | | Importer | X | X | X | | Fusionner | X | X | | | Nouveau | X | | |

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

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

    Paramètres :

|Nom|Description|Obligatoire ?|Type|
|---|---|---|---|
|Migrer par composants|Consultez \[Migrer par composants]\(#migrate-by-components).\||SwitchParameters|
|Filtrage par noms d’objets|Consultez \[Filtrage par noms d’objets]\(#filtering-by-object-names).\||Liste de chaînes|
|Paramètres d’accès au cloud|Consultez \[Paramètres d’accès au cloud]\(#cloud-accessing-parameters).\||SwitchParameters|
|`SourceFolder`|Identifie un dossier racine de substitution pour \*%HOMEPATH%\Documents\Citrix\AutoConfig\*.\||Chaîne|
|`Locale`|Spécifie la langue du texte lisible par l’homme qui peut être exporté.\||Chaîne|
|`Quiet`|Supprime la journalisation dans la console.\||SwitchParameter|
|`DisplayLog`|Affiche le fichier journal à la fin de l’exécution de l’applet de commande. Définissez sur `$false` pour supprimer l’affichage du journal.\||`$true` ou `$false`|
|`Merge`|Lorsque la valeur est `$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 la valeur est `$true`, ajoute uniquement de 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 et les filtres de stratégie. La fusion ne se produit que lorsqu’une stratégie importée existe déjà dans le DDC cloud. Le résultat de la fusion des stratégies est que les stratégies DDC cloud contiennent les paramètres et les filtres qu’elles avaient déjà en plus des nouveaux paramètres et filtres importés. Notez que lorsque des collisions de paramètres et de filtres se produisent, les valeurs importées prévalent.\||SwitchParameter|
|`OnErrorAction`|Consultez le \[paramètre OnErrorAction]\(/fr-fr/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).\||Chaîne| <!--- table-end --->

Renvoie :
  • Consultez Valeurs de retour des cmdlets

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

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

    Paramètres :

    Nom Description Obligatoire ? Type
    Migrer par composants Consultez Migrer par composants. SwitchParameters
    Filtrage par noms d’objets Consultez Filtrage par noms d’objets. List of strings
    Paramètres d’accès au cloud Consultez Paramètres d’accès au cloud. SwitchParameters
    SourceFolder Identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig. String
    Locale Spécifie la langue du texte lisible par l’homme qui peut être exporté. String
    Quiet Supprime la journalisation dans la console. SwitchParameter
    DisplayLog Affiche le fichier journal à la fin de l’exécution de la cmdlet. Définissez sur $false pour supprimer l’affichage du journal. $true ou $false
    Merge Lorsque la valeur est $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 la valeur est $true, ajoute uniquement de 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 et les filtres de stratégie. La fusion ne se produit que lorsqu’une stratégie importée existe déjà dans le DDC cloud. Le résultat de la fusion des stratégies est que les stratégies DDC cloud contiennent les paramètres et les filtres qu’elles avaient déjà en plus des nouveaux paramètres et filtres importés. Notez que lorsque des collisions de paramètres et de filtres se produisent, les valeurs importées prévalent. SwitchParameter
    OnErrorAction Consultez Paramètre OnErrorAction. String

    Valeurs de retour :

  • Consultez Valeurs de retour des cmdlets

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

    Importe la configuration du site sur site vers le cloud, mais n’ajoute que de nouveaux composants. Les composants de site cloud existants ne sont ni mis à jour ni supprimés. Utilisez cette commande si vos composants de site cloud existants doivent rester inchangés.

    Paramètres :

    Nom Description Obligatoire ? Type
    Migrer par composants Consultez Migrer par composants. SwitchParameters
    Filtrage par noms d’objets Consultez Filtrage par noms d’objets. List of strings
    Paramètres d’accès au cloud Consultez Paramètres d’accès au cloud. SwitchParameters
    SourceFolder Identifie un dossier racine de substitution pour %HOMEPATH%\Documents\Citrix\AutoConfig. String
    Locale Spécifie la langue du texte lisible par l’homme qui peut être exporté. String
    Quiet Supprime la journalisation dans la console. SwitchParameter
    DisplayLog Affiche le fichier journal à la fin de l’exécution de la cmdlet. Définissez sur $false pour supprimer l’affichage du journal. $true ou $false
    OnErrorAction Consultez Paramètre OnErrorAction. String

    Valeurs de retour :

  • Consultez Valeurs de retour des cmdlets

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

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

    Paramètres :

    Nom Description Obligatoire ? Type
    Migrer par composants Consultez Migrer par composants SwitchParameters
    Filtrage par noms d’objets Consultez Filtrage par noms d’objets List of strings
    Paramètres d’accès au cloud Consultez Paramètres d’accès au cloud SwitchParameters
    SourceTargetFolder Spécifie le dossier de destination de l’exportation/importation. String
    Locale Spécifie la langue du texte lisible par l’homme qui peut être exporté. String
    AdminAddress Spécifie l’adresse DNS ou IP du contrôleur de livraison lorsque l’exportation n’est pas exécutée sur le contrôleur de livraison. String
    Quiet Supprime la journalisation dans la console. SwitchParameter
    DisplayLog Affiche le fichier journal à la fin de l’exécution de la cmdlet. Définissez sur $false pour supprimer l’affichage du journal. $true ou $false
    Merge Lorsque la valeur est $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 la valeur est $true, ajoute uniquement de 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 et les filtres de stratégie. La fusion ne se produit que lorsqu’une stratégie importée existe déjà dans le DDC cloud. Le résultat de la fusion des stratégies est que les stratégies DDC cloud contiennent les paramètres et les filtres qu’elles avaient déjà en plus des nouveaux paramètres et filtres importés. Notez que lorsque des collisions de paramètres et de filtres se produisent, les valeurs importées prévalent. SwitchParameter

    Valeurs de retour :

  • Consultez Valeurs de retour des cmdlets

Cmdlets de cloud à 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 les composants perdus.

    Paramètres :

    Nom Description Obligatoire ? Type
    Migrer par composants Consultez Migrer par composants SwitchParameters
    Paramètres d’accès au cloud Consultez Paramètres d’accès au cloud SwitchParameters
    TargetFolder Spécifie le dossier de destination de l’exportation. String
    Locale Spécifie la langue du texte lisible par l’homme qui peut être exporté. String
    Quiet Supprime la journalisation dans la console. SwitchParameter
    DisplayLog Affiche le fichier journal à la fin de l’exécution de la cmdlet. Définissez sur $false pour supprimer l’affichage du journal. $true ou $false
    ZipResults Compresse les fichiers YAML de sauvegarde dans 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

Valeurs renvoyées :

  • Consultez Valeurs renvoyées par les cmdlets

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

    Restaure le site cloud à la configuration précédente. 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. Il doit s’agir d’une spécification de dossier entièrement qualifiée. Cette cmdlet 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|Obligatoire ?|Type|
|---|---|---|---|
|Migrer par composants|Consultez \[Migrer par composants]\(#migrate-by-components).\||SwitchParameters|
|Filtrage par noms d’objets|Consultez \[Filtrage par noms d’objets]\(#filtering-by-object-names).\||List of strings|
|Paramètres d’accès au cloud|Consultez \[Paramètres d’accès au cloud]\(#cloud-accessing-parameters).\||SwitchParameters|
|`RestoreFolder`|Identifie le dossier contenant les fichiers .yml à restaurer sur le site cloud. Il doit s’agir d’une spécification de dossier entièrement qualifiée.\||String|
|`Locale`|Spécifie la langue du texte lisible par l’homme qui peut être exporté.\||String|
|`Quiet`|Supprime la journalisation dans la console.\||SwitchParameter|
|`DisplayLog`|Affiche le fichier journal à la fin de la cmdlet. Définissez sur `$false` pour supprimer l’affichage du journal.\||`$true` ou `$false`|
|`Merge`|Lorsque défini 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 défini sur `$true`, ajoute uniquement de 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 et les filtres de stratégie. La fusion n’a lieu que lorsqu’une stratégie importée existe déjà dans le DDC cloud. Le résultat de la fusion des stratégies est que les stratégies du DDC cloud contiennent les paramètres et les filtres qu’elles avaient déjà en plus de tous les nouveaux paramètres et filtres importés. Notez que lorsque des collisions de paramètres et de filtres se produisent, les valeurs importées prévalent.\||SwitchParameter|
|`OnErrorAction`|Consultez \[Paramètre OnErrorAction]\(/fr-fr/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).\||String| <!--- table-end --->

Valeurs renvoyées :

-  Consultez [Valeurs renvoyées par les cmdlets](#cmdlet-return-values)
  • Remove-CvadAcFromSite – Supprime les membres des composants du cloud.

    Peut réinitialiser l’ensemble du site ou supprimer des éléments membres d’un composant (par exemple, supprimer un catalogue de machines de la liste des catalogues). Cela peut être utilisé en conjonction avec le paramètre IncludeByName pour supprimer sélectivement des membres spécifiques.

    Paramètres :

|Nom|Description|Obligatoire ?|Type|
|---|---|---|---|
|Migrer par composants|Consultez \[Migrer par composants]\(#migrate-by-components)\||SwitchParameters|
|Filtrage par noms d’objets|Consultez \[Filtrage par noms d’objets]\(#filtering-by-object-names)\||List of strings|
|Paramètres d’accès au cloud|Consultez \[Paramètres d’accès au cloud]\(#cloud-accessing-parameters)\||SwitchParameters|
|`Quiet`|Supprime la journalisation dans la console.\||SwitchParameter|
|`DisplayLog`|Affiche le fichier journal à la fin de la cmdlet. Définissez sur `$false` pour supprimer l’affichage du journal.\||`$true` ou `$false`| <!--- table-end --->

Valeurs renvoyées :

-  Consultez [Valeurs renvoyées par les cmdlets](#cmdlet-return-values)

Autres cmdlets de base

  • Compare-CvadAcToSite – Compare les fichiers .yml locaux avec la configuration cloud, produisant un rapport des modifications apportées par une cmdlet Import, Merge ou Restore.

    Paramètres :

|Nom|Description|Obligatoire ?|Type|
|---|---|---|---|
|Migrer par composants|Consultez \[Migrer par composants]\(#migrate-by-components).\||SwitchParameters|
|Filtrage par noms d’objets|Consultez \[Filtrage par noms d’objets]\(#filtering-by-object-names).\||List of strings|
|Paramètres d’accès au cloud|Consultez \[Paramètres d’accès au cloud]\(#cloud-accessing-parameters).\||SwitchParameters|
|`SourceFolder`|Identifie un dossier racine de substitution pour \*%HOMEPATH%\Documents\Citrix\AutoConfig\*.\||String|
|`Locale`|Spécifie la langue du texte lisible par l’homme qui peut être exporté.\||String|
|`Quiet`|Supprime la journalisation dans la console.\||SwitchParameter|
|`DisplayLog`|Affiche le fichier journal à la fin de la cmdlet. Définissez sur `$false` pour supprimer l’affichage du journal.\||`$true` ou `$false`|
|`Merge`|Lorsque défini 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 défini sur `$true`, ajoute uniquement de 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`|Consultez \[Paramètre OnErrorAction]\(/fr-fr/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).\||String| <!--- table-end --->

Valeurs renvoyées :

-  Consultez [Valeurs renvoyées par les cmdlets](#cmdlet-return-values)

Paramètres de migration granulaire

Migrer par composants

Les composants suivants peuvent être spécifiés avec les cmdlets qui les prennent en charge. 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

Migration par noms de composants

Les paramètres IncludeByName et ExcludeByName permettent d’inclure et d’exclure des membres de composants dans les cmdlets par nom. Un seul composant (par exemple, les groupes de mise à disposition) peut être choisi à la fois dans l’une des cmdlets prises en charge. Si un membre de composant se trouve dans les deux zones, l’exclusion annule tout autre paramètre et une entrée est effectuée dans la liste de correction du journal, identifiant le composant et le nom du membre qui a été exclu.

IncludeByName et ExcludeByName acceptent une liste de noms de membres de composants. Tout nom peut 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 si un nom de membre contient des caractères spéciaux.

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

IncludeByName et ExcludeByName peuvent également prendre un fichier contenant une liste de membres où chaque membre peut être explicite ou contenir des caractères génériques. Chaque ligne dans le fichier peut contenir un membre. Les espaces de début et de fin sont supprimés du nom du membre. Le nom du 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.

Un exemple de fusion de tous les groupes de mise à disposition dont les noms commencent par DgSite1 et contiennent Home2 serait écrit comme suit :

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

Par nom de groupe de mise à disposition

ByDeliveryGroupName filtre par le 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 de noms de groupes de mise à disposition. Tout nom peut 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 référencent tous les noms de groupes de mise à disposition commençant par EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Exclure les éléments désactivés

ExcludeDisabled filtre toutes les applications et tous les groupes d’applications désactivés des opérations d’importation. ExcludeDisabled est défini par défaut sur false, 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ù tout nom peut 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 et de l’utilisation de ByMachineName, si 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 :

L’utilisation de ByMachineName dans toute cmdlet de type importation entraîne la définition de MergeMachines sur $true.

Fusionner les machines

MergeMachines, lorsqu’il est 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 supprimées, ce qui permet des opérations additives incrémentielles.

MergeMachines est défini par défaut sur false, ce qui signifie que les machines sont supprimées si elles ne sont pas présentes dans le catalogue de machines ou le fichier .yml 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 prérequis

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

    Paramètres :

|Nom|Description|Obligatoire ?|Type|
|---|---|---|---|
|`CustomerId`|ID du client.|x|String|
|`ClientId`|ID client du client créé sur Citrix Cloud. Le CustomerId et le Secret doivent être spécifiés lors de l'utilisation de ce paramètre.|Conditionally|String|
|`Secret`|Clé secrète du client créée sur Citrix Cloud. Le CustomerId et le ClientId doivent être spécifiés lors de l'utilisation de ce paramètre.|Conditionally|String|
|`Environment`|Environnement Production, ProductionGov ou ProductionJP.\||Enumeration|
|`LogFileName`|Modifie le préfixe du fichier journal de CitrixLog à autre chose.\||String|
|`AltRootUrl`|À utiliser uniquement sous la direction de Citrix.\||String|
|`StopOnError`|Arrête l'opération à la première erreur.\||`$true` ou `$false`|
|`TargetFolder`|Utilise le dossier spécifié comme dossier racine au lieu de \*%HOMEPATH%\Documents\Citrix\AutoConfig\*.\||String|
|`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é.\||String|
|`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 de fichier entièrement qualifiée de l'éditeur et l'éditeur doit prendre la spécification de fichier journal comme seul paramètre.\||String|
|`SecurityCsvFileSpec`|La spécification de fichier entièrement qualifiée pointant vers le fichier SecurityClient.csv téléchargé depuis Citrix Identity and Access Management. Le CustomerId doit être spécifié lors de l'utilisation de ce paramètre.\||String| <!--- table-end --->

Retourne :

-  Voir [Valeurs de retour des applets de commande](#cmdlet-return-values)
  • 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|Obligatoire ?|Type|
|---|---|---|---|
|`CustomerId`|ID du client.\||String|
|`ClientId`|ID client du client créé sur Citrix Cloud.\||String|
|`Secret`|Clé secrète du client créée sur Citrix Cloud.\||String|
|`Environment`|Environnement Production, ProductionGov ou ProductionJP.\||Enumeration|
|`LogFileName`|Modifie le préfixe du fichier journal de CitrixLog à autre chose.\||String|
|`StopOnError`|Arrête l'opération à la première erreur.\||`$true` ou `$false`|
|`TargetFolder`|Utilise le dossier spécifié comme dossier racine au lieu de \*%HOMEPATH%\Documents\Citrix\AutoConfig\*.\||String|
|`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é.\||String|
|`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 de fichier entièrement qualifiée de l'éditeur et l'éditeur doit prendre la spécification de fichier journal comme seul paramètre.\||String|
|`SecurityCsvFileSpec`|La spécification de fichier entièrement qualifiée pointant vers le fichier SecurityClient.csv téléchargé depuis Citrix Identity and Access Management. Le CustomerId doit être spécifié lors de l'utilisation de ce paramètre.\||String| <!--- table-end --->

Retourne :

-  Voir [Valeurs de retour des applets de commande](#cmdlet-return-values)

Paramètres liés aux prérequis

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 prérequis :

  • Environment – Environnement Production ou ProductionGov.
  • LogFileName – Modifie le préfixe du fichier journal de CitrixLog à autre chose.
  • StopOnError – Arrête l’opération à 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 de fichier entièrement qualifiée de l’éditeur et l’éditeur doit prendre la spécification de fichier journal comme seul paramètre.

Applets de commande de support et de dépannage

  • New-CvadAcZipInfoForSupport – Compresse tous les fichiers journaux et .yml dans un seul fichier zip à envoyer à Citrix pour le support. Les informations sensibles du client (CustomerInfo.yml et CvadAcSecurity.yml) ne sont pas incluses dans le fichier 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’heure. Ce fichier zip peut également servir de sauvegarde.

    Paramètres :

|Nom|Description|Obligatoire ?|Type|
|---|---|--|--|
|`TargetFolder`|Spécifie un dossier cible pour créer et enregistrer le fichier zip.\||String|
|`Quiet`|Supprime la journalisation dans la console.\||SwitchParameter|

Retourne :

-  Le fichier zip avec le nom et l'emplacement du fichier zip est affiché dans l'invite de commande.
  • Get-CvadAcStatus – Permet de tester la connectivité et de s’assurer que tous les prérequis sont remplis. Renvoie des informations sur l’outil, telles que le numéro de version, la connectivité avec le cloud et l’état du connecteur.

    Paramètres :

    Nom Description Obligatoire ? Type
    Paramètres d’accès au cloud Voir Paramètres d’accès au cloud SwitchParameters
    SiteId Identifie le site auquel se connecter. String
    AdminAddress Il s’agit de l’adresse DNS ou IP du Delivery Controller sur site utilisée pour vérifier le niveau d’accès des administrateurs. Ceci est requis si l’outil n’est pas exécuté sur un Delivery Controller. String

Valeur renvoyée :

  • 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 cmdlet 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 Obligatoire ? Type
    Paramètres d’accès au cloud Voir Paramètres d’accès au cloud SwitchParameters
    Quiet Supprime la journalisation dans la console. SwitchParameter

    Valeur renvoyée :

    • Les résultats du test sont affichés sur la ligne de commande.
  • Find-CvadAcConnector - Localise les connecteurs existants et détermine leur état d’exécution. Cette cmdlet utilise les informations du fichier CustomerInfo.yml ou le paramètre d’ID client pour localiser les connecteurs du client.

    Paramètres :

    Nom Description Obligatoire ? Type
    CustomerInfoFileSpec La 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. String
    CustomerId L’ID du client. Ce paramètre remplace la même valeur dans le fichier CustomerInfo.yml. String

    Valeur renvoyée :

    • Les résultats sont affichés sur la ligne de commande.
  • Get-CvadAcCustomerSites - Renvoie la liste de tous les sites clients. Cette cmdlet 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 :

    Valeur renvoyée :

    • Affiche une liste des ID de sites clients trouvés.
  • New-CvadAcTemplateToFile – Crée un fichier de modèle pour les composants sélectionnés, vous permettant de créer manuellement un fichier d’importation.

    Paramètres :

    Nom Description Obligatoire ? Type
    Migrer par composants Voir Migrer par composants SwitchParameters
    TargetFolder Spécifie le dossier de destination de l’exportation. String

    Valeur renvoyée :

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

    Paramètres :

  • Aucun.

Retourne :

  • Affiche cette page web dans le navigateur web par défaut.

  • Find-CvadAcInFile - La fonction de recherche dans les fichiers recherche dans les fichiers YAML des composants les 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 recherche dans les fichiers ne peut rechercher qu’un seul composant à la fois. La recherche dans les fichiers recherche tous les fichiers YAML dans le dossier actuel et tous les sous-dossiers. Utilisez FindSourceFolder pour limiter le nombre de fichiers à rechercher.

Paramètres :

Nom Description Obligatoire ? 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 l’activation de l’état actif du site. Les caractères génériques « * » et « ? » sont pris en charge dans les noms.   Liste de chaînes
Unique Signale uniquement les membres uniques trouvés.   SwitchParameter
IncludeYaml Inclut le fichier YAML spécifique au membre.   SwitchParameter
FindSourceFolder Dossier dans lequel la recherche commence.   Chaîne
DisplayLog Affiche le fichier journal à la fin de l’exécution de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.   SwitchParameter
Quiet Supprime la journalisation dans la console.   SwitchParameter

Retourne :

  • 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 des sites et l’utilisation de ces applets de commande, consultez Activation des sites.

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

Paramètres :

Nom Description Obligatoire ? Type
Paramètres d’accès au cloud Voir Paramètres d’accès au cloud   SwitchParameters
SiteActive Lorsqu’il est présent, définit le site sur site comme actif, supprimant 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 l’activation de l’état actif du site. Les caractères génériques « * » et « ? » sont pris en charge dans les noms.   Liste de chaînes
ExcludeByName Liste spécifiant les noms des groupes de mise à disposition à exclure lors de l’activation de l’état actif du site. Les caractères génériques « * » et « ? » sont pris en charge dans les noms.   Liste de chaînes
Quiet Supprime la journalisation dans la console.   SwitchParameter
DisplayLog Affiche le fichier journal à la fin de l’exécution de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.   $true ou $false

Retourne :

Paramètres :

Nom Description Obligatoire ? Type
Paramètres d’accès au cloud Voir Paramètres d’accès au cloud   SwitchParameters
SiteActive Lorsqu’il est présent, définit le site cloud comme actif, supprimant 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 l’activation de l’état actif du site. Les caractères génériques « * » et « ? » sont pris en charge dans les noms.   Liste de chaînes
ExcludeByName Liste spécifiant les noms des groupes de mise à disposition à exclure lors de l’activation de l’état actif du site. Les caractères génériques « * » et « ? » sont pris en charge dans les noms.   Liste de chaînes
Quiet Supprime la journalisation dans la console.   SwitchParameter
DisplayLog Affiche le fichier journal à la fin de l’exécution de l’applet de commande. Définissez sur $false pour supprimer l’affichage du journal.   $true ou $false

Retourne :

Applets de commande de fusion de plusieurs sites sur site

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

  • New-CvadAcSiteMergingInfo - Crée un ensemble d’informations de 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 Obligatoire ? Type
SiteName Nom utilisé pour identifier l’ensemble de préfixes/suffixes pour un site spécifique. Il peut correspondre au nom du site réel, mais ce n’est pas obligatoire. x Chaîne
Paramètres de fusion de site Voir Paramètres de fusion de site   SwitchParameters
Quiet Supprime la journalisation dans la console.   SwitchParameter

Retourne :

  • Aucun

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

    Paramètres :

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

    Retours :

    • Aucun
  • Remove-CvadAcSiteMergingInfo - Supprime un ensemble d’informations de 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 et il est obligatoire.

    Retours :

    • Aucun

Paramètres de fusion de site

Les paramètres suivants peuvent être utilisés lors de l’exécution des cmdlets de fusion de site. Tous les paramètres listés sont des chaînes de caractères.

  • SiteName – le nom utilisé pour identifier l’ensemble des préfixes/suffixes pour un site spécifique. Il peut correspondre au nom du site réel, mais ce n’est pas obligatoire. SiteName est un paramètre obligatoire.
  • AdminScopedPrefix – le préfixe à appliquer aux étendues d’administrateur.
  • ApplicationPrefix - le préfixe à appliquer aux applications.
  • ApplicationFolderPrefix – le préfixe à appliquer aux dossiers d’application ; ApplicationFolderPrefix peut être combiné avec ApplicationFolderRoot.
  • ApplicationFolderRoot – le nouveau dossier racine pour les dossiers d’application. Cela crée une hiérarchie de dossiers supplémentaire. ApplicationFolderRoot peut être combiné avec ApplicationFolderPrefix.
  • ApplicationGroupPrefix – le préfixe pour les groupes d’applications.
  • ApplicationUserPrefix – le préfixe à appliquer au nom de l’application que l’utilisateur voit.
  • ApplicationAdminPrefix – le préfixe à appliquer au nom de l’application que l’administrateur voit.
  • DeliveryGroupPrefix – le préfixe à appliquer aux groupes de mise à disposition.
  • GroupPolicyPrefix – le préfixe à appliquer aux noms de stratégie.
  • HostConnectionPrefix – le préfixe à appliquer aux connexions d’hôte.
  • MachineCatalogPrefix – le préfixe à appliquer aux catalogues de machines.
  • StoreFrontPrefix – le préfixe à appliquer aux noms StoreFront™.
  • TagPrefix – le préfixe à appliquer aux balises.
  • AdminScopedSuffix – le suffixe à appliquer aux étendues d’administrateur.
  • ApplicationSuffix - le suffixe à appliquer aux applications.
  • ApplicationFolderSuffix – le suffixe à appliquer aux dossiers d’application ; ApplicationFolderSuffix peut être combiné avec ApplicationFolderRoot.
  • ApplicationGroupSuffix – le suffixe pour les groupes d’applications.
  • ApplicationUserSuffix – le suffixe à appliquer au nom de l’application que l’utilisateur voit.
  • ApplicationAdminSuffix – le suffixe à appliquer au nom de l’application que l’administrateur voit.
  • DeliveryGroupSuffix – le suffixe à appliquer aux groupes de mise à disposition.
  • GroupPolicySuffix – le suffixe à appliquer aux noms de stratégie.
  • HostConnectionSuffix – le suffixe à appliquer aux connexions d’hôte.
  • MachineCatalogSuffix – le suffixe à appliquer aux catalogues de machines.
  • StoreFrontSuffix – le suffixe à appliquer aux noms StoreFront.
  • TagSuffix – le suffixe à appliquer aux balises.
  • SiteRootFolder – le 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 cmdlets accédant au cloud prennent en charge les paramètres supplémentaires suivants.

Remarque :

Les paramètres CustomerId, ClientId et Secret peuvent être placés dans le fichier CustomerInfo.yml ou spécifiés avec la cmdlet à l’aide des paramètres suivants. Lorsqu’ils sont spécifiés aux deux endroits, les paramètres de la cmdlet ont la priorité.

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

Paramètres du mode de migration

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

  • 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 qu’elle ne se produise.
  • 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. La cmdlet Remove affiche une invite en raison de sa nature destructive. Définissez sur false si aucune invite n’est souhaitée, par exemple lors de l’exécution dans des scripts automatisés. Confirm est défini sur true par défaut.
  • SecurityFileFolder – Il s’agit du dossier complet contenant le fichier CustomerInfo.yml qui peut pointer vers un dossier local ou un dossier de partage réseau pouvant être 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 l’ensemble de préfixes et suffixes de fusion de site à utiliser lors de l’importation.
  • SiteActive – Spécifie 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 cmdlets Export, Import, Sync, Restore, Backup, Compare et Remove affichent le fichier journal une fois l’opération terminée. 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.

Éditeur : C:\Program Files\Notepad++\notepad++.exe

Valeurs de retour des cmdlets

ActionResult

Toutes les cmdlets renvoient la valeur suivante.

Applets de commande de l’outil de configuration automatisée pour la migration