はじめに

以前に、Couchbase Server管理者が理解すべきことという記事を発表しましたが、その中に挙げられているような、初期構築・運用管理を実施するにあたっては、コマンドラインツールや管理用Rest APIを理解・利用し、再現性を担保することが重要です。本記事では、その手始めとして、couchbase-cliを使って、どのようなことが可能かを紹介します。

概要

couchbase-cliはCouchbaseのクラスタ管理のため提供されている、中心となるコマンド・ライン・インターフェースです。

基本的な構文は以下の通りです。

couchbase-cli <command> [options]

基本オプション

--version
バージョン情報を出力します。
--help (-h)
ヘルプメッセージを出力します。

コマンド一覧

コマンド	内容
admin-role-manage	LDAPユーザーロールを管理します。
bucket-compact	Couchbaseデータバケットを圧縮します。
bucket-create	新しいCouchbaseデータバケットを作成します。
bucket-delete	Couchbaseデータバケットを削除します。
bucket-edit	Couchbaseデータバケット設定を編集します。
bucket-flush	Couchbaseデータバケットのデータをフラッシュします。
bucket-list	すべてのCouchbaseデータバケットを一覧表示します。
cluster-edit	クラスター設定を編集します。
node-to-node-encryption	ノード間暗号化の有効化/無効化を設定します。
cluster-init	Couchbaseクラスターを初期化します。
ip-family	Couchbaseクラスターを初期化します。
collect-logs-start	ログ収集を開始します。
collect-logs-status	ログ収集ステータスを取得します。
collect-logs-stop	現在のログ収集タスクを停止します。
eventing-function-setup	Eventingサービス機能を管理します。
failover	クラスター内のサーバーをフェイルオーバーします。
group-manage	サーバーグループを管理します。
host-list	クラスター内のすべてのホストを一覧表示します。
node-init	ノードを初期化します。
rebalance	クラスター内のノード間でデータのリバランスを行います。
rebalance-status	現在のリバランスステータスを表示します。
rebalance-stop	現在のリバランスタスクを停止します。
recovery	以前にフェイルオーバーしたノードを回復します。
reset-admin-password	管理者パスワードをリセットします。
reset-cipher-suites	暗号スイートをデフォルトにリセットします。
server-add	サーバーをクラスターに追加します。
server-info	サーバーレベルの情報と統計を表示します。
server-list	クラスター内のすべてのサーバーを一覧表示します。
server-readd	フェイルオーバー後にサーバーをクラスターに追加し直します。
setting-alert	アラート設定を変更します。
setting-audit	監査ログの設定を変更します。
setting-autofailover	自動フェイルオーバー設定を変更します。
setting-autoreprovision	自動再プロビジョニングの設定を変更します。
setting-cluster	クラスター設定を変更します。
setting-compaction	圧縮設定を変更します。
setting-index	インデックス設定を変更します。
setting-ldap	LDAP設定を変更します。
setting-notification	通知設定を変更します。
setting-password-policy	パスワードポリシーを変更します。
setting-query	クエリ設定を変更します。
setting-rebalance	リバランス設定を変更します。
setting-security	セキュリティポリシーを変更します。
setting-xdcr	クロスデータセンターレプリケーション（XDCR）設定を変更します。
ssl-manage	SSL証明書を管理します。
user-manage	RBACユーザーを管理します。
xdcr-replicate	XDCRクラスター参照を管理します。
xdcr-setup	XDCRレプリケーションを管理します。
setting-saslauthd	saslauth設定を管理します。
enable-developer-preview	開発者プレビューを有効にします。
collection-manage	コレクションを管理します。

最後に

本記事では、couchbase-cliを使って出来ることを把握するために、（サブ）コマンドの一覧を整理しました。今後適宜、重要性の高いものから、より詳細な内容について、紹介していきたいと考えています。

関連情報