Citrix DaaS

Cmdlets da ferramenta Automated Configuration

Esta página lista todos os cmdlets e parâmetros suportados pela configuração automatizada.

Todos os cmdlets adotam parâmetros com um dos seguintes tipos.

  • Cadeia de caracteres
  • Lista de cadeias de caracteres
  • Booleano: $true ou $false
  • SwitchParameter: presença das médias dos parâmetros $true; ausência das médias dos parâmetros $false

Nota:

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

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

Categoria Cmdlet Descrição
Migração de local para nuvem Export-CvadAcToFile Exportar arquivos locais para arquivos YAML.
  Import-CvadAcToSite Importar arquivos YAML para a nuvem. Suporta operações de criação, atualização e exclusão.
  Merge-CvadAcToSite Importar arquivos YAML para a nuvem. Oferece suporte a operações de criação e atualização.
  New-CvadAcToSite Importar arquivos YAML para a nuvem. Oferece suporte a operações de criação e atualização.
  Sync-CvadAcToSite Exportar e importar em uma única etapa.
  Migração granular No caso de componentes, use parâmetros com os comandos acima. Exemplos: MachineCatalogs, Tags. No caso de nomes de componentes, use parâmetros com os comandos acima. Exemplos: IncludeByName, ExcludeByName. Migrar 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 da nuvem. Esse site na nuvem pode ser igual ou diferente do site de nuvem de origem.
  Remove-CvadAcFromSite Remova membros do componente da nuvem.
  Migração granular No caso de componentes, use parâmetros com os comandos acima. Exemplos: MachineCatalogs, Tags. No caso de nomes de componentes, use parâmetros com os comandos acima. Exemplos: IncludeByName, ExcludeByName. Migrar 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 Criar um arquivo de informações do consumidor.
  Set-CvadAcCustomerInfoFile Atualizar um arquivo de informações do consumidor 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 o status do conector.
  Test-CvadAcConnectionWithSite Teste a conexão com o site da nuvem.
  Find-CvadAcConnector Localiza os conectores existentes e determina seu estado de execução.
  Get-CvadAcCustomerSites Retorna a lista de todos os sites de consumidores.
  New-CvadAcTemplateToFile Cria um arquivo de modelo para componentes selecionados.
  Show-CvadAcDocument Exibe essa documentação no navegador padrão.
  Find-CvadAcInFile Localizar no componente de pesquisas de arquivos YAML procurando membros que correspondam a um ou mais nomes que possam conter curingas.
Cmdlets de ativação do site Set-CvadAcSiteActiveStateOnPrem Define o estado do site local como ativo ou inativo.
  Set-CvadAcSiteActiveStateCloud Define o estado do site da nuvem como ativo ou inativo.
Mesclagem de vários cmdlets de sites locais New-CvadAcSiteMergingInfo Cria um conjunto de informações de prefixo/sufixo de mesclagem de sites.
  Set-CvadAcSiteMergingInfo Atualiza um conjunto de informações de prefixo/sufixo de mesclagem de sites 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 locais para a nuvem

  • Export-CvadAcToFile - Exportar arquivos locais para arquivos YAML.

    Exporta a configuração da configuração local. Essa é 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 Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos   Lista de cadeias de caracteres
    TargetFolder Especifica a pasta de destino da exportação.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    AdminAddress Especifica o DNS ou o endereço IP do Delivery Controller quando a exportação não está sendo executada no Controlador de Entrega.   Cadeia de caracteres
    CheckUserAndMachines Verifica se os usuários e as 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 o backup de arquivos YAML 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:

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 da nuvem:

  • Adicionar, atualizar e excluir
  • Adicionar e atualizar somente
  • Adicionar apenas
