VMware Workspace ONE Community
VMware Employee
VMware Employee

EUC CST Tech Notes - Proper VMware Identity Manager Node Monitoring when using F5 BIG-IP Appliances-UPDATED for 3.3


The document will walk you through the setup of a custom F5 BIG-IP Health Monitor for use with VMware Identity Manager appliances when acting as nodes in a cluster.


In previous versions of documentation from VMware and F5 which discussed clustering of VMware Identity Manager with F5 BIG-IP load balancers, it was suggested to use the `http_head_f5` health monitor.  However, due to security updates within VMware Identity Manager 2.8 and higher, the use of the aforementioned F5 BIG-IP health monitor is no longer a viable option.  Because of this, many customers were using the `gateway_icmp` F5 health monitor as a temporary workaround. Unfortunately, this would allow the F5 BIG-IP to see a node as good even though it may only be responding to a ping, resulting in traffic failures and web pages failing to load for end users.  Therefore, a better health monitor needed to be used.


Working together, VMware and F5 come up with a validated custom health monitor using built-in VMware Identity Manager APIs to determine if the node (or appliance) in question is properly responding.

The basic F5 health monitor information is as follows:

Send String:

GET /SAAS/API/1.0/REST/system/health/heartbeat HTTP/1.1\r\nHost: <LB_FQDN>\r\nConnection: Close\r\n\r\n

NOTE: Remove the "<>" if you copy/paste into your health monitor.

Receive String:


Receive Disable String:


F5 BIG-IP Health Monitor VMware Identity Manager 3.3.png

Creation Procedure:

Here is how to create this within the F5 BIG-IP.

  1. Login as administrator to your F5 BIG-IP appliance.
  2. Browse to Monitors under the Local Traffic tab in the left hand menu.
  3. Click the CREATE button in the upper left to start the creation of a new health monitor.
  4. Give it a name such as ViDM_Monitor or something similar and provide a description as needed.
  5. Select HTTPS as type.  This will set the parent monitor to https and open up the "Configuration" screen with options for Send String, Receive String, and Receive Disable String among the many shown.
  6. Use the following for the Send String.
    GET /SAAS/API/1.0/REST/system/health/heartbeat HTTP/1.1\r\nHost: <LB_FQDN>\r\nConnection: Close\r\n\r\n
    1. NOTE: Remove the "<>" if you copy/paste the above line into your BIG-IP settings.
  7. Use the following for the Receive String.
  8. Use the following as the Receive Disable String.
  9. Leave the rest of the fields as their default settings.
  10. Click the FINISHED button.

F5 BIG-IP Health Monitor VMware Identity Manager 3.3.png

Now you need to assign this to the VMware Identity Manager Pool for the F5 BIG-IP virtual server to utilize.

NOTE:  Make sure you do this part during off-hours or scheduled down time.

  1. Assuming you are already logged in from above, browse to Local Traffic > Virtual Servers > Pools and select your pool of VMware Identity Manager appliances.
  2. Edit the Health Monitors section to remove previous active health monitors and assign your new health monitor you just created above.
  3. Click the UPDATE button when ready.
  4. Validate the new health monitor works properly and as expected by viewing the pool members status and Virtual Server status within the F5 BIG-IP admin console.

F5 BIG-IP VIDM Pool Health Monitor Steps.png


Now you can rest assured the F5 BIG-IP is properly monitoring your VMware Identity Manager cluster to determine which nodes are live and which are not!


Big thanks to F5's Matt Mabis for helping us work through these settings and to VMware's Michael Almond and Karen Zelenko for guidance and support in testing this.

Document was edited by Dean Flaming April 26th, 2017 to correct the Receive String when heartbeat is not showing "ok" and correct the Receive Disable String when appliance is showing 404.

Document was edited by Dean Flaming November 6th, 2018 to correct the steps not showing correctly due to format issues.

-Dean F. https://www.vmware.com/support/pubs/identitymanager-pubs.html
Labels (2)
0 Replies