Install Cloud Connectors from the command line
You can install the Citrix Cloud Connector software interactively or use silent or automated installation.
During installation, the Cloud Connector needs cloud access to authenticate the user, validate permissions, download, and configure services. The installation occurs with the privileges of the user who initiates it.
Important:
Avoid using the same installer for repeated installations over time. Instead, obtain a new Cloud Connector from the Resource Locations page in the Citrix Cloud Japan console.
Requirements
To use the command-line installation with Citrix Cloud Japan, you need to supply the following information:
- The customer ID of the Citrix Cloud Japan 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 client ID and secret of the secure API client you want to use to install the Cloud Connector. To acquire these values, you must first create a secure client. The client ID and secret ensures that your access to the Citrix Cloud API is secured appropriately. When creating a secure client, it operates with the same administrator permissions you possess. To install a Cloud Connector, use a secure client created by a Full Access administrator, which ensures full access permissions.
- 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 Japan uses the ID of the default resource location.
Create a secure client
When creating a secure client, Citrix Cloud Japan generates a unique client ID and secret. You must supply these values when you invoke the API through the command line.
- From the Citrix Cloud Japan menu, select Identity and Access Management and then select API Access.
- From the Secure Clients tab, enter a name for your client and select Create Client. Citrix Cloud Japan generates and displays a client ID and secret for the secure client.
- Select Download to download the client ID and secret as a CSV file and store it in a secure location. Alternatively, select Copy to manually acquire each value. When finished, select Close to return to the console.
Supported parameters
For secure client security details, the installer requires a JSON configuration file. Delete this file after installation completion. Supported configuration file values include:
- customerName Required. The customer ID shown on the API Access page in the Citrix Cloud Japan console.
- clientId Required. The secure client ID, created by an administrator, is found on the API Access page.
- clientSecret Required. The secure client secret that can be downloaded after the secure client is created and it is found 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.
A sample configuration file:
{
"customerName": "*CustomerID*",
"clientId": "*ClientID*",
"clientSecret": "*ClientSecret*",
"resourceLocationId": "*ResourceLocationId*"
"acceptTermsOfService": "true",
}
<!--NeedCopy-->
A sample command line that installs using the parameter file:
CWCConnector.exe /q /ParametersFilePath:c:\cwcconnector_install_params.json
<!--NeedCopy-->
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.
Troubleshooting
Installation Logs
Installation logs are available at %LOCALAPPDATA%\Temp\CitrixLogs\CloudServicesSetup.
Also, logs are added to %ProgramData%\Citrix\WorkspaceCloud\InstallLogs after installation.
Exit codes
- 1603 - An unexpected error occurred.
- 2 - A prerequisite check failed.
- 0 - Installation completed successfully.