Cloud Connector Installation

Last published : Nov 18, 2026
You can install the Cloud Connector software interactively or using the command line.
The installation occurs with the privileges of the user who begins the install. The Cloud Connector requires access to the cloud to:
  • Register the Cloud Connector with your Citrix Cloud account.
  • Download and configure the Cloud Connector services and the Microsoft .NET runtimes that they need.

Information to review before installation

Review the System requirements before installation.
The installer installs the Microsoft .NET Desktop Runtime 10 and the Microsoft ASP.NET Core Runtime 10 if the machine doesn't have them. It downloads them from the same Citrix site that it uses for the other Cloud Connector files.

Post-deployment guidance

After installation, keep all Cloud Connectors powered on continuously to ensure an always-on connection to Citrix Cloud.

Upgrades

Upgrades are normally automatically managed by Citrix Cloud. To do a manual upgrade, first uninstall the old Cloud Connector before installing the new version. Don't upgrade a previously installed Cloud Connector with a newer version. Do not upgrade individual components of the Cloud Connector separately. The Microsoft .NET runtimes aren't Cloud Connector components. Cloud Connector updates install a newer .NET 10 runtime when needed, and you can also keep the runtimes updated through Windows Update. Uninstalling the Cloud Connector doesn't remove the .NET runtimes.

Renaming machines

After installation, don't rename the machine hosting the Cloud Connector. If you need to change the server name later on, perform the following tasks:
  1. Remove the machine from the resource location:
    1. From the Citrix Cloud menu, select Resource Locations.
    2. Locate the resource location you want to manage and then select the Cloud Connectors tile.
    3. Locate the machine you want to manage and then click the ellipsis menu. Select Remove Connector.
  2. Uninstall the Cloud Connector software.
  3. Rename the machine.
  4. Install the latest version of the Cloud Connector software, as described in this article.

Moving machines to a different domain

After installation, don't move the machine hosting the Cloud Connector into a different domain. If you need to join the machine to a different domain later on, perform the following tasks:
  1. Remove the machine from the resource location.
  2. Uninstall the Cloud Connector software.
  3. Unjoin the machine from its current domain and rejoin the machine to the new domain.
  4. Install the latest version of the Cloud Connector software, as described in this article.

Considerations for cloned machines

Each machine hosting the Cloud Connector must have a unique SID and connector ID so that Citrix Cloud can communicate reliably with the machines in your resource location. If you intend to host the Cloud Connector on multiple machines in your resource location and you want to use cloned machines, perform the following steps:
  1. Prepare the machine template according to the requirements for your environment.
  2. Provision the number of machines that you intend to use as Cloud Connectors.
  3. Install the Cloud Connector on each machine, either manually or using the silent installation mode.
Installing the Cloud Connector on a machine template (before cloning) isn't supported. If you clone a machine with the Cloud Connector installed, the Cloud Connector services won't run and the machine can't connect to Citrix Cloud.

Considerations for services

The installation steps in this article describe the process for deploying Cloud Connectors, regardless of the service for which they are used.
When deploying Cloud Connectors for Citrix DaaS, verify that the AD domains where the connectors reside are active and are not showing as "unused" in the Citrix Cloud console. If you specify an unused domain during machine catalog setup in Citrix DaaS, an error might occur. For more information, see Add a resource type or activate an unused domain in Citrix Cloud in the Citrix DaaS product documentation.
For additional considerations for other services, consult the service's documentation.

Default resource locations

If you have no resource locations, create one in the Citrix Cloud console before you install Cloud Connectors. You can have only one default resource location in your account.
When you add a Cloud Connector, it joins the resource location from which you opened the Add Cloud Connector wizard. When you install from the command line with a service principal, use the resourceLocationId parameter.

Interactive installation

You can download and install Cloud Connectors using the graphical installer interface. Before you do this, you must create one or more resource locations in the Citrix Cloud management console to deploy Cloud Connectors on. For more information on resource locations, see Resource locations.

Download the Citrix Cloud Connector™ software

  1. Sign in as a Windows administrator to the machine you intend to install Citrix Cloud Connectors on.
  2. Visit https://citrix.cloud.com and sign in to your administrator account.
  3. In the Citrix Cloud console, navigate to Resource Locations from the main menu.
  4. If you do not already have a resource location, click the plus icon (+) or select Add a Resource Location. For more information, see create a resource location.
  5. Locate the resource location you want to manage and select + Add connector. The Add connector panel opens.
    Add Connector panel
  6. Select Cloud Connector, and then select Add Cloud Connector. In the Add Cloud Connector wizard, under 1. Download and install, select Download. Save the cwcconnector.exe file on the machine where you want to install the Cloud Connector..
    Add a Cloud Connector window
  7. Keep the Add Cloud Connector wizard open. You enter the registration code in it later. The wizard can be open on any computer; it doesn't need to be the connector machine.

