Membase Manual 1.7 - Chapter 4. Membase Administration

4.2.1. membase Tool
Prev	4.2. Membase Command-line Interface	Next

4.2.1. membase Tool

4.2.1. Examples:

Linux	`/opt/membase/bin/cli/membase`
Windows	`C:\Program Files\Membase\Server\bin\cli\membase.exe`

This tool provides access to various management operations for Membase clusters, nodes and buckets. The basic usage format is:

membase COMMAND CLUSTER [OPTIONS]

Where:

COMMAND is a command from Table 4.2, “membase Tool Commands”
CLUSTER is a cluster specification. You can use either:
```
--cluster=HOST[:PORT]
```
Or the shortened form:
```
-c HOST[:PORT]
```
OPTIONS is zero or more options.

Table 4.2. membase Tool Commands

Command	Description
`server-list`	List all servers in a cluster
`server-info`	Show details on one server
`server-add`	Add one or more servers to the cluster
`server-readd`	Re-add a server that was failed over
`rebalance`	Start a cluster rebalancing
`rebalance-stop`	Stop current cluster rebalancing
`rebalance-status`	Show status of current cluster rebalancing
`failover`	Failover one or more servers
`cluster-init`	Set the username,password and port of the cluster
`node-init`	Set node specific parameters
`bucket-list`	List all buckets in a cluster
`bucket-create`	Add a new bucket to the cluster
`bucket-edit`	Modify an existing bucket
`bucket-delete`	Delete an existing bucket
`bucket-flush`	Flush a given bucket
`help`	Show longer usage/help and examples

Table 4.3. Standard membase Options

Option	Command	Description
`--user=USERNAME`, `-u USERNAME`		Administrator username for accessing the cluster
`--password=PASSWORD`, `-p PASSWORD`		Administrator password for accessing the cluster
`--output=KIND`, `-o KIND`		Output kind, either `json` for JSON format, or `standard` for the native format for the command.
`--debug`, `-d`		Output debug information.
`--server-add=HOST[:PORT]`	`server-add`, `server-readd`, `rebalance`	Server to be added
`--server-add-username=USERNAME`	`server-add`, `server-readd`, `rebalance`	Admin username for the server to be added
`--server-add-password=PASSWORD`	`server-add`, `server-readd`, `rebalance`	Admin password for the server to be added
`--server-remove=HOST[:PORT]`	`rebalance`	The server to be removed
`--server-failover=HOST[:PORT]`	`failover`	Server to failover
`--cluster-init-username=USER`	`cluster-init`	New admin username
`--cluster-init-password=PASSWORD`	`cluster-init`	New admin password
`--cluster-init-port=PORT`	`cluster-init`	New cluster port (must be at least 6 characters)
`--cluster-init-ramsize=300`	`cluster-init`	New RAM quota
`--bucket=BUCKETNAME`	`bucket*`	Bucket to act on
`--bucket-type=TYPE`	`bucket*`	Memcached or membase
`--bucket-port=PORT`	`bucket*`	Supports ASCII protocol and is auth-less
`--bucket-password=PASSWORD`	`bucket*`	Standard port, exclusive with bucket-port
`--bucket-ramsize=RAMSIZEMB`	`bucket*`	RAM quota in MB
`--bucket-replica=COUNT`	`bucket*`	Replication count

Examples:

List servers in a cluster:
```
membase server-list -c 192.168.0.1:8091
```
Server information
```
membase server-info -c 192.168.0.1:8091
```

Add a node to a cluster, but do not rebalance:

membase server-add -c 192.168.0.1:8091 \
     --server-add=192.168.0.2:8091

Add a node to a cluster and rebalance:

membase rebalance -c 192.168.0.1:8091 \
     --server-add=192.168.0.2:8091

Remove a node from a cluster and rebalance:

membase rebalance -c 192.168.0.1:8091 \
     --server-remove=192.168.0.2:8091

Remove and add nodes from/to a cluster and rebalance:

membase rebalance -c 192.168.0.1:8091 \
      --server-remove=192.168.0.2 \
      --server-add=192.168.0.4

Stop the current rebalancing:

membase rebalance-stop -c 192.168.0.1:8091

Change the username, password and port:

membase cluster-init -c 192.168.0.1:8091 \
      --cluster-init-username=Administrator \
      --cluster-init-password=password \
      --cluster-init-port=8080

List buckets in a cluster:
```
membase bucket-list -c 192.168.0.1:8091
```

Create a new dedicated port membase bucket:

membase bucket-create -c 192.168.0.1:8091 --bucket=test_bucket \
      --bucket-type=membase --bucket-port=11222 --bucket-ramsize=200 \
      --bucket-replica=1

Create a new sasl memcached bucket:

membase bucket-create -c 192.168.0.1:8091 --bucket=test_bucket \
      --bucket-type=memcached --bucket-password=password \
      --bucket-ramsize=200

Modify a dedicated port bucket:

membase bucket-edit -c 192.168.0.1:8091 --bucket=test_bucket \
      --bucket-port=11222 --bucket-ramsize=400

Delete a bucket:

membase bucket-delete -c 192.168.0.1:8091 --bucket=test_bucket