docs:smbdotconf: add enumlist property to parameters where missing
[Samba.git] / docs-xml / smbdotconf / browse / domainmaster.xml
blob8817f2b9e053da65492e846e6e25ed354bde8662
1 <samba:parameter name="domain master"
2                  type="enum"
3                  enumlist="enum_bool_auto"
4                  context="G"
5                  function="_domain_master"
6                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
7 <description>
8         <para>
9         Tell <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> to enable
10         WAN-wide browse list collation. Setting this option causes <command moreinfo="none">nmbd</command> to claim a
11         special domain specific NetBIOS name that identifies it as a domain master browser for its given
12         <smbconfoption name="workgroup"/>. Local master browsers in the same <smbconfoption name="workgroup"/> on
13         broadcast-isolated subnets will give this <command moreinfo="none">nmbd</command> their local browse lists,
14         and then ask <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> for a
15         complete copy of the browse list for the whole wide area network.  Browser clients will then contact their
16         local master browser, and will receive the domain-wide browse list, instead of just the list for their
17         broadcast-isolated subnet.
18         </para>
20         <para>
21         Note that Windows NT Primary Domain Controllers expect to be able to claim this <smbconfoption
22         name="workgroup"/> specific special NetBIOS name that identifies them as domain master browsers for that
23         <smbconfoption name="workgroup"/> by default (i.e. there is no way to prevent a Windows NT PDC from attempting
24         to do this). This means that if this parameter is set and <command moreinfo="none">nmbd</command> claims the
25         special name for a <smbconfoption name="workgroup"/> before a Windows NT PDC is able to do so then cross
26         subnet browsing will behave strangely and may fail.
27         </para>
28                 
29         <para>
30         If <smbconfoption name="domain logons">yes</smbconfoption>, then the default behavior is to enable the
31         <smbconfoption name="domain master"/> parameter.  If <smbconfoption name="domain logons"/> is not enabled (the
32         default setting), then neither will <smbconfoption name="domain master"/> be enabled by default.
33         </para>
35         <para>
36         When <smbconfoption name="domain logons">Yes</smbconfoption> the default setting for this parameter is
37         Yes, with the result that Samba will be a PDC. If <smbconfoption name="domain master">No</smbconfoption>,
38         Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
39         </para>
41 </description>
42 <value type="default">auto</value>
43 </samba:parameter>