Cmdlet Adicionar Atualizar Delete
Importar X X X
Mesclar X X  
Novo X    
  • Import-CvadAcToSite - Importar arquivos YAML para a nuvem. Suporta operações de criação, atualização e exclusão.

    Importa todos os arquivos locais para a nuvem. Esse comando garante que o estado final da nuvem seja idêntico ao estado local. Essa opção exclui todas as alterações existentes na nuvem. Os arquivos de configuração de site importados são provenientes de %HOMEPATH%\Documents\Citrix\AutoConfig. Use com cuidado.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes.   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos.   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem.   SwitchParameters
    SourceFolder Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    Merge Quando definido como $true, só adiciona componentes ao site da 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 esse parâmetro é $true.   $true ou $false
    MergePolicies Mesclar configurações de política e filtros. A mesclagem ocorre somente quando uma política que está sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas de nuvem DDC contêm as configurações e os filtros que já tinham, além de novas configurações e filtros que estão sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.   SwitchParameter
    OnErrorAction Consulte Parâmetro OnErrorAction.   Cadeia de caracteres

    Retorna:

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

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

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes.   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos.   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem.   SwitchParameters
    SourceFolder Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    Merge Quando definido como $true, só adiciona componentes ao site da 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 esse parâmetro é $true.   $true ou $false
    MergePolicies Mesclar configurações de política e filtros. A mesclagem ocorre somente quando uma política que está sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas de nuvem DDC contêm as configurações e os filtros que já tinham, além de novas configurações e filtros que estão sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.   SwitchParameter
    OnErrorAction Consulte Parâmetro OnErrorAction.   Cadeia de caracteres

    Retorna:

  • New-CvadAcToSite - Importar 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 adiciona apenas novos componentes. Os componentes existentes do site na nuvem não são atualizados nem excluídos. Use esse comando se for necessário que os componentes do site de nuvem existentes permaneçam inalterados.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes.   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos.   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem.   SwitchParameters
    SourceFolder Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    OnErrorAction Consulte Parâmetro OnErrorAction.   Cadeia de caracteres

    Retorna:

  • Sync-CvadAcToSite - Exportar e importar em uma única etapa.

    A sincronização executa a exportação e a 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 Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    SourceTargetFolder Especifica a pasta de destino de exportação/importação.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    AdminAddress Especifica o DNS ou o endereço IP do controlador de entrega quando a exportação não está sendo executada no controlador de entrega.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    Merge Quando definido como $true, só adiciona componentes ao site da 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 esse parâmetro é $true.   $true ou $false
    MergePolicies Mesclar configurações de política e filtros. A mesclagem ocorre somente quando uma política que está sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas de nuvem DDC contêm as configurações e os filtros que já tinham, além de novas configurações e filtros que estão sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.   SwitchParameter

    Retorna:

Cmdlets de nuvem para nuvem

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

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

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes   SwitchParameters
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    TargetFolder Especifica a pasta de destino da exportação.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    ZipResults Compacta o backup de arquivos YAML 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:

  • Restore-CvadAcToSite - Restaura arquivos YAML de backup para o site da nuvem. Esse site na nuvem pode ser igual ou diferente do site de nuvem de origem.

    Restaura o site da 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 que devem ser restaurados no site da nuvem. Essa deve ser uma especificação de pasta totalmente qualificada. Esse cmdlet pode ser usado para reverter para a configuração anterior ou para fazer backup e restaurar seu site na nuvem. Esse comando pode adicionar, excluir e atualizar seu site na nuvem.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes.   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos.   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem.   SwitchParameters
    RestoreFolder Identifica a pasta que contém os arquivos .yml que devem ser restaurados no site da nuvem. Essa deve ser uma especificação de pasta totalmente qualificada.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    Merge Quando definido como $true, só adiciona componentes ao site da 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 esse parâmetro é $true.   $true ou $false
    MergePolicies Mesclar configurações de política e filtros. A mesclagem ocorre somente quando uma política que está sendo importada já existe no DDC da nuvem. O resultado da mesclagem de políticas é que as políticas de nuvem DDC contêm as configurações e os filtros que já tinham, além de novas configurações e filtros que estão sendo importados. Observe que, quando ocorrem colisões de configuração e filtro, os valores importados têm precedência.   SwitchParameter
    OnErrorAction Consulte Parâmetro OnErrorAction.   Cadeia de caracteres

    Retorna:

  • Remove-CvadAcFromSite — Remover membros do componente da nuvem.

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

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false

    Retorna:

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 Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes.   SwitchParameters
    Filtrar por nomes de objetos Consulte Filtragem por nomes de objetos.   Lista de cadeias de caracteres
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem.   SwitchParameters
    SourceFolder Identifica uma pasta raiz substituta para %HOMEPATH%\Documents\Citrix\AutoConfig.   Cadeia de caracteres
    Locale Especifica o idioma do texto legível por seres humanos que pode ser exportado.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true ou $false
    Merge Quando definido como $true, só adiciona componentes ao site da 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 esse parâmetro é $true.   $true ou $false
    OnErrorAction Consulte Parâmetro OnErrorAction.   Cadeia de caracteres

    Retorna:

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 não é especificado nenhum parâmetro de componente.

  • All
  • Tags
  • AdminRolesScopes
  • MachineCatalogs
  • StoreFronts
  • DeliveryGroups
  • ApplicationGroups
  • Applications
  • GroupPolicies

