Skip to content

Installing the Cloud Access Connector

Once the files are downloaded and the access token is set, you can install the Cloud Access Connector. If you are not already connected, connect to the machine via SSH and navigate to the ~/v2connector directory.

Latest Installer Version

Ensure that you are using the latest installer prior to installing or upgrading the Cloud Access Connector.

Install the Connector by running the ./cloud-access-connector install command, using the options best suited to your system architecture and requirements. If required values are not provided on the command line, you will be prompted for them.

You need to obtain a Cloud Access Connector token prior to installation. For information on how to obtain this token, see Obtaining a Cloud Access Connector Token.

sudo ./cloud-access-connector install -t "token obtained in previous section" [options]

When installed with no options, the Connector will not use MFA, and will use your SSL key and certificate.

The available options are:

Flag Description
--token (-t) Required. The token generated for Cloud Access Manager.
‑‑enable‑mfa Installs with multi-factor authentication enabled.
‑‑self-signed Installs the Cloud Access Connector with self-signed certificates.
This mode is not secure and is intended for testing.
The --insecure flag is still supported.
--force-install Replaces any existing Cloud Access Connector installation.

The following flags can be used to provide values at the command line. If they are omitted from the command and are required, you will be prompted for them:

Flag                                           Type Description
‑‑reg‑code String Cloud Access Software registration code, provided by Teradici.
‑‑domain String The AD domain that remote workstations will join.
--domain-group String The Distinguished Name of the user group you want to use to log into the legacy Cloud Access Manager management interface.
This option can be used when you install a Cloud Access Connector or update an existing Cloud Access Connector.
‑‑sa‑user String The Active Directory service account username.
‑‑sa‑password String The Active Directory service account password.
‑‑radius‑server String The FQDN or IP address of the RADIUS server to use for MFA.
This flag is optional.
‑‑radius‑port String The RADIUS server port.
If not specified, the default port (1812) is used.
If --radius-server is specifed then this flag is optional.
‑‑radius‑secret String The shared secret used for configuring RADIUS authentication.
If --radius-server is specifed then this flag is required.
‑‑ssl‑key String The full path and filename of the SSL key to use.
The --self-signed flag overrides this flag.
‑‑ssl‑cert String The full path and filename of the SSL certificate (in PEM format) to use.
The --self-signed flag overrides this flag.
--https-proxy String Specify the URL for a HTTPS proxy
(overrides related proxy settings in environment variables)
‑‑accept‑policies Automatically accept the EULA and Privacy Policy.
--retrieve-agent-state Boolean Enables the broker to retrieve the agent state for unmanaged and managed remote workstations.
The default value for this flag is false.
The available states are In Session, Ready, Starting, Stopping, Stopped and Unknown.
The value of this flag can either be true or false.
--show-agent-state Boolean Controls if the agent state is displayed as part of the remote workstation name in the PCoIP Client.
The default value for this flag is true.
Setting the value of this flag to true and the --retrieve-agent-state flag to false will result in no agent state displaying.
--domain-controller String Specifies one or more domain controllers to use with the Cloud Access Connector.
For more information, see Specifing Domain Controllers.

Configuring User and Computer Active Directory Distinguished Names

The Cloud Access Connector can optionally be configured to use specific Distinguished Names (DNs) when querying Active Directory for users and computers has been extended to be available when running the update command in addition to the install command. You can also configure the frequency at which the Cloud Access Connector syncs this data with the CAM service, as outlined in the following table:

Flag                                           Type Description
‑‑users-dn String The base DN to search for users within Active Directory. This option may be specified multiple times to provide multiple DNs.
--computers-dn String The base DN to search for computers within Active Directory. This option may be specified multiple times to provide multiple DNs.
--sync-interval String The interval time in minutes for how often to sync Active Directory users and computers with the CAM service.
It must be at least five minutes.

These flags outlined are optional and may be provided with the install or update commands. If you are updating a Cloud Access Connector you only need to provide these flags if you want to changing the DN settings associated with that Cloud Access Connector. If you do not add these flags when performing an update then the Cloud Access Connector will retain the same settings.

You can reset user or computer DNs to their default values by providing an explicit DN with a wider scope than the original DN used.

If you want to have multiple connectors with different Active Directory settings then you need to ensure that each Cloud Access Connector belongs to a separate deployment. If you create two Cloud Access Connectors that are associated with the same deployment then both will use the same Active Directory sync settings, and the configuration of the last Cloud Access Connector created will take precedence.

Installing the Cloud Access Connector for Testing

To install the Cloud Access Connector with MFA enabled and in insecure mode for testing, you would run this command (note that we are providing the --enable-mfa flag but not the RADIUS server information, so prompts will appear to collect it):

sudo ./cloud-access-connector install -t $token --enable-mfa --self-signed

When the installer completes, the IP address of the Cloud Access Connector will be displayed and you will be directed to go to https://cam.teradici.com to begin managing your deployments, connectors and remote workstations.

Cloud Access Connector - Troubleshooting

If there is an issue installing the Cloud Access Connector or an existing Connector is failing, please see the troubleshooting section on Cloud Access Connector Connectivity. Within this section there are steps to check the following:

  • Remote Workstation connections
  • Active Directory connections
  • Cloud Access Connector component information