docs:smbdotconf: make formatting of headers uniform.
[Samba.git] / docs-xml / smbdotconf / misc / ctdbtimeout.xml
blobb02b2c8a3c388257df55ba4b5f2903b69384cf0b
1 <samba:parameter name="ctdb timeout"
2                  context="G"
3                  type="integer"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This parameter specifies a timeout in milliseconds for the
7           connection between Samba and ctdb. It is only valid if you
8           have compiled Samba with clustering and if you have
9           set <parameter>clustering=yes</parameter>.
10         </para>
11         <para>When something in the cluster blocks, it can happen that
12           we wait indefinitely long for ctdb, just adding to the
13           blocking condition. In a well-running cluster this should
14           never happen, but there are too many components in a cluster
15           that might have hickups. Choosing the right balance for this
16           value is very tricky, because on a busy cluster long service
17           times to transfer something across the cluster might be
18           valid. Setting it too short will degrade the service your
19           cluster presents, setting it too long might make the cluster
20           itself not recover from something severely broken for too
21           long.
22         </para>
23         <para>
24           Be aware that if you set this parameter, this needs to be in
25           the file smb.conf, it is not really helpful to put this into
26           a registry configuration (typical on a cluster), because to
27           access the registry contact to ctdb is required.
28         </para>
29         <para>Setting <parameter>ctdb timeout</parameter> to n makes
30           any process waiting longer than n milliseconds for a reply by the
31           cluster panic. Setting it to 0 (the default) makes Samba
32           block forever, which is the highly recommended default.
33         </para>
34 </description>
35 <value type="default">0</value>
36 </samba:parameter>