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-saslauthd

    March 23, 2025
    + 12

    Modifies saslauthd settings

    SYNOPSIS

    couchbase-cli setting-saslauthd [--cluster <url>] [--username <user>]
    [--password <password>] [--admins <admins_list>]
    [--roadmins <ro_admin_list>] [--default <default>]
    [--enabled <1|0>]

    DESCRIPTION

    This command is only available for clusters running Enterprise Edition on GNU/Linux.

    This command allows users to enable SASL on their cluster as well as add administrator and read-only administrator SASL users to their cluster.

    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.

    --admins <admins_list>

    A list of SASL users who should have administrator privileges on this cluster. This list should be comma separated if multiple users are being added.

    --roadmins <ro_admin_list>

    A list of SASL users who should have read-only administrator privileges on this cluster. This list should be comma separated if multiple users are being added.

    --enabled <1|0>

    Enables or disables SASL on this cluster. To enable SASL set this option to "1". To disable SASL set this parameter to "0".

    --default <default>

    Specifies the default role for SASL users who have not been explicitly been added to the cluster. This option may be set to "admins", "ro_admins", or "none". If this option is set to "admins" then all SASL users not explicitly add to this cluster have administrator privileges. If this option is set to "roadmins" then all SASL users not explicitly add to this cluster have read-only administrator privileges. If this option is set to "none" then all SASL users not explicitly add to this cluster will have no access. This option default to "none".

    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 SASL on a cluster run the following command.

    $ couchbase-cli setting-saslauthd -c 192.168.1.5 --username Administrator \
 --password password --enabled 1

    To add users alice and barry as Administrators and users clair and daniel as Read-Only Administrators run the following command.

    $ couchbase-cli setting-saslauthd -c 192.168.1.5 --username Administrator \
 --password password --enabled 1 --admins alice,barry \
 --roadmins clair,daniel

    To enable SASL and allow all SASL users to have Administrator access run the following command.

    $ couchbase-cli setting-saslauthd -c 192.168.1.5 --username Administrator \
 --password password --enabled 1 --default admins

    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

    admin-role-manage, user-manage

    COUCHBASE-CLI

    Part of the couchbase-cli suite