{ "schema_version": 2, "id": "operate/rs/references/cli-utilities/rladmin/status", "title": "rladmin status", "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/status/", "summary": "Displays the current cluster status and topology information.", "tags": [ "docs", "operate", "rs" ], "last_updated": "2026-05-14T08:58:05-05:00", "page_type": "content", "content_hash": "9715443a3fc527c6d86f4b5b1c69ba049453a07746d2aaeda957d3966cce2384", "sections": [ { "id": "overview", "title": "Overview", "role": "overview", "text": "Displays the current cluster status and topology information." }, { "id": "status", "title": "`status`", "role": "content", "text": "Displays the current status of all nodes, databases, database endpoints, and shards on the cluster.\n\n[code example]" }, { "id": "parameters", "title": "Parameters", "role": "parameters", "text": "| Parameter | Description |\n|-----------|-------------|\n| extra \\ | Extra options that show more information |\n| issues_only | Filters out all items that have an `OK` status |\n\n| Extra parameter | Description |\n|-------------------|-------------|\n| extra all | Shows all `extra` information |\n| extra backups | Shows periodic backup status |\n| extra frag | Shows fragmented memory available after the restart |\n| extra nodestats | Shows shards per node |\n| extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |\n| extra redis_version | Shows Redis version of all databases in the cluster |\n| extra state_machine | Shows execution of state machine information |\n| extra traffic_manually_disabled | Conditionally shows if any database's traffic was manually stopped with the `stop_traffic` API |\n| extra watchdog | Shows watchdog status |" }, { "id": "returns", "title": "Returns", "role": "returns", "text": "Returns tables of the status of all nodes, databases, and database endpoints on the cluster.\n\nIf `issues_only` is specified, it only shows instances that do not have an `OK` status.\n\nIn the `CLUSTER NODES` section, `*node` indicates which node you are connected to.\n\nFor descriptions of the fields returned by `rladmin status extra all`, see the output tables for [nodes](#returns-nodes), [databases](#returns-dbs), [endpoints](#returns-endpoints), and [shards](#returns-shards)." }, { "id": "example", "title": "Example", "role": "example", "text": "[code example]" }, { "id": "status-databases", "title": "`status databases`", "role": "content", "text": "Displays the current status of all databases on the cluster.\n\n[code example]" }, { "id": "parameters-1", "title": "Parameters", "role": "parameters", "text": "| Parameter | Description |\n|-----------|-------------|\n| extra \\ | Extra options that show more information |\n| sort \\ | Sort results by specified column titles |\n| issues_only | Filters out all items that have an `OK` status |\n\n\n| Extra parameter | Description |\n|-------------------|-------------|\n| extra all | Shows all `extra` information |\n| extra backups | Shows periodic backup status |\n| extra frag | Shows fragmented memory available after the restart |\n| extra nodestats | Shows shards per node |\n| extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |\n| extra redis_version | Shows Redis version of all databases in the cluster |\n| extra state_machine | Shows execution of state machine information |\n| extra traffic_manually_disabled | Conditionally shows if any database's traffic was manually stopped with the `stop_traffic` API |\n| extra watchdog | Shows watchdog status |" }, { "id": "returns-dbs", "title": "Returns", "role": "returns", "text": "Returns a table of the status of all databases on the cluster.\n\nIf `sort ` is specified, the result is sorted by the specified table columns.\n\nIf `issues_only` is specified, it only shows databases that do not have an `OK` status.\n\nThe following table describes the fields returned by `rladmin status databases extra all`:\n\n| Field | Description |\n|-------|-------------|\n| DB:ID | Database ID |\n| NAME | Database name |\n| TYPE | Database type: Redis or Memcached |\n| STATUS | Database status |\n| SHARDS | The number of primary shards in the database |\n| PLACEMENT | How the shards are spread across nodes in the cluster, densely or sparsely |\n| REPLICATION | Is replication enabled for the database |\n| PERSISTENCE | Is persistence enabled for the database |\n| ENDPOINT | Database endpoint |\n| EXEC_STATE | The current state of the state machine |\n| EXEC_STATE_MACHINE | The name of the running state machine |\n| BACKUP_PROGRESS | The database’s backup progress |\n| MISSING_BACKUP_TIME | How long ago a backup was done |\n| REDIS_VERSION | The database’s Redis version |" }, { "id": "example-1", "title": "Example", "role": "example", "text": "[code example]" }, { "id": "status-endpoints", "title": "`status endpoints`", "role": "content", "text": "Displays the current status of all endpoints on the cluster.\n\n[code example]" }, { "id": "parameters-2", "title": "Parameters", "role": "parameters", "text": "| Parameter | Description |\n|-----------|-------------|\n| node \\ | Only show endpoints for the specified node ID |\n| db db:\\ | Only show endpoints for the specified database ID |\n| db \\ | Only show endpoints for the specified database name |\n| extra \\ | Extra options that show more information |\n| sort \\ | Sort results by specified column titles |\n| issues_only | Filters out all items that have an `OK` status |\n\n\n| Extra parameter | Description |\n|-------------------|-------------|\n| extra all | Shows all `extra` information |\n| extra backups | Shows periodic backup status |\n| extra frag | Shows fragmented memory available after the restart |\n| extra nodestats | Shows shards per node |\n| extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |\n| extra redis_version | Shows Redis version of all endpoints in the cluster |\n| extra state_machine | Shows execution of state machine information |\n| extra watchdog | Shows watchdog status |" }, { "id": "returns-endpoints", "title": "Returns", "role": "returns", "text": "Returns a table of the status of all endpoints on the cluster.\n\nIf `sort ` is specified, the result is sorted by the specified table columns.\n\nIf `issues_only` is specified, it only shows endpoints that do not have an `OK` status.\n\nThe following table describes the fields returned by `rladmin status endpoints extra all`:\n\n| Field | Description |\n|-------|-------------|\n| DB:ID | Database ID |\n| NAME | Database name |\n| ID | Endpoint ID |\n| NODE | The node that hosts the endpoint |\n| ROLE | The proxy policy of the database: single, all-master-shards, or all-nodes |\n| SSL | Is SSL enabled |\n| WATCHDOG_STATUS | The shards related to the endpoint are monitored and healthy |" }, { "id": "example-2", "title": "Example", "role": "example", "text": "[code example]" }, { "id": "status-modules", "title": "`status modules`", "role": "content", "text": "Displays the current status of modules installed on the cluster and modules used by databases. This information is not included in the combined status report returned by [`rladmin status`](#status).\n\n[code example]" }, { "id": "parameters-3", "title": "Parameters", "role": "parameters", "text": "| Parameter | Description |\n|-----------|-------------|\n| db db:\\ | Provide a list of database IDs to show only modules used by the specified databases
(for example: `rladmin status modules db db:1 db:2`) |\n| db \\ | Provide a list of database names to show only modules used by the specified databases
(for example: `rladmin status modules db name1 name2`) |\n| extra all | Shows all extra information |\n| extra compatible_redis_version | Shows the compatible Redis database version for the module |\n| extra module_id | Shows module IDs |\n| extra min_redis_version | Shows the minimum compatible Redis database version for each module |" }, { "id": "returns-1", "title": "Returns", "role": "returns", "text": "Returns the status of modules installed on the cluster and modules used by databases." }, { "id": "example-3", "title": "Example", "role": "example", "text": "[code example]" }, { "id": "status-nodes", "title": "`status nodes`", "role": "content", "text": "Displays the current status of all nodes on the cluster.\n\n[code example]" }, { "id": "parameters-4", "title": "Parameters", "role": "parameters", "text": "| Parameter | Description |\n|-----------|-------------|\n| extra \\ | Extra options that show more information |\n| sort \\ | Sort results by specified column titles |\n| issues_only | Filters out all items that have an `OK` status |\n\n\n| Extra parameter | Description |\n|-------------------|-------------|\n| extra all | Shows all `extra` information |\n| extra backups | Shows periodic backup status |\n| extra frag | Shows fragmented memory available after the restart |\n| extra nodestats | Shows shards per node |\n| extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |\n| extra redis_version | Shows Redis version of all nodes in the cluster |\n| extra state_machine | Shows execution of state machine information |\n| extra watchdog | Shows watchdog status |" }, { "id": "returns-nodes", "title": "Returns", "role": "returns", "text": "Returns a table of the status of all nodes on the cluster.\n\nIf `sort ` is specified, the result is sorted by the specified table columns.\n\nIf `issues_only` is specified, it only shows nodes that do not have an `OK` status.\n\n`*node` indicates which node you are connected to.\n\nThe following table describes the fields returned by `rladmin status nodes extra all`:\n\n| Field | Description |\n|-------|-------------|\n| NODE:ID | Node ID |\n| ROLE | Is the node a primary (`master`) or secondary (`slave`) node |\n| ADDRESS | The node’s internal IP address |\n| EXTERNAL ADDRESS | The node’s external IP address |\n| HOSTNAME | Node name |\n| MASTERS | The number of primary shards on the node |\n| SLAVES | The number of replica shards on the node |\n| OVERBOOKING_DEPTH | Memory available to create new shards, accounting for the memory reserved for existing shards to grow, even if `shards_overbooking` is enabled. A negative value indicates how much memory is overbooked rather than just showing that no memory is available for new shards. |\n| SHARDS | The number of shards on the node |\n| CORES | The number of cores on the node |\n| FREE_RAM | free_memory/total_memory
**free_memory**: the amount of free memory reported by the OS.
**total_memory**: the total physical memory available on the node. |\n| PROVISIONAL_RAM | Memory available to create new shards, displayed as available_provisional_memory/total_provisional_memory.
**available_provisional_memory**: memory currently available for the creation of new shards.
**total_provisional_memory**: memory that would be available to create new shards if the used memory on the node was 0.
If the available provisional memory is 0, the node cannot create new shards because the node has reached its shard limit, is in maintenance mode, or is a quorum-only node. |\n| FLASH | The amount of flash memory available on the node, similar to `FREE_RAM` |\n| AVAILABLE_FLASH | Flash memory available to create new shards, similar to `PROVISIONAL_RAM` |\n| VERSION | The cluster version installed on the node |\n| SHA | The node’s SHA hash |\n| RACK-ID | The node’s rack ID |\n| STATUS | The node’s status |" }, { "id": "example-4", "title": "Example", "role": "example", "text": "[code example]" }, { "id": "status-shards", "title": "`status shards`", "role": "content", "text": "Displays the current status of all shards on the cluster.\n\n[code example]" }, { "id": "parameters-5", "title": "Parameters", "role": "parameters", "text": "| Parameter | Description |\n|-----------|-------------|\n| node \\ | Only show shards for the specified node ID |\n| db db:\\ | Only show shards for the specified database ID |\n| db \\ | Only show shards for the specified database name |\n| extra \\ | Extra options that show more information |\n| sort \\ | Sort results by specified column titles |\n| issues_only | Filters out all items that have an `OK` status |\n\n\n| Extra parameter | Description |\n|-------------------|-------------|\n| extra all | Shows all `extra` information |\n| extra backups | Shows periodic backup status |\n| extra frag | Shows fragmented memory available after the restart |\n| extra shardstats | Shows shards per node |\n| extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |\n| extra redis_version | Shows Redis version of all shards in the cluster |\n| extra state_machine | Shows execution of state machine information |\n| extra watchdog | Shows watchdog status |" }, { "id": "returns-shards", "title": "Returns", "role": "returns", "text": "Returns a table of the status of all shards on the cluster.\n\nIf `sort ` is specified, the result is sorted by the specified table columns.\n\nIf `issues_only` is specified, it only shows shards that do not have an `OK` status.\n\nThe following table describes the fields returned by `rladmin status shards extra all`:\n\n| Field | Description |\n|-------|-------------|\n| DB:ID | Database ID |\n| NAME | Database name |\n| ID | Shard ID |\n| NODE | The node on which the shard resides |\n| ROLE | The shard’s role: primary (`master`) or replica (`slave`) |\n| SLOTS | Redis keys slot range of the shard |\n| USED_MEMORY | Memory used by the shard |\n| BACKUP_PROGRESS | The shard’s backup progress |\n| RAM_FRAG | The shard’s RAM fragmentation caused by deleted data or expired keys. A large value can indicate inefficient memory allocation. |\n| FLASH_FRAG | For Auto Tiering databases, the shard’s flash fragmentation |\n| WATCHDOG_STATUS | The shard is being monitored by the node watchdog and the shard is healthy |\n| STATUS | The shard’s status |" }, { "id": "example-5", "title": "Example", "role": "example", "text": "[code example]" } ], "examples": [ { "id": "status-ex0", "language": " sh", "code": "rladmin status\n [ extra ]\n [ issues_only]", "section_id": "status" }, { "id": "example-ex0", "language": " sh", "code": "$ rladmin status extra all\nCLUSTER:\nOK. Cluster master: 1 (198.51.100.2)\nCluster health: OK, [1, 0.13333333333333333, 0.03333333333333333]\nfailures/minute - avg1 1.00, avg15 0.13, avg60 0.03.\n\nCLUSTER NODES:\nNODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME MASTERS SLAVES OVERBOOKING_DEPTH SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION SHA RACK-ID STATUS\nnode:1 master 198.51.100.2 3d99db1fdf4b 4 0 10.91GB 4/100 6 14.91GB/19.54GB 10.91GB/16.02GB 6.2.12-37 5c2106 - OK \nnode:2 slave 198.51.100.3 fc7a3d332458 0 0 11.4GB 0/100 6 14.91GB/19.54GB 11.4GB/16.02GB 6.2.12-37 5c2106 - OK \n*node:3 slave 198.51.100.4 b87cc06c830f 0 0 11.4GB 0/100 6 14.91GB/19.54GB 11.4GB/16.02GB 6.2.12-37 5c2106 - OK \n\nDATABASES:\nDB:ID NAME TYPE STATUS SHARDS PLACEMENT REPLICATION PERSISTENCE ENDPOINT EXEC_STATE EXEC_STATE_MACHINE BACKUP_PROGRESS MISSING_BACKUP_TIME REDIS_VERSION\ndb:3 database3 redis active 4 dense disabled disabled redis-11103.cluster.local:11103 N/A N/A N/A N/A 6.0.16 \n\nENDPOINTS:\nDB:ID NAME ID NODE ROLE SSL WATCHDOG_STATUS \ndb:3 database3 endpoint:3:1 node:1 single No OK \n\nSHARDS:\nDB:ID NAME ID NODE ROLE SLOTS USED_MEMORY BACKUP_PROGRESS RAM_FRAG WATCHDOG_STATUS STATUS\ndb:3 database3 redis:4 node:1 master 0-4095 2.08MB N/A 4.73MB OK OK \ndb:3 database3 redis:5 node:1 master 4096-8191 2.08MB N/A 4.62MB OK OK \ndb:3 database3 redis:6 node:1 master 8192-12287 2.08MB N/A 4.59MB OK OK \ndb:3 database3 redis:7 node:1 master 12288-16383 2.08MB N/A 4.66MB OK OK", "section_id": "example" }, { "id": "status-databases-ex0", "language": " sh", "code": "rladmin status databases\n [ extra ]\n [ sort ]\n [ issues_only ]", "section_id": "status-databases" }, { "id": "example-1-ex0", "language": " sh", "code": "$ rladmin status databases sort REPLICATION PERSISTENCE\nDB:ID NAME TYPE STATUS SHARDS PLACEMENT REPLICATION PERSISTENCE ENDPOINT \ndb:1 database1 redis active 1 dense disabled disabled redis-10269.testdbd11169.localhost:10269\ndb:2 database2 redis active 1 dense disabled snapshot redis-13897.testdbd11169.localhost:13897\ndb:3 database3 redis active 1 dense enabled snapshot redis-19416.testdbd13186.localhost:19416", "section_id": "example-1" }, { "id": "status-endpoints-ex0", "language": " sh", "code": "rladmin status endpoints\n [ node ]\n [ db { db: | } ]\n [ extra ]\n [ sort ]\n [ issues_only ]", "section_id": "status-endpoints" }, { "id": "example-2-ex0", "language": " sh", "code": "$ rladmin status endpoints\nDB:ID NAME ID NODE ROLE SSL \ndb:1 database1 endpoint:1:1 node:1 single No \ndb:2 database2 endpoint:2:1 node:2 single No \ndb:3 database3 endpoint:3:1 node:3 single No", "section_id": "example-2" }, { "id": "status-modules-ex0", "language": " sh", "code": "rladmin status modules\n [ db { db: | } ... { db: | } ]\n [ extra { all | compatible_redis_version | min_redis_version | module_id } ]", "section_id": "status-modules" }, { "id": "example-3-ex0", "language": "sh", "code": "$ rladmin status modules extra all \nCLUSTER MODULES:\nMODULE VERSION MIN_REDIS_VERSION ID \nRedisBloom 2.4.5 6.0 1b895a180592cbcae5bd3bff6af24be2 \nRedisBloom 2.6.8 7.1 95264e7c9ac9540268c115c86a94659b \nRediSearch 2 2.6.12 6.0 2c000539f65272f7a2712ed3662c2b6b \nRediSearch 2 2.8.9 7.1 dd9a75710db528afa691767e9310ac6f \nRedisGears 2.0.15 7.1 18c83d024b8ee22e7caf030862026ca6 \nRedisGraph 2.10.12 6.0 5a1f2fdedb8f6ca18f81371ea8d28f68 \nRedisJSON 2.4.7 6.0 28308b101a0203c21fa460e7eeb9344a \nRedisJSON 2.6.8 7.1 b631b6a863edde1b53b2f7a27a49c004 \nRedisTimeSeries 1.8.11 6.0 8fe09b00f56afe5dba160d234a6606af \nRedisTimeSeries 1.10.9 7.1 98a492a017ea6669a162fd3503bf31f3 \n\nDATABASE MODULES:\nDB:ID NAME MODULE VERSION ARGS STATUS \ndb:1 search-json-db RediSearch 2 2.8.9 PARTITIONS AUTO OK \ndb:1 search-json-db RedisJSON 2.6.8 OK \ndb:2 timeseries-db RedisTimeSeries 1.10.9 OK", "section_id": "example-3" }, { "id": "status-nodes-ex0", "language": " sh", "code": "rladmin status nodes\n [ extra ]\n [ sort ]\n [ issues_only ]", "section_id": "status-nodes" }, { "id": "example-4-ex0", "language": " sh", "code": "$ rladmin status nodes sort PROVISIONAL_RAM HOSTNAME\nCLUSTER NODES:\nNODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION STATUS \nnode:1 master 198.51.100.2 3d99db1fdf4b 4/100 6 14.74GB/19.54GB 10.73GB/16.02GB 6.2.12-37 OK \n*node:3 slave 198.51.100.4 b87cc06c830f 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 6.2.12-37 OK \nnode:2 slave 198.51.100.3 fc7a3d332458 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 6.2.12-37 OK", "section_id": "example-4" }, { "id": "status-shards-ex0", "language": " sh", "code": "rladmin status shards\n [ node ]\n [ db {db: | } ]\n [ extra ]\n [ sort ]\n [ issues_only ]", "section_id": "status-shards" }, { "id": "example-5-ex0", "language": " sh", "code": "$ rladmin status shards sort USED_MEMORY ID\nSHARDS:\nDB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS \ndb:3 database3 redis:6 node:1 master 8192-12287 2.04MB OK \ndb:3 database3 redis:4 node:1 master 0-4095 2.08MB OK \ndb:3 database3 redis:5 node:1 master 4096-8191 2.08MB OK \ndb:3 database3 redis:7 node:1 master 12288-16383 2.08MB OK", "section_id": "example-5" } ] }