To obtain the latest Horizon Cloud features for your cloud-connected Horizon pods, update those pods' Horizon Cloud Connector virtual appliance to the latest version applicable to Horizon Cloud.

This documentation topic describes the steps to manually update the virtual appliance within the vSphere environment in which it is deployed. If your Horizon Cloud tenant account is configured for automated updates of the Horizon Cloud Connector, the appliance is automatically updated from the cloud plane when the VMware Operations team makes a new version available to your tenant account. For details, see Configuring Automated Updates of the Horizon Cloud Connector Virtual Appliance.

Note: Proxy SSL configuration is not supported during an update of the Horizon Cloud Connector virtual appliance.

Prerequisites

  • Download the most recent version of the Horizon Cloud Connector virtual appliance that is supported for the current Horizon Cloud release. For the version supported for this Horizon Cloud release, see the Release Notes at the Horizon Cloud documentation page.
  • Verify that the new Horizon Cloud Connector virtual appliance and the existing Horizon Cloud Connector virtual appliance that needs the update are in the same network so that the new virtual appliance can establish an SSH communication with the existing virtual appliance.
  • Verify that the virtual appliance is powered on. It would be unusual if the appliance was powered off, because the Horizon Cloud Connector must maintain a connection with the cloud control plane to ensure your Horizon subscription license remains active for the cloud-connected pod.
  • Use vSphere Web Client to take a snapshot of the existing Horizon Cloud Connector virtual appliance.
  • Obtain the static IP address, DNS address, gateway address, and subnet mask for the Horizon Cloud Connector virtual appliance.
  • Verify that you have the My VMware account credentials that are valid to log in to your Horizon Cloud tenant account. As described in the onboarding information in the Deployment Guide, you use a My VMware account to log in to the Horizon Cloud Connector onboarding and management portal. If the pod's associated Active Directory domain is already registered in your Horizon Cloud tenant to which the connector is paired, a second login screen will appear after you log in with your My VMware credentials. This second login screen requests the Active Directory credentials of an administrator that has the Super Administrators role in your Horizon Cloud tenant environment. If you see that second login screen, you will need the credentials for an Active Directory account in that domain that has access permissions. For a description of this login process, see Log In to the Horizon Cloud Administration Console to Perform Management Tasks on Your Horizon Cloud Environment.
  • Add the FQDN of the vCenter Server to the /etc/hosts file on the Horizon Cloud Connector virtual appliance. This FQDN is needed for these manual update steps to work.
    After editing the /etc/hosts file, you must restart the hze-core and csms services. Use the following commands:
    systemctl restart hze-core
    systemctl restart csms
Important: Version 1.0 of the connector appliance is no longer supported. If you are updating from version 1.0, you must log in to the appliance's operating system and run the chage -E -1 -M -1 tomcat8 command in the Horizon Cloud Connector virtual appliance after you have taken its snapshot.
root@example.com [ ~ ]# chage -E -1 -M -1 tomcat8
This command is required only when updating from Horizon Cloud Connector version 1.0, and not for updating from later versions.

Procedure

  1. In a Web browser, to log in to the Horizon Cloud Connector onboarding and management portal, enter either the Horizon Cloud Connector virtual appliance IP address or, if you mapped that IP to an FQDN in your DNS, enter that FQDN in the browser.
    Use your My VMware account credentials to log in. This step logs you in to your Horizon Cloud tenant account, as described in the onboarding process in the Deployment Guide. A successful login verifies that the existing Horizon Cloud connection was successfully configured with the cloud-connected pod's Connection Server. If your Horizon Cloud tenant has a registered Active Directory domain, a second login screen will appear. If that happens, enter the appropriate Active Directory credentials, as described in Log In to the Horizon Cloud Administration Console to Perform Management Tasks on Your Horizon Cloud Environment.
  2. Deploy the latest version of the Horizon Cloud Connector virtual appliance as described in steps 1 through 8 of Connect Horizon Cloud Service with an Existing Horizon Pod to Use Horizon Subscription Licenses or Cloud-Hosted Services or Both.
    Note: If the previous instance of the Horizon Cloud Connector virtual appliance used an HTTP proxy, reconfigure the proxy settings by following the prompts in the deployment wizard. Proxy settings are not transferred from the previous virtual appliance to the new virtual appliance during a manual update.
  3. Log in to the onboarding portal for the Horizon Cloud Connector appliance that you just deployed in step 2 using its IP address in your browser.
    Log in with your My VMware credentials as described in step 1 above. If your Horizon Cloud tenant account has a registered Active Directory domain, the Active Directory login window appears and you must log in with the appropriate Active Directory credentials.
  4. Connect the latest version of the Horizon Cloud Connector appliance that you just deployed with the appropriate Connection Server instance.
    The previous version of the Horizon Cloud Connector is connected to the cloud-connected pod's Connection Server instance. In the Connect to Horizon Connection Server box, enter the FQDN of the Connection Server, and click Connect.
  5. If the display requests verification of the thumbprint certificate, click the check box to verify the thumbprint certificate for the Connection Server.
    Note: This verification is skipped if the Connection Server has a valid Root CA certificate.
  6. Enter the domain name, user name, and password for the Connection Server and click Connect.
    Note: For better auditing of Horizon Cloud Connector actions, use a unique user name and password for the Connection Server.
  7. When updating to Horizon Cloud Connector version 1.5, enable the Enable SSH on Cloud Connector toggle.
    Enabling SSH provides for the new connector appliance to communicate over SSH with the existing one for the update process. When the update is complete, you can disable this toggle.
  8. Click Upgrade in the dialog box.
  9. In the Old Cloud Connector address text box, enter the IP address of the earlier Horizon Cloud Connector virtual appliance and then click Connect.
  10. Click the check box to verify the thumbprint for the SSH connection.
  11. Click Upgrade.
    The new Horizon Cloud Connector is now managing the cloud connection between the Horizon pod and Horizon Cloud.

What to do next

If the previous instance of the Horizon Cloud Connector virtual appliance used custom CA-signed certificates, configure a new CA-signed certificate for the updated virtual appliance. Certificates are not transferred from the previous virtual appliance to the new virtual appliance during a manual update. For more information, see Configure a CA-Signed Certificate for the Horizon Cloud Connector Virtual Appliance.

Remove the old version of the appliance from your vSphere environment.

For future updates, if you want to be able to have automated updates of the Horizon Cloud Connector virtual appliance, instead of using these manual steps, see the information in Configuring Automated Updates of the Horizon Cloud Connector Virtual Appliance.