Install the Citrix Cloud Connector software

Prerequisites

  1. Right-click the cwcconnector.exe file and select Run as administrator. If the machine doesn't have the Microsoft .NET runtimes that the Cloud Connector needs, the installer downloads and installs them automatically before its window opens. You don't need to do anything.
  2. The installer checks that it can connect to Citrix Cloud. If the check fails, Install Cloud Connector isn't available until the connection problem is fixed.
    Note:
    There is only one proxy server supported due to a limitation in Microsoft WinHTTP. For more information, see AutoProxy Issues in WinHTTP
  3. Select Manage to update the proxy server. Install Cloud Connector
  4. Select Advanced Connectivity Check to run a verbose check to ensure that the basic connectivity requirements for Connector installation are met on the machine. Advanced Connectivity Chcek

Register the Cloud Connector

  1. Select Install Cloud Connector.
  2. The Register Cloud Connector page shows an 8-character registration code. Select the copy icon to copy the code. The page shows how long the code is valid. If the code expires, select Generate new code.
    Register Cloud Connector Page
  3. Go back to the Add Cloud Connector wizard in Citrix Cloud. You can use any computer.
  4. Under 2. Install, paste the registration code and select Next. If you see Invalid or expired registration code., copy the current code from the installer and try again.
    Registration code entered
  5. On Review registration details, check the Connector name, and then select Add. Citrix Cloud shows Registered connector ‘connector name’.
    Don't close the wizard while the registration is in progress. If you close it, the code might stop working before the connector is added, and you need a new code.
    Review registration details
  6. The installer shows Registration confirmed. Finalizing connector setup... and continues.

Initial upgrade and tests

  1. The Citrix Cloud Connectivity Test window appears and the status of the Initial upgrade and tests are displayed along with Event logs.
    Initial tests in progress
  2. Select View logs to open the directory (C:\ProgramData\Citrix\WorkspaceCloud\InstallLogs) that includes all connectivity check debug logs.
  3. Once the Initial upgrade and tests are completed, you'll see the Citrix Cloud Connectivity Test is Successful as shown in the following image. The connectivity check results are displayed in the Event log box after the first upgrade.
    Initial tests complete

Activate unused domains

If you're creating resource locations and deploying Cloud Connectors for Citrix DaaS™, verify that the AD domains that you're using with Citrix DaaS are active and are not considered unused. If you specify an unused domain when setting up machine catalogs in Citrix DaaS, an error could occur.
For more information, see Add a resource type or activate an unused domain in Citrix Cloud in the Citrix DaaS product documentation.

Create additional resource locations

  1. From the Citrix Cloud management console, click the menu button and select Resource Locations.
  2. Click + Resource Location and enter a meaningful name.
  3. Click Save. Citrix Cloud displays a tile for the new resource location.
  4. In the new resource location, open the Add Cloud Connector wizard and select Download to get the Cloud Connector software.
  5. On each prepared machine, install the Cloud Connector software using either the graphical installer or the command-line installation. The Cloud Connector joins the resource location from which you opened the Add Cloud Connector wizard. With a service principal, specify the resource location with resourceLocationId.

Installation with multiple customers and existing resource locations

The Cloud Connector is added to the Citrix Cloud account and the resource location in which you enter the registration code. Before you enter the code, make sure that you're signed in to the right customer account and that you opened the Add Cloud Connector wizard from the right resource location.

Command-line installation

Silent or automated installation is supported. You can register the Cloud Connector with a service principal or with a registration code. A registration code doesn't need a service principal, but someone must enter the code in Citrix Cloud while the installer waits.
The installer is updated regularly, so download the latest installer from the Add Cloud Connector wizard for each installation.
A silent installation also installs the Microsoft .NET 10 runtimes if the machine doesn't have them.

Requirements

The following requirements and parameters apply when you install with a service principal. To install with a registration code instead, see Install from the command line with a registration code.
To use the command line installation with Citrix Cloud, you need to supply the following information:
  • The customer ID of the Citrix Cloud account for which you are installing the Cloud Connector. This ID appears at the top of the API Access tab in Identity and Access Management.
  • The ID and secret of the service principal you want to use to install the Cloud Connector. To acquire these values, you must first create a service principal. The service principal must be created with "Full Access". For more information on creating a service principal, see Create a Service Principal. Once you have the ID and secret of the service principal you can continue with Cloud Connector installation.
  • The resource location ID for the resource location that you want to associate with the Cloud Connector. To retrieve this value, select the ID button located beneath the resource location name on the Resource Locations page. If you don't supply this value, Citrix Cloud uses the ID of the default resource location.