Filtrar por nomes de objetos

Migrar por nomes de componentes

Os ExcludeByName parâmetros IncludeByName e 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 substituirá qualquer outro parâmetro e será criada uma entrada na lista de correção de log para identificar o componente e o nome do membro que foi excluído.

IncludeByName e ExcludeByName obtêm uma lista de nomes de membros de componentes. Qualquer nome pode conter um ou mais curingas. Dois tipos de curingas têm suporte. A lista de nomes de membros de componentes deve estar 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 obter um arquivo que contém uma lista de membros em que cada membro pode ser explícito ou conter curingas. Cada linha do arquivo pode conter um membro. Os espaços à esquerda e à direita são cortados 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). Podem ser listados vários arquivos, que também podem ser 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. Esse parâmetro é sempre uma lista de inclusão que identifica os membros a serem incluídos com base na associação do grupo de entrega.

ByDeliveryGroupName pega uma lista de nomes de grupos de entrega. Qualquer nome pode conter um ou mais curingas. Dois tipos de curingas têm suporte.

  • * 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 desativado

ExcludeDisabled filtra das operações de importação todos os aplicativos e grupos de aplicativos que estão desativados. ExcludeDisabled passa para o valor padrão false, o que significa que todos os aplicativos e grupos de aplicativos são importados independentemente do estado ativado.

Por nome de máquina

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

ByMachineName usa uma lista de nomes de máquinas em que qualquer nome pode conter um ou mais curingas. Dois tipos de curingas têm suporte.

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

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

Nota:

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

Mesclar máquinas

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

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

Cmdlets relacionados a pré-requisitos

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

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    CustomerId ID do consumidor. x Cadeia de caracteres
    ClientId ID de consumidor do consumidor criado no Citrix Cloud. O CustomerID e o Secret devem ser especificados ao usar esse parâmetro. Condicionalmente Cadeia de caracteres
    Secret Chave secreta do consumidor criada no Citrix Cloud. O CustomerID e o ClientID devem ser especificados ao usar esse parâmetro. Condicionalmente Cadeia de caracteres
    Environment Ambiente Production, ProductionGov ou ProductionJP.   Enumeração
    LogFileName Altere o prefixo do arquivo de log do CitrixLog para outra coisa.   Cadeia de caracteres
    AltRootUrl Use somente sob a direção da Citrix.   Cadeia de caracteres
    StopOnError Interrompe a operação no primeiro erro.   $true ou $false
    TargetFolder Use a pasta especificada como a pasta raiz em vez de %HOMEPATH%\Documents\Citrix\AutoConfig.   Cadeia de caracteres
    Locale Use o local especificado em vez da localidade derivada do sistema em que a ferramenta é executada.   Cadeia de caracteres
    Editor Use o editor especificado para exibir o log na conclusão de cada cmdlet. O Notepad.exe é o editor padrão. Esse parâmetro deve incluir a especificação de arquivo totalmente qualificada para o editor e o editor deve tomar a especificação do arquivo de log como seu único parâmetro.   Cadeia de caracteres
    SecurityCsvFileSpec A especificação de arquivo totalmente qualificada que aponta para o arquivo SecurityClient.csv baixado do Citrix Identity and Access Management. O CustomerID deve ser especificado quando esse parâmetro é usado.   Cadeia de caracteres

    Retorna:

  • Set-CvadAcCustomerInfoFile - Atualize um arquivo de informações do consumidor existente. Somente os parâmetros especificados pelo cmdlet são alterados. Todos os valores de parâmetros não especificados no arquivo CustomerInfo.yml permanecem inalterados.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    CustomerId ID do consumidor.   Cadeia de caracteres
    ClientId ID de consumidor do consumidor criado no Citrix Cloud.   Cadeia de caracteres
    Secret Chave secreta do consumidor criada no Citrix Cloud.   Cadeia de caracteres
    Environment Ambiente Production, ProductionGov ou ProductionJP.   Enumeração
    LogFileName Altere o prefixo do arquivo de log do CitrixLog para outra coisa.   Cadeia de caracteres
    StopOnError Interrompe a operação no primeiro erro.   $true ou $false
    TargetFolder Use a pasta especificada como a pasta raiz em vez de %HOMEPATH%\Documents\Citrix\AutoConfig.   Cadeia de caracteres
    Locale Use o local especificado em vez da localidade derivada do sistema em que a ferramenta é executada.   Cadeia de caracteres
    Editor Use o editor especificado para exibir o log na conclusão de cada cmdlet. O Notepad.exe é o editor padrão. Esse parâmetro deve incluir a especificação de arquivo totalmente qualificada para o editor e o editor deve tomar a especificação do arquivo de log como seu único parâmetro.   Cadeia de caracteres
    SecurityCsvFileSpec A especificação de arquivo totalmente qualificada que aponta para o arquivo SecurityClient.csv baixado do Citrix Identity and Access Management. O CustomerID deve ser especificado quando esse parâmetro é usado.   Cadeia de caracteres

    Retorna:

