You are viewing the documentation for a prerelease version.

View Latest

setting-rebalance

Modifies rebalance retry settings

SYNOPSIS

_couchbase-cli setting-rebalance [--cluster <url>] [--username <user>]
    [--set] [--get] [--cancel] [--pending-info] [--enable <1|0>]
    [--wait-for <sec>] [--max-attempts <num>] [--rebalance-id <id>]

DESCRIPTION

This command allows configuring and retrieving automatic rebalance retry settings as well as canceling and retrieving information of pending rebalance retries.

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
--user <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.

--set

Specify to configure the automatic rebalance retry settings.

--get

Specify to retrieve the automatic rebalance retry settings.

--cancel

Specify to cancel a pending rebalance retry, use --rebalance-id together with this option to provide the rebalance id.

--pending-info

Specify to retrieve information of pending rebalance retries.

--enable <1|0>

Enable (1) or disable (0) automatic rebalance retry. This flag is required when using --set. By default automatic rebalance retry is disabled.

--wait-for <sec>

Specify the amount of time to wait after a failed rebalance before retrying. Time must be a value between 5 abd 3600 seconds. By default the wait time is 300 seconds.

--max-attempts <num>

Specify the number of times a failed rebalance will be retried. The value provided must be between 1 and 3, the default is 1.

--rebalance-id <id>

Specify the rebalance id of a failed rebalance. Use together with --cancel, to cancel a pending retry.

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

To retrieve the current automatic rebalance retry configuration use:

$ couchbase-cli setting-rebalance -c 127.0.0.1:8091 -u Administrator \
 -p password --get

To enable automatic rebalance retry use the command bellow.

$ couchbase-cli setting-rebalance -c 127.0.0.1:8091 -u Administrator \
 -p password --set --enabled 1

You can also set the the wait for period and the maximum number of retries. The command above enables automatic rebalance retry as well as setting the wait time before retrying to 60 seconds and the maximum number of retires to 2.

 $ couchbase-cli setting-rebalance -c 127.0.0.1:8091 -u Administrator \
-p password --set --enabled 1 --wait-for 60 --retries 2

To retrieve information of the pending rebalance retries run the command bellow.

 $ couchbase-cli setting-rebalance -c 127.0.0.1:8091 -u Administrator \
-p password --pending-info

To cancel a pending rebalance retry run the command bellow where 4198f4b1564a800223271af76edd4f98 is the rebalance id, this can be retrieved using the --pending-info flag above.

 $ couchbase-cli setting-rebalance -c 127.0.0.1:8091 -u Administrator \
-p password --pending-info --rebalance-id 4198f4b1564a800223271af76edd4f98

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.

COUCHBASE-CLI

Part of the couchbase-cli suite