Supported parameters

To ensure the security of the service principal ID and secret, a JSON configuration file must be provided to the installer. This file must be deleted after the installation has completed. Supported values for the configuration file are:
  • customerName Required. The customer ID shown on the API Access page in the Citrix Cloud console (within Identity and Access Management).
  • clientId Required. The service principal ID an administrator can create, located on the API Access page.
  • clientSecret Required. The service principal secret that can be downloaded after the service principal is created. Located on the API Access page.
  • resourceLocationId Recommended. The unique identifier for an existing resource location. Select the ID button to retrieve the resource location ID on the Resource Locations page in the Citrix Cloud console. If no value is specified, Citrix Cloud uses the ID of the first resource location in the account.
  • acceptTermsOfService Required. Must be set to true.

Sample configuration file

{
"customerName": "CustomerID",
"clientId": "clientID",
"clientSecret": "ClientSecret",
"resourceLocationId": "ResourceLocationId",
"acceptTermsOfService": "true"
}

Sample command

The following command silently installs the Cloud Connector software using a JSON configuration file:
CWCConnector.exe /q /ParametersFilePath:c:\cwcconnector_install_params.json
Use /q to specify a silent install.
Use Start /Wait CWCConnector.exe /ParametersFilePath:value to examine a potential error code in the case of a failure. You can use the standard mechanism of running echo %ErrorLevel% after the installation completes.

Install from the command line with a registration code

  1. On the machine where you want to install the Cloud Connector, open a Command Prompt as administrator.
  2. Run this command:
    start /wait CWCConnector.exe /q /UseKrs:true /AcceptTermsOfService:true
  3. The installer gets a registration code and writes it to its log file. Open the newest CWCConnector_<date and time>.log file in %LOCALAPPDATA%\Temp\CitrixLogs\CloudServicesSetup and find the line that starts with KRS device code:. The 8 characters after it are the registration code.
  4. In Citrix Cloud, open the Add Cloud Connector wizard for the resource location you want. Enter the code under 2. Install, select Next, and then select Add.
  5. The installer continues by itself after the code is accepted. Wait for the command to finish.
If a code expires before you enter it, the installer gets a new one automatically, up to three times. Each new code is written to the same log file.
The command uses these parameters:
  • /UseKrs:true Required. Installs with a registration code.
  • /AcceptTermsOfService:true Required if your account hasn't yet accepted the latest Citrix Cloud terms of service.
  • /KrsTimeout:seconds Optional. How long the installer waits in total for the code to be entered. The default is 2700 (45 minutes). The maximum is 3600 (60 minutes).
Don't use customerName, clientId or clientSecret with a registration code. The Cloud Connector registers with the Citrix Cloud account in which the code is entered.
If the code isn't entered in time, or the registration fails, the installer stops before it installs the Cloud Connector and returns exit code 1603.

HTTPS Configuration

To allow StoreFront™ and NetScaler Gateway appliances to securely connect to the Cloud Connector and encrypt all data, it is strongly recommended that you enable HTTPS. This requires an SSL certificate.
  • The certificate must include the FQDN used to reach the connector as the Common Name or Subject Alternative Name. If you have deployed a load balancer in front of the connector then use the load balancer's FQDN.
  • The certificate can be signed by an enterprise CA or public CA.
  • Any StoreFront and gateway servers that connect to the Cloud Connector must trust the certificate.
To enable HTTPS:
  1. Create or import a suitable certificate in the Personal Certificates store. For more information on managing certificates, see Manage certificates.
  2. Open the certificate, go to the Details tab and take a note of the Thumbprint, ignoring any spaces.
    Screenshot of certificate details
  3. Determine which IP address to bind the certificate to. Normally you can use IP address of 0.0.0.0 to apply to all IPv4 addresses. If IPv6 is enabled then use [::] to apply to all IPv6 addresses. If you only want to apply the change to a specific network adapter then make a note of the IP address of the network adapter.
  4. In an elevated command prompt run
    netsh http add sslcert ipport=<IP address>:<Port number> certhash=<Certificate Hash Number> appid={Any GUID}
    You can use any valid GUID for the AppId. It's purpose is to record which application added the binding. However the binding applies to all applications using that port.
    For example:
    C:\> netsh http add sslcert ipport=0.0.0.0:443 certhash=BC96F958848639FD101A793B87915D5F2829B0B6 appid={6DE9BEFD-F4CB-4D63-8681-E88012D6F5F1}

    SSL Certificate successfully added
  5. To disable HTTP, in the registry go to HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\DesktopServer and create a DWORD with name XMLServicesEnableNonSSL and value 0.

