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