You can have your pod configured to perform an automated update of the Horizon Cloud Connector virtual appliance. This configuration allows the Horizon Cloud operations team to run maintenance actions on the virtual appliance from the cloud control plane, as needed for successful service operations.

Note: The following limitations apply to automated updates:
  • To participate in automated updates, your existing Horizon Cloud Connector appliance must be running with a minimum version of 1.6.0.0.
  • The automated update feature is not supported for Horizon pods deployed in the Azure VMware Solution (AVS) environment. To update your Horizon pod in AVS, see Manually Update the Horizon Cloud Connector Virtual Appliance.
Attention: The ability to configure the automated update feature is deactivated by default for Horizon Cloud Connector 1.6. To gain access to the automated update feature, you must specifically request it by contacting your VMware representative or VMware support to activate it on your Horizon Cloud tenant account.

Requirements for Automated Updates

To support automated updates of the Horizon Cloud Connector appliance, prepare your system environment by performing the following tasks:

  1. Contact your VMware representative or VMware support and request that they activate the automated update feature for your Horizon Cloud tenant account.
  2. Enable the pod to accept automated updates.

    By default, pods do not accept automated updates, even if your tenant account has the automated update feature activated. To enable a pod to receive automated updates, contact your VMware representative or VMware support. You must make a specific request for each pod that you want to receive automated updates.

  3. Verify that your system environment meets the following requirements:
    • You have deployed the existing Horizon Cloud Connector appliance with a static IP address.
    • The existing Horizon Cloud Connector appliance is running with a minimum version of 1.6.0.0.
    • You have at least 50 GB of datastore capacity available for deploying the appliance update.
    • The Horizon Cloud Connector appliance can access the ESXi host.
    • You have configured the vCenter Server and network settings in the Horizon Cloud Connector configuration portal. For detailed instructions, see the next section in this topic.
    • An unassigned static IP address is available for temporary use during the appliance update. This temporary address must be distinct from the static IP address used by your current version of the Horizon Cloud Connector appliance.

Configuring vCenter Server and Network Settings

The automated update feature deploys new versions of the Horizon Cloud Connector appliance to your vCenter Server. To prepare your system environment for these deployments, gather the required network information as specified: an unassigned static IP address and the network settings that you want to use for the updated appliance. Then perform the following steps.

Note: To perform the deployment and configuration steps required for the automated update feature, you must configure a user account with Administrator privileges on the vCenter Server.
Remember: As stated at the start of this topic, the ability to configure the automated update feature is deactivated by default for Horizon Cloud Connector 1.6. You can access the feature if and only if the configuration of your Horizon Cloud tenant account allows it. You will not see any of these elements in the user interface if you have not specifically requested the feature by contacting your VMware representative or VMware support to activate it on your tenant account.
  1. Gather the required network information as follows.
    • (Current Horizon Cloud Connector 1.9 and later) Determine the unassigned static IP address that you want to use temporarily for the updated appliance. All the other required network settings configured for the existing appliance are used for the updated appliance during the update.
    • (Current Horizon Cloud Connector 1.6 through 1.8) Gather the unassigned static IP address and network settings that you want to use for the updated appliance.
  2. Log in to the Horizon Cloud Connector configuration portal.
  3. To open the configuration screen for vCenter Server details, do one of the following:
    • (Horizon Cloud Connector 1.7 or later) Click the Configure vCenter Server and Network Details button.
    • (Horizon Cloud Connector 1.6) Click the Configure Automatic Cloud Connector Updates button.
  4. In the Horizon Cloud Connector vCenter Server Details screen, enter the FQDN of the vCenter Server, and click Get Certificate. After the certificate information appears, select I have verified the above certificate and would like to continue.
  5. Under Horizon Cloud Connector vCenter Server Credentials, enter the login credentials for a user that has Administrator privileges on the vCenter Server.
  6. Under Additional Static IP Details for Cloud Connector upgrade, configure the static IP address and other network settings as needed.
    • (Current Horizon Cloud Connector 1.9 and later) Specify the unassigned static IP address that you want to use temporarily for the new appliance version during the update. The new appliance version uses the gateway, subnet, and DNS server settings configured for the existing appliance version.
    • (Current Horizon Cloud Connector 1.6 through 1.8) Specify the unassigned static IP address that you want to use temporarily for the new appliance version during the update. The new appliance version does not use the gateway, subnet, and DNS server settings configured for the existing appliance version. To use the automated update feature, you must manually configure these settings for the new appliance version under Additional Static IP Details for Cloud Connector upgrade.
    Setting Description
    Static IP

    The temporary, unassigned static IP address that you determined earlier. This address must be distinct from the static IP address used by the current version of the appliance.

    During the update process, the new version of the appliance uses the temporary static IP address to gain network access temporarily while the current version of the appliance remains operational.

    Default Gateway (Current Horizon Cloud Connector 1.6 through 1.8 only) Gateway configuration that you want to use for the new version of the appliance.
    Subnet Mask (Current Horizon Cloud Connector 1.6 through 1.8 only) Subnet mask that you want to use for the new version of the appliance.
    DNS Servers

    (Current Horizon Cloud Connector 1.6 through 1.8 only) DNS server that you want to use for the new version of the appliance.

    Important: Configure at most one DNS server for the new appliance version. If you configure multiple DNS servers, the appliance update will fail.
  7. Click Save.

End-to-End Flow of the Automated Update Process

