Documentation produit
Citrix DaaS
Voir PDF

Applets de commande d’outils de configuration automatisée pour la sauvegarde et la restauration

September 15, 2025
Contributeur: 
C

Cette page répertorie tous les paramètres et applets de commande pris en charge par l’outil pour déclencher les API de sauvegarde et de restauration utilisées par Studio.

Applets de commande de stockage de sauvegarde

Get-BckRstrStorage

Cette applet de commande ne s’applique qu’aux applications locales. Obtient des informations sur le stockage dans lequel les sauvegardes sont enregistrées.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.

Set-BckRstrStorage

Cette applet de commande ne s’applique qu’aux applications locales. Définit un nouveau stockage dans lequel enregistrer les sauvegardes.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
MaximumBackups Nombre maximum de sauvegardes non épinglées à conserver jusqu’à ce que le processus de nettoyage des sauvegardes supprime les plus anciennes lors de la création de nouvelles sauvegardes.
MaximumPinnedBackups Nombre maximum de sauvegardes épinglées à conserver. Ces sauvegardes ne sont pas supprimées lors du processus de nettoyage.
BlobStorageType Type de stockage : FileStorage ou CustomerAzure Storage.
FileStoragefolder Spécification de dossier complète pour l’option BlobStorageType FileStorage.
Info1
Pour FileStorage, UserName facultatif
Pour CustomerAzure Storage, l’URL Azure SAS
Info2 Pour FileStorage, mot de passe facultatif
Info3 et Info4 Non utilisé

Test-BCKRSTR Storage

Cette applet de commande ne s’applique qu’aux applications locales. Tests visant à déterminer si le stockage défini est valide.

Pour FileStorage, le test vérifie que le dossier existe et qu’il est possible d’y écrire.

Pour CustomerAzureStorage, le test vérifie que l’URL SAS dispose des autorisations appropriées et que la date actuelle correspond à la date de début et de fin de l’URL.

Renvoie true s’il est valide et false s’il n’est pas valide.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.

Applets de commande de sauvegarde

Get-BckRstrBackups

Énumère les sauvegardes stockées dans l’emplacement de stockage blob de sauvegarde ou de restauration. Pour Citrix Virtual Apps and Desktops, cet emplacement est configuré par l’administrateur via WebStudio. Pour le DaaS, il s’agit du stockage Azure du client préexistant. Pour obtenir des informations complètes sur chaque sauvegarde, utilisez Get-BckRstrBackupsWithDetiails. Les détails de sauvegarde incluent les éléments suivants :

  • Nom de la sauvegarde
  • Remarques
  • Épinglé (vrai ou faux)
  • Date et heure de sauvegarde
  • Historique UID
  • UID associé (UID du dernier enregistrement d’historique de restauration)
  • Date et heure associées
  • Associé, s’il est exécuté en mode vérification
  • Durée en secondes
  • Nom de l’administrateur
  • Détails énumérant chaque composant et le nombre de membres dans chacun d’eux.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.

Get-BckRstrBackupsMembers

Énumère les membres d’un seul composant stockés dans une sauvegarde sélectionnée. Les noms des membres sont renvoyés dans une liste simple.

Les composants sont les suivants :

  • Balises
  • Étendues d’administration
  • Rôles d’administrateur
  • AdminAdministrators (sur site uniquement)
  • Connexions hôtes
  • Icônes
  • Dossiers d’administration
  • Catalogues de machines
  • StoreFront
  • Groupes de mise à disposition
  • Groupes d’applications
  • Dossiers d’application
  • Applications
  • Serveurs AppV
  • Détection de packages App-Lib
  • Groupes d’isolement AppV
  • Stratégies de groupe
  • Préférences de zone utilisateur
  • Données du site
  • Zones (sur site uniquement)

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.
Component Composants à inclure dans la sauvegarde.

New-BCKRSTR Backup

Lance une nouvelle action de sauvegarde sur le Delivery Controller. Cette action est asynchrone par rapport à l’applet de commande New-BckRstrBackup.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
Remarques Notes concernant la sauvegarde.
PollForCompletion Paramètre permettant d’interroger l’action exécutée sur le Delivery Controller jusqu’à ce que celle-ci soit terminée. L’interrogation enregistre la progression et les résultats d’achèvement sur la console à moins que le paramètre Quite ne soit spécifié.

Applets de commande Épingler une sauvegarde

Set-BckRstrPinBackups

Épingle une sauvegarde afin qu’elle ne soit pas supprimée lors du processus de nettoyage des sauvegardes du Delivery Controller.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.

Set-BckRstrUnpinBackups

Annule l’épinglage d’une sauvegarde afin qu’elle puisse être supprimée lors du processus de nettoyage des sauvegardes du Delivery Controller.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.

Applet de commande Supprimer une sauvegarde

Remove-BckRstrBackup

Supprime une ou plusieurs sauvegardes.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
IncludeByName Filtre permettant de spécifier les membres du composant à prendre en compte pour la restauration. Il s’agit d’une liste de valeurs de filtre séparées par des virgules et pouvant contenir les caractères génériques * et ?.

