A newer version of this documentation is available.

View Latest

setting-security

Manage security policies

SYNOPSIS

couchbase-cli setting-security [--cluster <url>] [--username <user>]
    [--password <password>] [--disable-http-ui <0|1>]

DESCRIPTION

Allows enabling and disabling of the Couchbase Administration Console.

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
--user <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.

--disable-http-ui <0|1>

Specifies whether the Couchbase Administration UI can be accessible over http. To disable access set this option to "1". To enable access set this option to "0". By default, access to the UI over http is enabled.

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 disable the Couchbase Administration Console over HTTP run the following command.

$ couchbase-cli setting-security -c 192.168.1.5 -u Administrator \
 -p password --disable-http-ui 1

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

COUCHBASE-CLI

Part of the couchbase-cli suite