A newer version of this documentation is available.

View Latest


    The cbepctl tool is used to control vBucket states, configuration, and memory and disk persistence behavior.


    This tool is a per-node, per-bucket operation. That means that the IP address of a node in the cluster and a named bucket must be specified. If a named bucket is not provided, the server applies the setting to any default bucket that exists at the specified node. To perform this operation for an entire cluster, perform the command for every node/bucket combination that exists for that cluster.

    For example, when a bucket is shared by two nodes, issue this command twice and provide the different host names and ports for each node along with the bucket name. Similarly, when two data buckets are on the same node, issue the command twice for each bucket. If a bucket is not specified, the command applies to the default bucket or returns an error if a default bucket does not exist.

    Changes to the cluster configuration using cbepctl are not persisted over a cluster restart.

    The tool is found in the following locations:

    Operating system Location




    C:\Program Files\Couchbase\Server\bin\cbepctl.exe

    Mac OS X

    /Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/cbepctl


    Basic syntax for this command:

    cbepctl [host]:11210 -b [bucket_name] -p [bucket-password] start
    	cbepctl [host]:11210 -b [bucket_name] -p [bucket-password] stop
    	cbepctl [host]:11210 -b [bucket_name] -p [bucket-password] set [command-type] [parameter] [value]

    For this command, host is the IP address for the Couchbase Server cluster or node in the cluster. The port is always the standard port used for cluster-wide stats and is at 11210. The bucket name and password is provided first and then the command option and authentication.

    Use the following command options to manage persistence:

    Table 1. cbepctl command options
    Command option Description


    Stop persistence


    Start persistence


    Wait until queues are drained


    Set checkpoint_param, flush_param, and tap_param command types. This changes how or when the persisting occurs.

    The set command option along with the checkpoint_param, flush_param, and tap_param command types change the behavior of persistence in Couchbase Server.