Citrix DaaS

Cmdlets da ferramenta de configuração automatizada para backup e restauração

January 28, 2025

Contribuição de:

Esta página lista todos os cmdlets e parâmetros compatíveis com a ferramenta para disparar as APIs de backup e restauração que o Studio usa.

Cmdlets de armazenamento de backup

Get-BckRstrStorage

Esse cmdlet é aplicável somente ao local. Obtém detalhes do armazenamento em que os backups são salvos.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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

Esse cmdlet é aplicável somente ao local. Define um novo armazenamento onde os backups são salvos.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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 desafixados a serem mantidos até que o processo de limpeza de backup remova os backups mais antigos quando novos backups são criados.
`MaximumPinnedBackups`	O número máximo de backups fixados a serem mantidos. Esses backups não são removidos pelo processo de limpeza.
`BlobStorageType`	O tipo de armazenamento: `Armazenamento de arquivos` ou `CustomerAzureStorage`.
`FileStoragefolder`	A especificação de pasta totalmente qualificada para o `BlobStorageType` `Armazenamento de arquivos` opção.
`Info1`	Durante `Armazenamento de arquivos`opcional `Nome de usuário` Durante `CustomerAzureStorage`, a URL da SAS do Azure
`Info1`
`Info2`	Durante `Armazenamento de arquivos`, senha opcional
`Info3` and `Info4`	Não utilizado

Test-BckRstrStorage

Esse cmdlet é aplicável somente ao local. Testes para determinar se o armazenamento definido é válido.

Durante Armazenamento de arquivos, o teste verifica se a pasta existe e pode ser gravada.

Durante CustomerAzureStorage, o teste verifica se a URL SAS tem as permissões corretas e se a data atual é a data de início e término da URL.

Retorna verdadeiro se for válido e falso se inválido.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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.

Fazer backup de cmdlets

Get-BckRstrBackups

Enumera backups armazenados no local de armazenamento de blobs de Backup ou Restauração. Para Citrix Virtual Apps and Desktops, esse local é configurado pelo administrador por meio do WebStudio. Para DaaS, esse é o armazenamento do Azure do cliente pré-existente. Usar Get-BckRstrBackupsWithDetiails para obter informações completas sobre cada backup. Os detalhes do backup incluem o seguinte:

Nome do backup
Anotações
Fixado (verdadeiro ou falso)
Data e hora do backup
UID do histórico
UID relacionado (UID do último registro do 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 enumerando cada componente e contagem de membros em cada componente.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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
Funções de administrador
AdminAdministrators (somente local)
Conexões de host
Ícones
Pastas de administração
Catálogos de máquinas
Lojas
Grupos de Entrega
Grupos de aplicativos
Pastas de aplicativos
Aplicativos
Aplicações VServers
AppLibPackageDiscovery
Grupos de aplicativos
Políticas de Grupo
UserZonePreferences
Dados do site
Zonas (somente local)

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é opcional.
`Component`	Os componentes a serem incluídos no backup.

Novo-BckRstrBackup

Inicia uma nova ação de backup no Delivery Controller. Essa ação é assíncrona para o Novo-BckRstrBackup cmdlet.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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.
`Anotações`	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. A sondagem registra o progresso e os resultados de conclusão no console, a menos que o `Bastante` é especificado.

Fixar cmdlets de 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é opcional.

Remover cmdlet de backup

Remover-BckRstrBackup

Remove um ou mais backups.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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 devem ser considerados para restauração. Esta é uma lista separada por vírgulas de valores de filtro e pode ter 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é opcional.
`Anotações`	As notas a serem definidas ou alteradas.

Novo-BckRstrSchedule

Cria uma nova programação de backup.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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.
`Nome`	O nome da agenda.
`Frequency`	O tipo de frequência: Diária, Semanal ou Mensal.
`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/aa`
`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)
`Descrição`	A descrição do backup agendado
`Enabled`	O parâmetro para habilitar esse agendamento de backup. `Verdadeiro` quando habilitado e `falso` quando desabilitado
`TimeZoneId`	A ID do fuso horário do Windows

Set-BckRstrSchedule

Modifica uma programação de backup existente. Forneça o nome ou Uid para selecionar o agendamento a ser modificado.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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.
`Nome`	O nome da agenda.
`Uid`	Se o nome da programação for alterado.
`Frequency`	O tipo de frequência: Diária, Semanal ou Mensal.
`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/aa`
`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)
`Descrição`	A descrição do backup agendado
`Enabled`	O parâmetro para habilitar esse agendamento de backup. `Verdadeiro` quando habilitado e `falso` 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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.
`Nome`	O nome da agenda.
`Uid`	Se o nome da programação 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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.
`Nome`	O nome da agenda.
`Uid`	Se o nome da programação for alterado.

Cmdlet Limit backups

Set-BckRstrOptions

Limita os backups agendados a um por dia para evitar backups idênticos.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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

Restaurar-BckRstrBackups

Restaura membros de um único componente de um backup existente.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é opcional.
`Component`	Os componentes a serem incluídos no backup.
`Anotações`	As notas sobre o backup.
`CheckMode`	O parâmetro para identificar os 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 devem ser considerados para restauração. Esta é uma lista separada por vírgulas de valores de filtro e pode ter 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é opcional.

Set-BckRstrNotes

Define ou altera as notas em um registro de histórico.

Parâmetros:

Parâmetro	Descrição
`CustomerId`	O ID do cliente precisava obter um token de portador.
`CientId`	O ID do cliente precisava 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. Ver XenApp & XenDesktop: SDK do PowerShell remoto v2 para 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. O `.nada` A extensão é opcional.
`Anotações`	As notas a serem definidas ou alteradas.

A versão oficial deste conteúdo está em inglês. Parte do conteúdo da documentação da Cloud Software Group é traduzida automaticamente para sua conveniência. A Cloud Software Group não tem controle sobre o conteúdo traduzido automaticamente, que pode conter erros, imprecisões ou linguagem inadequada. Nenhuma garantia de qualquer tipo, expressa ou implícita, é fornecida quanto à precisão, confiabilidade, adequação ou correção de quaisquer traduções feitas do original em inglês para qualquer outro idioma, ou quanto à conformidade do seu produto ou serviço Cloud Software Group com qualquer conteúdo traduzido automaticamente, e nenhuma garantia fornecida sob o contrato de licença de usuário final aplicável ou os termos de serviço, ou qualquer outro contrato com a Cloud Software Group, de que o produto ou serviço esteja em conformidade com qualquer documentação será aplicável na medida em que essa documentação tenha sido traduzida automaticamente. A Cloud Software Group não se responsabiliza por quaisquer danos ou problemas que possam surgir em decorrência do uso de conteúdo traduzido automaticamente.

Isso foi útil?

Cmdlets da ferramenta de configuração automatizada para backup e restauração

January 28, 2025

Contribuição de:

Neste artigo

Isso foi útil?