Applets de commande Sauvegardes planifiées

Get-BckRstrSchedules

Obtient la liste des planifications de sauvegarde.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.
Remarques Les notes à définir ou à modifier.

New-BckRstrSchedule

Crée une planification de sauvegarde.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
Nom Nom de la planification.
Frequency Type de fréquence : quotidienne, hebdomadaire ou mensuelle.
Day Si la fréquence est quotidienne.
DaysInWeek Si la fréquence est hebdomadaire.
DayInMonth Si la fréquence est mensuelle.
WeekInMonth Si la fréquence est mensuelle.
StartDate Le format est M/j/aa.
StartTime Heure de début spécifiée par une horloge de 24 heures.
FrequencyFactor Nombre n d’exécutions, par exemple tous les jours (valeur = 1) ou tous les deux jours (valeur = 2)
Description Description de la sauvegarde planifiée
Enabled Paramètre permettant d’activer cette planification de sauvegarde. True lorsqu’il est activé et false lorsqu’il est désactivé.
TimeZoneId Identifiant du fuseau horaire de Windows

Set-BckRstrSchedule

Modifie une planification de sauvegarde. Entrez le nom ou l’UID pour sélectionner la planification à modifier.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
Nom Nom de la planification.
Uid Détermine si le nom de la planification doit être modifié.
Frequency Type de fréquence : quotidienne, hebdomadaire ou mensuelle.
Day Si la fréquence est quotidienne.
DaysInWeek Si la fréquence est hebdomadaire.
DayInMonth Si la fréquence est mensuelle.
WeekInMonth Si la fréquence est mensuelle.
StartDate Le format est M/j/aa.
StartTime Heure de début spécifiée par une horloge de 24 heures.
FrequencyFactor Nombre n d’exécutions, par exemple tous les jours (valeur = 1) ou tous les deux jours (valeur = 2)
Description Description de la sauvegarde planifiée
Enabled Paramètre permettant d’activer cette planification de sauvegarde. True lorsqu’il est activé et false lorsqu’il est désactivé.
TimeZoneId Identifiant du fuseau horaire de Windows

Set-BckRstrScheduleEnabled

Active une planification de sauvegarde. Entrez le nom ou l’UID pour sélectionner la planification à activer.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
Nom Nom de la planification.
Uid Détermine si le nom de la planification doit être modifié.

Set-BckRstrScheduleDisabled

Désactive une planification de sauvegarde. Fournissez le nom ou l’UID pour sélectionner la planification à désactiver.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
Nom Nom de la planification.
Uid Détermine si le nom de la planification doit être modifié.

Applet de commande de limitation des sauvegardes

Set-BckRstrOptions

Limite les sauvegardes planifiées à une par jour afin d’éviter les sauvegardes identiques.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
OneScheduledBackupPerDay Paramètre permettant de limiter les sauvegardes planifiées à une par jour afin d’éviter des sauvegardes identiques.

Applet de commande de restauration

Restore-BckRstrBackups

Restaure les membres d’un seul composant à partir d’une sauvegarde existante.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.
Component Composants à inclure dans la sauvegarde.
Remarques Notes concernant la sauvegarde.
CheckMode Paramètre permettant d’identifier les membres du composant à restaurer, mais qui n’effectue pas la restauration proprement dite.
RestoreType Type de restauration : MissingOnly ou MissingUpdateExisting
IncludeByName Filtre permettant de spécifier les membres du composant à prendre en compte pour la restauration. Il s’agit d’une liste de valeurs de filtre séparées par des virgules et pouvant contenir les caractères génériques * et ?.

Applets de commande d’historique

Get-BckRstrHistory

Obtient une liste des détails de l’historique de toutes les actions.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.

Get-BckRstrSpecificBackupHistory

Obtient une liste de détails d’historique pour une sauvegarde spécifique.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.

Set-BckRstrNotes

Définit ou modifie les notes d’un enregistrement d’historique.

Paramètres:

Paramètre Description
CustomerId Identifiant client nécessaire pour obtenir un jeton de porteur.
CientId Identifiant client nécessaire pour obtenir un jeton de porteur.
Secret Secret nécessaire pour obtenir un jeton de porteur.
CustomerInforFileSpec Spécification complète du fichier d’informations client contenant des informations relatives à la sécurité et à l’environnement.
ProfileName Paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez l’article XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir des profils de sécurité.
Environment Type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
Quiet Paramètre permettant de supprimer la sortie vers la console.
BackupName Nom de la sauvegarde. L’extension .zip est facultative.
Remarques Les notes à définir ou à modifier.
Applets de commande d’outils de configuration automatisée pour la sauvegarde et la restauration
September 15, 2025
Contributeur: 
C
September 15, 2025
Contributeur: 
C

Dans cet article

Commentaires sur le site | Your privacy choices footer linkVos préférences de confidentialité | Confidentialité et conditions légales | Préférences de cookies | Paramètres de consentement | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.