setting-ldap

Configure LDAP

SYNOPSIS

couchbase-cli setting-ldap [--cluster <url>] [--username <user>]
    [--password <password>] [--authentication-enabled <1|0>]
    [--authorization-enabled <1|0>] [--hosts <host_list>] [--port <port>]
    [--encryption <tls|startTLS|none>] [--server-cert-validation <1|0>]
    [--ldap-cacert <path>] [--request-timeout <ms>]
    [--user-dn-query <query> | --user-dn-template <template>]
    [--max-parallel <max>] [--max-cache-size <size>]
    [--cache-value-lifetime <ms>] [--bind-dn <dn>] [--bind-password <password>]
    [--client-cert <path>] [--client-key <path>]
    [--group-query <query>] [--enable-nested-groups <0|1>]
    [--nested-group-max-depth <depth>]

DESCRIPTION

This command allows administrators to configure and connect LDAP servers.

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.
--authentication-enabled <1|0>: Enables using LDAP to authenticate users
--authorization-enabled <1|0>: Enables using LDAP to give users authorization
--hosts <host_list>: Specifies a comma separated list of LDAP hosts.
--port <port>: LDAP port.
--encryption <tls|startTLS|none>: Security used to communicate with LDAP servers. Supported options [tls, startTLS, none].
--server-cert-validation <1|0>: Enable or disable certificate validation when connecting to LDAP server.
--ldap-cacert <path>: CA certificate to be used for server’s certificate validation, required if certificate validation is not disabled
--request-timeout <ms>: The timeout for LDAP requests in milliseconds.
--user-dn-query <query>: LDAP query to get user’s DN. Must contains at least one instance of %u Example: ou=Users,dc=example??one?(uid=%u)
--user-dn-template <template>: Template to construct user’s DN. Must contain at least one instance of %u Example: uid=%u,ou=Users,dc=example
--max-parallel <max>: Maximum number of parallel connections that can be established with LDAP servers.
--max-cache-size <size>: Maximum number of requests that can be cached, defaults to 10000.
--cache-value-lifetime <ms>: Lifetime of values in cache in milliseconds. Default 300000 ms.
--bind-dn <dn>: The DN of a user to authenticate as to allow user search and groups synchronization. If bind details or client TLS certificate are not provided anonymous bind will be used instead.
--bind-password <password>: The bind user password
--client-cert <path>: The client TLS certificate to be used to bind against the LDAP Server to allow user and groups synchronization. If bind details or client TLS certificate are not provided anonymous bind will be used instead. '--client-cert' and '--client-key' need to be set together.
--client-key <path>: The client TLS key. This is used with '--client-cert' flag for certificate authentication. '--client-cert' and '--client-key' need to be set together.
--group-query <query>: LDAP query, to get the users' groups by username in RFC4516 format. The %u and %D placeholders can be used, for username and user’s DN respectively. If attribute is present in the query, the list of attribute values in the search result is considered as list of user’s groups (single entry result is expected): for example: '%D?memberOf?base'. If the attribute is not present in the query, every returned entry is considered a group, for example: 'ou=groups,dc=example,dc=com??one?(member=%D)'
--enable-nested-groups <0|1>: If enabled Couchbase server will try to recursively search for groups for every discovered ldap group.
--nested-groups-max-depth <depth>: Maximum number of recursive groups requests the server is allowed to perform. This option is only valid when nested groups are enabled. The depth is an integer between 1 and 100, default is 10.

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 authentication and authorization using ldap server ldap.couchbase.com with encryption disabled:

$ couchbase-cli setting-ldap -c 192.168.1.5 -u Administrator \
 -p password --authentication-enabled 1 --authorization-enabled 1 \
 --hosts ldap.couchbase.com --encryption none

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.

COUCHBASE-CLI

Part of the couchbase-cli suite