Citrix DaaS™

Cmdlets da ferramenta de configuração automatizada para migração

September 15, 2025

Contribuição de:

C C

Esta página lista todos os cmdlets e parâmetros compatíveis com a ferramenta para casos de uso de migração.

Todos os cmdlets aceitam parâmetros que possuem um dos seguintes tipos:

String
Lista de strings
Boolean: $true ou $false
SwitchParameter: a presença do parâmetro significa $true; a ausência do parâmetro significa $false

Nota:

SwitchParameter é o método preferencial para seleções de verdadeiro ou falso, mas os booleanos ainda são usados na ferramenta devido a problemas de legado.

A tabela a seguir é um resumo de todos os cmdlets. Consulte cada seção individual para encontrar quais parâmetros cada cmdlet oferece suporte.

Categoria	Cmdlet	Descrição
Migração do local para a nuvem	`Export-CvadAcToFile`	Exporta arquivos locais para arquivos YAML.
	`Import-CvadAcToSite`	Importa arquivos YAML para a nuvem. Oferece suporte a operações de criação, atualização e exclusão.
	`Merge-CvadAcToSite`	Importa arquivos YAML para a nuvem. Oferece suporte a operações de criação e atualização.
	`New-CvadAcToSite`	Importa arquivos YAML para a nuvem. Oferece suporte a operações de criação e atualização.
	`Sync-CvadAcToSite`	Exporta e importa em uma única etapa.
	Migração granular Para componentes, use parâmetros com os comandos acima. Exemplos: `MachineCatalogs`, `Tags`. Para nomes de componentes, use parâmetros com os comandos acima. Exemplos: `IncludeByName`, `ExcludeByName`.	Migra seletivamente apenas componentes ou nomes de componentes
Cmdlets de nuvem para nuvem	`Backup-CvadAcToFile`	Faz backup de toda a configuração do seu site na nuvem.
	`Restore-CvadAcToSite`	Restaura arquivos YAML de backup para o site na nuvem. Este site na nuvem pode ser o mesmo ou diferente do site na nuvem de origem.
	`Remove-CvadAcFromSite`	Remove membros de componentes da nuvem.
	Migração granular Para componentes, use parâmetros com os comandos acima. Exemplos: `MachineCatalogs`, `Tags`. Para nomes de componentes, use parâmetros com os comandos acima. Exemplos: `IncludeByName`, `ExcludeByName`.	Migra seletivamente apenas componentes ou nomes de componentes
Outros cmdlets básicos	`Compare-CvadAcToSite`	Compara os arquivos .yml locais com a configuração da nuvem.
Cmdlets relacionados a pré-requisitos	`New-CvadAcCustomerInfoFile`	Cria um arquivo de informações do cliente.
Cmdlets relacionados a pré-requisitos	`Set-CvadAcCustomerInfoFile`	Atualiza um arquivo de informações do cliente existente.
Cmdlets de suporte e solução de problemas	`New-CvadAcZipInfoForSupport`	Compacta todos os arquivos de log e .yml em um único arquivo zip para enviar à Citrix® para suporte.
	`Get-CvadAcStatus`	Use para testar a conectividade e garantir que todos os pré-requisitos sejam atendidos. Retorna informações sobre a ferramenta, como número da versão e conectividade com a nuvem e status do conector.
	`Test-CvadAcConnectionWithSite`	Testa a conexão com o site na nuvem.
	`Find-CvadAcConnector`	Localiza conectores existentes e determina seu estado de execução.
	`Get-CvadAcCustomerSites`	Retorna a lista de todos os sites do cliente.
	`New-CvadAcTemplateToFile`	Cria um arquivo de modelo para componentes selecionados.
	`Show-CvadAcDocument`	Exibe esta documentação no navegador padrão.
	`Find-CvadAcInFile`	A função “Localizar em arquivo” pesquisa arquivos YAML de componentes procurando membros que correspondam a um ou mais nomes que podem conter curingas.
Cmdlets de ativação de site	`Set-CvadAcSiteActiveStateOnPrem`	Define o estado do site local como ativo ou inativo.
Cmdlets de ativação de site	`Set-CvadAcSiteActiveStateCloud`	Define o estado do site na nuvem como ativo ou inativo.
Cmdlets de mesclagem de vários sites locais	`New-CvadAcSiteMergingInfo`	Cria um conjunto de informações de prefixo/sufixo de mesclagem de site.
	`Set-CvadAcSiteMergingInfo`	Atualiza um conjunto de informações de prefixo/sufixo de mesclagem de site existente.
	`Remove-CvadAcSiteMergingInfo`	Remove um conjunto de informações de prefixo/sufixo de mesclagem de site existente.

Para obter mais informações sobre parâmetros e como usá-los, consulte Parâmetros de migração granular.

Cmdlets básicos

Cmdlets de migração do local para a nuvem

Export-CvadAcToFile - Exporta arquivos locais para arquivos YAML.

