--- title: setting-cluster description: Modifies cluster settings pubDate: 2026-08-17T09:53:44.266Z antora: editUrl: https://github.com/couchbaselabs/docs-enterprise-analytics/edit/release/2.0/modules/cli/pages/couchbase-cli-setting-cluster.adoc xref: xref:2.0@enterprise-analytics:cli:couchbase-cli-setting-cluster.adoc[] --- [Consult the llms.txt file for a full list of contents](/llms.txt) [View original HTML](/enterprise-analytics/2.0/cli/couchbase-cli-setting-cluster.html) # setting-cluster Modifies cluster settings ## [](#synopsis)SYNOPSIS _couchbase-cli setting-cluster_ [--cluster ] [--username ] [--password ] [--client-cert ] [--client-cert-password ] [--client-key ] [--client-key-password ] [--cluster-username ] [--cluster-password ] [--cluster-port ] [--cluster-ramsize ] [--cluster-name ] [--cluster-index-ramsize ] [--cluster-fts-ramsize ] [--cluster-eventing-ramsize ] [--cluster-analytics-ramsize ] ## [](#description)DESCRIPTION This command is used to modify cluster level settings. It allows users to change the Couchbase root username and password, change the port that the cluster manager listens on, and modify the data, index, full-text or analytics service memory quotas. ## [](#options)OPTIONS \-c \--cluster Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information about specifying a hostname. \-u \--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 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. \--client-cert The path to a client certificate used to authenticate when connecting to a cluster. May be supplied with `--client-key` as an alternative to the `--username` and `--password` flags. See the CERTIFICATE AUTHENTICATION section for more information. \--client-cert-password The password for the certificate provided to the `--client-cert` flag, when using this flag, the certificate/key pair is expected to be in the PKCS#12 format. See the CERTIFICATE AUTHENTICATION section for more information. \--client-key The path to the client private key whose public key is contained in the certificate provided to the `--client-cert` flag. May be supplied with `--client-cert` as an alternative to the `--username` and `--password`flags. See the CERTIFICATE AUTHENTICATION section for more information. \--client-key-password The password for the key provided to the `--client-key` flag, when using this flag, the key is expected to be in the PKCS#8 format. See the CERTIFICATE AUTHENTICATION section for more information. \--cluster-username Specifies the new username for the Couchbase administrator user. \--cluster-password Specifies the new password for the Couchbase administrator user. \--cluster-ramsize Specifies the data services memory quota. This quota will be assigned to all future nodes added to the cluster with the data service. \--cluster-fts-ramsize Sets the full-text service memory quota. This parameter is required if the full-text service is specified in the --services option. This quota will be assigned to all future nodes added to the cluster with the full-text service. \--cluster-index-ramsize Sets the index service memory quota. This parameter is required if the index service is specified in the --services option. This quota will be assigned to all future nodes added to the cluster with the index service. \--cluster-eventing-ramsize Sets the Eventing service memory quota (in MiB). This parameter is required if the Eventing service is specified in the --services option. This quota will be assigned to all future nodes added to the cluster with the eventing service. \--cluster-analytics-ramsize Sets the Analytics service memory quota (in MiB). This parameter is required if the Analytics service is specified in the --services option. This quota will be assigned to all future nodes added to the cluster with the Analytics service. \--cluster-query-ramsize Sets the Query service memory quota (in MiB). This parameter is required if the Query service is specified in the --services option. This quota will be assigned to all future nodes added to the cluster with the Query service. \--cluster-name Sets the name for this cluster. Naming clusters is useful when you have multiple Couchbase clusters in your deployment. \--cluster-port Specifies the port for the Couchbase Administration Console. Defaults to port 8091. ## [](#host-formats)HOST FORMATS When specifying a host for the couchbase-cli command the following formats are expected: * `couchbase://` or `couchbases://` * `http://:` or `https://:` * `:` It is recommended to use the couchbase:// or couchbases:// format for standard installations. The other 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 (or 18091 for https). ## [](#certificate-authentication-mtls-authentication)CERTIFICATE AUTHENTICATION (MTLS AUTHENTICATION) This tool supports authenticating against a Couchbase Cluster by using certificate based authentication (mTLS authentication). To use certificate based authentication a certificate/key must be supplied, there a currently multiple ways this may be done. ### [](#pem-encoded-certificatekey)PEM ENCODED CERTIFICATE/KEY An unencrypted PEM encoded certificate/key may be supplied by using: - `--client-cert `\- `--client-key ` The file passed to `--client-cert` must contain the client certificate, and an optional chain required to authenticate the client certificate. The file passed to `--client-key` must contain at most one private key, the key can be in one of the following formats: - PKCS#1 - PKCS#8 Currently, only the following key types are supported: - RSA - DSA ### [](#pem-encoded-certificatepem-or-der-encrypted-pkcs8-key)PEM ENCODED CERTIFICATE/PEM OR DER ENCRYPTED PKCS#8 KEY An encrypted PKCS#8 formatted key may be provided using: - `--client-cert `\- `--client-key `\- `--client-key-password ` The file passed to `--client-cert` must contain the client certificate, and an optional chain required to authenticate the client certificate. Currently, only the following key types are supported: - RSA - DSA ### [](#encrypted-pkcs12-certificatekey)ENCRYPTED PKCS#12 CERTIFICATE/KEY An encrypted PKCS#12 certificate/key may be provided using: - `--client-cert `\- `--client-cert-password ` The file passed to `--client-cert` must contain the client certificate and exactly one private key. It may also contain the chain required to authenticate the client certificate. Currently, only the following key types are supported: - RSA - DSA ## [](#examples)EXAMPLES To change the username and password of the Couchbase administrator user run the following command. $ couchbase-cli setting-cluster -c 192.168.1.5:8091 --username cur_user \ --password cur_password --cluster-username new_username \ --cluster-password new_password To change the port number that the cluster manager listens on and the cluster name to "new\_name" run the following command. $ couchbase-cli setting-cluster -c 192.168.1.5:8091 --username Administrator \ --password password --cluster-port 5000 --cluster-name new_name To change the memory quota of the data server to 2048 and the memory quota of the index service to 4096 run the following command. $ couchbase-cli setting-cluster -c 192.168.1.5:8091 --username Administrator \ --password password --cluster-ramsize 2048 --cluster-index-ramsize 4096 All of the parameters in this command can be specified at the same time. To change the username and password of the Couchbase administrator user, change the port number to 5000, change the cluster name to "new\_name", change the memory quota of the data service to 2048 and change the memory quota of the index service to 4096 run the following command. $ couchbase-cli setting-cluster -c 192.168.1.5:8091 --username cur_user \ --password cur_password --cluster-username new_username \ --cluster-password new_password --cluster-port 5000 \ --cluster-name new_name --cluster-ramsize 2048 --cluster-index-ramsize 4096 ## [](#environment-and-configuration-variables)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. CB\_CLIENT\_CERT The path to a client certificate used to authenticate when connecting to a cluster. May be supplied with `CB_CLIENT_KEY` as an alternative to the `CB_USERNAME` and `CB_PASSWORD` variables. See the CERTIFICATE AUTHENTICATION section for more information. CB\_CLIENT\_CERT\_PASSWORD The password for the certificate provided to the `CB_CLIENT_CERT` variable, when using this variable, the certificate/key pair is expected to be in the PKCS#12 format. See the CERTIFICATE AUTHENTICATION section for more information. CB\_CLIENT\_KEY The path to the client private key whose public key is contained in the certificate provided to the `CB_CLIENT_CERT` variable. May be supplied with `CB_CLIENT_CERT` as an alternative to the `CB_USERNAME` and `CB_PASSWORD`variables. See the CERTIFICATE AUTHENTICATION section for more information. CB\_CLIENT\_KEY\_PASSWORD The password for the key provided to the `CB_CLIENT_KEY` variable, when using this variable, the key is expected to be in the PKCS#8 format. See the CERTIFICATE AUTHENTICATION section for more information. ## [](#see-also)SEE ALSO [cluster-init](couchbase-cli-cluster-init.md) ## [](#couchbase-cli)COUCHBASE-CLI Part of the [couchbase-cli](couchbase-cli.md) suite