RIAK-ADMIN(1)()

NAME
riak-admin - Riak node administration

SYNOPSIS
riak-admin [join] [leave] [backup] [restore] [test] [status] [reip] [js_reload] [wait-for-service] [ringready] [transfers] [force-remove] [down] [cluster_info] [member_status] [ring_status] [vnode_status] [top]

DESCRIPTION
Riak is a distributed, decentralized data storage system written in Erlang.

Cluster node membership management, status reporting, backup and restoration, and network configuration related tasks are performed with the riak-admin command.

OPTIONS
The riak-admin command provides several subcommands for managing a Riak cluster, and can be invoked without arguments for a list of those subcommands.

join
    <node>
    Join node to another node for cluster participation.
    $riak-admin join riak@r0.example.com

leave
    Instruct node to leave cluster after handing off all replicas to other cluster nodes.
    $riak-admin leave

backup
    <node> <cookie> <filename> [[node|all]]
    Backup a node or cluster to a file.

    $riak-admin backup riak@r0.example.com riak <directory/backup_file> node

    $riak-admin backup riak@r0.example.com riak <directory/backup_file> all

restore
    <node> <cookie> <filename>
    Restore a node or cluster from file created by backup.

    $riak-admin restore riak@r0.example.com riak <directory/backup_file>

test
    Performs a series of test read and write operations on the node.

    $riak-admin test

status
    Output detailed node status information and performance statistics for the node.

    $riak-admin status

reip
    <old nodename> <new nodename>
    Reconfigure the local Riak node to use a different IP address or node name.

    $riak-admin reip <old_nodename> <new_nodename>

js_reload
    Reloads the Javascript virtual machines on the node.

    $riak-admin js_reload

wait-for-service
    <service> <nodename>
    Checks the status of a Riak service such as riak_kv.

    $riak-admin wait-for-service riak_kv riak@r0.example.com

ringready
    Checks that all Riak nodes agree on partition assignments of the ring.

    $riak-admin ringready

transfers
    List pending partition transfers (this subcommand restarts handoff timers, and should be used sparingly).

    $riak-admin transfers

force-remove
    <node>
    Immediately removes specified node from the cluster without ensuring replica handoffs. This is a dangerous command that should be used with extreme caution in cases where the normal and safe leave command cannot be used.

    $riak-admin force-remove riak@r3.example.com

down
    <node>
    Marks <node> as down; transitions in the ring will be performed when the node is next online.

    $riak-admin down riak@r3.example.com

cluster_info
    <output_file> [<node_list]
    Collect and output Riak cluster system information from all or a subset of nodes into a plain text file.

    $riak-admin cluster_info /tmp/three_nodes.txt riak@r0.example.com riak@r1.example.com riak@r2.example.com

member_status
    Output current status of all cluster member nodes.

    $riak-admin member_status

ring_status
    Output current ring claimant, status of ring, pending handoffs, and any unreachable nodes.

    $riak-admin ring_status

vnode_status
    Output current status of all vnodes on the node.

    $riak-admin vnode_status

top Output current CPU utilization, memory, and message queue sizes for the node.

    $riak-admin top

AUTHORS
Riak is developed by Basho Technologies, Inc. http://basho.com