Next steps

  1. Set up the Citrix Cloud Connector update schedule. For information on Citrix Cloud Connector updates and managing update schedules, visit Connector updates.
  2. If you are using StoreFront, configure StoreFront so it can use the connector to reach DaaS to enumerate and launch resources. If this is the first connector in a new DaaS deployment then create a new resource feed. If this is an additional connector then it is recommended for resiliency that you add all Cloud Connectors to the server list for your existing DaaS resource feed. For more information, see Manage the resources made available in stores.
  3. If you are using StoreFront with a NetScaler gateway, you can use the connector to reach the Citrix Cloud Secure Ticket Authority (STA). For more information, see Configure Citrix Gateways.
  4. If this is the first connector on a particular Active Directory domain then you can connect that domain to Citrix Cloud. For more information, see To connect your Active Directory to Citrix Cloud.

Troubleshooting installation issues

This section details some ways of diagnosing and fixing problems you might encounter during installation. For more guidance about troubleshooting installation issues, see the Citrix Cloud Connector Troubleshooting Guide.

Installation logs

You can troubleshoot issues encountered with installation by first consulting the available log files.
Events that occurred during installation are available in the Windows Event Viewer. You can also review Cloud Connector installation logs, which are located at %LOCALAPPDATA%\Temp\CitrixLogs\CloudServicesSetup. Logs are also added to %ProgramData%\Citrix\WorkspaceCloud\InstallLogs after installation.
In %LOCALAPPDATA%\Temp\CitrixLogs\CloudServicesSetup, the log file CWCConnector_<date and time>.log also records the download and installation of the Microsoft .NET runtimes. Look for lines that contain .NET 10.

Exit codes

The following exit codes might be returned depending on the success or failure of the installation process:
  • 1603 - An unexpected error occurred
  • 2 - A prerequisite check failed
  • 0 - Installation completed successfully

Installation error

If you install the Citrix Cloud Connector software by double-clicking the installer, you might receive the following error message:
Can't reach this page.
This error can occur even if you are logged in to the machine as an administrator to install the Citrix Cloud Connector. To avoid this error, run the Citrix Cloud Connector software as an administrator by right-clicking the installer and selecting Run as administrator.

Registration code issues

  • Install Cloud Connector isn't available, or the connectivity check fails. Make sure the machine can reach https://trust.citrixnetworkapi.net on port 443. See System and Connectivity Requirements.
  • Citrix Cloud shows "Invalid or expired registration code." Copy the current code from the installer and try again. If the code has expired, select Generate new code in the installer.
  • The Cloud Connector doesn't appear in the resource location. Check that you entered the code in the right customer account and resource location, and that the installer showed Registration confirmed.
  • A command-line installation with a registration code returns exit code 1603. Open the newest CWCConnector_<date and time>.log file in %LOCALAPPDATA%\Temp\CitrixLogs\CloudServicesSetup:
    • If you find KRS connectivity pre-check failed, the machine can't reach the registration service. Allow the address through your firewall or proxy.
    • If you find KRS poll loop exited, the code wasn't entered in time. Run the installer again and enter the code sooner, or use a longer /KrsTimeout.

Connectivity failures

To ensure that the Cloud Connector can communicate with Citrix Cloud, confirm that the following Citrix services are in a Started state:
  • Citrix Cloud AD Provider
  • Citrix Cloud Agent Logger
  • Citrix Cloud Agent System
  • Citrix Cloud Agent Watchdog
  • Citrix Cloud Credential Provider
  • Citrix Config Synchronizer Service
  • Citrix High Availability Service
  • Citrix NetScaler® CloudGateway
  • Citrix Remote Broker Provider
  • Citrix Remote HCL Server
  • Citrix Session Manager Proxy
If the Citrix Cloud Agent System, Citrix Cloud Agent Watchdog, Citrix Cloud Agent Logger or Citrix Cloud Credential Provider service doesn't start, check that the Microsoft .NET 10 runtimes are installed. In Control Panel > Programs > Programs and Features, look for Microsoft Windows Desktop Runtime 10.0.x (x64) and Microsoft ASP.NET Core Runtime - 10.0.x (x64), where x is any number. If either is missing, download and install the latest version from the Microsoft .NET 10.0 download page, and then start the service again.
For more information about these services, see Installed Services.
The Cloud Connector Advanced Connectivity Check Tool can help verify that the Cloud Connector can reach Citrix Cloud and its related services.
For more information on how to resolve a failed connectivity check, see CTX224133: Cloud Connector Connectivity Check Failed.