Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

setting-notification

      +

      Modifies notification settings

      SYNOPSIS

      couchbase-cli setting-notification [--cluster <url>] [--username <user>]
    [--password <password>] [--enable-notifications <int>]

      DESCRIPTION

      Enabling notifications allows the Couchbase Administration Console to notify users about newer versions of Couchbase Server. This system also collects information about use and experience with the product every time an administrator interacts with the administrator user interface. It collects configuration, usage and performance data, including cluster information (such as settings and configuration, software version, cluster ID, load levels, and resource quotas), and browser and network information (such as IP address, inferred geolocation only at the city level, and browser type). This does not allow Couchbase to track your specific interactions or usage of the Couchbase Server. It never accesses or collects any data stored within Couchbase Server.

      OPTIONS

      -c
      --cluster

      Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

      -u
      --username <username>

      Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

      -p
      --password <password>

      Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

      --enable-notification <int>

      Specifies whether or not notifications should be enabled. To enable notifications set this flag to "1". To disable notifications set this flag to "0".

      HOST FORMATS

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

      • couchbase://<addr>

      • <addr>:<port>

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

      It is recommended to use the couchbase://<addr> format for standard installations. The other two 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.

      EXAMPLES

      To enable notifications on a Couchbase cluster run the following command\&.

      $ couchbase-cli setting-notifications -c 192.168.1.5 -u Administrator \
 -p password --enable-notification 1

      To disable notifications run the following command.

      $ couchbase-cli setting-notifications -c 192.168.1.5 -u Administrator \
 -p password --enable-notification 0

      DISCUSSION

      The setting-notification subcommand either enables or disables notifications about new Couchbase releases. This setting is a global parameter and applies to all nodes in a cluster.

      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.

      SEE ALSO

      couchbase-cli, cluster-init

      COUCHBASE-CLI

      Part of the couchbase-cli suite