Before a Horizon pod on a VMware SDDC-based platform can participate in multi-cloud assignments brokered by Universal Broker, you must install the required plugin on each Connection Server instance in that pod. The Universal Broker plugin supports communication between the brokering service and the Connection Server instances within a pod.

When installing the Universal Broker plugin, observe the following considerations:
  • You must download and install the version of the Universal Broker plugin that is compatible with your Connection Server version. To download the correct version of the plugin:
    1. Log in to my.vmware.com with your My VMware credentials and navigate to Product Downloads > Products A - Z > VMware Horizon Service > View Download Components.
    2. Locate the Horizon Cloud Connector product downloads group and click Go To Downloads. The Universal Broker plugin installer is on the Horizon Cloud Connector downloads page.
    3. To access and download the correct version of the plugin for your Connection Server version, select the appropriate version of Horizon Cloud Connector on the downloads page.
      Note: The Horizon Cloud Connector version listed in the following table indicates the location of the Universal Broker plugin installer and does not necessarily correspond to the version of Horizon Cloud Connector that you have paired with your Connection Server. For example, you might be running Connection Server 7.11 paired with Horizon Cloud Connector 1.7. However, you still must select Horizon Cloud Connector 1.5 on the downloads page to access the installer for version 19.4 of the plugin which is compatible with Connection Server 7.11.
      If your Connection Server version is: Select this Horizon Cloud Connector version: Then download this Universal Broker plugin version:
      7.11 1.5 19.4
      7.12 or 8.0 (2006) 1.7 20.3
      7.13 1.8 20.10
      8.1 (2012) 1.9 21.01
  • If a pod has multiple Connection Server instances, you must install the Universal Broker plugin on each Connection Server instance.
  • You must install the same version of the plugin on all Connection Server instances within participating pods. For example, if you upgrade the plugin to a later version on one Connection Server instance, you must upgrade the plugin to that same version on every other Connection Server instance within the pod.
  • If you add a new Connection Server instance to a participating pod, you must install the plugin on the new Connection Server instance.
  • Any existing plugin installation is lost during a Connection Server upgrade. If you upgrade your Horizon deployment, you must reinstall the plugin immediately after upgrading each Connection Server instance to the later version.

    For example, if you upgrade your Connection Server instances to version 7.12, you must then install version 20.1 of the plugin on those Connection Server instances.

  • During the plugin installation, the Connection Server service is restarted and all administration console sessions on the Connection Server are logged off.
  • In this release of Universal Broker, the plugin only supports IPv4.
  • When working with the LDAP configuration in a Connection Server instance that has the Universal Broker plugin installed, observe the following guidelines:
    • In addition to making a backup copy of the LDAP configuration, take a virtual-machine snapshot of the current Connection Server instance. If you use the backup to restore the LDAP configuration to an earlier state, you can use the snapshot to populate the restored LDAP configuration with the information required by the Universal Broker plugin to function.
    • When restoring the LDAP configuration to an earlier state, only use LDAP backups made after the plugin was installed on the Connection Server.
    • If you restore the LDAP configuration to a state earlier than the Universal Broker plugin installation, certain information required by the plugin will be missing in the restored LDAP configuration. Therefore, the plugin will not function.

After downloading the correct version of the Universal Broker plugin for your Connection Server version, use the following procedures to install the plugin on the Connection Server instances within your pod.

  • To install the Universal Broker plugin silently on a bulk deployment of Connection Server instances, use the following command. Replace X.X.X with the version number and yyyyyyyy with the build number of the plugin installer that you downloaded. Replace <portNumber> with the TCP port that the plugin uses to listen for and accept incoming requests from the Universal Broker client.
    horizon-universal-broker-plugin-X.X.X-yyyyyyyy-x64.exe /s /v"LISTENPORT=<portNumber> /qn"
  • To install the Universal Broker plugin on an individual Connection Server instance, perform the numbered steps outlined later in this topic.

Prerequisites

Verify that:

  • Each Connection Server instance on the pod is running version 7.11 or later, and you have downloaded the compatible version of the Universal Broker plugin for your Connection Server version.
  • You have both Horizon administrator and local administrator privileges on the Connection Server. The plugin installer only runs when initiated by an administrator with both of these privileges.

Procedure

  1. If needed, place the downloaded plugin installer file on the Connection Server.
  2. Run the .exe installer file.
  3. At the Welcome screen of the installer wizard, click Next.
  4. Accept the End-User License Agreement, and click Next.
  5. At the Configuration screen, specify the required port information.
    1. Enter the TCP port number that the Universal Broker plugin will use to listen for and accept incoming requests from the Universal Broker client.
      Note: The installer validates that the specified port is available. If the port already has a process running on it, a warning message appears and the installation is stopped. To resume the installation, you must specify an available TCP port.
    2. Select Configure Windows firewall exception automatically if you want the installer to configure the firewall exception required to allow incoming connections through the specified port. Deselect this option if you want to configure the firewall exception manually.
      Note: The Windows firewall exception is mandatory for Universal Broker, whether you instruct the installer to configure it or you configure it yourself.
    3. Click Next.
  6. Follow the prompts in the remaining screens of the wizard to finish installing the Universal Broker plugin on the Connection Server.

What to do next

Important: If, at a later time, you want to uninstall the Universal Broker plugin or the Connection Server instance, follow this order of uninstallation:
  1. First, uninstall the Universal Broker plugin.
  2. Next, uninstall Connection Server.

If you uninstall Connection Server first, a system error results and you will not be able to uninstall the Universal Broker plugin.

Note: If you want to change the port that the Universal Broker plugin uses to listen for incoming requests from the Universal Broker client, do the following:
  1. In the LDAP configuration for the Connection Server, change the value of the pae-RCXServerPort property to the new port number.
  2. Restart the Connection Server.
  3. If needed, update the corresponding Windows firewall exception to allow incoming traffic through the new port.

The new port configuration takes effect after the Connection Server and the Universal Broker plugin complete their restart sequences.