In this step in the workflow of onboarding a Horizon pod to Horizon Cloud, you download and deploy the Horizon Cloud Connector in your vSphere environment. The result of these steps is the Horizon Cloud Connector virtual appliance is deployed and running in your vSphere environment.

Important: You must deploy the Horizon Cloud Connector virtual appliance into your pod's vSphere environment using vSphere Client or vSphere Web Client. Do not deploy the appliance directly into the ESXi host.

Prerequisites

Procedure

  1. As described in the prerequisites list, download the Horizon Cloud Connector appliance using the link provided in your subscription email.
    The Horizon Cloud Connector appliance is available as an OVA file and has its home location in my.vmware.com after you log in to my.vmware.com using your My VMware account credentials.
    Important: Ensure that the downloaded version is the most recent version —version 1.8.0.0 or later — to enable the most up-to-date features. If you previously downloaded a Horizon Cloud Connector OVA with a version prior to 1.8.0.0, log in to my.vmware.com and obtain the most recent version to use to pair your pod.
  2. Use vSphere Client or vSphere Web Client to deploy the Horizon Cloud Connector appliance as an OVF template into your Horizon pod.
    For general information about deploying OVF templates, see the vSphere Virtual Machine Administration guide on the VMware vSphere Documentation page.
    The OVF deployment wizard has several steps, where you make typical OVF deployment choices such as which host, which datastore, which network, and so on.
    • (Horizon Cloud Connector 1.8 or later) The Configuration step is where you select a feature profile for the Horizon Cloud Connector appliance. The feature profile determines which Horizon Cloud services to activate for the appliance.
      Note: If you are deploying Horizon Cloud Connector 1.7 or earlier, you do not have the option to select a feature profile. Deploying one of these versions of the appliance always activates the subscription license service and all additional cloud-hosted services, such as the Cloud Monitoring Service (CMS).
    • The Customize template step is where you provide details that are specific for the Horizon Cloud Connector appliance.
    Important: You might have best results deploying the appliance into your pod when you use the VMware vSphere ® Web Client, which is a Flex-based user interface. If you deploy using the VMware vSphere ® Client™, which is the newest HTML5-based user interface, you might encounter an error message about an invalid value. That issue is caused by a known issue in the vSphere Client, and is not an issue with the Horizon Cloud Connector appliance package. If you encounter that error, deploy the appliance using the Flex-based user interface instead.
  3. (Horizon Cloud Connector 1.8 or later) In the Configuration wizard step, select a feature profile to specify the Horizon Cloud services that are activated for the appliance.
    Note: Each feature profile has specific resource requirements. Before you select a profile for the appliance, ensure that you have configured the minimum resource capacity required by that profile, as described in VMware Horizon Pods with Horizon Cloud - Requirements Checklist - Updated as Appropriate for Connecting Pods Starting from the October 2020 Service Release.
    Feature Profile Description
    Full Feature

    Activates all supported Horizon Cloud services for the appliance. These services include:

    • Horizon subscription license service
    • Cloud Broker Client Service, which supports Universal Broker and the creation of multi-cloud assignments
    • Cloud Monitoring Service, which gives you the ability to monitor capacity, usage, and health within and across your fleet of cloud-connected pods
    • Image Locality Service, which supports the Horizon Image Management Service

    This feature profile is selected by default.

    Basic Feature

    Activates the subscription license service only. The Cloud Broker Client Service, Cloud Monitoring Service, and Image Locality Service are all deactivated.

    Select this profile if you do not want to use additional Horizon Cloud services with the pod and you want to reduce the resource usage of the Horizon Cloud Connector appliance.

    Note: If you select this feature profile and are onboarding your first pod into a new tenant account, manually turn off the Cloud Monitoring Service (CMS) setting after pairing the appliance with your pod. Due to a known limitation, the CMS setting does not automatically turn off when you select the Basic Feature profile. Turning off the setting manually ensures that the administration console does not make unnecessary attempts to connect to the CMS service. See the end of the topic Complete Pairing the Horizon Pod with Horizon Cloud Using the Horizon Cloud Connector Configuration Portal.

    If you want to use additional Horizon Cloud services after deploying the appliance, you must activate each service manually. See Manually Activate Horizon Cloud Services for Horizon Cloud Connector 1.8 or Later.

  4. In the Customize template wizard step, provide input for the required fields and for those items that are appropriate for your environment.
    The input in this step is used to configure the virtual appliance.
    1. Specify a root password for the appliance that meets the security standards of a strong password. Verify that the password contains a minimum of eight characters with at least one capital, one numeric, and one special character.
      Important: Due to a known limitation, the OVF deployment wizard continues to deploy the virtual appliance even if you specify a root password that does not contain a special character. In this case, the deployment succeeds but you will be blocked from logging in to the virtual appliance's operating system after deployment. To ensure your access to the virtual appliance after it is deployed, verify that your root password contains at least one special character.
    2. Specify a static IP address for the virtual appliance.
      Do not use IPv6 with the Horizon Cloud Connector virtual appliance. IPv6 is not supported.
    3. If your environment requires use of an HTTP proxy server for your virtual appliances to access the Internet, configure the proxy-related settings.
      Important: Keep the following considerations in mind:
      • Proxy SSL configuration is not supported for the self-signed certificate for the Horizon Cloud Connector virtual appliance.
      • (Horizon Cloud Connector 1.6 or later) To ensure that only outbound requests to the Internet route through the HTTP proxy, configure no-proxy hosts that bypass the proxy server when receiving internal requests from the appliance. At the minimum, for No Proxy For, enter the DNS subdomain of the Connection Server and vCenter Server instances associated with the pod that will be paired with Horizon Cloud Connector. You can also specify no-proxy hosts by entering an IP range, using a comma separator between entries as shown in the following example:
        .ad-domain.example.com, 10.109.*
        If you leave the No Proxy For setting blank, the virtual appliance fetches the Connection Server host names provided by the administrator or discovered through querying the pod and configures those hosts as implicit no-proxy hosts.
  5. Power on the Horizon Cloud Connector appliance.
  6. When the appliance is fully powered on, use the vSphere Web Client's option to start the Horizon Cloud Connector appliance's console.
    The Horizon Cloud Connector appliance's blue console screen appears. That blue console screen displays the URL address to load in your browser for the onboarding workflow. The following screenshot is an example for a deployed appliance that has address https://10.92.245.255/.
    Blue console of the Horizon Cloud Connector as it appears in the vSphere Client.
  7. Complete the steps in Enable SSH Access to the Horizon Cloud Connector Before Pairing It with Your Horizon Connection Server.
  8. If you want to use a fully qualified domain name (FQDN) for the Horizon Cloud Connector virtual appliance and resolve the host name, create a forward and reverse lookup record in your DNS server that maps that FQDN to the Horizon Cloud Connector virtual appliance's static IP.
  9. Continue with the pod onboarding workflow by doing one of the following.