Deploy PSM Health Check
This topic describes how to install and configure PSM Health Check.
Typically, load balancers verify PSM server availability by examining network connectivity to the server alone. The PSM Health Check enables you to determine PSM service availability (health) by querying a dedicated PSM Web Service deployed on each PSM instance.
The PSM Web Service verifies PSM service health of the PSM instance upon request and sends a response to the load balancer.
- Web Server (IIS 8.5 or higher) role is installed
- A valid SSL certificate is installed on the Web Server
Install PSM Health Check
Use a user with administrative privileges to perform this procedure.
To install the Health Check:
From the PSM installation package, copy the HeathCheck folder to the PSM server.
Install Microsoft .NET Core Windows Server Hosting by running dotnet-hosting-2.2.0-win.exe file, included in the HealthCheck folder.
In a PowerShell window, navigate to the HealthCheck folder.
To start the script, run the following command:
Configure the response mode
You can configure the response mode of the health check web service.
To configure the response mode:
Open the following file:
C:\Program Files (x86)\CyberArk\PSM\HealthCheck\appsettings.json
Modify the ResponseMode as follows:
The health check service responds with 200 (OK) whether the PSM service is healthy or not, but the response body includes PASS or FAIL indicating if the server is healthy.
The health check service responds with 200 (OK) when the PSM service is healthy, and 503(Service unavailable) when the service is not healthy.
This mode behaves like the Classic mode, but adds a parameter in the response header called IsHealthy, with a value of either Yes or No.
Restart the IIS service.
Navigate to: https://<server>/psm/api/health to test if the service is up and running.
If the HealthCheck service failed, the response code 500 (Internal server error) is returned.
For additional error details , see the PSMWebService.log file located under the HealthCheck folder, by default:
C:\Program Files (x86)\CyberArk\PSM\HealthCheck.