docs: insert meta data into guest account parameter
[Samba.git] / docs-xml / smbdotconf / security / passwordserver.xml
blob18baa9bdbcde267c234266a93c5cef07f715dd78
1 <samba:parameter name="password server"
2                  context="G"
3                                  type="list"
4                  advanced="1" wizard="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7     <para>By specifying the name of a domain controller with this option,
8     and using <command moreinfo="none">security = [ads|domain]</command>
9     it is possible to get Samba
10     to do all its username/password validation using a specific remote server.</para>
12     <para>Ideally, this option
13     <emphasis>should not</emphasis> be used, as the default '*' indicates to Samba 
14     to determine the best DC to contact dynamically, just as all other hosts in an 
15     AD domain do.  This allows the domain to be maintained (addition
16     and removal of domain controllers) without modification to
17     the smb.conf file.  The cryptographic protection on the authenticated RPC calls
18     used to verify passwords ensures that this default is safe.</para>
20     <para><emphasis>It is strongly recommended that you use the
21     default of '*'</emphasis>, however if in your particular
22     environment you have reason to specify a particular DC list, then
23     the list of machines in this option must be a list of names or IP
24     addresses of Domain controllers for the Domain. If you use the
25     default of '*', or list several hosts in the <parameter
26     moreinfo="none">password server</parameter> option then <command
27     moreinfo="none">smbd </command> will try each in turn till it
28     finds one that responds.  This is useful in case your primary
29     server goes down.</para>
31     <para>If the list of servers contains both names/IP's and the '*'
32     character, the list is treated as a list of preferred 
33     domain controllers, but an auto lookup of all remaining DC's
34     will be added to the list as well.  Samba will not attempt to optimize 
35     this list by locating the closest DC.</para>
36                 
37     <para>If parameter is a name, it is looked up using the 
38     parameter <smbconfoption name="name resolve order"/> and so may resolved
39     by any method and order described in that parameter.</para>
41 </description>
43 <related>security</related>
44 <value type="default">*</value>
45 <value type="example">NT-PDC, NT-BDC1, NT-BDC2, *</value>
46 <value type="example">windc.mydomain.com:389 192.168.1.101 *</value>
47 </samba:parameter>