Displaying Additional Information in Health Check API

You can control whether sensitive information, such as IP addresses and host names, is displayed in the output of the health check APIs https://<VIDM_FQDN>/SAAS/jersey/manager/api/system/health and https://<VIDM_FQDN>/SAAS/API/1.0/REST/system/health. By default, the API output does not include this information.

The service.health.check.basic property in the runtime-config.properties file controls this setting. When the property is set to true, only basic information is displayed and sensitive information is hidden. The label "unknown" in the output indicates that the information is restricted. For example:

AnalyticsUrl:	"unknown"
ElasticsearchServiceOk:	"true"
EhCacheClusterPeers:	"unknown"
ElasticsearchMasterNode:	"unknown"
ElasticsearchIndicesCount	"unknown"
ElasticsearchDocsCount:	"unknown"
AuditPollInterval:	"1000"
AnalyticsConnectionOk:	"true"
...
IpAddress:	"unknown"
AuditDisabled:	"false"
AllOk:	"true"
		

When the property is set to false, all available information is displayed. For example:

AnalyticsUrl: "http://198.51.100.0"
ElasticsearchServiceOk: "true"
EhCacheClusterPeers: ""
ElasticsearchMasterNode: "198.51.100.1"
ElasticsearchIndicesCount: "13"
ElasticsearchDocsCount: "11173"
AuditPollInterval: "1000"
AnalyticsConnectionOk: "true"
...
IpAddress: "198.51.100.2"
AuditDisabled: "false"
AllOk: "true"

By default, the property is set to true.

Note: If you have set up a VMware Identity Manager cluster, if you change the property ensure that you make the change in all nodes in the cluster.

Procedure

1. Log in to the VMware Identity Manager virtual appliance as the root user.
2. Edit the /usr/local/horizon/conf/runtime-config.properties file and set the value of the service.health.check.basic property to true or false.

   Option	Description
   true	Displays only basic information. Sensitive information is hidden and the label Unknown appears in its place.
   false	Displays all available information

3. Save the file.
4. Restart the service.
   service horizon-workspace restart
5. If you have set up a VMware Identity Manager cluster, make these changes in each node of the cluster.