In the 19.03 release, you can configure high availability for directory sync by associating the directory with multiple connector instances and then setting up a Sync Connectors list for the directory. The connectors in the Sync Connectors list are arranged in failover order. The VMware Identity Manager service uses the first connector in the list to sync users and groups for the directory. If the first connector is unavailable, it uses the next connector in the list, and so on.

Each directory has its own Sync Connectors list.

As a best practice, set up your deployment in a way that the same connector does not sync multiple directories at the same time. You can use the following strategies.

  • Use a different set of connectors for different directories.
  • If you use the same set of connectors in the same failover order, schedule the sync at different times for each directory.
  • If you use the same set of connectors for multiple directories, set a different failover order for each directory so that sync does not fall back to the same connector.

This feature is available beginning with the VMware Identity Manager 19.03 on-premises release. To use this feature, upgrade all connectors to version 19.03.0.0, then follow this procedure to set up the Sync Connectors list. Take into account the following situations.

  • For existing directories, the Sync Connectors list is empty. Until you configure the Sync Connectors list, the connector that was originally configured for the directory continues to be used for sync and no fallback is available if the connector fails.
  • New directories created in an upgraded or new environment have one connector listed in the Sync Connectors list. This connector is the one you selected as the sync connector while creating the directory.
Important: In the 19.03 release, this feature is only available in VMware Identity Manager on-premises installations. It is not available in VMware Identity Manager cloud with the 19.03 connector.

Prerequisites

  • You have installed and configured additional connector instances. See Install and Configure Additional VMware Identity Manager Connector Instances in Installing and Configuring VMware Identity Manager Connector 19.03.0.0 (Windows).
  • All connectors associated with the VMware Identity Manager service must be version 19.03.0.0 or later. If any connectors are an older version, the Sync Connectors tab does not appear in the directory's Sync Settings page.

Procedure

  1. Associate the new connector instances with the Workspace IDP of the directory.
    1. In the VMware Identity Manager console, click the Identity & Access Management tab.
    2. In the Directories page that appears, click the directory for which you want to configure high availability.
    3. In the Directory Sync and Authentication section, click the WorkspaceIDP link.
    4. In the WorkspaceIDP page, scroll to the Connector(s) section, select each new connector instance from the drop-down menu, and click Add Connector.
    5. Click Save.
  2. Click the Directories tab, then click the directory name.
  3. Click Sync Settings.
  4. Click the Sync Connectors tab.
  5. Select the connector instances to be used to sync users and groups for this directory.
    1. From the Select a Connector list, which displays all the connectors added to the service, select a connector and click the + icon.
      The connector is added to the Sync Connectors list.
    2. Add all the connectors that you want to use for sync to the Sync Connectors list.
    3. In the Sync Connectors list, arrange the connectors in failover order by using the up and down arrow keys.
      To perform a directory sync, VMware Identity Manager tries to use the first connector in the list. If the first connector is unavailable, it tries to use the second connector, and so on.
      For example:
      Sync Connectors tab screenshot

  6. Click Save.

Results

The list of sync connectors for the directory is saved and is applied from the next sync onwards.

You can view which connectors were used for sync in the Sync Log tab of the directory page.

For example:


Sync log screenshot