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.

Although you can use the admin console for some of these tasks, others are unique to the rladmin command-line tool.

rladmin commands

CommandDescription
bindManages the proxy policy for a specified database endpoint.
clusterManage cluster.
failoverFail over primary shards of a database to their replicas.
helpShows available commands or specific command usage.
infoShows the current configuration of a cluster, database, node, or proxy.
migrateMoves Redis Enterprise Software shards or endpoints to a new node in the same cluster.
nodeManage nodes.
placementConfigures the shard placement policy for a database.
recoverRecovers databases in recovery mode.
restartRestarts Redis Enterprise Software processes for a specific database.
statusDisplays the current cluster status and topology information.
suffixManages the DNS suffixes in the cluster.
tuneConfigures parameters for databases, proxies, nodes, and clusters.
upgradeUpgrades the version of a module or Redis Enterprise Software for a database.
verifyPrints verification reports for the cluster.

Use the rladmin shell

To open the rladmin shell:

  1. Sign in to a Redis Enterprise Software node with an account that is a member of the redislabs group.

    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 <username> to sign in as a user with permissions for that directory.

  2. Run: rladmin

    Note:
    If the CLI does not recognize the rladmin command, run this command to load the necessary configuration first: bash -l

In the rladmin shell, you can:

  • Run any rladmin command without prefacing it with rladmin.
  • Enter ? to view the full list of available commands.
  • Enter help followed by the name of a command for a detailed explanation of the command and its usage.
  • Press the Tab key for command completion.
  • Enter exit or press Control+D to exit the rladmin shell and return to the terminal prompt.