Documentazione dei prodotti
Citrix Virtual Apps and Desktops
Service Current Release 2402 LTSR 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
Visualizza PDF

Cmdlet dello strumento di configurazione automatica per il backup e il ripristino

January 23, 2026
Grazie al contributo di: 
C

Questa pagina elenca tutti i cmdlet e i parametri supportati dallo strumento per attivare le API di backup e ripristino utilizzate da Web Studio.

Cmdlet di archiviazione di backup

Get-BckRstrStorage

Questo cmdlet è applicabile solo per le distribuzioni on-premise. Recupera i dettagli per l’archiviazione in cui vengono salvati i backup.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.

Set-BckRstrStorage

Questo cmdlet è applicabile solo per le distribuzioni on-premise. Imposta una nuova posizione di archiviazione in cui vengono salvati i backup.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
MaximumBackups Il numero massimo di backup non bloccati da mantenere finché il processo di pulizia dei backup non rimuove i backup più vecchi quando vengono creati nuovi backup.
MaximumPinnedBackups Il numero massimo di backup bloccati da mantenere. Questi backup non vengono rimossi dal processo di pulizia.
BlobStorageType Il tipo di archiviazione: FileStorage o CustomerAzureStorage.
FileStoragefolder La specifica della cartella completamente qualificata per l’opzione FileStorage di BlobStorageType.
Info1
Per FileStorage, UserName facoltativo
Per CustomerAzureStorage, l’URL SAS di Azure
Info2 Per FileStorage, password facoltativa
Info3 e Info4 Non utilizzati

Test-BckRstrStorage

Questo cmdlet è applicabile solo per le distribuzioni on-premise. Verifica che l’archiviazione definita sia valida.

Per FileStorage, il test verifica che la cartella esista e che sia possibile scrivervi.

Per CustomerAzureStorage, il test verifica che l’URL SAS abbia le autorizzazioni corrette e che la data corrente rientri tra la data di inizio e la data di fine dell’URL.

Restituisce true se valido e false se non valido.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.

Cmdlet di backup

Get-BckRstrBackups

Enumera i backup archiviati nella posizione di archiviazione BLOB di backup o ripristino. Per Citrix Virtual Apps and Desktops™, questa posizione viene configurata dall’amministratore tramite WebStudio. Per DaaS, si tratta dell’archiviazione Azure del cliente preesistente. Utilizzare Get-BckRstrBackupsWithDetiails per informazioni complete su ogni backup. I dettagli del backup includono quanto segue:

  • Nome backup
  • Note
  • Bloccato (vero o falso)
  • Data e ora del backup
  • UID cronologia
  • UID correlato (UID dell’ultimo record della cronologia di ripristino)
  • Data e ora correlate
  • Correlato se eseguito in modalità di controllo
  • Durata in secondi
  • Nome amministratore
  • Dettagli che enumerano ogni componente e il conteggio dei membri in ogni componente.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.

Get-BckRstrBackupsMembers

Enumera i membri di un singolo componente archiviati in un backup selezionato. I nomi dei membri vengono restituiti in un semplice elenco.

I componenti sono:

  • Tags
  • AdminScopes
  • AdminRoles
  • AdminAdministrators (solo on-premise)
  • HostConnections
  • Icons
  • AdminFolders
  • MachineCatalogs
  • StoreFronts
  • DeliveryGroups
  • ApplicationGroups
  • ApplicationFolders
  • Applications
  • AppVServers
  • AppLibPackageDiscovery
  • AppVIsolationGroups
  • GroupPolicies
  • UserZonePreferences
  • SiteData
  • Zones (solo on-premise)

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.
Component I componenti da includere nel backup.

New-BckRstrBackup

Avvia una nuova azione di backup sul Delivery Controller. Questa azione è asincrona rispetto al cmdlet New-BckRstrBackup.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
Notes Le note sul backup.
PollForCompletion Il parametro per eseguire il polling dell’azione in esecuzione sul Delivery Controller fino al completamento dell’azione. Il polling registra l’avanzamento e i risultati del completamento nella console, a meno che non sia specificato il parametro Quiet.

Cmdlet per bloccare i backup

Set-BckRstrPinBackups

Blocca un backup in modo che non venga rimosso come parte del processo di pulizia del backup del Delivery Controller.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.

Set-BckRstrUnpinBackups

Sblocca un backup in modo che sia disponibile per essere rimosso nel processo di pulizia del backup del Delivery Controller.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.

Cmdlet per rimuovere il backup

Remove-BckRstrBackup

Rimuove uno o più backup.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
IncludeByName Il filtro per specificare quali membri del componente considerare per il ripristino. Si tratta di un elenco di valori di filtro separati da virgole e può contenere i caratteri jolly * e ?.

