setting-notification

setting-notification

Modifies notification settings

SYNTAX

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

DESCRIPTION

Enabling notifications allow the Couchbase Administration Console to notify users about newer versions of Couchbase.

OPTIONS

-c
--cluster

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

-u
--user <username>

Specifies the username of the user executing the command. If you do not have a user account with permision 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 permision 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-notification -c 192.168.1.5 -u Administrator \
 -p password --enable-notification 1

To disable notifications run the following command.

$ couchbase-cli setting-notification -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_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_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.