Cmdlets da ferramenta de configuração automatizada para backup e restauração
Esta página lista todos os cmdlets e parâmetros compatíveis com a ferramenta para acionar as APIs de backup e restauração que o Studio usa.
Cmdlets de armazenamento de backup
Get-BckRstrStorage
Este cmdlet é aplicável apenas a ambientes locais. Obtém detalhes do armazenamento onde os backups são salvos.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Set-BckRstrStorage
Este cmdlet é aplicável apenas a ambientes locais. Define um novo armazenamento onde os backups são salvos.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
MaximumBackups |
O número máximo de backups não fixados a serem persistidos até que o processo de limpeza de backup remova os backups mais antigos quando novos backups forem criados. |
MaximumPinnedBackups |
O número máximo de backups fixados a serem persistidos. Esses backups não são removidos pelo processo de limpeza. |
BlobStorageType |
O tipo de armazenamento: FileStorage ou CustomerAzureStorage. |
FileStoragefolder |
A especificação de pasta totalmente qualificada para a opção FileStorage de BlobStorageType. |
Info1
|
Para FileStorage, UserName opcional
Para CustomerAzureStorage, a URL SAS do Azure |
Info2 |
Para FileStorage, senha opcional |
Info3 e Info4
|
Não usados |
Test-BckRstrStorage
Este cmdlet é aplicável apenas a ambientes locais. Testa para determinar se o armazenamento definido é válido.
Para FileStorage, o teste verifica se a pasta existe e pode ser gravada.
Para CustomerAzureStorage, o teste verifica se a URL SAS tem as permissões corretas e se a data atual está dentro das datas de início e término da URL.
Retorna true se for válido e false se for inválido.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Cmdlets de backup
Get-BckRstrBackups
Enumera os backups armazenados no local de armazenamento de blob de Backup ou Restauração. Para Citrix Virtual Apps and Desktops™, este local é configurado pelo administrador através do WebStudio. Para DaaS, este é o armazenamento Azure do cliente pré-existente. Use Get-BckRstrBackupsWithDetiails para obter informações completas sobre cada backup. Os detalhes do backup incluem o seguinte:
- Nome do backup
- Notas
- Fixado (true ou false)
- Data e hora do backup
- UID do histórico
- UID relacionado (UID do último registro de histórico de Restauração)
- Data e hora relacionadas
- Relacionado se executado no modo de verificação
- Duração em segundos
- Nome do administrador
- Detalhes que enumeram cada componente e contagem de membros em cada componente.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Get-BckRstrBackupsMembers
Enumera os membros de um único componente armazenados em um backup selecionado. Os nomes dos membros são retornados em uma lista simples.
Os componentes são:
- Tags
- AdminScopes
- AdminRoles
- AdminAdministrators (somente local)
- HostConnections
- Icons
- AdminFolders
- MachineCatalogs
- StoreFronts
- DeliveryGroups
- ApplicationGroups
- ApplicationFolders
- Applications
- AppVServers
- AppLibPackageDiscovery
- AppVIsolationGroups
- GroupPolicies
- UserZonePreferences
- SiteData
- Zones (somente local)
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Component |
Os componentes a serem incluídos no backup. |
New-BckRstrBackup
Inicia uma nova ação de backup no Delivery Controller. Esta ação é assíncrona ao cmdlet New-BckRstrBackup.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Notes |
As notas sobre o backup. |
PollForCompletion |
O parâmetro para sondar a ação em execução no Delivery Controller até que a ação seja concluída. O registro de sondagem registra o progresso e os resultados da conclusão no console, a menos que o parâmetro Quiet seja especificado. |
Cmdlets para fixar backups
Set-BckRstrPinBackups
Fixa um backup para que ele não seja removido como parte do processo de limpeza de backup do Delivery Controller.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Set-BckRstrUnpinBackups
Desafixa um backup para que ele esteja disponível para ser removido no processo de limpeza de backup do Delivery Controller.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Cmdlet para remover backup
Remove-BckRstrBackup
Remove um ou mais backups.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
IncludeByName |
O filtro para especificar quais membros do componente considerar para restauração. Esta é uma lista de valores de filtro separados por vírgulas e pode conter os caracteres curinga * e ?. |
Cmdlets de backups agendados
Get-BckRstrSchedules
Obtém uma lista de agendamentos de backup.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Notes |
As notas a serem definidas ou alteradas. |
New-BckRstrSchedule
Cria um novo agendamento de backup.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Name |
O nome do agendamento. |
Frequency |
O tipo de frequência: Daily, Weekly ou Monthly. |
Day |
Se a frequência for diária. |
DaysInWeek |
Se a frequência for semanal. |
DayInMonth |
Se a frequência for mensal. |
WeekInMonth |
Se a frequência for mensal. |
StartDate |
O formato é M/d/yy
|
StartTime |
A hora de início especificada como um relógio de 24 horas. |
FrequencyFactor |
Executar a cada n vezes, como todos os dias (valor = 1) ou a cada dois dias (valor = 2) |
Description |
A descrição do backup agendado |
Enabled |
O parâmetro para habilitar este agendamento de backup. True quando habilitado e false quando desabilitado |
TimeZoneId |
A ID do fuso horário do Windows |
Set-BckRstrSchedule
Modifica um agendamento de backup existente. Forneça o nome ou Uid para selecionar o agendamento a ser modificado.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Name |
O nome do agendamento. |
Uid |
Se o nome do agendamento for alterado. |
Frequency |
O tipo de frequência: Daily, Weekly ou Monthly. |
Day |
Se a frequência for diária. |
DaysInWeek |
Se a frequência for semanal. |
DayInMonth |
Se a frequência for mensal. |
WeekInMonth |
Se a frequência for mensal. |
StartDate |
O formato é M/d/yy
|
StartTime |
A hora de início especificada como um relógio de 24 horas. |
FrequencyFactor |
Executar a cada n vezes, como todos os dias (valor = 1) ou a cada dois dias (valor = 2) |
Description |
A descrição do backup agendado |
Enabled |
O parâmetro para habilitar este agendamento de backup. True quando habilitado e false quando desabilitado |
TimeZoneId |
A ID do fuso horário do Windows |
Set-BckRstrScheduleEnabled
Habilita um agendamento de backup existente. Forneça o nome ou Uid para selecionar o agendamento a ser habilitado.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Name |
O nome do agendamento. |
Uid |
Se o nome do agendamento for alterado. |
Set-BckRstrScheduleDisabled
Desabilita um agendamento de backup existente. Forneça o nome ou Uid para selecionar o agendamento a ser desabilitado.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Name |
O nome do agendamento. |
Uid |
Se o nome do agendamento for alterado. |
Cmdlet para limitar backups
Set-BckRstrOptions
Limita os backups agendados a um por dia para evitar backups idênticos.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
OneScheduledBackupPerDay |
O parâmetro para limitar os backups agendados a um por dia para evitar backups idênticos. |
Cmdlet de restauração
Restore-BckRstrBackups
Restaura membros de um único componente de um backup existente.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Component |
Os componentes a serem incluídos no backup. |
Notes |
As notas sobre o backup. |
CheckMode |
O parâmetro para identificar membros do componente que seriam restaurados, mas não executa a restauração real. |
RestoreType |
O tipo de restauração: MissingOnly ou MissingUpdateExisting |
IncludeByName |
O filtro para especificar quais membros do componente considerar para restauração. Esta é uma lista de valores de filtro separados por vírgulas e pode conter os caracteres curinga * e ?. |
Cmdlets de histórico
Get-BckRstrHistory
Obtém uma lista de detalhes do histórico para todas as ações.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
Get-BckRstrSpecificBackupHistory
Obtém uma lista de detalhes do histórico para um backup específico.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Set-BckRstrNotes
Define ou altera as notas em um registro de histórico.
Parâmetros:
| Parâmetro | Descrição |
|---|---|
CustomerId |
A ID do cliente necessária para obter um token de portador. |
CientId |
A ID do cliente necessária para obter um token de portador. |
Secret |
O segredo necessário para obter um token de portador. |
CustomerInforFileSpec |
A especificação de arquivo totalmente qualificada do arquivo de informações do cliente contendo informações de segurança e ambiente. |
ProfileName |
O parâmetro para identificar um perfil de segurança existente usado no lugar dos parâmetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber como definir perfis de segurança. |
Environment |
O tipo de ambiente de produção: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
O parâmetro para suprimir a saída para o console. |
BackupName |
O nome do backup. A extensão .zip é opcional. |
Notes |
As notas a serem definidas ou alteradas. |
Cmdlets da ferramenta de configuração automatizada para backup e restauração
Copiado!
Falha!