28.2 UMC Health Script

The umcServiceHealth Script verifies the health of the UMC server and all services running on the server.

Syntax

umcServiceHealth [options]

Options

Options

Description

-h|--help

Displays the help screen.

-s|--service-check

Verifies the health of the dependent services. The services are:

  • apache2.service

  • postgresql.service

  • ndsd.service

  • microfocus-umc-server.service

  • microfocus-umc-backend.service

  • docker.service

  • docker-edirapi.service

  • redis@umc.service

-e|--edirapi-check

Verifies the health of edirapi and Identity Console container (identityconsole-oes).

-c|--cert-check

Verifies the health of the server certificate, displaying details such as:

  • Certificate expiry date

  • Public Key SAN details

  • Private Key status

-u|--edirObj-check

Verifies the health of the umcConfig object under the security context of the eDirectory.

-d|--db-check

Verifies the health of the PostgreSQL database (internal or remote).

IMPORTANT:umcServiceHealth.sh -dautofix - mention that .sh is not required. It will be cleaned up soon.

-n|--nodeModule-check

Verifies the availability of the node_modules folder.

-r|--redis-check

Verifies the health of Redis.

-a|--all-check

Verifies the health of the UMC server and run the other checks.

28.2.1 Autofix

The autofix script automatically fixes detected issues without your intervention. If an issue is encountered upon executing the health script, to resolve it, run the same script with the autofix option enabled. This option can be used along with:

  • --service-check

  • --db-check

  • --nodeModule-check

  • --all-check

The autofix script does not resolve issues related to critical components like eDirectory and server certificate. Hence, these options (--edirapi-check, --cert-check, and --edirObj-check) are not supported as they require your validation and intervention for proper resolution.

Examples

  • To verify the health of the dependent services, run the script:

    umcServiceHealth -s

    Displays the status of dependent services on this server. The Apache service is down, it displays its state and command to restart the service. Alternatively, you can rerun this command with autofix to resolve the issue.

    Figure 28-1 umcServiceHealth Script

    To fix the Apache issue automatically, run the script with autofix option.

    umcServiceHealth -sautofix

    The Apache service is successfully restarted.

  • To verify health of Redis, run the script:

    umcServiceHealth -r

    This displays the permissions Redis has on certificate files and health of the parameters in the /etc/redis/umc.conf file.

    To resolve the Redis issues listed by the script, re-install the microfocus-oes-umc-server RPM. This regenerates the /etc/redis/umc.conf file to fix the issues.