This documentation page describes the Add Horizon Edge workflow steps in Horizon Universal Console for the use case where you have the Horizon Plus subscription, have already completed the steps of logging in to the Horizon Universal Console and selecting your Horizon Cloud region, and now need to connect your Horizon 8 pod to the Horizon Control Plane.
Introduction
Deploying a Horizon 8 Edge consists of deploying a Horizon Edge Gateway appliance into the desired virtualization platform, pairing that appliance with the Horizon Cloud control plane, and configuring details of the Horizon 8 pod's Horizon Connection Server for your Horizon 8 Edge.
Note: Onboard each Horizon 8 pod as an individual Horizon Edge.
This end-to-end process has multiple steps.
-
You start this process within the Horizon Universal Console.
-
Halfway through, you deploy an OVA appliance into your vSphere environment (non-federated). You must use the pairing code information that the system creates in the first part of the process in the Deploy OVF Template UI fields as you are deploying the OVA.
Note: A Horizon Edge Gateway OVA/OVF deployment is only available for Horizon 8 providers with an All-in-SDDC architecture or a capacity type of Private Data Center. For Horizon 8 providers with a federated architecture, see the procedure for your specific capacity type.
-
After the appliance is powered up, you return to the Horizon Universal Console to verify that the pairing status is successful and you complete the remaining steps in this console to add details of the Horizon 8 Edge.
Before You Begin
- Review the Requirements Checklist for Deploying a Horizon 8 Edge and ensure that those requirements are fulfilled.
- Review the Port and Protocol Requirements for Deploying Horizon 8 Edge and ensure that those requirements are fulfilled.
- Determine the fully-qualified domain name (FQDN) that you will use for the deployed Horizon Edge Gateway appliance. The UI wizard asks you to input that FQDN.
- If the Horizon Connection Server involved in this Horizon Edge has a self-signed certificate, ensure you know the certificate fingerprint for the wizard's verification step.
Starting the Add Horizon Edge Wizard
You deploy a Horizon Edge using the console's Add Horizon Edge wizard.
The console makes the Add Horizon Edge wizard available from various entry points. Your starting point in the console for this step typically depends on whether your environment is greenfield or it has an existing Horizon Edge.
- If you have just finished the steps described at Horizon Plus Documentation, there are no existing Horizon Edges in your environment and the console displays its Welcome screen. In this case, you start the console's Add Horizon Edge wizard by clicking Start.
- If your environment already has at least one Horizon Edge, the Horizon Universal Console's Capacity page contains a grid that lists the existing Horizon Edge. In this scenario, you navigate to the Capacity page and begin adding another Horizon Edge from there.
-
Start the console's Add Horizon Edge wizard, either from the Welcome screen if your environment has no existing Horizon Edges or from the Capacity page if you have an existing Horizon Edge.
The console displays its Add Horizon Edge UI stepper wizard starting at its Step 1.
-
Complete the steps by following the procedure described at Add and Deploy a Horizon 8 Edge.
Considerations As You Deploy the OVA into Your vSphere Environment
As you use the Deploy OVF Template tool to deploy the OVA into your environment, keep in mind these important points. These items are critical for a successful end-to-end deployment.
A Horizon Edge Gateway OVA/OVF deployment is only available for Horizon 8 providers with an All-in-SDDC architecture or a capacity type of Private Data Center. For Horizon 8 providers with a federated architecture, see the procedure for your specific capacity type.
- At the Deploy and Pair Horizon Edge Gateway step, you will see a field labeled Pairing Code. This pairing code is very important to a successful end-to-end process. You must use this pairing code within the Deploy OVF Template UI when you deploy the appliance into your vSphere environment.
- When you copy the pairing code from the wizard step, you must use the copy icon because the console does not display the full pairing code string. The code string is longer than what the console displays and so simply highlighting the displayed text and copying that will fail to get the complete code string.
- In the Deploy OVF Template UI's Customize template step, in the field Connection String, you must enter the Pairing Code string that you copied in the preceding step, from the Add Horizon Edge wizard.
- Even though at the time of this writing you might see that the on-screen text indicates the Connection String field is optional, be aware that entering the pairing code is a critical key to a successful Horizon Edge Gateway Appliance deployment.
For more information, see Add and Deploy a Horizon 8 Edge.
Results
If all is successful, the console closes the wizard UI and displays the details page for this newly added Horizon Edge.
Depending on network traffic, the system might take a minute to complete updating the connectivity status indicators in the details page.
If you later want to edit the details of the Horizon Edge or delete it, navigate to the Capacity page, select the Horizon Edge from the list, and use the appropriate action (Edit or Delete).
Was this page helpful?