1= couchbase-cli-setting-ldap(1)
2ifndef::doctype-manpage[:doctitle: setting-ldap]
3
4ifdef::doctype-manpage[]
5== NAME
6
7couchbase-cli-setting-ldap -
8endif::[]
9Modifies LDAP settings
10
11== SYNOPSIS
12
13[verse]
14_couchbase-cli setting-ldap_ [--cluster <url>] [--username <user>]
15    [--password <password>] [--ldap-admins <admins_list>]
16    [--ldap-roadmins <ro_admin_list>] [--ldap-default <default>]
17    [--ldap-enabled <num>]
18
19== DESCRIPTION
20
21This command allows users to enable LDAP on their cluster as well as add
22administrator and read-only administrator LDAP users to their cluster.
23
24== OPTIONS
25
26include::{partialsdir}/cbcli/part-common-options.adoc[]
27
28--ldap-admins <admins_list>::
29  A list of LDAP users who should have administrator privileges on this
30  cluster. This list should be comma separated if multiple users are being
31  added.
32
33--ldap-roadmins <ro_admin_list>::
34  A list of LDAP users who should have read-only administrator privileges on
35  this cluster. This list should be comma separated if multiple users are
36  being added.
37
38--ldap-enabled <num>::
39  Enables or disables LDAP on this cluster. To enable LDAP set this option to
40  "1". To disable LDAP set this parameter to "0".
41
42--ldap-default <default>::
43  Specifies the default role for LDAP users who have not been explicitly been
44  added to the cluster. This option may be set to "admins", "ro_admins", or
45  "none". If this option is set to "admins" then all LDAP users not explicitly
46  add to this cluster have administrator privileges. If this option is set to
47  "roadmins" then all LDAP users not explicitly add to this cluster have
48  read-only administrator privileges. If this option is set to "none" then all
49  LDAP users not explicitly add to this cluster will have no access. This
50  option default to "none".
51
52include::{partialsdir}/cbcli/part-host-formats.adoc[]
53
54== EXAMPLES
55
56To enable LDAP on a cluster run the following command.
57
58  $ couchbase-cli setting-ldap -c 192.168.1.5 --username Administrator \
59   --password password --ldap-enabled 1
60
61To add users alice and barry as Administrators and users clair and daniel as
62Read-Only Administrators run the following command.
63
64  $ couchbase-cli setting-ldap -c 192.168.1.5 --username Administrator \
65   --password password --ldap-enabled 1 --ldap-admins alice,barry \
66   --ldap-ro-admins clair,daniel
67
68To enable LDAP and allow all LDAP users to have Amdinistrator access run the
69following command.
70
71  $ couchbase-cli setting-ldap -c 192.168.1.5 --username Administrator \
72   --password password --ldap-enabled 1 --ldap-default admins
73
74== ENVIRONMENT AND CONFIGURATION VARIABLES
75
76include::{partialsdir}/cbcli/part-common-env.adoc[]
77
78== SEE ALSO
79
80man:couchbase-cli-admin-role-manage[1],
81man:couchbase-cli-user-manage[1]
82
83include::{partialsdir}/cbcli/part-footer.adoc[]
84