Exporta a configuração da sua configuração local. Esta é a operação de exportação padrão para a configuração automatizada. Nenhuma modificação é feita na configuração do site local. Os arquivos exportados são colocados no diretório %HOMEPATH%\Documents\Citrix\AutoConfig em uma subpasta Export com nome exclusivo. A pasta %HOMEPATH%\Documents\Citrix\AutoConfig sempre contém a configuração de site local exportada mais recente.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components	SwitchParameters
Filtering by object names	Consulte Filtering by object names	List of strings
`TargetFolder`	Especifica a pasta de destino da exportação.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`AdminAddress`	Especifica o DNS ou endereço IP do Delivery Controller quando a exportação não está sendo executada no Delivery Controller.	String
`CheckUserAndMachines`	Verifica se usuários e máquinas estão no Active Directory. Usuários e máquinas que não estão no Active Directory podem resultar em falhas de importação.	`$true` ou `$false`
`ZipResults`	Compacta arquivos YAML de backup em um único arquivo zip. O arquivo está na mesma pasta que os arquivos YAML de backup e tem o mesmo nome da pasta.	SwitchParameter

Retorna:

Consulte Valores de retorno do cmdlet

Existem três maneiras de importar dados para a nuvem. A execução de cmdlets específicos pode resultar em uma das três combinações de ações no site na nuvem:

Adicionar, Atualizar e Excluir
Apenas Adicionar e Atualizar
Apenas Adicionar

Cmdlet	Adicionar	Atualizar	Excluir
Import	X	X	X
Merge	X	X
New	X

Import-CvadAcToSite - Importa arquivos YAML para a nuvem. Oferece suporte a operações de criação, atualização e exclusão.

Importa todos os arquivos locais para a nuvem. Este comando garante que o estado final da nuvem seja idêntico ao estado local. Esta opção exclui quaisquer alterações existentes na nuvem. Os arquivos de configuração do site importados são originados de %HOMEPATH%\Documents\Citrix\AutoConfig. Use com cautela.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components.	SwitchParameters
Filtering by object names	Consulte Filtering by object names.	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters.	SwitchParameters
`SourceFolder`	Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`Merge`	Quando definido como `$true`, apenas adiciona componentes ao site na nuvem. Os componentes não são removidos. Defina como `$false` para remover componentes.	`$true` ou `$false`
`AddOnly`	Quando definido como `$true`, adiciona apenas novos componentes, não atualiza nem exclui componentes existentes. Defina como `$false` para permitir atualizações e exclusões. `Merge` é ignorado quando este parâmetro é `$true`.	`$true` ou `$false`
`MergePolicies`	Mescla configurações e filtros de política. A mesclagem ocorre apenas quando uma política sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas do DDC da nuvem contêm as configurações e filtros que já possuíam, além de quaisquer novas configurações e filtros sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.	SwitchParameter
`OnErrorAction`	Consulte OnErrorAction parameter.	String

Retorna:

Consulte Valores de retorno do cmdlet

Merge-CvadAcToSite - Importa arquivos YAML para a nuvem. Oferece suporte a operações de criação e atualização.

Mescla os arquivos locais para a nuvem, mas não exclui nenhum componente na nuvem ou no site local. Isso preserva as alterações já feitas na nuvem. Se um componente existir no Citrix Cloud com o mesmo nome, este comando poderá modificar esse componente. Esta é a operação de importação padrão para a configuração automatizada. Os arquivos de configuração do site mesclados são originados de %HOMEPATH%\Documents\Citrix\AutoConfig.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components.	SwitchParameters
Filtering by object names	Consulte Filtering by object names.	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters.	SwitchParameters
`SourceFolder`	Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`Merge`	Quando definido como `$true`, apenas adiciona componentes ao site na nuvem. Os componentes não são removidos. Defina como `$false` para remover componentes.	`$true` ou `$false`
`AddOnly`	Quando definido como `$true`, adiciona apenas novos componentes, não atualiza nem exclui componentes existentes. Defina como `$false` para permitir atualizações e exclusões. `Merge` é ignorado quando este parâmetro é `$true`.	`$true` ou `$false`
`MergePolicies`	Mescla configurações e filtros de política. A mesclagem ocorre apenas quando uma política sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas do DDC da nuvem contêm as configurações e filtros que já possuíam, além de quaisquer novas configurações e filtros sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.	SwitchParameter
`OnErrorAction`	Consulte OnErrorAction parameter.	String

Retorna:

Consulte Valores de retorno do cmdlet

New-CvadAcToSite - Importa arquivos YAML para a nuvem. Oferece suporte a operações de criação e atualização.

Importa a configuração do site local para a nuvem, mas apenas adiciona novos componentes. Os componentes existentes do site na nuvem não são atualizados nem excluídos. Use este comando se os componentes existentes do seu site na nuvem devem permanecer inalterados.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components.	SwitchParameters
Filtering by object names	Consulte Filtering by object names.	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters.	SwitchParameters
`SourceFolder`	Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`OnErrorAction`	Consulte OnErrorAction parameter.	String

Retorna:

Consulte Valores de retorno do cmdlet

Sync-CvadAcToSite - Exporta e importa em uma única etapa.

