{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rladmin",
  "title": "rladmin",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/",
  "summary": "Manage Redis Enterprise clusters and databases.",
  "content": "\n`rladmin` is a command-line utility that lets you perform administrative tasks such as failover, migration, and endpoint binding on a Redis Enterprise Software cluster. You can also use `rladmin` to edit cluster and database configurations.\n\nAlthough you can use the Cluster Manager UI for some of these tasks, others are unique to the `rladmin` command-line tool.\n\n## `rladmin` commands\n\n\n| Command | Description |\n| --- | --- |\n| [bind](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/bind/) | Manages the proxy policy for a specified database endpoint. |\n| [cluster](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/cluster/) | Manage cluster. |\n| [failover](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/failover/) | Fail over primary shards of a database to their replicas. |\n| [help](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/help/) | Shows available commands or specific command usage. |\n| [info](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/info/) | Shows the current configuration of a cluster, database, node, or proxy. |\n| [migrate](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/migrate/) | Moves Redis Enterprise Software shards or endpoints to a new node in the same cluster. |\n| [node](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/node/) | Manage nodes. |\n| [placement](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/placement/) | Configures the shard placement policy for a database. |\n| [recover](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/recover/) | Recovers databases in recovery mode. |\n| [restart](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/restart/) | Restarts Redis Enterprise Software processes for a specific database. |\n| [status](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/status/) | Displays the current cluster status and topology information. |\n| [suffix](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/suffix/) | Manages the DNS suffixes in the cluster. |\n| [tune](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/tune/) | Configures parameters for databases, proxies, nodes, and clusters. |\n| [upgrade](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/upgrade/) | Upgrades the version of a module or Redis for a database. |\n| [verify](https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/verify/) | Prints verification reports for the cluster. |\n\n\n## Use the `rladmin` shell\n\nTo open the `rladmin` shell:\n\n1. Sign in to a Redis Enterprise Software node with an account that is a member of the **redislabs** group.\n\n    The `rladmin` binary is located in `/opt/redislabs/bin`. If you don't have this directory in your `PATH`, you may want to add it. Otherwise, you can use `bash -l \u003cusername\u003e` to sign in as a user with permissions for that directory.\n\n1. Run: `rladmin`\n\n    \u003e [!NOTE]\n    \u003e If the CLI does not recognize the `rladmin` command,\n    \u003e run this command to load the necessary configuration first: \u003cnobr\u003e`bash -l`\u003c/nobr\u003e\n\nIn the `rladmin` shell, you can:\n\n- Run any `rladmin` command without prefacing it with `rladmin`.\n- Enter `?` to view the full list of available commands.\n- Enter [`help`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/help) followed by the name of a command for a detailed explanation of the command and its usage.\n- Press the `Tab` key for command completion.\n- Enter `exit` or press `Control+D` to exit the `rladmin` shell and return to the terminal prompt.\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-10-21T09:46:20-07:00",
  "children": [{"id":"operate/rs/references/cli-utilities/rladmin/bind","summary":"Manages the proxy policy for a specified database endpoint.","title":"rladmin bind","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/bind/"},{"id":"operate/rs/references/cli-utilities/rladmin/cluster","summary":"Manage cluster.","title":"rladmin cluster","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/cluster/"},{"id":"operate/rs/references/cli-utilities/rladmin/failover","summary":"Fail over primary shards of a database to their replicas.","title":"rladmin failover","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/failover/"},{"id":"operate/rs/references/cli-utilities/rladmin/help","summary":"Shows available commands or specific command usage.","title":"rladmin help","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/help/"},{"id":"operate/rs/references/cli-utilities/rladmin/info","summary":"Shows the current configuration of a cluster, database, node, or proxy.","title":"rladmin info","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/info/"},{"id":"operate/rs/references/cli-utilities/rladmin/migrate","summary":"Moves Redis Enterprise Software shards or endpoints to a new node in the same cluster.","title":"rladmin migrate","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/migrate/"},{"id":"operate/rs/references/cli-utilities/rladmin/node","summary":"Manage nodes.","title":"rladmin node","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/node/"},{"id":"operate/rs/references/cli-utilities/rladmin/placement","summary":"Configures the shard placement policy for a database.","title":"rladmin placement","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/placement/"},{"id":"operate/rs/references/cli-utilities/rladmin/recover","summary":"Recovers databases in recovery mode.","title":"rladmin recover","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/recover/"},{"id":"operate/rs/references/cli-utilities/rladmin/restart","summary":"Restarts Redis Enterprise Software processes for a specific database.","title":"rladmin restart","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/restart/"},{"id":"operate/rs/references/cli-utilities/rladmin/status","summary":"Displays the current cluster status and topology information.","title":"rladmin status","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/status/"},{"id":"operate/rs/references/cli-utilities/rladmin/suffix","summary":"Manages the DNS suffixes in the cluster.","title":"rladmin suffix","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/suffix/"},{"id":"operate/rs/references/cli-utilities/rladmin/tune","summary":"Configures parameters for databases, proxies, nodes, and clusters.","title":"rladmin tune","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/tune/"},{"id":"operate/rs/references/cli-utilities/rladmin/upgrade","summary":"Upgrades the version of a module or Redis for a database.","title":"rladmin upgrade","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/upgrade/"},{"id":"operate/rs/references/cli-utilities/rladmin/verify","summary":"Prints verification reports for the cluster.","title":"rladmin verify","url":"https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/verify/"}]
}