Parâmetros relacionados aos pré-requisitos

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

  • Environment – Ambiente Production ou ProductionGov.
  • LogFileName – Altere o prefixo do arquivo de log do CitrixLog para outra coisa.
  • StopOnError – Interrompe a operação no primeiro erro.
  • AlternateRootFolder – Usar a pasta especificada como a pasta raiz em vez de %HOMEPATH%\Documents\Citrix\AutoConfig.
  • Locale – Usar o local especificado em vez da localidade derivada do sistema em que a ferramenta é executada.
  • Editor – Usar o editor especificado para exibir o log na conclusão de cada cmdlet. O Notepad.exe é o editor padrão. Esse parâmetro deve incluir a especificação de arquivo totalmente qualificada para o editor e o editor deve tomar a especificação do 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 consumidor (CustomerInfo.yml e CvadAcSecurity.yml) não estã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 no carimbo de data/hora. Esse arquivo zip também pode funcionar como um backup.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    TargetFolder Especifica uma pasta de destino para criar e salvar o arquivo zip.   Cadeia de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter

    Retorna:

    • O arquivo zip com o nome e a localização é 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 o status do conector.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    SiteId Identifica o site ao qual se conectar.   Cadeia de caracteres
    AdminAddress Este é o endereço DNS ou IP do Delivery Controller local usado para verificar o nível de acesso do administrador. Isso é necessário se a ferramenta não estiver sendo executada em um Delivery Controller.   Cadeia de caracteres

    Retorna:

    • Exibe os resultados de cada item.
  • Test-CvadAcConnectionWithSite — Teste a conexão com o site da nuvem para verificar se a conexão de comunicação está funcionando. Esse cmdlet usa os parâmetros de acesso à nuvem ou o arquivo CustomerInfo.yml para especificar as informações de conexão do consumidor.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    Quiet Suprimir o registro em log no console.   SwitchParameter

    Retorna:

    • Os resultados do teste são exibidos na linha de comando.
  • Find-CvadAcConnector - Localiza os conectores existentes e determina seu estado de execução. Esse cmdlet usa informações do arquivo CustomerInfo.yml ou do parâmetro de ID do cliente para localizar os conectores do consumidor.

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    CustomerInfoFileSpec A especificação do arquivo que aponta para um arquivo de informações do consumidor para substituir o local e o nome padrão. Esse parâmetro é ignorado quando é fornecido o parâmetro CustomerId.   Cadeia de caracteres
    CustomerId O ID do consumidor. Esse parâmetro substitui o mesmo valor no arquivo CustomerInfo.yml.   Cadeia de caracteres

    Retorna:

    • Os resultados são mostrados na linha de comando.
  • Get-CvadAcCustomerSites - Retorna a lista de todos os sites dos consumidores. Esse cmdlet usa os parâmetros de acesso à nuvem ou o arquivo CustomerInfo.yml para especificar as informações de conexão do consumidor.

    Parâmetros:

    Retorna:

    • Exibe uma lista de IDs de sites de consumidor 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
    Migrar por componentes Consulte Migrar por componentes   SwitchParameters
    TargetFolder Especifica a pasta de destino da exportação.   Cadeia de caracteres

    Retorna:

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

    Parâmetros:

    • Nenhuma.

    Retorna:

    • Exibir esta página da Web no navegador da Web padrão.
  • Find-CvadAcInFile - Encontrar no componente de pesquisas de arquivos YAML procurando membros que correspondam a um ou mais nomes que possam conter curingas. O resultado é um relatório de membros encontrados. Localizar no arquivo só pode pesquisar um componente por vez. Localizar no 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 Obrigatório? Tipo
    Migrar por componentes Consulte Migrar por componentes. Nota: O valor -All não é válido.   SwitchParameters
    IncludeByName Uma lista que especifica os nomes dos grupos de entrega que devem ser incluídos ao definir o estado ativo do site como ativo. Os caracteres curinga ‘*’ e ‘?’ são suportados em nomes.   Lista de cadeias de caracteres
    Unique Indicar apenas membros encontrados exclusivamente.   SwitchParameter
    IncludeYaml Inclua o YAML específico do membro.   SwitchParameter
    FindSourceFolder A pasta em que a função de busca começa.   Cadeia de caracteres
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   SwitchParameter
    Quiet Suprimir o registro em log no console.   SwitchParameter

    Retorno:

    • Cria um relatório que contém membros encontrados para o componente especificado.