Sync executa uma exportação e uma importação em uma única etapa. Use o parâmetro SourceTargetFolder para especificar a pasta de destino de exportação/importação.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components	SwitchParameters
Filtering by object names	Consulte Filtering by object names	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters	SwitchParameters
`SourceTargetFolder`	Especifica a pasta de destino de exportação/importação.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`AdminAddress`	Especifica o DNS ou endereço IP do Delivery Controller quando a exportação não está sendo executada no Delivery Controller.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`Merge`	Quando definido como `$true`, apenas adiciona componentes ao site na nuvem. Os componentes não são removidos. Defina como `$false` para remover componentes.	`$true` ou `$false`
`AddOnly`	Quando definido como `$true`, adiciona apenas novos componentes, não atualiza nem exclui componentes existentes. Defina como `$false` para permitir atualizações e exclusões. `Merge` é ignorado quando este parâmetro é `$true`.	`$true` ou `$false`
`MergePolicies`	Mescla configurações e filtros de política. A mesclagem ocorre apenas quando uma política sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas do DDC da nuvem contêm as configurações e filtros que já possuíam, além de quaisquer novas configurações e filtros sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.	SwitchParameter

Retorna:

Consulte Valores de retorno do cmdlet

Cmdlets de nuvem para nuvem

Backup-CvadAcToFile - Faz backup de toda a configuração do seu site na nuvem.

Exporta sua configuração de nuvem para arquivos .yml. Este backup pode ser usado em um processo de backup e restauração para restaurar componentes perdidos.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components	SwitchParameters
Cloud-accessing parameters	Consulte Cloud-accessing parameters	SwitchParameters
`TargetFolder`	Especifica a pasta de destino da exportação.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`ZipResults`	Compacta arquivos YAML de backup em um único arquivo zip. O arquivo está na mesma pasta que os arquivos YAML de backup e tem o mesmo nome da pasta.	SwitchParameter

Retorna:

Consulte Valores de retorno do cmdlet

Restore-CvadAcToSite - Restaura arquivos YAML de backup para o site na nuvem. Este site na nuvem pode ser o mesmo ou diferente do site na nuvem de origem.

Restaura o site na nuvem para a configuração anterior. Os arquivos importados são originados da pasta especificada usando o parâmetro -RestoreFolder, que identifica a pasta que contém os arquivos .yml a serem restaurados para o site na nuvem. Esta deve ser uma especificação de pasta totalmente qualificada. Este cmdlet pode ser usado para reverter para sua configuração anterior ou para fazer backup e restaurar seu site na nuvem. Este comando pode adicionar, excluir e atualizar seu site na nuvem.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components.	SwitchParameters
Filtering by object names	Consulte Filtering by object names.	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters.	SwitchParameters
`RestoreFolder`	Identifica a pasta que contém os arquivos .yml a serem restaurados para o site na nuvem. Esta deve ser uma especificação de pasta totalmente qualificada.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`Merge`	Quando definido como `$true`, apenas adiciona componentes ao site na nuvem. Os componentes não são removidos. Defina como `$false` para remover componentes.	`$true` ou `$false`
`AddOnly`	Quando definido como `$true`, adiciona apenas novos componentes, não atualiza nem exclui componentes existentes. Defina como `$false` para permitir atualizações e exclusões. `Merge` é ignorado quando este parâmetro é `$true`.	`$true` ou `$false`
`MergePolicies`	Mescla configurações e filtros de política. A mesclagem ocorre apenas quando uma política sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas do DDC da nuvem contêm as configurações e filtros que já possuíam, além de quaisquer novas configurações e filtros sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.	SwitchParameter
`OnErrorAction`	Consulte OnErrorAction parameter.	String

Retorna:

Consulte Valores de retorno do cmdlet

Remove-CvadAcFromSite – Remove membros de componentes da nuvem.

Pode redefinir o site inteiro ou remover itens de membros de um componente (por exemplo, remover um catálogo de máquinas da lista de catálogos). Isso pode ser usado em conjunto com o parâmetro IncludeByName para remover seletivamente membros específicos.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components	SwitchParameters
Filtering by object names	Consulte Filtering by object names	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters	SwitchParameters
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`

Retorna:

Consulte Valores de retorno do cmdlet

Outros cmdlets básicos

Compare-CvadAcToSite - Compara os arquivos .yml locais com a configuração da nuvem, produzindo um relatório de alterações feitas por um cmdlet Import, Merge ou Restore.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components.	SwitchParameters
Filtering by object names	Consulte Filtering by object names.	List of strings
Cloud-accessing parameters	Consulte Cloud-accessing parameters.	SwitchParameters
`SourceFolder`	Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.	String
`Locale`	Especifica o idioma do texto legível por humanos que pode ser exportado.	String
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true` ou `$false`
`Merge`	Quando definido como `$true`, apenas adiciona componentes ao site na nuvem. Os componentes não são removidos. Defina como `$false` para remover componentes.	`$true` ou `$false`
`AddOnly`	Quando definido como `$true`, adiciona apenas novos componentes, não atualiza nem exclui componentes existentes. Defina como `$false` para permitir atualizações e exclusões. `Merge` é ignorado quando este parâmetro é `$true`.	`$true` ou `$false`
`OnErrorAction`	Consulte OnErrorAction parameter.	String

Retorna:

Consulte Valores de retorno do cmdlet

Parâmetros de migração granular

Migrar por componentes

Os seguintes componentes podem ser especificados com cmdlets que os suportam. A opção All é selecionada automaticamente quando nenhum parâmetro de componente é especificado. Para evitar erros, recomendamos que você migre os componentes na seguinte ordem:

All
Tags
AdminRoles
AdminScopes
HostConnections
MachineCatalogs
StoreFronts
DeliveryGroups
ApplicationGroups
ApplicationFolders
Applications
GroupPolicies
UserZonePreference