Cmdlet per i backup pianificati

Get-BckRstrSchedules

Recupera un elenco di pianificazioni di backup.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.
Notes Le note da impostare o modificare.

New-BckRstrSchedule

Crea una nuova pianificazione di backup.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
Name Il nome della pianificazione.
Frequency Il tipo di frequenza: Daily (quotidiana), Weekly (settimanale) o Monthly (mensile).
Day Se la frequenza è giornaliera.
DaysInWeek Se la frequenza è settimanale.
DayInMonth Se la frequenza è mensile.
WeekInMonth Se la frequenza è mensile.
StartDate Il formato è M/d/yy
StartTime L’ora di inizio specificata con un orologio a 24 ore.
FrequencyFactor Esegui ogni n volte, ad esempio ogni giorno (valore = 1) o a giorni alterni (valore = 2)
Description La descrizione del backup pianificato
Enabled Il parametro per abilitare questa pianificazione di backup. True se abilitato e false se disabilitato
TimeZoneId L’ID del fuso orario di Windows

Set-BckRstrSchedule

Modifica una pianificazione di backup esistente. Fornire il nome o l’Uid per selezionare la pianificazione da modificare.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
Name Il nome della pianificazione.
Uid Se il nome della pianificazione deve essere modificato.
Frequency Il tipo di frequenza: Daily (quotidiana), Weekly (settimanale) o Monthly (mensile).
Day Se la frequenza è giornaliera.
DaysInWeek Se la frequenza è settimanale.
DayInMonth Se la frequenza è mensile.
WeekInMonth Se la frequenza è mensile.
StartDate Il formato è M/d/yy
StartTime L’ora di inizio specificata con un orologio a 24 ore.
FrequencyFactor Esegui ogni n volte, ad esempio ogni giorno (valore = 1) o a giorni alterni (valore = 2)
Description La descrizione del backup pianificato
Enabled Il parametro per abilitare questa pianificazione di backup. True se abilitato e false se disabilitato
TimeZoneId L’ID del fuso orario di Windows

Set-BckRstrScheduleEnabled

Abilita una pianificazione di backup esistente. Fornire il nome o l’Uid per selezionare la pianificazione da abilitare.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
Name Il nome della pianificazione.
Uid Se il nome della pianificazione deve essere modificato.

Set-BckRstrScheduleDisabled

Disabilita una pianificazione di backup esistente. Fornire il nome o l’Uid per selezionare la pianificazione da disabilitare.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
Name Il nome della pianificazione.
Uid Se il nome della pianificazione deve essere modificato.

Cmdlet per limitare i backup

Set-BckRstrOptions

Limita i backup pianificati a uno al giorno per evitare backup identici.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
OneScheduledBackupPerDay Il parametro per limitare i backup pianificati a uno al giorno per evitare backup identici.

Cmdlet di ripristino

Restore-BckRstrBackups

Ripristina i membri da un singolo componente da un backup esistente.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.
Component I componenti da includere nel backup.
Notes Le note sul backup.
CheckMode Il parametro per identificare i membri del componente che verrebbero ripristinati, ma non esegue il ripristino effettivo.
RestoreType Il tipo di ripristino: MissingOnly o MissingUpdateExisting
IncludeByName Il filtro per specificare quali membri del componente considerare per il ripristino. Si tratta di un elenco di valori di filtro separati da virgole e può contenere i caratteri jolly * e ?.

Cmdlet della cronologia

Get-BckRstrHistory

Recupera un elenco di dettagli della cronologia per tutte le azioni.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.

Get-BckRstrSpecificBackupHistory

Recupera un elenco di dettagli della cronologia per un backup specifico.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.

Set-BckRstrNotes

Imposta o modifica le note in un record della cronologia.

Parametri:

Parametro Descrizione
CustomerId L’ID cliente necessario per ottenere un token di connessione.
CientId L’ID client necessario per ottenere un token di connessione.
Secret Il segreto necessario per ottenere un token di connessione.
CustomerInforFileSpec La specifica del file completamente qualificata del file di informazioni del cliente contenente informazioni sulla sicurezza e sull’ambiente.
ProfileName Il parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud per informazioni su come impostare i profili di sicurezza.
Environment Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem.
Quiet Il parametro per sopprimere l’output nella console.
BackupName Il nome del backup. L’estensione .zip è facoltativa.
Notes Le note da impostare o modificare.
Cmdlet dello strumento di configurazione automatica per il backup e il ripristino
January 23, 2026
Grazie al contributo di: 
C
January 23, 2026
Grazie al contributo di: 
C

In questo articolo

Feedback sito | Your privacy choices footer linkScelte di privacy | Privacy e condizioni legali | Preferenze cookie | Impostazioni di consenso | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.