Cmdlets de ativação do site

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

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

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    SiteActive Quando presente, define o site local como ativo removendo o modo de manutenção de todos os grupos de entrega. Quando esse parâmetro não está presente, o modo de manutenção é definido em todos os grupos de entrega.   SwitchParameter
    IncludeByName Uma lista que especifica os nomes dos grupos de entrega que devem ser incluídos ao definir o estado ativo do site como ativo. Os caracteres curinga ‘*’ e ‘?’ são suportados em nomes.   Lista de cadeias de caracteres
    ExcludeByName Uma lista que especifica os nomes dos grupos de entrega que devem ser excluídos ao definir o estado ativo do site como ativo. Os caracteres curinga ‘*’ e ‘?’ são suportados em nomes.   Lista de cadeias de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true or $false

    Retorna:

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

    Parâmetros:

    Nome Descrição Obrigatório? Tipo
    Parâmetros de acesso à nuvem Consulte Parâmetros de acesso à nuvem   SwitchParameters
    SiteActive Quando presente, define o site local como ativo removendo o modo de manutenção de todos os grupos de entrega. Quando esse parâmetro não está presente, o modo de manutenção é definido em todos os grupos de entrega.   SwitchParameter
    IncludeByName Uma lista que especifica os nomes dos grupos de entrega que devem ser incluídos ao definir o estado ativo do site como ativo. Os caracteres curinga ‘*’ e ‘?’ são suportados em nomes.   Lista de cadeias de caracteres
    ExcludeByName Uma lista que especifica os nomes dos grupos de entrega que devem ser excluídos ao definir o estado ativo do site como ativo. Os caracteres curinga ‘*’ e ‘?’ são suportados em nomes.   Lista de cadeias de caracteres
    Quiet Suprimir o registro em log no console.   SwitchParameter
    DisplayLog Exibe o arquivo de log quando o cmdlet é concluído. Defina como $false para suprimir a exibição do log.   $true or $false

    Retorna:

Mesclagem de vários cmdlets de 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 sites. Não é necessário conhecer 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. Ele pode corresponder ao nome do site real, mas não obrigatoriamente. x Cadeia de caracteres
    Parâmetros de fusão do site Consulte Parâmetros de fusão do site   SwitchParameters
    Quiet Suprimir o registro em log no console.   SwitchParameter

    Retorna:

    • Nenhuma
  • Set-CvadAcSiteMergingInfo - Atualiza um conjunto de informações de prefixo/sufixo de mesclagem de sites 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. Ele pode corresponder ao nome do site real, mas não obrigatoriamente. x Cadeia de caracteres
    Parâmetros de fusão do site Consulte Parâmetros de fusão do site   SwitchParameters
    Quiet Suprimir o registro em log no console.   SwitchParameter

    Retorna:

    • Nenhuma
  • 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. Esta é uma cadeia de caracteres e é obrigatória.

    Retorna:

    • Nenhuma

Parâmetros de fusão do site