Filtragem por nomes de objetos

Migrar por nomes de componentes

Os parâmetros IncludeByName e ExcludeByName permitem incluir e excluir membros de componentes em cmdlets por nome. Apenas um componente (por exemplo, grupos de entrega) pode ser escolhido por vez em qualquer um dos cmdlets suportados. Se um membro do componente estiver em ambas as áreas, a exclusão substitui qualquer outro parâmetro e uma entrada é feita na lista de correção de log identificando o componente e o nome do membro que foi excluído.

IncludeByName e ExcludeByName aceitam uma lista de nomes de membros de componentes. Qualquer nome pode conter um ou mais curingas. Dois tipos de curingas são suportados. A lista de nomes de membros de componentes deve ser incluída entre aspas simples quando qualquer nome de membro contiver caracteres especiais.

* Corresponde a qualquer número de caracteres
? Corresponde a um único caractere

IncludeByName e ExcludeByName também podem aceitar um arquivo contendo uma lista de membros onde cada membro pode ser explícito ou conter curingas. Cada linha no arquivo pode conter um membro. Espaços iniciais e finais são removidos do nome do membro. O nome do arquivo deve ser precedido pelo sinal @ e estar entre aspas simples (um requisito do PowerShell para que o @ não seja reinterpretado). Vários arquivos podem ser listados, além de serem misturados com nomes de membros.

Um exemplo de mesclagem de todos os grupos de entrega cujos nomes começam com DgSite1 e contêm Home2 seria escrito:

Merge-CvadAcToSite –DeliveryGroups –IncludeByName DgSite1*,*Home2*

Por nome do grupo de entrega

ByDeliveryGroupName filtra pelo nome do grupo de entrega para aplicativos e grupos de aplicativos. Este parâmetro é sempre uma lista de inclusão que identifica os membros a serem incluídos com base em sua associação ao grupo de entrega.

ByDeliveryGroupName aceita uma lista de nomes de grupos de entrega. Qualquer nome pode conter um ou mais curingas. Dois tipos de curingas são suportados.

* corresponde a qualquer número de caracteres
? corresponde a um único caractere

O exemplo a seguir mescla todos os aplicativos que fazem referência a todos os nomes de grupos de entrega que começam com EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Excluir desabilitados

ExcludeDisabled filtra de operações de importação todos os aplicativos e grupos de aplicativos que estão desabilitados. ExcludeDisabled assume o valor padrão false, o que significa que todos os aplicativos e grupos de aplicativos são importados independentemente de seu estado habilitado.

Por nome da máquina

ByMachineName filtra pelo nome da máquina para catálogos de máquinas e grupos de entrega. Este parâmetro é sempre uma lista de inclusão que identifica os membros a serem incluídos com base em sua associação ao nome da máquina.

ByMachineName aceita uma lista de nomes de máquinas onde qualquer nome pode conter um ou mais curingas. Dois tipos de curingas são suportados.

* corresponde a qualquer número de caracteres
? corresponde a um único caractere

Ao exportar ou importar e usar ByMachineName, se um filtro de nome de máquina resultar em nenhuma máquina no catálogo de máquinas ou grupo de entrega, o catálogo de máquinas ou grupo de entrega será excluído da exportação ou importação.

Nota:

O uso de ByMachineName em qualquer cmdlet do tipo importação resulta em MergeMachines sendo definido como $true.

Mesclar máquinas

MergeMachines, quando definido como $true, instrui a operação de importação a adicionar máquinas apenas ao catálogo de máquinas ou grupo de entrega. As máquinas não são removidas, permitindo operações aditivas incrementais.

MergeMachines assume o valor padrão false, o que significa que as máquinas são removidas se não estiverem presentes no arquivo .yml do catálogo de máquinas ou grupo de entrega. MergeMachines é definido como $true quando ByMachineName é usado, mas pode ser substituído definindo MergeMachines como false.

Cmdlets relacionados a pré-requisitos

New-CvadAcCustomerInfoFile - Cria um arquivo de informações do cliente. Por padrão, o arquivo de informações do cliente está localizado em %HOMEPATH%\Documents\Citrix\AutoConfig.

Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
`CustomerId`	ID do cliente.	x	String
`ClientId`	ID do cliente criada no Citrix Cloud. O `CustomerId` e o `Secret` devem ser especificados ao usar este parâmetro.	Conditionally	String
`Secret`	Chave secreta do cliente criada no Citrix Cloud. O `CustomerId` e o `ClientId` devem ser especificados ao usar este parâmetro.	Conditionally	String
`Environment`	Ambiente Production, ProductionGov ou ProductionJP.		Enumeration
`LogFileName`	Altera o prefixo do arquivo de log de CitrixLog para outro.		String
`AltRootUrl`	Use apenas sob a direção da Citrix.		String
`StopOnError`	Interrompe a operação no primeiro erro.		`$true` ou `$false`
`TargetFolder`	Usa a pasta especificada como pasta raiz em vez de %HOMEPATH%\Documents\Citrix\AutoConfig.		String
`Locale`	Usa o local especificado em vez do local derivado do sistema em que a ferramenta é executada.		String
`Editor`	Usa o editor especificado para exibir o log ao concluir cada cmdlet. Notepad.exe é o editor padrão. Este parâmetro deve incluir a especificação de arquivo totalmente qualificada para o editor e o editor deve aceitar a especificação de arquivo de log como seu único parâmetro.		String
`SecurityCsvFileSpec`	A especificação de arquivo totalmente qualificada apontando para o arquivo SecurityClient.csv baixado do Citrix Identity and Access Management. O `CustomerId` deve ser especificado ao usar este parâmetro.		String

