Citrix DaaS™

Cmdlets de l’outil de configuration automatisée pour la sauvegarde et la restauration

March 25, 2026

Contributeur:

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

Cmdlets de stockage de sauvegarde

Get-BckRstrStorage

Cette cmdlet s’applique uniquement aux déploiements sur site. Elle récupère les détails du stockage où les sauvegardes sont enregistrées.

Paramètres :

Set-BckRstrStorage

Cette cmdlet s’applique uniquement aux déploiements sur site. Elle définit un nouveau stockage où les sauvegardes sont enregistrées.

Paramètres :

|Paramètre|Description| |—|—| |CustomerId|L’ID client nécessaire pour obtenir un jeton de porteur.| |CientId|L’ID client nécessaire pour obtenir un jeton de porteur.| |Secret|Le secret nécessaire pour obtenir un jeton de porteur.| |CustomerInforFileSpec|La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.| |ProfileName|Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez [XenApp & XenDesktop : Remote PowerShell SDK v2 pour Citrix Cloud](https://www.citrix.com/blogs/2016/07/01/introducing-remote-powershell-sdk-v2-for-citrix-cloud/) pour savoir comment définir des profils de sécurité.| |Environment|Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.| |Quiet|Le paramètre permettant de supprimer la sortie vers la console.| |MaximumBackups|Le nombre maximal de sauvegardes non épinglées à conserver jusqu’à ce que le processus de nettoyage des sauvegardes supprime les sauvegardes les plus anciennes lorsque de nouvelles sauvegardes sont créées.| |MaximumPinnedBackups|Le nombre maximal de sauvegardes épinglées à conserver. Ces sauvegardes ne sont pas supprimées par le processus de nettoyage.| |BlobStorageType|Le type de stockage : FileStorage ou CustomerAzureStorage.| |FileStoragefolder|La spécification de dossier entièrement qualifiée pour l’option FileStorage de BlobStorageType.| |Info1|Pour FileStorage, UserName facultatif| |^^|^^ Pour CustomerAzureStorage, l’URL SAS Azure| |Info2|Pour FileStorage, mot de passe facultatif| |Info3 et Info4|Non utilisés|

Test-BckRstrStorage

Cette cmdlet s’applique uniquement aux déploiements sur site. Elle teste si le stockage défini est valide.

Pour FileStorage, le test vérifie que le dossier existe et qu’il est accessible en écriture.

Pour CustomerAzureStorage, le test vérifie que l’URL SAS dispose des autorisations correctes et que la date actuelle se situe entre la date de début et la date de fin de l’URL.

Renvoie true si valide et false si invalide.

Paramètres :

Cmdlets de sauvegarde

Get-BckRstrBackups

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

Nom de la sauvegarde
Notes
Épinglé (true ou false)
Date et heure de la sauvegarde
UID de l’historique
UID associé (UID du dernier enregistrement d’historique de restauration)
Date et heure associées
Associé si 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 chaque composant.

Paramètres :

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 :

Tags
AdminScopes
AdminRoles
AdminAdministrators (uniquement sur site)
HostConnections
Icons
AdminFolders
MachineCatalogs
StoreFronts
DeliveryGroups
ApplicationGroups
ApplicationFolders
Applications
AppVServers
AppLibPackageDiscovery
AppVIsolationGroups
GroupPolicies
UserZonePreferences
SiteData
Zones (uniquement sur site)

Paramètres :

New-BckRstrBackup

Démarre 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|L’ID client nécessaire pour obtenir un jeton de porteur.| |CientId|L’ID client nécessaire pour obtenir un jeton de porteur.| |Secret|Le secret nécessaire pour obtenir un jeton de porteur.| |CustomerInforFileSpec|La spécification de fichier entièrement qualifiée du fichier d’informations client contenant des informations de sécurité et d’environnement.| |ProfileName|Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez [XenApp & XenDesktop : SDK PowerShell distant v2 pour Citrix Cloud](https://www.citrix.com/blogs/2016/07/01/introducing-remote-powershell-sdk-v2-for-citrix-cloud/) pour savoir comment définir les profils de sécurité.| |Environment|Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.| |Quiet|Le paramètre permettant de supprimer la sortie vers la console.| |Notes|Les notes concernant la sauvegarde.| |PollForCompletion|Le paramètre permettant d’interroger l’action en cours d’exécution sur le Delivery Controller jusqu’à ce que l’action se termine. L’interrogation enregistre la progression et les résultats d’achèvement dans la console, sauf si le paramètre Quite est spécifié.|

Applets de commande d’épinglage de sauvegardes

Set-BckRstrPinBackups

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

Paramètres :

|Paramètre|Description| |–|–| |CustomerId|L’ID client nécessaire pour obtenir un jeton de porteur.| |CientId|L’ID client nécessaire pour obtenir un jeton de porteur.| |Secret|Le secret nécessaire pour obtenir un jeton de porteur.| |CustomerInforFileSpec|La spécification de fichier entièrement qualifiée du fichier d’informations client contenant des informations de sécurité et d’environnement.| |ProfileName|Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez [XenApp & XenDesktop : SDK PowerShell distant v2 pour Citrix Cloud](https://www.citrix.com/blogs/2016/07/01/introducing-remote-powershell-sdk-v2-for-citrix-cloud/) pour savoir comment définir les profils de sécurité.| |Environment|Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.| |Quiet|Le paramètre permettant de supprimer la sortie vers la console.| |BackupName|Le nom de la sauvegarde. L’extension .zip est facultative.|

Set-BckRstrUnpinBackups

Désépingle une sauvegarde afin qu’elle puisse être supprimée dans le cadre du processus de nettoyage des sauvegardes du Delivery Controller.

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant des informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop : SDK PowerShell distant v2 pour Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`BackupName`	Le nom de la sauvegarde. L’extension `.zip` est facultative.

Applet de commande de suppression de sauvegarde

Remove-BckRstrBackup

Supprime une ou plusieurs sauvegardes.

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`IncludeByName`	Le 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 `?`.

Cmdlets de sauvegardes planifiées

Get-BckRstrSchedules

Obtient une liste de planifications de sauvegarde.

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`BackupName`	Le nom de la sauvegarde. L’extension `.zip` est facultative.
`Notes`	Les notes à définir ou à modifier.

New-BckRstrSchedule

Crée une nouvelle planification de sauvegarde.

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`Name`	Le nom de la planification.
`Frequency`	Le 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/d/yy`
`StartTime`	L’heure de début spécifiée au format 24 heures.
`FrequencyFactor`	Exécuter toutes les n fois, par exemple tous les jours (valeur = 1) ou tous les deux jours (valeur = 2)
`Description`	La description de la sauvegarde planifiée
`Enabled`	Le paramètre permettant d’activer cette planification de sauvegarde. `True` si activée et `false` si désactivée
`TimeZoneId`	L’ID de fuseau horaire Windows

Set-BckRstrSchedule

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`Name`	Le nom de la planification.
`Uid`	Si le nom de la planification doit être modifié.
`Frequency`	Le 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/d/yy`
`StartTime`	L’heure de début spécifiée au format 24 heures.
`FrequencyFactor`	Exécuter toutes les n fois, par exemple tous les jours (valeur = 1) ou tous les deux jours (valeur = 2)
`Description`	La description de la sauvegarde planifiée
`Enabled`	Le paramètre permettant d’activer cette planification de sauvegarde. `True` si activée et `false` si désactivée
`TimeZoneId`	L’ID de fuseau horaire Windows

Set-BckRstrScheduleEnabled

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`Name`	Le nom de la planification.
`Uid`	Si le nom de la planification doit être modifié.

Set-BckRstrScheduleDisabled

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton de porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton de porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`Name`	Le nom de la planification.
`Uid`	Si le nom de la planification doit être modifié.

Cmdlet 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`	L’ID client nécessaire pour obtenir un jeton du porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton du porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`OneScheduledBackupPerDay`	Le paramètre permettant de limiter les sauvegardes planifiées à une par jour afin d’éviter les sauvegardes identiques.

Cmdlet de restauration

Restore-BckRstrBackups

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton du porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`BackupName`	Le nom de la sauvegarde. L’extension `.zip` est facultative.
`Component`	Les composants à inclure dans la sauvegarde.
`Notes`	Les notes concernant la sauvegarde.
`CheckMode`	Le paramètre permettant d’identifier les membres du composant qui seraient restaurés, mais n’effectue pas la restauration réelle.
`RestoreType`	Le type de restauration : MissingOnly ou MissingUpdateExisting
`IncludeByName`	Le 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 peut contenir les caractères génériques `*` et `?`.

Cmdlets d’historique

Get-BckRstrHistory

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton du porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.

Get-BckRstrSpecificBackupHistory

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton du porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`BackupName`	Le nom de la sauvegarde. L’extension `.zip` est facultative.

Set-BckRstrNotes

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

Paramètres :

Paramètre	Description
`CustomerId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`CientId`	L’ID client nécessaire pour obtenir un jeton du porteur.
`Secret`	Le secret nécessaire pour obtenir un jeton du porteur.
`CustomerInforFileSpec`	La spécification de fichier entièrement qualifiée du fichier d’informations client contenant les informations de sécurité et d’environnement.
`ProfileName`	Le paramètre permettant d’identifier un profil de sécurité existant utilisé à la place des paramètres précédents. Consultez XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud pour savoir comment définir les profils de sécurité.
`Environment`	Le type d’environnement de production : Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	Le paramètre permettant de supprimer la sortie vers la console.
`BackupName`	Le nom de la sauvegarde. L’extension `.zip` est facultative.
`Notes`	Les notes à définir ou à modifier.

La version officielle de ce document est en anglais. Certains contenus de la documentation Cloud Software Group ont été traduits de façon automatique à des fins pratiques uniquement. Cloud Software Group n'exerce aucun contrôle sur le contenu traduit de façon automatique, qui peut contenir des erreurs, des imprécisions ou un langage inapproprié. Aucune garantie, explicite ou implicite, n'est fournie quant à l'exactitude, la fiabilité, la pertinence ou la justesse de toute traduction effectuée depuis l'anglais d'origine vers une autre langue, ou quant à la conformité de votre produit ou service Cloud Software Group à tout contenu traduit de façon automatique, et toute garantie fournie en vertu du contrat de licence de l'utilisateur final ou des conditions d'utilisation des services applicables, ou de tout autre accord avec Cloud Software Group, quant à la conformité du produit ou service à toute documentation ne s'applique pas dans la mesure où cette documentation a été traduite de façon automatique. Cloud Software Group ne pourra être tenu responsable de tout dommage ou problème dû à l'utilisation de contenu traduit de façon automatique.

Cela vous a-t-il été utile ?

Cmdlets de l’outil de configuration automatisée pour la sauvegarde et la restauration

March 25, 2026

Contributeur:

March 25, 2026

Contributeur:

Dans cet article

Cmdlets de stockage de sauvegarde
Cmdlets de sauvegarde
Applets de commande d’épinglage de sauvegardes
Applet de commande de suppression de sauvegarde
Cmdlets de sauvegardes planifiées
Cmdlet de limitation des sauvegardes
Cmdlet de restauration
Cmdlets d’historique

Cela vous a-t-il été utile ?