Citrix Virtual Apps and Desktops

SDKs e APIs

Vários SDKs e APIs estão disponíveis nesta versão. Para obter detalhes, consulte a documentação do desenvolvedor. Nela você pode acessar informações de programação para:

  • Delivery Controller
  • Monitor Service OData
  • StoreFront

O Citrix Group Policy SDK permite exibir e definir configurações e filtros da Política de Grupo. Ele usa um provedor do PowerShell para criar uma unidade virtual que corresponde a configurações e filtros de máquina e usuário. O provedor aparece como uma extensão a New-PSDrive. Para usar o Group Policy SDK, o Studio ou o Citrix Virtual Apps and Desktops SDK devem estar instalados. Consulte Group Policy SDK para obter mais informações.

Delivery Controller SDK

O SDK inclui vários snap-ins do PowerShell que são instalados automaticamente quando você instala um Delivery Controller ou o Studio.

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

Para 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 mais informações sobre a política de execução do PowerShell, consulte a documentação da Microsoft.

    Nota:

    O SDK atual é instalado como um snap-in do PowerShell e um módulo do PowerShell.

    Com a adição da funcionalidade de módulo, você pode usar os cmdlets desse SDK sem um cmdlet Add-PSSnapin (ou asnp) precedente.

    Para SDKs de componentes associados (como Citrix Licensing, Citrix Provisioning e StoreFront) que são instalados apenas como um snap-in, o uso de seus cmdlets ainda requer um Add-PSSnapin (ou asnp) precedente.

    Se você quiser usar esse SDK por meio do snap-in, continue com a próxima etapa.

  3. Adicione os snap-ins necessários ao ambiente do PowerShell usando o cmdlet Add -PSSnapin no console Windows PowerShell.

    V1 e V2 indicam a versão do snap-in. Os snap-ins do XenDesktop 5 são da versão 1. O Citrix Virtual Apps and Desktops e snap-ins anteriores à versão XenDesktop 7 são da versão 2 Por exemplo, para instalar snap-ins do Citrix Virtual Apps and Desktops, digite Add-PSSnapin Citrix.ADIdentity.Admin.V2. Para importar todos os cmdlets, digite: Add-PSSnapin Citrix.*.Admin.V*

Depois de adicionar os snap-ins, você pode acessar os cmdlets e a ajuda associada.

Para ver a ajuda do cmdlet atual do PowerShell do Citrix Virtual Apps and Desktops:

  1. No console do PowerShell, adicione os snap-ins da Citrix: Add –PSSnapin Citrix.*.Admin.V*.
  2. Siga as instruções em The Windows PowerShell ISE.

Group Policy SDK

Para usar o Group Policy SDK, o Studio ou o Citrix Virtual Apps and Desktops SDK devem estar instalados.

Para adicionar o Group Policy SDK, 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 cadeia de caracteres Controller é o nome de domínio totalmente qualificado de um Controller no site ao qual você deseja se conectar e do qual deseja carregar configurações.

Monitor Service OData

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

SDKs e APIs