Retorna:

Consulte Valores de retorno do cmdlet

Set-CvadAcCustomerInfoFile - Atualiza um arquivo de informações do cliente existente. Apenas os parâmetros especificados do cmdlet são alterados. Todos os valores de parâmetros não especificados no arquivo CustomerInfo.yml permanecem inalterados.

Parâmetros:

Nome	Descrição	Tipo
`CustomerId`	ID do cliente.	String
`ClientId`	ID do cliente criada no Citrix Cloud.	String
`Secret`	Chave secreta do cliente criada no Citrix Cloud.	String
`Environment`	Ambiente Production, ProductionGov ou ProductionJP.	Enumeration
`LogFileName`	Altera o prefixo do arquivo de log de CitrixLog para outro.	String
`StopOnError`	Interrompe a operação no primeiro erro.	`$true` ou `$false`
`TargetFolder`	Usa a pasta especificada como pasta raiz em vez de %HOMEPATH%\Documents\Citrix\AutoConfig.	String
`Locale`	Usa o local especificado em vez do local derivado do sistema em que a ferramenta é executada.	String
`Editor`	Usa o editor especificado para exibir o log ao concluir cada cmdlet. Notepad.exe é o editor padrão. Este parâmetro deve incluir a especificação de arquivo totalmente qualificada para o editor e o editor deve aceitar a especificação de arquivo de log como seu único parâmetro.	String
`SecurityCsvFileSpec`	A especificação de arquivo totalmente qualificada apontando para o arquivo SecurityClient.csv baixado do Citrix Identity and Access Management. O `CustomerId` deve ser especificado ao usar este parâmetro.	String

Retorna:

Consulte Valores de retorno do cmdlet

Parâmetros relacionados a pré-requisitos

Juntamente com os parâmetros de acesso à nuvem, os seguintes parâmetros podem ser usados com os cmdlets relacionados a pré-requisitos:

Environment – Ambiente Production ou ProductionGov.
LogFileName – Altera o prefixo do arquivo de log de CitrixLog para outro.
StopOnError – Interrompe a operação no primeiro erro.
AlternateRootFolder – Usa a pasta especificada como pasta raiz em vez de %HOMEPATH%\Documents\Citrix\AutoConfig.
Locale – usa o local especificado em vez do local derivado do sistema em que a ferramenta é executada.
Editor – usa o editor especificado para exibir o log ao concluir cada cmdlet. Notepad.exe é o editor padrão. Este parâmetro deve incluir a especificação de arquivo totalmente qualificada para o editor e o editor deve aceitar a especificação de arquivo de log como seu único parâmetro.

Cmdlets de suporte e solução de problemas

New-CvadAcZipInfoForSupport - Compacta todos os arquivos de log e .yml em um único arquivo zip para enviar à Citrix para suporte. Informações confidenciais do cliente (CustomerInfo.yml e CvadAcSecurity.yml) não são incluídas no zip. O arquivo Icon.yml também é excluído devido ao seu tamanho. O arquivo zip é colocado em %HOMEPATH%\Documents\Citrix\AutoConfig e nomeado CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip, com base na data e hora. Este arquivo zip também pode atuar como um backup.

Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
`TargetFolder`	Especifica uma pasta de destino para criar e salvar o arquivo zip.		String
`Quiet`	Suprime o registro no console.		SwitchParameter

Retorna:

O arquivo zip com o nome e o local do arquivo zip é exibido no prompt de comando.

Get-CvadAcStatus - Use para testar a conectividade e garantir que todos os pré-requisitos sejam atendidos. Retorna informações sobre a ferramenta, como número da versão e conectividade com a nuvem e status do conector.

Parâmetros:

Nome	Descrição	Tipo
Cloud-accessing parameters	Consulte Cloud-accessing parameters	SwitchParameters
`SiteId`	Identifica o site ao qual se conectar.	String
`AdminAddress`	Este é o DNS ou endereço IP do Delivery Controller local usado para verificar o nível de acesso dos administradores. Isso é necessário se a ferramenta não estiver sendo executada em um Delivery Controller.	String

Retorna:

Exibe os resultados para cada item.

Test-CvadAcConnectionWithSite – Testa a conexão com o site na nuvem para verificar se a conexão de comunicação está funcionando. Este cmdlet usa os parâmetros de acesso à nuvem ou o arquivo CustomerInfo.yml para especificar as informações de conexão do cliente.

Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
Cloud-accessing parameters	Consulte Cloud-accessing parameters		SwitchParameters
`Quiet`	Suprime o registro no console.		SwitchParameter

Retorna:

Os resultados do teste são exibidos na linha de comando.

