Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

recovery

      +

      Recovers a previously failed over node

      SYNOPSIS

      couchbase-cli recovery [--cluster <url>] [--username <username>]
    [--password <password>] [--server-recovery <servers>]
    [--recovery-type <type>]

      DESCRIPTION

      When a server is failed over and removed from the cluster it may only be able to be added back to the cluster. And example of this is when a server loses power. This server might get failed over and removed from the cluster, but once power is restored to the server you may want to add it back to the cluster.

      Another use case is taking a server out of the cluster for maintenance. This is done by gracefully failing over a server to ensure there is no data loss. The administrator can then perform maintenance on the removed server and add it back with the recovery command.

      The recovery command also allows a server to have it’s data removed before being added back to the cluster (full recovery) or having the server resume from where it last left off (delta recovery). Delta recovery will always take the least amount of time and is the recommended recovery mode.

      Note that after the recovery subcommand is run you must rebalance the cluster. See the rebalance command for more information on rebalancing a cluster.

      OPTIONS

      -c
      --cluster

      Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

      -u
      --username <username>

      Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

      -p
      --password <password>

      Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

      --server-recovery <servers>

      A command separated list of servers to recover. The each server should correspond to the hostname or IP address of a server to be added back to the cluster.

      --recovery-type <type>

      Specifies whether or not we should do full or delta recovery of data on the servers being added back. Full recover means that all data on the servers being recovered will be removed and we will recover all data. Specifying delta recover means we will keep the data that is on each server and only recover the data that each server doesn’t have. To specify full recovery set this option to "full". For delta recovery set this option to "delta". The default value for this option is "full".

      HOST FORMATS

      When specifying a host for the couchbase-cli command the following formats are expected:

      • couchbase://<addr>

      • <addr>:<port>

      • http://<addr>:<port>

      It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

      EXAMPLES

      If we have a server at 192.168.1.6:8091 that we want to recover and we want to recover data using delta recovery then we can run the following command.

      $ couchbase-cli recovery -c 192.168.1.5:8091 --username Administrator \
 --password password --server-recovery 192.168.1.6:8091 \
 --recovery-type delta

      If we need to recover multiple servers then we would run the following command.

      $ couchbase-cli recovery -c 192.168.1.5:8091 --username Administrator \
 --password password --server-recovery 192.168.1.6:8091,192.168.1.7:8091 \
 --recovery-type delta

      If we wanted the servers being recovered to use full recovery then we would run the following command.

      $ couchbase-cli recovery -c 192.168.1.5:8091 --username Administrator \
 --password password --server-recovery 192.168.1.6:8091 \
 --recovery-type full

      ENVIRONMENT AND CONFIGURATION VARIABLES

      CB_REST_USERNAME

      Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

      CB_REST_PASSWORD

      Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

      SEE ALSO

      rebalance, server-add

      COUCHBASE-CLI

      Part of the couchbase-cli suite