A newer version of this documentation is available.

View Latest


Modifies cluster settings.


The basic syntax is:

couchbase-cli cluster-edit -c [host]:8091 -u [admin] -p [password] [options]


This command modifies an existing cluster.


The following are the command options:

Table 1. cluster-edit options
Option Description


New administrative username.


Per node RAM quota in MB for the Index service


New administrator’s password


New cluster REST/http port


Per node RAM quota in MB for the Data service


Services that Couchbase Server runs.


To edit the cluster:

couchbase-cli cluster-edit -c -u Administrator -p password

The following example changes the cluster username, password, port, and ram quota:

couchbase-cli cluster-edit -c -u Administrator -p password \
--cluster-username=Admin2 --cluster-password=pass2 \
--cluster-port=8080 --cluster-ramsize=300