Find-CvadAcConnector - Localiza conectores existentes e determina seu estado de execução. Este cmdlet usa informações do arquivo CustomerInfo.yml ou do parâmetro de ID do cliente para localizar os conectores do cliente.

Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
`CustomerInfoFileSpec`	A especificação de arquivo apontando para um arquivo de informações do cliente para substituir o local e o nome padrão. Este parâmetro é ignorado quando o parâmetro `CustomerId` é fornecido.		String
`CustomerId`	A ID do cliente. Este parâmetro substitui o mesmo valor no arquivo CustomerInfo.yml.		String

Retorna:

Os resultados são mostrados na linha de comando.

Get-CvadAcCustomerSites - Retorna a lista de todos os sites do cliente. Este cmdlet usa os parâmetros de acesso à nuvem ou o arquivo CustomerInfo.yml para especificar as informações de conexão do cliente.

Parâmetros:
- Consulte Cloud-accessing parameters
Retorna:
- Exibe uma lista de IDs de sites de clientes encontrados.

New-CvadAcTemplateToFile – Cria um arquivo de modelo para componentes selecionados, permitindo que você crie manualmente um arquivo de importação.

Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
Migrate by components	Consulte Migrate by components		SwitchParameters
`TargetFolder`	Especifica a pasta de destino da exportação.		String

Retorna:

Consulte Valores de retorno do cmdlet

Show-CvadAcDocument - Exibe esta documentação no navegador padrão.

Parâmetros:
- Nenhum.
Retorna:
- Exibe esta página da web no navegador da web padrão.

Find-CvadAcInFile - A função “Localizar em arquivo” pesquisa arquivos YAML de componentes procurando membros que correspondam a um ou mais nomes que podem conter curingas. O resultado é um relatório de membros encontrados. A função “Localizar em arquivo” pode pesquisar apenas um componente por vez. A função “Localizar em arquivo” pesquisa todos os arquivos YAML na pasta atual e em todas as subpastas. Use FindSourceFolder para limitar o número de arquivos a serem pesquisados.

Parâmetros:

Nome	Descrição	Tipo
Migrate by components	Consulte Migrate by components. Nota: O valor `-All` não é válido.	SwitchParameters
`IncludeByName`	Uma lista especificando os nomes dos grupos de entrega a serem incluídos ao definir o estado ativo do site como ativo. Os curingas ‘*’ e ‘?’ são suportados nos nomes.	List of strings
`Unique`	Relata apenas membros únicos encontrados.	SwitchParameter
`IncludeYaml`	Inclui o YAML específico do membro.	SwitchParameter
`FindSourceFolder`	A pasta onde a pesquisa começa.	String
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	SwitchParameter
`Quiet`	Suprime o registro no console.	SwitchParameter

Retorna:

Cria um relatório contendo os membros encontrados para o componente especificado.

Cmdlets de ativação de site

Para obter mais informações sobre a ativação de sites e o uso desses cmdlets, consulte Ativando sites.

Set-CvadAcSiteActiveStateOnPrem - Define o estado do site local como ativo ou inativo.

Parâmetros:

