man pages: Add documentation for new parameter 'ldap connection timeout'.
authorKarolin Seeger <kseeger@samba.org>
Tue, 3 Jun 2008 14:44:59 +0000 (16:44 +0200)
committerKarolin Seeger <kseeger@samba.org>
Tue, 3 Jun 2008 14:44:59 +0000 (16:44 +0200)
Karolin
(This used to be commit f7bfa1330cef34b1bbe7969bddbce2ff895321ed)

docs-xml/smbdotconf/ldap/ldapconnectiontimeout.xml [new file with mode: 0644]

diff --git a/docs-xml/smbdotconf/ldap/ldapconnectiontimeout.xml b/docs-xml/smbdotconf/ldap/ldapconnectiontimeout.xml
new file mode 100644 (file)
index 0000000..31713c9
--- /dev/null
@@ -0,0 +1,22 @@
+<samba:parameter name="ldap connection timeout"
+                context="G"
+                advanced="1" developer="1"
+                       type="integer"
+                xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>
+       This parameter tells the LDAP library calls which timeout in seconds
+       they should honor during initial connection establishments to LDAP servers.
+       It is very useful in failover scenarios in particular. If one or more LDAP
+       servers are not reachable at all, we do not have to wait until TCP
+       timeouts are over. This feature must be supported by your LDAP library.
+       </para>
+
+       <para>
+       This parameter is different from <smbconfoption name="ldap timeout"/>
+       which affects operations on LDAP servers using an existing connection
+       and not establishing an initial connection.
+       </para>
+</description>
+<value type="default">2</value>
+</samba:parameter>