docs:smbdotconf: remove swat-specific flags.
[Samba.git] / docs-xml / smbdotconf / base / interfaces.xml
blob39c90b9ad00c2aa016b0703ad8ac23801f6daff0
1 <samba:parameter name="interfaces"
2                  context="G"
3                                  type="list"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This option allows you to override the default 
7         network interfaces list that Samba will use for browsing, name 
8         registration and other NetBIOS over TCP/IP (NBT) traffic. By default Samba will query
9         the kernel for the list of all active interfaces and use any 
10         interfaces except 127.0.0.1 that are broadcast capable.</para>
12         <para>The option takes a list of interface strings. Each string 
13         can be in any of the following forms:</para>
15         <itemizedlist>
16                 <listitem><para>a network interface name (such as eth0). 
17                 This may include shell-like wildcards so eth* will match 
18                 any interface starting with the substring &quot;eth&quot;</para></listitem>
19                         
20                 <listitem><para>an IP address. In this case the netmask is 
21                 determined from the list of interfaces obtained from the 
22                 kernel</para></listitem>
23                         
24                 <listitem><para>an IP/mask pair. </para></listitem>
25                         
26                 <listitem><para>a broadcast/mask pair.</para></listitem>
27         </itemizedlist>
29         <para>The &quot;mask&quot; parameters can either be a bit length (such 
30         as 24 for a C class network) or a full netmask in dotted 
31         decimal form.</para>
33         <para>The &quot;IP&quot; parameters above can either be a full dotted 
34         decimal IP address or a hostname which will be looked up via 
35         the OS's normal hostname resolution mechanisms.</para>
37         <para>
38         By default Samba enables all active interfaces that are broadcast capable
39         except the loopback adaptor (IP address 127.0.0.1).
40         </para>
41         
42         <para>
43         The example below configures three network interfaces corresponding 
44         to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. 
45         The netmasks of the latter two interfaces would be set to 255.255.255.0.
46         </para>
48 </description>
49 <related>bind interfaces only</related>
51 <value type="example">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</value>
53 <value type="default"/>
54 </samba:parameter>