Merge Samba3 and Samba4 together
[amitay/samba.git] / docs-xml / smbdotconf / ldap / ldapssl.xml
1 <samba:parameter name="ldap ssl"
2                  context="G"
3                                  type="enum"
4                  advanced="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6  <description>
7         <para>This option is used to define whether or not Samba should
8         use SSL when connecting to the ldap server
9         This is <emphasis>NOT</emphasis> related to
10         Samba's previous SSL support which was enabled by specifying the 
11          <command moreinfo="none">--with-ssl</command> option to the <filename moreinfo="none">configure</filename> 
12         script.</para>
13                 
14 <para>The <smbconfoption name="ldap ssl"/> can be set to one of three values:</para>    
15         <itemizedlist>
16                 <listitem>
17                         <para><parameter moreinfo="none">Off</parameter> = Never 
18                         use SSL when querying the directory.</para>
19                 </listitem>
20
21                 <listitem>
22                         <para><parameter moreinfo="none">Start_tls</parameter> = Use 
23                         the LDAPv3 StartTLS extended operation (RFC2830) for 
24                         communicating with the directory server.</para>
25                 </listitem>
26             
27                 <listitem>
28                         <para><parameter moreinfo="none">On</parameter>  = Use SSL 
29                         on the ldaps port when contacting the <parameter 
30                         moreinfo="none">ldap server</parameter>. Only available when the 
31                         backwards-compatiblity <command 
32                         moreinfo="none">--with-ldapsam</command> option is specified
33                 to configure. See <smbconfoption name="passdb backend"/></para>.
34                 </listitem>
35         </itemizedlist>         
36 </description>
37 <value type="default">start_tls</value>
38 </samba:parameter>