A newer version of this documentation is available.

View Latest

couchbase-cli

      +

      The Couchbase cluster management utility.

      SYNOPSIS

      couchbase-cli <command> [options]

      DESCRIPTION

      The couchbase-cli script is the main command line interface for Couchbase cluster management.

      OPTIONS

      --version

      Prints version information.

      -h
      --help

      Prints the short and long help messages.

      COMMANDS

      admin-role-manage

      Manage LDAP user roles.

      backup-service

      Manage the backup service.

      bucket-compact

      Compact a Couchbase data bucket.

      bucket-create

      Create a new Couchbase data bucket.

      bucket-delete

      Delete a Couchbase data bucket.

      bucket-edit

      Edit a Couchbase data bucket.

      bucket-flush

      Flush a Couchbase data bucket.

      bucket-list

      List all Couchbase data buckets.

      cluster-edit

      Edits cluster settings.

      node-to-node-encryption

      Allows enabling and disabling of node-to-node encryption.

      cluster-init

      Initializes a Couchbase cluster.

      ip-family

      Change ip family used for node to node communication.

      collect-logs-start

      Start log collection.

      collect-logs-status

      Get log collection status.

      collect-logs-stop

      Stop the current log collection task.

      eventing-function-setup

      Manage the Eventing Service functions.

      failover

      Failover a server in the cluster.

      group-manage

      Manage server groups.

      host-list

      Lists all hosts in the cluster.

      node-init

      Initializes a node.

      rebalance

      Rebalances data across nodes in a cluster.

      rebalance-status

      Show the current rebalance status.

      rebalance-stop

      Stops the current rebalance task.

      recovery

      Recovers a previously failed over node.

      reset-admin-password

      Resets the administrator password.

      reset-cipher-suites

      Resets the cipher suites to the default.

      server-add

      Adds a server to the cluster.

      server-info

      Displays server level information and statistics.

      server-list

      Lists all servers in the cluster.

      server-readd

      Adds a server back to the cluster after a failover.

      setting-alert

      Modifies alert settings.

      setting-audit

      Modifies audit log settings.

      setting-autofailover

      Modifies auto-failover settings.

      setting-autoreprovision

      Modifies auto-reprovision settings.

      setting-cluster

      Modifies cluster settings.

      setting-compaction

      Modifies compaction settings.

      setting-index

      Modifies index settings.

      setting-ldap

      Modifies LDAP settings.

      setting-notification

      Modifies notification settings.

      setting-password-policy

      Modifies the password policy.

      setting-query

      Modifies the query settings.

      setting-rebalance

      Modifies the rebalance settings.

      setting-security

      Modifies security policies.

      setting-xdcr

      Modifies cross data center replication (XDCR) settings.

      ssl-manage

      Manage SSL certificates.

      user-manage

      Manage RBAC users.

      xdcr-replicate

      Manages XDCR cluster references.

      xdcr-setup

      Manages XDCR replications.

      setting-saslauthd

      Manage saslauth settings.

      enable-developer-preview

      Enable developer preview.

      collection-manage

      Manage collections.

      HOST FORMATS

      When specifying a host for the couchbase-cli command the following formats are expected:

      • couchbase://<addr> or couchbases://<addr>

      • http://<addr>:<port> or https://<addr>:<port>

      • <addr>:<port>

      It is recommended to use the couchbase://<addr> or couchbases://<addr> format for standard installations. The other formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091 (or 18091 for https).

      ENVIRONMENT AND CONFIGURATION VARIABLES

      CB_REST_USERNAME

      Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

      CB_REST_PASSWORD

      Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

      CB_CLIENT_CERT

      The path to a client certificate used to authenticate when connecting to a cluster. May be supplied with CB_CLIENT_KEY as an alternative to the CB_USERNAME and CB_PASSWORD variables. See the CERTIFICATE AUTHENTICATION section for more information.

      CB_CLIENT_CERT_PASSWORD

      The password for the certificate provided to the CB_CLIENT_CERT variable, when using this variable, the certificate/key pair is expected to be in the PKCS#12 format. See the CERTIFICATE AUTHENTICATION section for more information.

      CB_CLIENT_KEY

      The path to the client private key whose public key is contained in the certificate provided to the CB_CLIENT_CERT variable. May be supplied with CB_CLIENT_CERT as an alternative to the CB_USERNAME and CB_PASSWORD variables. See the CERTIFICATE AUTHENTICATION section for more information.

      CB_CLIENT_KEY_PASSWORD

      The password for the key provided to the CB_CLIENT_KEY variable, when using this variable, the key is expected to be in the PKCS#8 format. See the CERTIFICATE AUTHENTICATION section for more information.

      COUCHBASE-CLI

      Part of the couchbase-cli suite