Nome	Descrição	Tipo
Cloud-accessing parameters	Consulte Cloud-accessing parameters	SwitchParameters
`SiteActive`	Quando presente, define o site local como ativo, removendo o modo de manutenção de todos os grupos de entrega. Quando este parâmetro não está presente, o modo de manutenção é definido em todos os grupos de entrega.	SwitchParameter
`IncludeByName`	Uma lista especificando os nomes dos grupos de entrega a serem incluídos ao definir o estado ativo do site como ativo. Os curingas ‘*’ e ‘?’ são suportados nos nomes.	List of strings
`ExcludeByName`	Uma lista especificando os nomes dos grupos de entrega a serem excluídos ao definir o estado ativo do site como ativo. Os curingas ‘*’ e ‘?’ são suportados nos nomes.	List of strings
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true or $false`

Retorna:

Consulte Valores de retorno do cmdlet

Set-CvadAcSiteActiveStateCloud - Define o estado do site na nuvem como ativo ou inativo.

Parâmetros:

Nome	Descrição	Tipo
Cloud-accessing parameters	Consulte Cloud-accessing parameters	SwitchParameters
`SiteActive`	Quando presente, define o site na nuvem como ativo, removendo o modo de manutenção de todos os grupos de entrega. Quando este parâmetro não está presente, o modo de manutenção é definido em todos os grupos de entrega.	SwitchParameter
`IncludeByName`	Uma lista especificando os nomes dos grupos de entrega a serem incluídos ao definir o estado ativo do site como ativo. Os curingas ‘*’ e ‘?’ são suportados nos nomes.	List of strings
`ExcludeByName`	Uma lista especificando os nomes dos grupos de entrega a serem excluídos ao definir o estado ativo do site como ativo. Os curingas ‘*’ e ‘?’ são suportados nos nomes.	List of strings
`Quiet`	Suprime o registro no console.	SwitchParameter
`DisplayLog`	Exibe o arquivo de log ao concluir o cmdlet. Defina como `$false` para suprimir a exibição do log.	`$true or $false`

Retorna:

Consulte Valores de retorno do cmdlet

Cmdlets de mesclagem de vários sites locais

Para obter mais informações sobre a mesclagem de sites e o uso desses cmdlets, consulte Mesclar vários sites em um único site.

New-CvadAcSiteMergingInfo - Cria um conjunto de informações de prefixo/sufixo de mesclagem de site. Não é necessário saber todos os prefixos ou sufixos no início. Eles podem ser atualizados com Set-CvadAcSiteMergingInfo ou editando manualmente o arquivo SiteMerging.yml. Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
`SiteName`	O nome usado para identificar o conjunto de prefixos/sufixos para um site específico. Pode corresponder ao nome do site real, mas não é obrigatório.	x	String
Site merging parameters	Consulte Site merging parameters		SwitchParameters
`Quiet`	Suprime o registro no console.		SwitchParameter

Retorna:

Nenhum

Set-CvadAcSiteMergingInfo - Atualiza um conjunto de informações de prefixo/sufixo de mesclagem de site existente.

Parâmetros:

Nome	Descrição	Obrigatório?	Tipo
`SiteName`	O nome usado para identificar o conjunto de prefixos/sufixos para um site específico. Pode corresponder ao nome do site real, mas não é obrigatório.	x	String
Site merging parameters	Consulte Site merging parameters		SwitchParameters
`Quiet`	Suprime o registro no console.		SwitchParameter

Retorna:

Nenhum

Remove-CvadAcSiteMergingInfo - Remove um conjunto de informações de prefixo/sufixo de mesclagem de site existente.

Parâmetros:
- SiteName – identifica o conjunto de prefixos e sufixos do site. Este é um string e é obrigatório.
Retorna:
- Nenhum

Parâmetros de mesclagem de site

Os seguintes parâmetros podem ser usados ao executar os cmdlets de mesclagem de site. Todos os parâmetros listados são strings.

SiteName – o nome usado para identificar o conjunto de prefixos/sufixos para um site específico. Pode corresponder ao nome do site real, mas não é obrigatório. SiteName é um parâmetro obrigatório.
AdminScopedPrefix – o prefixo a ser aplicado aos escopos do administrador.
ApplicationPrefix - o prefixo a ser aplicado aos aplicativos.
ApplicationFolderPrefix – o prefixo a ser aplicado às pastas de aplicativos; ApplicationFolderPrefix pode ser combinado com ApplicationFolderRoot.
ApplicationFolderRoot – a nova pasta raiz para pastas de aplicativos. Isso cria uma hierarquia de pastas extra. ApplicationFolderRoot pode ser combinado com ApplicationFolderPrefix.
ApplicationGroupPrefix – o prefixo para grupos de aplicativos.
ApplicationUserPrefix – o prefixo a ser aplicado ao nome do aplicativo que o usuário vê.
ApplicationAdminPrefix – o prefixo a ser aplicado ao nome do aplicativo que o administrador vê.
DeliveryGroupPrefix – o prefixo a ser aplicado aos grupos de entrega.
GroupPolicyPrefix – o prefixo a ser aplicado aos nomes de política.
HostConnectionPrefix – o prefixo a ser aplicado às conexões de host.
MachineCatalogPrefix – o prefixo a ser aplicado aos catálogos de máquinas.
StoreFrontPrefix – o prefixo a ser aplicado aos nomes do StoreFront™.
TagPrefix – o prefixo a ser aplicado às tags.
AdminScopedSuffix – o sufixo a ser aplicado aos escopos do administrador.
ApplicationSuffix - o sufixo a ser aplicado aos aplicativos.
ApplicationFolderSuffix – o sufixo a ser aplicado às pastas de aplicativos; ApplicationFolderSuffix pode ser combinado com ApplicationFolderRoot.
ApplicationGroupSuffix – o sufixo para grupos de aplicativos.
ApplicationUserSuffix – o sufixo a ser aplicado ao nome do aplicativo que o usuário vê.
ApplicationAdminSuffix – o sufixo a ser aplicado ao nome do aplicativo que o administrador vê.
DeliveryGroupSuffix – o sufixo a ser aplicado aos grupos de entrega.
GroupPolicySuffix – o sufixo a ser aplicado aos nomes de política.
HostConnectionSuffix – o sufixo a ser aplicado às conexões de host.
MachineCatalogSuffix – o sufixo a ser aplicado aos catálogos de máquinas.
StoreFrontSuffix – o sufixo a ser aplicado aos nomes do StoreFront.
TagSuffix – o sufixo a ser aplicado às tags.
SiteRootFolder – o nome da pasta totalmente qualificado a ser usado para exportações e importações; pode ser uma pasta local ou um compartilhamento de arquivos.

Parâmetros genéricos

Parâmetros de acesso à nuvem

Todos os cmdlets que acessam a nuvem suportam os seguintes parâmetros extras.

Nota:

O CustomerId, ClientId e Secret podem ser colocados no arquivo CustomerInfo.yml ou especificados com o cmdlet usando os seguintes parâmetros. Quando são especificados em ambos os locais, os parâmetros do cmdlet têm precedência.

CustomerId – A ID do cliente usada nas APIs REST e é necessária para acessar todas as APIs REST. Sua ID de cliente é encontrada no Citrix Cloud.
ClientId – A ID do cliente criada no site Citrix Cloud Identity and Access Management. Isso é necessário para obter o token de portador necessário para autenticação para todas as APIs REST.
Secret – A chave secreta criada no site Citrix Cloud Identity and Access Management. Isso é necessário para obter o token de portador necessário para autenticação para todas as APIs REST.
CustomerInfoFileSpec – A especificação de arquivo apontando para um arquivo de informações do cliente para substituir o local e o nome padrão.

Parâmetros do modo de migração

Os cmdlets que modificam a configuração do site na nuvem (Import, Restore, Merge, New e Sync) suportam os seguintes parâmetros extras para fornecer maior flexibilidade.

CheckMode – Executa a operação de importação, mas não faz alterações. Todas as alterações esperadas são relatadas antes da conclusão da importação. Você pode usar este comando para testar sua importação antes que ela ocorra.
BackupFirst – Faz backup do conteúdo da nuvem para arquivos .yml antes de modificar a configuração da nuvem. Isso é habilitado por padrão.
Confirm – Quando verdadeiro, solicita que os usuários confirmem se desejam fazer alterações na configuração do site na nuvem. O cmdlet Remove mostra um prompt devido à sua natureza destrutiva. Defina como falso se nenhum prompt for desejado, como ao executar dentro de scripts automatizados. Confirm assume o valor padrão verdadeiro.
SecurityFileFolder – Esta é a pasta totalmente qualificada que contém o arquivo CustomerInfo.yml, que pode apontar para uma pasta local ou uma pasta de compartilhamento de rede que pode estar sob controle de autenticação. A ferramenta não solicitará credenciais; o acesso ao recurso controlado deve ser obtido antes de executar a ferramenta.
SiteName – Especifica o conjunto de prefixo e sufixo de mesclagem de site a ser usado na importação.
SiteActive – Especifica se o site importado está ativo ou inativo. Por padrão, este parâmetro é definido como $false, o que significa que o site importado está inativo.

Parâmetros de exibição de log

Os cmdlets Export, Import, Sync, Restore, Backup, Compare e Remove exibem o arquivo de log quando a operação é concluída. Você pode suprimir a exibição definindo o parâmetro -DisplayLog como $false. O Notepad.exe é usado por padrão para exibir o arquivo de log. Você pode especificar um editor diferente no arquivo CustomerInfo.yml.

Editor: C:\Program Files\Notepad++\notepad++.exe

Valores de retorno do cmdlet

ActionResult

Todos os cmdlets retornam o seguinte valor.

            public class ActionResult
            {
                public bool                         Overall_Success;
                public Dictionary<string, string>   Individual_Success;
                public object                       CustomResult;
            }

Overall_Success retorna um único booleano mostrando o sucesso geral do cmdlet em todos os componentes selecionados: verdadeiro significa sucesso e falso significa insucesso.

Individual_Success retorna um ou três valores para cada componente principal. O resultado de um componente pode ser Success, Failure ou Skipped. Skipped indica que o componente não foi selecionado para execução pelo cmdlet.

CustomResult é específico do cmdlet.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File e Remove retornam as seguintes informações de resultado personalizado para uma única instância de EvaluationResultData.

Nota:

Os cmdlets Export e Template não retornam um resultado personalizado.

                public class EvaluationResultData
                {
                    public Dictionary<string, Dictionary<string, ActionResultValues >> EvaluationResults;
                    public int                  Added;
                    public int                  Updated;
                    public int                  Deleted;
                    public int                  NoChange;
                    public int                  TotalChanged;
                    public EvaluationResults     OverallResult;
                    public string               CloudBackupFolder;
                    public string               SourceBackupFolder;
                }
                Where:
                public enum ActionResultValues
               {
                    Add,
                    Update,
                    Delete,
                    Identical,
                    DoNothing
                }
                public enum EvaluationResults
                {
                    Success,
                    Failure,
                    Skipped
                }

EvaluationResults exibe uma lista com uma entrada por componente selecionado. A chave é o nome do componente e o valor é uma lista de cada membro do componente e a ação tomada nesse membro do componente. As ações podem ser qualquer um dos valores de ActionResultValues.

Added, Updated, Deleted e NoChange indicam o número total de membros do componente adicionados, atualizados, excluídos ou nenhuma ação tomada, nessa ordem.

TotalChanged é a soma de Added, Updated e Deleted.

OverallResult é um único booleano indicando o resultado do cmdlet. Verdadeiro indica sucesso total em todos os componentes e falso indica falha no processamento de um ou mais componentes.

CloudBackupFolder é a especificação de arquivo totalmente qualificada do backup da configuração do site na nuvem antes que o cmdlet execute quaisquer ações de modificação da nuvem.

SourceBackupFolder é a especificação de arquivo totalmente qualificada do backup do arquivo de origem feito após a conclusão do cmdlet. Por padrão, esses arquivos estão em %HOMEPATH%\Documents\Citrix\AutoConfig.

Ajuda do PowerShell

A ajuda do PowerShell está disponível para cada cmdlet. Todos os parâmetros são documentados com cada cmdlet, juntamente com uma breve explicação do cmdlet. Para acessar a ajuda de qualquer cmdlet, digite Get-Help antes do cmdlet.

Get-Help Import-CvadAcToSite

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 migração

September 15, 2025

Contribuição de:

C C

September 15, 2025

Contribuição de:

C C

Neste artigo

Cmdlets básicos
Parâmetros de migração granular
Cmdlets relacionados a pré-requisitos
Cmdlets de suporte e solução de problemas
Cmdlets de ativação de site
Cmdlets de mesclagem de vários sites locais
Parâmetros genéricos
Valores de retorno do cmdlet
Ajuda do PowerShell

Isso foi útil?