healthcheck

healthcheck [OPTIONS]

The healthcheck command can be run periodically to determine the health of the HSMs in the system. A nonzero status indicates that the system is unhealthy and zero indicates that the system is healthy.

Option Description

-m, --module=MODULE

Specifies the module ID to check.
If you only have one module, MODULE is 1.
If you specify module 0, healthcheck checks whether at least one module is healthy. If you do not specify a module ID, healthcheck checks all modules.

Default: 0.

-t, --timeout=SECONDS

healthcheck returns exit code (1) if the module health check takes longer than SECONDS. If you specify a timeout of 0, the health check does not time out.

healthcheck -t 5

Default: 60.

Help options

-h, --help

Displays help for healthcheck.

-u, --usage

Displays a brief usage summary for healthcheck.

-v, --version

Displays the version number of the Security World Software that deploys healthcheck.

healthcheck examples

Example 1: Run healthcheck to check that there is at least one HSM is ok and respond within 5 seconds.

healthcheck -m 0 -t 5

Example 2: Run healthcheck to check that all HSMs are ok and respond within 5 seconds.

healthcheck -t 5

Example 3: Run healthcheck to check that a specific HSM (id = 3 in this case) is ok and respond within 5 seconds.

healthcheck -m 3 -t 5