Os parâmetros a seguir podem ser usados ao executar os cmdlets de mesclagem de sites. Todos os parâmetros listados são cadeias de caracteres.

  • SiteName - o nome usado para identificar o conjunto de prefixos/sufixos para um site específico. Ele pode corresponder ao nome do site real, mas não obrigatoriamente. SiteName é um parâmetro obrigatório.
  • AdminScopedPrefix - o prefixo que deve ser aplicado aos escopos do administrador.
  • ApplicationPrefix - o prefixo que deve ser aplicado aos aplicativos.
  • ApplicationFolderPrefix - o prefixo que deve ser aplicado às pastas de aplicativos; ApplicationFolderPrefix pode ser combinado com ApplicationFolderRoot.
  • ApplicationFolderRoot - a nova pasta raiz para as pastas do aplicativo. Isso cria uma hierarquia de pastas extra. ApplicationFolderRoot pode ser combinado com ApplicationFolderPrefix.
  • ApplicationGroupPrefix - o prefixo para grupos de aplicativos.
  • ApplicationUserPrefix - o prefixo que deve ser aplicado ao nome do aplicativo que o usuário vê.
  • ApplicationAdminPrefix - o prefixo que deve ser aplicado ao nome do aplicativo que o administrador vê.
  • DeliveryGroupPrefix - o prefixo que deve ser aplicado aos grupos de entrega.
  • GroupPolicyPrefix - o prefixo que deve ser aplicado aos nomes das políticas.
  • HostConnectionPrefix - o prefixo que deve ser aplicado às conexões de host.
  • MachineCatalogPrefix - o prefixo que deve ser aplicado aos catálogos de máquinas.
  • StoreFrontPrefix - o prefixo que deve ser aplicado aos nomes do StoreFront.
  • TagPrefix - o prefixo que deve ser aplicado às tags.
  • AdminScopedSuffix - o sufixo que deve ser aplicado aos escopos do administrador.
  • ApplicationSuffix - o sufixo que deve ser aplicado aos aplicativos.
  • ApplicationFolderSuffix - o sufixo que deve ser aplicado às pastas de aplicativos; ApplicationFolderSuffix pode ser combinado com ApplicationFolderRoot.
  • ApplicationGroupSuffix - o sufixo para grupos de aplicativos.
  • ApplicationUserSuffix - o sufixo que deve ser aplicado ao nome do aplicativo que o usuário vê.
  • ApplicationAdminSuffix - o sufixo que deve ser aplicado ao nome do aplicativo que o administrador vê.
  • DeliveryGroupSuffix - o sufixo que deve ser aplicado aos grupos de entrega.
  • GroupPolicySuffix - o sufixo que deve ser aplicado aos nomes das políticas.
  • HostConnectionSuffix - o sufixo que deve ser aplicado às conexões do host.
  • MachineCatalogSuffix - o sufixo que deve ser aplicado aos catálogos de máquinas.
  • StoreFrontSuffix - o sufixo que deve ser aplicado aos nomes do StoreFront.
  • TagSuffix - o sufixo que deve ser aplicado às tags.
  • SiteRootFolder - o nome da pasta totalmente qualificado que deve 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 oferecem suporte aos 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 eles são especificados em ambos os lugares, os parâmetros do cmdlet têm precedência.

  • CustomerId – O ID do cliente usado nas APIs Rest e é necessário para acessar todas as APIs Rest. Seu ID de cliente é encontrado no Citrix Cloud.
  • ClientId – O ClientID criado no site Citrix Cloud Identity and Access Management. Isso é necessário para obter o token de portador necessário para autenticação de 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 de todas as APIs Rest.
  • CustomerInfoFileSpec — A especificação do arquivo que aponta para um arquivo de informações do consumidor 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) oferecem suporte aos seguintes parâmetros extras para fornecer mais 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 esse comando para testar sua importação antes que ela ocorra.
  • BackupFirst – Faz backup do conteúdo da nuvem em arquivos .yml antes de modificar a configuração da nuvem. Essa opção está ativada por padrão.
  • Confirm – Quando true, solicita que os usuários confirmem que desejam fazer alterações na configuração do site na nuvem. O cmdlet Remove mostra um prompt devido à sua natureza destrutiva. Defina como false se não desejar nenhum prompt, como executar dentro de scripts automatizados. O padrão de Confirm é true.
  • 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 prefixo de mesclagem do site e o sufixo definidos a serem usados ao importar.
  • SiteActive – Especifica se o site importado está ativo ou inativo. Por padrão, esse 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 como 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 que mostra o sucesso geral do cmdlet em todos os componentes selecionados: verdadeiro, que significa bem-sucedido, e falso, que significa malsucedido.

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 resultados personalizados para uma única instância do 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 executada nesse membro do componente. As ações podem ser qualquer um dos valores de ActionResultValues.

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

TotalChanged é a soma de Added, Updated e Deleted.

OverallResult é um único booleano que indica o resultado do cmdlet. O valor true indica sucesso total em todos os componentes e false indica falha no processamento de um ou mais componentes.

CloudBackupFolder é a especificação de arquivo totalmente qualificada do backup de configuração do site na nuvem antes do cmdlet executar qualquer ação de modificação na 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 sobre o cmdlet. Para acessar a ajuda de qualquer cmdlet, digite Get-Help na frente do cmdlet.

Get-Help Import-CvadAcToSite

Cmdlets da ferramenta Automated Configuration