Skip to content

healthCheck ​

Command: healthCheck
Category: System Admin
Status: Production Ready

Description ​

Perform a comprehensive database health assessment by running multiple diagnostic checks on memory, disk space, connections, transactions, backups, replication, and resource utilization. Results are categorized by severity (HEALTHY, WARNING, CRITICAL) with an overall health status.

Syntax ​

bash
hana-cli healthCheck [options]

Aliases ​

  • health
  • h

Command Diagram ​

Parameters ​

Options ​

OptionAliasTypeDefaultDescription
--checks-cstringallHealth checks to perform. Choices: all, memory, disk, connection, transaction, backup, replication, resources

Connection Parameters ​

OptionAliasTypeDefaultDescription
--admin-abooleanfalseConnect via admin (default-env-admin.json)
--conn-string-Connection filename to override default-env.json

Troubleshooting ​

OptionAliasTypeDefaultDescription
--disableVerbose--quietbooleanfalseDisable verbose output - removes all extra output that is only helpful to human readable interface
--debug-dbooleanfalseDebug hana-cli itself by adding output of LOTS of intermediate details

Examples ​

Run All Health Checks ​

bash
hana-cli healthCheck --checks all

Run all available health checks and display a comprehensive assessment.

Check Memory Only ​

bash
hana-cli healthCheck --checks memory

Perform only memory utilization health check.

Check Multiple Systems ​

bash
hana-cli healthCheck --checks memory,disk,backup

Run memory, disk, and backup health checks.

Quick Health Check with Alias ​

bash
hana-cli health

Run all health checks using the short alias.

See the Commands Reference for other commands in this category.

See Also ​