A newer version of this documentation is available.

View Latest



    Sends the Couchbase master password


    couchbase-cli master-password [--new-password <password>] [--rotate-data-key]


    Couchbase Server Enterprise Edition has a "Secret Management" feature, which allows users to securely encrypt passwords and other sensitive configuration information that is stored on disk. These secrets must be stored in a secure way, and access must be controlled to reduce the risk of accidental exposure. By using Secret Management in Couchbase Server, secrets are written to disk in encrypted format. To decrypt these secrets, Couchbase requires the entering of a "master password", which is supplied by the user during server startup. This master password can be passed to the server using this command.

    By default the Secret Management feature is disabled. To enable the feature, you must first set the master password. Once a master password is set, the user is required to enter it when the server starts up. This can be done by setting the environment variable CB_MASTER_PASSWORD=<password> during server startup. Alternatively, you can set the environment variable CB_WAIT_FOR_MASTER_PASSWORD=true, and then enter the master password using the couchbase-cli master-password command. This command must be run locally on the node that needs to be unlocked.



    Sends the master password to the server that is waiting to start up.


    If provided it will rotate the master password data key. This option cannot be provided together with --new-password.


    To use the Secret Management feature, the first thing you need to do is set a password on each node of the cluster. To do this, install and start Couchbase, but don’t go through the setup process or initialize the cluster. Once Couchbase has started, run the following command to set the master password for your server.

    $ couchbase-cli setting-master-password -c -u Administrator \
      -p password --new-password password

    Once the master password has been set, you need to set the server environment variable CB_WAIT_FOR_MASTER_PASSWORD=true. You can do this by running the command below or by setting the variable in your .bashrc file.


    This environment variable will cause Couchbase to wait for the master password before starting up. Once it is set, you need to restart your cluster. Upon restarting the cluster you will notice that the server doesn’t fully start. This is because it is waiting for you to enter the master password. You can do this by running the command below. The master-password subcommand has to be run locally on the node that is waiting for the master password.

    $ couchbase-cli master-password --send-password password



    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.


    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.


    Part of the couchbase-cli suite