The cbepctl command enables you to control many of the configuration, RAM and disk parameters of a running cluster. This tool is for controlling the vBucket states on a Couchbase Server node. It is also responsible for controlling the configuration, memory and disk persistence behavior. This tool was formerly provided as the separate tools, cbvbucketctl and cbflushctl in Couchbase 1.8.
Changes to the cluster configuration using cbepctl are not persisted over a cluster restart.
| Linux | /opt/couchbase/bin/cbepctl |
| Windows | C:\Program Files\Couchbase\Server\bin\cbepctl.exe |
| Mac OS X | /Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin/cbepctl |
Be aware that this tool is a per-node, per-bucket operation. That means that if you want to perform this operation, you must specify the IP address of a node in the cluster and a named bucket. If you do not provided a named bucket, the server will apply the setting to any default bucket that exists at the specified node. If you want to perform this operation for an entire cluster, you will need to perform the command for every node/bucket combination that exists for that cluster.
cbepctl host:11210 -b bucket1 -p bucket_password start cbepctl host:11210 -b bucket1 -p bucket_password stop cbepctl host:11210 -b bucket1 -p bucket_password set type param value
For this command, host is the IP address for
your Couchbase cluster, or node in the cluster. The port will
always be the standard port used for cluster-wide stats and is at
11210. You also provide the named bucket and
the password for the named bucket. After this you provide command
options and authentication.
You can use the following command options to manage persistence:
| Option | Description |
|---|---|
| stop | stop persistence |
| start | start persistence |
| drain | wait until queues are drained |
| set | to set checkpoint_param,
flush_param, and
tap_param. This changes how or when
persistence occurs. |
You can use the following command options, combined with the
parameters to set checkpoint_param,
flush_param, and tap_param.
These changes the behavior of persistence in Couchbase Server.
The command options for checkpoint_param are:
| Parameter | Description |
|---|---|
| chk_max_items | Max number of items allowed in a checkpoint. |
| chk_period | Time bound (in sec.) on a checkpoint. |
| inconsistent_slave_chk | True if we allow a downstream master to receive checkpoint begin/end messages from the upstream master. |
| item_num_based_new_chk | True if a new checkpoint can be created based on. the number of items in the open checkpoint. |
| keep_closed_chks | True if we want to keep closed checkpoints in memory, as long as the current memory usage is below high water mark. |
| max_checkpoints | Max number of checkpoints allowed per vbucket. |