SDKとAPIについて
このリリースでは、いくつかのSDKとAPIが利用可能です。SDKとAPIにアクセスするには、Build anything with Citrixにアクセスしてください。そこから、Citrix Workspaceを選択して、Citrix Virtual Apps and Desktopsおよび関連コンポーネントのプログラミング情報にアクセスします。
注：
Citrix Virtual Apps and Desktops™ のSDKとCitrix Group Policy SDKは、モジュールまたはスナップインとしてインストールできます。Citrixライセンス、Citrixプロビジョニング、StoreFrontなどのいくつかのコンポーネントSDKは、スナップインのみを使用してインストールされます。
この製品は、PowerShellバージョン3から5をサポートしています。
シトリックス仮想アプリケーションおよびデスクトップSDK
このSDKは、Delivery Controller™またはStudioをインストールすると、PowerShellモジュールとして自動的にインストールされます。これにより、スナップインを追加することなく、このSDKのコマンドレットを使用できます。（このSDKをスナップインとしてインストールすることを選択した場合、手順は以下に記載されています。）
アクセス権
Citrix管理権限を持つIDを使用してシェルまたはスクリプトを実行する必要があります。Controller上のローカル管理者グループのメンバーは、Citrix Virtual AppsまたはCitrix Virtual Desktops™をインストールするための完全な管理権限を自動的に持ちますが、Citrixは、通常の操作では、ローカル管理者アカウントを使用するのではなく、適切な権限を持つCitrix管理者を作成することを推奨します。
コマンドレットへのアクセスと実行
- PowerShellでシェルを起動するには、Studioを開いて、PowerShellタブを選択し、Launch PowerShellをクリックしてください。
- スクリプト内でSDKコマンドレットを使用するには、PowerShellで実行ポリシーを設定します。PowerShellの実行ポリシーについては、Microsoftのドキュメントを参照してください。
-
モジュールではなくスナップインを使用する場合は、
Add-PSSnapin（またはasnp）コマンドレットを使用してスナップインを追加します。V1とV2はスナップインのバージョンを示します。XenDesktop 5のスナップインはバージョン1です。Citrix Virtual Apps and Desktops、および以前のXenDesktop 7バージョンのスナップインはバージョン2です。たとえば、Citrix Virtual Apps and Desktopsスナップインをインストールするには、
Add-PSSnapin Citrix.ADIdentity.Admin.V2と入力します。すべてのコマンドレットをインポートするには、次のように入力します。Add-PSSnapin Citrix.*.Admin.V*
これで、コマンドレットとヘルプファイルを使用できます。
- このSDKのヘルプファイルにアクセスするには、Categoriesリストで製品またはコンポーネントを選択し、Citrix Virtual Apps and Desktops SDKを選択します。
- PowerShellに関するガイダンスについては、Windows PowerShell 統合スクリプト環境 (ISE)を参照してください。
グループポリシーSDK
CitrixグループポリシーSDKを使用すると、グループポリシー設定とフィルターを表示および構成できます。このSDKは、PowerShellプロバイダーを使用して、マシンとユーザーの設定およびフィルターに対応する仮想ドライブを作成します。プロバイダーはNew-PSDriveの拡張機能として表示されます。
グループポリシーSDKを使用するには、StudioまたはCitrix Virtual Apps and Desktops SDKのいずれかがインストールされている必要があります。
CitrixグループポリシーPowerShellプロバイダーは、モジュールまたはスナップインとして利用できます。
- モジュールを使用する場合、追加の作業は必要ありません。
- スナップインを追加するには、
Add-PSSnapin citrix.common.grouppolicyと入力します。
ヘルプにアクセスするには、次のように入力します: help New-PSDrive -path localgpo:/。
仮想ドライブを作成し、設定をロードするには、New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string>と入力します。ここで、Controller文字列は、接続して設定をロードするサイトのControllerの完全修飾ドメイン名です。
シトリックス バーチャル アプリケーションズ アンド デスクトップス REST API
シトリックス バーチャル アプリケーションズ アンド デスクトップス REST APIを使用すると、シトリックス バーチャル アプリケーションズ アンド デスクトップス展開内のリソースの管理を自動化できます。
Citrix Virtual Apps and Desktops REST APIはhttps://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/docs/citrix-virtual-apps-and-desktops-apisで利用できます。Citrix Virtual Apps and Desktopsに適用されないAPIは、そのようにマークされています。そこにあるガイダンスに従って、APIサービスへのアクセスを構成し、APIを使用してリソースを管理および最適化してください。
モニターサービス OData
Monitor APIは、OData APIのバージョン3または4を使用してMonitor Serviceデータへのアクセスを許可します。Monitor Serviceデータからクエリされたデータに基づいて、カスタマイズされた監視およびレポートダッシュボードを作成できます。OData V.4はASP.NET Web APIに基づいており、集計クエリをサポートしています。
詳細については、Monitor Service OData APIを参照してください。