The Integration Broker is a VMware Identity Manager component that is used to communicate with the Citrix server farm. You install the Integration Broker on premises on a supported Windows Server.

Follow these guidelines when you deploy the Integration Broker.

  • You can install the Integration Broker on Windows Server 2008 R2, Windows Server 2012, or Windows Server 2012 R2.

  • Integration Broker version requirements:

    VMware Identity Manager or Connector Version

    Integration Broker Version Supported

    VMware Identity Manager 3.0

    3.0

    VMware Identity Manager Connector 2017.8.1.0 (Connector released with VMware Identity Manager 3.0)

    3.0

    VMware Identity Manager 2.9.1 or earlier

    2.9.1 or earlier

    VMware Identity Manager Connector 2.9.1 or earlier

    2.9.1 or earlier

    Note:

    To use the Citrix StoreFront REST API, Integration Broker 2.9.1 or later is required. For XenApp or XenDesktop 7.x, Integration Broker 2.6 or later is required. To use the NetScaler feature, Integration Broker 2.4 or later is required.

    Note:

    Using the latest available version of VMware Identity Manager and its components is recommended.

  • The VMware Identity Manager connector must be able to communicate with the Integration Broker. If you have set up multiple connector instances, ensure that all of them can communicate with the Integration Broker.

  • A single Integration Broker instance can support multiple Citrix 5.x, 6.x, and 7.x environments.

  • If you are using the VMware Enterprise Systems Connector on Windows, note the following.

    • Download the Integration Broker from the VMware Identity Manager product page on My VMware.

    • Installing the Integration Broker and the VMware Enterprise Systems Connector on different servers is recommended.

    • If you are installing the Integration Broker on the same server as the connector, ensure that the HTTP and HTTPS binding ports do not conflict with the ports used by the VMware Identity Manager Connector component.

      The VMware Identity Manager Connector component always uses port 80. It also uses 443, unless a different port is configured during installation.

    • A self-signed certificate is generated during the connector installation. If you are installing the Integration Broker on the same server as the connector, you can use this certificate. Install the certificate in the Microsoft store and use it for the HTTPS binding.

Before you start, also plan your deployment strategy.

  • Consider whether you will use multiple Integration Broker instances. Multiple instances are useful for high-availability and load-balancing purposes.

    • For high availability, set up a cluster of two or more Integration Broker instances. You can use the same cluster for syncing resources and entitlements and for launching resources, or set up different clusters, based on your requirements.

    • If your deployment distributes heavy traffic, increase the number of Integration Broker instances used for launching resources.

  • Consider whether you will use load balancers.

    If your deployment uses multiple Integration Broker instances for high-availability or load-balancing purposes, consider installing them behind one or more load balancers.