Cmdlet dello strumento di configurazione automatizzato per il backup e il ripristino
In questa pagina sono elencati tutti i cmdlet e i parametri supportati dallo strumento per attivare le API di backup e ripristino utilizzate da Studio.
Cmdlet di archiviazione di backup
Get-BckRstrStorage
Questo cmdlet è applicabile solo all’ambiente locale. Ottiene 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Set-BckRstrStorage
Questo cmdlet è applicabile solo all’ambiente locale. Imposta un nuovo archivio 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
MaximumBackups |
Numero massimo di backup non bloccati da rendere persistenti fino a quando il processo di pulizia del backup non rimuove i backup meno recenti quando vengono creati nuovi backup. |
MaximumPinnedBackups |
Numero massimo di backup bloccati da rendere persistenti. Questi backup non vengono rimossi dal processo di pulizia. |
BlobStorageType |
Il tipo di conservazione: Archiviazione file o CustomerAzureStorage. |
FileStoragefolder |
La specifica completa della cartella per il BlobStorageType Archiviazione file opzione. |
Info1
|
Per Archiviazione fileopzionale Nome utentePer CustomerAzureStorage, l’URL della firma di accesso condiviso di Azure |
Info2 |
Per Archiviazione file, Password opzionale |
Info3 and Info4
|
Non utilizzato |
Test-BckRstrStorage
Questo cmdlet è applicabile solo all’ambiente locale. Test per determinare che l’archiviazione definita sia valida.
Per Archiviazione file, il test verifica che la cartella esista e possa essere scritta.
Per CustomerAzureStorage, il test verifica che l’URL della firma di accesso condiviso disponga delle autorizzazioni corrette e che la data corrente corrisponda alla data di inizio e di fine dell’URL.
Rendiconto vero se valido e falso 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Cmdlet di backup
Get-BckRstrBackups
Enumera i backup archiviati nel percorso 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 di Azure del cliente preesistente. Usare Get-BckRstrBackupsWithDetiails per informazioni complete su ciascun backup. I dettagli del backup includono quanto segue:
- Nome backup
- Note
- Bloccato (vero o falso)
- Data e ora del backup
- Storia UID
- 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 relativi all’enumerazione di ogni componente e al 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare 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 elenco semplice.
I componenti sono:
- Tag
- AdminScopes
- Ruoli amministrativi
- AdminAdministrators (solo locale)
- Connessioni host
- Icone
- Cartelle di amministrazione
- Cataloghi di macchine
- Vetrine
- Gruppi di consegna
- Gruppi di applicazioni
- Cartelle dell’applicazione
- Applicazioni
- AppVServers
- AppLibPackageDiscovery
- AppVIsolationGroups
- Criteri di gruppo
- Preferenze UserZonePreferences
- Dati del sito
- Zone (solo in locale)
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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Component |
I componenti da includere nel backup. |
New-BckRstrBackup
Avvia una nuova azione di backup sul Delivery Controller. Questa azione è asincrona rispetto al New-BckRstrBackup cmdlet.
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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Note |
Le note sul backup. |
PollForCompletion |
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 di completamento nella console, a meno che l’opzione Abbastanza viene specificato. |
Aggiunta di cmdlet per 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Set-BckRstrUnpinBackups
Sblocca un backup in modo che sia disponibile per la rimozione 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Rimuovere il cmdlet di backup
Rimuovi-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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
IncludeByName |
Filtro per specificare i membri del componente da considerare per il ripristino. Si tratta di un elenco separato da virgole di valori di filtro e può contenere caratteri jolly * e ?. |
Cmdlet per i backup pianificati
Get-BckRstrSchedules
Ottiene 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Note |
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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Nome |
Nome della pianificazione. |
Frequency |
Il tipo di frequenza: Giornaliera, Settimanale o 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/g/aa
|
StartTime |
L’ora di inizio specificata come orologio a 24 ore. |
FrequencyFactor |
Esegui ogni n volte, ad esempio ogni giorno (valore = 1) o a giorni alterni (valore = 2) |
Descrizione |
La descrizione del backup pianificato |
Enabled |
Parametro per abilitare la pianificazione del backup. Vero quando abilitato e falso quando disabilitato |
TimeZoneId |
L’ID del fuso orario di Windows |
Set-BckRstrSchedule
Modifica una pianificazione di backup esistente. Specificare 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Nome |
Nome della pianificazione. |
Uid |
Se il nome della pianificazione deve essere modificato. |
Frequency |
Il tipo di frequenza: Giornaliera, Settimanale o 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/g/aa
|
StartTime |
L’ora di inizio specificata come orologio a 24 ore. |
FrequencyFactor |
Esegui ogni n volte, ad esempio ogni giorno (valore = 1) o a giorni alterni (valore = 2) |
Descrizione |
La descrizione del backup pianificato |
Enabled |
Parametro per abilitare la pianificazione del backup. Vero quando abilitato e falso quando disabilitato |
TimeZoneId |
L’ID del fuso orario di Windows |
Set-BckRstrScheduleEnabled
Abilita una pianificazione di backup esistente. Specificare 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Nome |
Nome della pianificazione. |
Uid |
Se il nome della pianificazione deve essere modificato. |
Set-BckRstrScheduleDisabled
Disabilita una pianificazione di backup esistente. Specificare 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Nome |
Nome della pianificazione. |
Uid |
Se il nome della pianificazione deve essere modificato. |
Cmdlet Limit backups
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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
OneScheduledBackupPerDay |
Parametro per limitare i backup pianificati a uno al giorno per evitare backup identici. |
Cmdlet di ripristino
Ripristino-BckRstrBackup
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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Component |
I componenti da includere nel backup. |
Note |
Le note sul backup. |
CheckMode |
Parametro per identificare i membri del componente che verrebbero ripristinati, ma non esegue il ripristino effettivo. |
RestoreType |
Tipo di ripristino: MissingOnly o MissingUpdateExisting |
IncludeByName |
Filtro per specificare i membri del componente da considerare per il ripristino. Si tratta di un elenco separato da virgole di valori di filtro e può contenere caratteri jolly * e ?. |
Cmdlet della cronologia
Get-BckRstrHistory
Ottiene 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
Get-BckRstrSpecificBackupHistory
Ottiene 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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Set-BckRstrNotes
Imposta o modifica le note in un record storico.
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 al portatore. |
CustomerInforFileSpec |
La specifica completa del file di informazioni sul cliente contenente informazioni sulla sicurezza e sull’ambiente. |
ProfileName |
Parametro per identificare un profilo di sicurezza esistente utilizzato al posto dei parametri precedenti. Vedere XenApp & XenDesktop: SDK PowerShell remoto v2 per Citrix Cloud per informazioni su come impostare i profili di sicurezza. |
Environment |
Il tipo di ambiente di produzione: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parametro per eliminare l’output nella console. |
BackupName |
Nome del backup. Le .zip L’estensione è facoltativa. |
Note |
Le note da impostare o modificare. |
Cmdlet dello strumento di configurazione automatizzato per il backup e il ripristino
Copiato!
Non riuscito!