APIs 编辑

Citrix Provisioning APIs are available on the Citrix Developer Documentation site:

• SOAP Server Programmer’s Guide
• PowerShell with Object Programmer’s Guide

PowerShell SDK files after upgrading

Files located in C:\Program Files\Citrix\PowerShell SDK are missing after upgrading. This issue occurs because the CDF version used by Citrix Provisioning does not match the version used by other components associated with Citrix Virtual Apps and Desktops. As a result, newer CDF files have a lower version number than previous ones. This issue does not affect the functionality of importing CPV device collections into CVAD machine catalogs. To resolve this issue:

1. Close Citrix Studio.
2. Mount the new Citrix Virtual Apps and Desktops ISO.
3. In the mounted ISO, navigate to \x64\DesktopStudio.
4. Right-click PVS PowerShell SDK x64 to expose a contextual menu.
5. Select Repair.
6. Run the Repair option. The installation adds the two CDF files as needed.

Active Directory group enumeration method

The Citrix Provisioning console contains the Citrix Virtual Apps and Desktops Setup Wizard, providing integration tasks between Citrix Provisioning, Citrix Virtual Apps and Desktops, and Windows Active Directory. The Wizard creates the VMs and any necessary objects in Citrix Provisioning, Citrix Virtual Apps and Desktops and Windows Active Directory.

Note:

This implementation was limited in earlier releases due to the absence of an exposed API. Without it, Citrix Provisioning users cannot run various automated testing paradigms in their environments.

Citrix Virtual Apps and Desktops and Streamed VM Wizard functionality are exposed by a service on the Provisioning Server through a PowerShell API. This API provides a PowerShell front end. It can be used to automate the functionality provided by the Streamed VM Setup Wizard and the Citrix Virtual Apps and Desktops Setup Wizard.

Tip:

The Citrix Provisioning API service uses an SSL connection which requires you to configure an X.509 certificate on the Provisioning Server.

Configure the X.509 certificate

The Citrix Provisioning API service uses an SSL connection requiring an X.509 certificate on the provisioning server. The certificate’s CA certificate must also be present on the server and console machine.

To create a self-signed certificate for Citrix Provisioning API:

1. Download and install the Windows SDK for your provisioning server operating system.
2. Open a command prompt and navigate to the bin folder of the SDK. By default: C:\Program Files (x86)\Windows Kits\SDK_Version\bin\x64> and run the following commands.
3. Create a certificate to act as your root certificate authority: makecert -n "CN= PVSRoot CA" -r -sv PVSRoot CA.pvk PVSRoot CA.cer.
4. Create and install the service certificate: makecert -sk PVSAP I -iv PVSRoot CA.pvk -n "CN= FQDN of the PVS Server" -ic PVSRoot CA.cer -sr localmachine -ss my -sky exchange -pe.
5. Install the root CA certificate in the Trusted Root Certification Authorities location on the server and console Machines: cert mgr -add "PVSRoot CA.cer" -s -r localMachine Root.
6. Run the Configuration Wizard. On the Soap SSL Configuration page, select the created certificate.

Note:

When you run PowerShell commands, use the FQDN of the PVS Server for PvsServerAddress and 54324 (default) for PvsServerPort.

Citrix Provisioning API

To use the Provisioning API with Citrix DaaS (formerly Citrix Virtual Apps and Desktops service), you must provide credentials to authenticate to Citrix Cloud.

Use the Provisioning API with Citrix DaaS

When using Citrix DaaS, the Provisioning API service running on each provisioning server requires credentials to authenticate to Citrix Cloud. After you provide these credentials, any process running with the specified user name uses the secure client credentials to authenticate to Citrix Cloud.

To provide these credentials:

1. Log in to the Citrix Cloud portal IAM page as an admin user.
2. Create a secure client from the Citrix Cloud IAM page. From this page, also record your customer ID.
3. Download the secure client to a CSV file on the PVS server.

   Important: The CSV file contains a secret that can be used to authenticate to Citrix Cloud as the user who created the secure client. Save and protect this file.

4. On each server that runs Provisioning API calls:
   1. Run a PowerShell window using the Provisioning Services user name.
   2. Download the CSV file.

   3. Run this command:

      Set-XDCredentials -CustomerId "<customerIDFromPortal>" -SecureClientFile "<CSVPath>" -ProfileType CloudAPI –StoreAs "default"
      <!--NeedCopy-->