SDK e API

Last published : Nov 13, 2026
Diverse SDK e API sono disponibili con questa versione. Per accedere agli SDK e alle API, vai a Build anything with Citrix. Da lì, seleziona Citrix Workspace per accedere alle informazioni di programmazione per Citrix Virtual Apps and Desktops e i suoi componenti correlati.
Nota:
L'SDK di Citrix Virtual Apps and Desktops™ e l'SDK di Citrix Group Policy possono essere installati come modulo o come snap-in. Diversi SDK di componenti (come Citrix Licensing, Citrix Provisioning e StoreFront) si installano utilizzando solo uno snap-in.
Questo prodotto supporta le versioni di PowerShell dalla 3 alla 5.

SDK di Citrix Virtual Apps and Desktops

Questo SDK si installa automaticamente come modulo PowerShell quando si installa un Delivery Controller™ o Studio. Ciò consente di utilizzare i cmdlet di questo SDK senza dover aggiungere snap-in. (Le istruzioni sono fornite di seguito se si sceglie di installare questo SDK come snap-in.)

Autorizzazioni

È necessario eseguire la shell o lo script utilizzando un'identità che disponga dei diritti di amministrazione Citrix. Sebbene i membri del gruppo di amministratori locali sul Controller abbiano automaticamente privilegi amministrativi completi per consentire l'installazione di Citrix Virtual Apps o Citrix Virtual Desktops™, Citrix raccomanda che per il normale funzionamento si creino amministratori Citrix con i diritti appropriati, piuttosto che utilizzare l'account degli amministratori locali.

Accedere ed eseguire i cmdlet

  1. Avviare una shell in PowerShell: Aprire Studio, selezionare la scheda PowerShell e quindi fare clic su Launch PowerShell.
  2. Per utilizzare i cmdlet SDK all'interno degli script, impostare i criteri di esecuzione in PowerShell. Per informazioni sui criteri di esecuzione di PowerShell, consultare la documentazione Microsoft.
  3. Se si desidera utilizzare lo snap-in (anziché il modulo), aggiungere lo snap-in utilizzando il cmdlet Add-PSSnapin (o asnp).
    V1 e V2 indicano la versione dello snap-in. Gli snap-in di XenDesktop 5 sono la versione 1. Gli snap-in di Citrix Virtual Apps and Desktops e delle versioni precedenti di XenDesktop 7 sono la versione 2. Ad esempio, per installare lo snap-in di Citrix Virtual Apps and Desktops, digitare Add-PSSnapin Citrix.ADIdentity.Admin.V2. Per importare tutti i cmdlet, digitare: Add-PSSnapin Citrix.*.Admin.V*
È ora possibile utilizzare i cmdlet e i file della guida.

SDK di Group Policy

L'SDK di Citrix Group Policy consente di visualizzare e configurare le impostazioni e i filtri di Group Policy. Questo SDK utilizza un provider PowerShell per creare un'unità virtuale che corrisponde alle impostazioni e ai filtri di macchina e utente. Il provider appare come un'estensione di New-PSDrive.
Per utilizzare l'SDK di Group Policy, è necessario che siano installati Studio o l'SDK di Citrix Virtual Apps and Desktops.
Il provider PowerShell dei Criteri di gruppo Citrix è disponibile come modulo o snap-in.
  • Per utilizzare il modulo, non è necessario alcun lavoro aggiuntivo.
  • Per aggiungere lo snap-in, digitare Add-PSSnapin citrix.common.grouppolicy.
Per accedere alla guida, digitare: help New-PSDrive -path localgpo:/.
Per creare un'unità virtuale e caricarla con le impostazioni, digitare New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string> dove la stringa Controller è il nome di dominio completo di un Controller nel sito a cui si desidera connettersi e da cui caricare le impostazioni.

API REST di Citrix Virtual Apps and Desktops

Con le API REST di Citrix Virtual Apps and Desktops, è possibile automatizzare la gestione delle risorse all'interno di una distribuzione di Citrix Virtual Apps and Desktops.
Le API REST di Citrix Virtual Apps and Desktops sono disponibili all'indirizzo <https://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/docs/citrix-virtual-apps-and-desktops-apis>. Le API non applicabili a Citrix Virtual Apps and Desktops sono contrassegnate di conseguenza. Seguire le indicazioni fornite per configurare l'accesso al servizio API e utilizzare le API per gestire e ottimizzare le risorse.

OData del servizio Monitor

L'API Monitor consente l'accesso ai dati del servizio Monitor utilizzando la versione 3 o 4 dell'API OData. È possibile creare dashboard di monitoraggio e reporting personalizzati basati sui dati interrogati dal servizio Monitor. OData V.4 si basa sull'API Web ASP.NET e supporta le query di aggregazione.
Per maggiori informazioni, consultare l'API OData del servizio Monitor.