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 2016, Windows Server 2012 R2, Windows Server 2012, or Windows Server 2008 R2.
    Table 1. Integration Broker Server Requirements
    Requirement Notes
    Windows Server 2016, Windows Server 2012 R2, Windows Server 2012, or Windows Server 2008 R2 with dual core processor
    4 GB RAM
    30 GB This includes the storage required for the Windows OS.
  • Integration Broker version requirements:
    VMware Identity Manager or Connector Version Integration Broker Version Supported
    VMware Identity Manager 3.3 3.3
    VMware Identity Manager Connector 2018.8.1.0 (connector released with VMware Identity Manager 3.3) 3.3
    VMware Identity Manager 3.2 3.2
    VMware Identity Manager Connector 2018.1.1.0 (connector released with VMware Identity Manager 3.2) 3.2
    VMware Identity Manager 3.1 3.1
    VMware Identity Manager Connector 2017.12.1.0 (connector released with VMware Identity Manager 3.1) 3.1
    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 set up multiple connector instances, ensure that all of them can communicate with the Integration Broker.
    Note: You must connect over SSL to any Integration Broker instance that is used for launch.
  • A single Integration Broker instance can support multiple Citrix environments.
  • If you are using the Windows version of the VMware Identity Manager connector, follow these guidelines.
    • Installing the Integration Broker and the VMware Identity Manager 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.

      The VMware Identity Manager Connector 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, plan your deployment strategy. See Integration Broker Deployment Models for recommendations for common scenarios.