{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rlcheck",
  "title": "rlcheck",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rlcheck/",
  "summary": "Verify nodes.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-01-30T12:29:26-06:00",
  "children": [],
  "page_type": "content",
  "content_hash": "e021c2c302376ccbe4d70ffb5b88f7e10a2f4be37879d66433c36bee5454cee6",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "The `rlcheck` utility runs various [tests](#tests) to check the health of a Redis Software node and reports any discovered issues.\nYou can use this utility to confirm a successful installation or to verify that the node is functioning properly.\n\nTo resolve issues reported by `rlcheck`, [contact Redis support](https://redis.com/company/support/)."
    },
    {
      "id": "run-rlcheck",
      "title": "Run rlcheck",
      "role": "content",
      "text": "You can run `rlcheck` from the node host's command line.\nThe output of `rlcheck` shows information specific to the host you run it on.\n\nTo run `rlcheck` tests:\n\n1. Sign in to the Redis Software host with an account that is a member of the **redislabs** operating system group.\n\n1. Run: \n\n    [code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "You can run `rlcheck` with the following options:\n\n| Option | Description |\n|--------|-------------|\n| <nobr>`--suppress-tests TEXT`</nobr> | Skip the specified, comma-delimited list of tests. See [Tests](#tests) for the list of tests and descriptions. |\n| <nobr>`--retry-delay INTEGER`</nobr> | Delay between retries, in seconds. |\n| <nobr>`--retry INTEGER`</nobr> | Number of retries after a failure. |\n| <nobr>`--file-path TEXT`</nobr> | Custom path to `rlcheck.log`. |\n| <nobr>`--continue-on-error`</nobr> | Continue to run all tests even if a test fails, then show all errors when complete. |\n| `--help` | Return the list of `rlcheck` options. |"
    },
    {
      "id": "tests",
      "title": "Tests",
      "role": "content",
      "text": "`rlcheck` runs the following tests by default:\n\n| Test name | Description |\n|-----------|-------------|\n| verify_owner_and_group | Verifies the owner and group for Redis Software files are correct. |\n| verify_bootstrap_status | Verifies the local node's bootstrap process completed without errors. |\n| verify_services | Verifies all Redis Software services are running. |\n| verify_port_range | Verifies the [`ip_local_port_range`](https://www.kernel.org/doc/html/latest/networking/ip-sysctl.html) doesn't conflict with the ports Redis Software might assign to shards. |\n| verify_pidfiles | Verifies all active local shards have PID files. |\n| verify_capabilities | Verifies all binaries have the proper capability bits. |\n| verify_existing_sockets | Verifies sockets exist for all processes that require them. |\n| verify_host_settings | Verifies the following:<br />• Linux `overcommit_memory` setting is 1.<br />•`transparent_hugepage` is disabled.<br />• Socket maximum connections setting `somaxconn` is 1024. |\n| verify_tcp_connectivity | Verifies this node can connect to all other alive nodes. |\n| verify_encrypted_gossip | Verifies gossip communication is encrypted. |"
    }
  ],
  "examples": [
    {
      "id": "run-rlcheck-ex0",
      "language": "sh",
      "code": "rlcheck",
      "section_id": "run-rlcheck"
    }
  ]
}