The automated update process for Horizon Cloud Connector follows the software industry technique known as the blue-green deployment.


Conceptual illustration of the blue-green update process.

The existing to-be-updated Horizon Cloud Connector instance is known as the blue appliance. The new version of Horizon Cloud Connector is known as the green appliance.

To view the current version number of the blue appliance, select Settings > Capacity > and click the Pods tab if needed. The version number appears next to the paired pod's name in the list.


Detail of appliance version number on Capacity page.

After you configure the vCenter Server and network settings in the Horizon Cloud Connector onboarding user interface, the end-to-end update process consists of the following steps:

  1. When VMware releases an updated version of Horizon Cloud Connector that is compatible with the blue appliance, one of the following occurs:
    • If your system environment meets all the requirements for supporting the automated update, a notification message appears when you click the version number of the pod in the Capacity page.

      Notification message for availability of update.

      In addition, the Schedule Update button becomes available on the pod details page. (To display the pod details page, select Settings > Capacity > , click the Pods tab if needed, and click the name of the pod in the list.) A notification banner on the page indicates the version number of the update that is available.


      Schedule Update button on pod details page.

      If your system environment meets all the requirements for automated updates, you can proceed to step 3 of the update process.

    • If your system environment does not meet all the requirements for automated updates, the Clear Update Errors button appears instead on the pod details page. An alert banner also notifies you that an error is preventing the update.

      Clear Update Errors button on pod details page.
  2. If one or more error conditions prevent the update, you must resolve them. Click the Clear Update Errors button or the link in the alert banner to open the Resolve Pod Update Errors dialog box. Using the message in this dialog box as guidance, perform the necessary actions or update the necessary configurations to clear the described error condition. Then validate the error resolution by selecting the check box next to the error description and clicking Continue.

    The following screenshot shows an example of the Resolve Pod Update Errors dialog box after you have validated the error resolution.


    Resolve Pod Update Errors dialog box

    It can take up to 30 minutes for the configuration changes to take effect and for the administration console to reflect these changes. When the error is cleared, the Clear Update Errors button changes to Schedule Update.

  3. You must manually schedule the update to initiate the update workflow. On the pod details page, click Schedule Update. Then set a day and time for the Horizon Cloud service to update the blue appliance to the green appliance.

    You determine the convenient time for the update to take place. Typically, the update process, including the deployment of the green appliance and the migration from the blue to the green appliance, takes up to 90 minutes. As a best practice, schedule the update at a time when the environment is least busy. After the update is scheduled, the console displays the time remaining until the scheduled update in a top banner. You can reschedule the time for the update at any time prior to the scheduled time, if required by your organization's needs.

    The following screenshot shows an example of a banner indicating the scheduled update.


    Notification banner for scheduled update.
    Important: When you schedule the update, you must specify a date and time. This time is local to your browser time zone.
  4. At your scheduled day and time, the service deploys the green appliance to the vCenter Server using the temporary IP address that you configured earlier in the Horizon Cloud Connector vCenter Server Details screen. This deployment stage typically takes around 25 minutes to complete. However, the exact duration can vary depending on the capacity and characteristics of your system infrastructure.
    Note: During the update process—which includes the stages of deployment, migration, and IP address reassignment—you cannot perform administrative tasks on the pod paired with the blue appliance that is undergoing the update. In addition, all action buttons in the Horizon Cloud Connector configuration portal are in a deactivated state. However, the blue appliance remains fully operational during the update and the pod remains connected to the cloud control plane and the subscription license service.
  5. After the green appliance is completely deployed, the service migrates the configuration from the blue appliance to the green appliance. The migration stage typically takes around 10 minutes to complete.
  6. When the migration is complete, the temporary IP address is unassigned from the green appliance and the permanent IP address of your Horizon Cloud Connector instance is reassigned from the blue appliance to the green appliance.
    Note: The reassignment results in a short period of downtime lasting less than a minute, during which the pod momentarily loses its connection to the control plane and Horizon Cloud services. During this time, end users might momentarily lose their connection sessions to remote desktops and applications on the pod.
    Once the IP address reassignment is complete:
    • The green appliance becomes fully operational and the pod's connection to the control plane and the subscription license service is restored.
    • The green appliance takes a name composed of the blue appliance's name with the new version number appended as the suffix.
    • The blue appliance remains in the datastore and is powered off.
  7. To verify that the update has completed successfully, do the following:
    1. Select Settings > Capacity > and click the Pods tab if needed. The version number of the updated appliance appears next to the pod's name in the list.

      Appliance version number on Capacity page after update.
    2. Log in to the Horizon Cloud Connector configuration portal of the green appliance and verify the health of the Horizon Cloud Connector components.
Note: Updating to version 1.10 or later of Horizon Cloud Connector automatically activates all Horizon Cloud services. Horizon Cloud Connector version 1.10 or later does not support the Basic Feature profile that was available with version 1.8 or 1.9 of the appliance.

Error Conditions That Prevent Automated Updates

Examples of common error messages include:

  • Check to ensure Cloud Connector is online
  • Cloud Connector is not deployed with static IP
  • Unable to contact vCenter for upgrade. Please re-enter vCenter credentials in the Cloud Connector setup
  • There is not enough disk space to perform upgrade. Minimum required disk space is 50 GB.

Make the necessary configuration changes to fix the specified error so that you can proceed to schedule the automated update.