Search:

Search all manuals
Search this manual
Manual
Couchbase Server Manual 1.8
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Parent Section
Couchbase Server Manual 1.8
Child Sections
Chapters

Chapter 7. Command-line Interface for Administration

Table of Contents

7.1. Command-Line Tools Availability
7.2. Using couchbase-cli
7.2.1. Listing Servers
7.2.2. Getting Node Information
7.2.3. Adding Nodes to a Cluster
7.2.4. Removing Nodes from Clusters
7.2.5. Rebalancing a Cluster
7.2.6. Initializing Nodes
7.2.7. Viewing Buckets
7.2.8. Creating New Buckets
7.2.9. Updating Bucket Properties
7.2.10. Deleting Buckets
7.3. Using cbstats
7.3.1. Retrieving Bucket Statistics
7.3.2. Viewing Memory Allocations
7.3.3. Viewing Timing for Operations
7.4. Using cbflushctl
7.4.1. cbflushctl set Command
7.5. Using tap.py
7.6. Using cbvbucketctl
7.7. Usingcbvbuckettool
7.8. Using cbdbmaint
7.9. Using cbcollect_info

Couchbase Server includes a number of command-line tools that can be used to manage and monitor a Couchbase Server cluster or server. Most operations correspond to Couchbase REST API requests, and were applicable we cross-reference these REST reqeusts: Chapter 8, REST API for Administration.

Couchbase command-line tools are described individually within the following sections:

Table 7.1. Couchbase Server Command-line Tools

ToolDescription
couchbase-cliMain tool for communicating and managing your Couchbase Server.
cbstatsTo view stats from a Couchbase Server node
cbflushctlFor managing the configuration, memory and disk persistence behavior.
tap.pyTo access the TAP interface of a Couchbase Server node.
cbvbucketctlTo manage vBucket states on a Couchbase Server node.
cbdbmaintTo manage the SQLite database on a Couchbase Server node.
cbcollect_infoFor gathering a several of statistics from a Couchbase Server node.

Couchbase Server installer places tools in a number of directories, dependent on the tool and platform. You can either go to that directory and use the command line tool, or create a symbolic link to the directory:

Linux/opt/couchbase/bin
WindowsC:\Program Files\Couchbase\Server\bin\cli
Mac OS X/Applications/Couchbase\ Server.app/Contents/Resources/couchbase-core/bin