SDKs e APIs

Last published : Nov 13, 2026
Vários SDKs e APIs estão disponíveis com esta versão. Para acessar os SDKs e APIs, vá para Crie qualquer coisa com Citrix. A partir daí, selecione Citrix Workspace para acessar informações de programação para Citrix Virtual Apps and Desktops e seus componentes relacionados.
Nota:
O SDK do Citrix Virtual Apps and Desktops™ e o SDK da Política de Grupo do Citrix podem ser instalados como um módulo ou um snap-in. Vários SDKs de componentes (como Citrix Licensing, Citrix Provisioning e StoreFront) são instalados usando apenas um snap-in.
Este produto oferece suporte às versões 3 a 5 do PowerShell.

SDK do Citrix Virtual Apps and Desktops

Este SDK é instalado automaticamente como um módulo PowerShell quando você instala um Delivery Controller™ ou o Studio. Isso permite que você use os cmdlets deste SDK sem precisar adicionar snap-ins. (As instruções são fornecidas abaixo se você optar por instalar este SDK como um snap-in.)

Permissões

Você deve executar o shell ou script usando uma identidade que tenha direitos de administração do Citrix. Embora os membros do grupo de administradores locais no Controller tenham automaticamente privilégios administrativos completos para permitir que o Citrix Virtual Apps ou o Citrix Virtual Desktops™ sejam instalados, o Citrix recomenda que, para operação normal, você crie administradores Citrix com os direitos apropriados, em vez de usar a conta de administradores locais.

Acessar e executar os cmdlets

  1. Inicie um shell no PowerShell: Abra o Studio, selecione a guia PowerShell e clique em Launch PowerShell.
  2. Para usar cmdlets do SDK em scripts, defina a política de execução no PowerShell. Para obter informações sobre a política de execução do PowerShell, consulte a documentação da Microsoft.
  3. Se você quiser usar o snap-in (em vez do módulo), adicione o snap-in usando o cmdlet Add-PSSnapin (ou asnp).
    V1 e V2 denotam a versão do snap-in. Os snap-ins do XenDesktop 5 são a versão 1. Os snap-ins do Citrix Virtual Apps and Desktops e das versões anteriores do XenDesktop 7 são a versão 2. Por exemplo, para instalar o snap-in do Citrix Virtual Apps and Desktops, digite Add-PSSnapin Citrix.ADIdentity.Admin.V2. Para importar todos os cmdlets, digite: Add-PSSnapin Citrix.*.Admin.V*
Agora você pode usar os cmdlets e os arquivos de ajuda.

SDK da Política de Grupo

O SDK da Política de Grupo do Citrix permite exibir e configurar as configurações e filtros da Política de Grupo. Este SDK usa um provedor PowerShell para criar uma unidade virtual que corresponde às configurações e filtros de máquina e usuário. O provedor aparece como uma extensão para New-PSDrive.
Para usar o SDK da Política de Grupo, o Studio ou o SDK do Citrix Virtual Apps and Desktops deve estar instalado.
O provedor PowerShell de Política de Grupo do Citrix está disponível como um módulo ou um snap-in.
  • Para usar o módulo, nenhum trabalho adicional é necessário.
  • Para adicionar o snap-in, digite Add-PSSnapin citrix.common.grouppolicy.
Para acessar a ajuda, digite: help New-PSDrive -path localgpo:/.
Para criar uma unidade virtual e carregá-la com configurações, digite New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string> onde a string do Controlador é o nome de domínio totalmente qualificado de um Controlador no site ao qual você deseja se conectar e carregar as configurações.

OData do Serviço de Monitoramento

A API do Monitor permite o acesso aos dados do Serviço de Monitoramento usando a Versão 3 ou 4 da API OData. Você pode criar painéis de monitoramento e relatórios personalizados com base nos dados consultados do Serviço de Monitoramento. O OData V.4 é baseado na API Web ASP.NET e oferece suporte a consultas de agregação.
Para obter mais informações, consulte a API OData do Serviço de Monitoramento.