sync packagaing with SAMBA_3_0
[kai/samba.git] / docs / docbook / smbdotconf / ldap / ldapssl.xml
1 <samba:parameter xmlns:samba="http://samba.org/common">
2                 <term><anchor id="LDAPSSL"/>ldap ssl (G)</term>
3                 <listitem><para>This option is used to define whether or not Samba should
4                 use SSL when connecting to the ldap server
5                 This is <emphasis>NOT</emphasis> related to
6                 Samba's previous SSL support which was enabled by specifying the 
7                 <command moreinfo="none">--with-ssl</command> option to the <filename moreinfo="none">configure</filename> 
8                 script.
9                 </para>
10                 
11                 <para>
12                 The <parameter moreinfo="none">ldap ssl</parameter> can be set to one of three values:
13                 </para> 
14                 <itemizedlist>
15                         <listitem><para><parameter moreinfo="none">Off</parameter> = Never use SSL when querying the directory.</para></listitem>
16
17                         <listitem><para><parameter moreinfo="none">Start_tls</parameter> = Use the LDAPv3 StartTLS extended operation 
18                         (RFC2830) for communicating with the directory server.</para></listitem>
19             
20                         <listitem><para><parameter moreinfo="none">On</parameter>  =
21                         Use SSL on the ldaps port when contacting the 
22                         <parameter moreinfo="none">ldap server</parameter>.  Only
23                         available when the backwards-compatiblity <command moreinfo="none">
24                         --with-ldapsam</command> option is specified
25                         to configure.  See <link linkend="PASSDBBACKEND"><parameter moreinfo="none">passdb backend</parameter></link></para></listitem>
26                 </itemizedlist>         
27                 
28                 <para>Default : <command moreinfo="none">ldap ssl = start_tls</command></para>
29                 </listitem>
30                 </samba:parameter>