summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/base/interfaces.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/base/interfaces.xml')
-rw-r--r--docs/smbdotconf/base/interfaces.xml49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/smbdotconf/base/interfaces.xml b/docs/smbdotconf/base/interfaces.xml
new file mode 100644
index 0000000000..e6d9d6c3ec
--- /dev/null
+++ b/docs/smbdotconf/base/interfaces.xml
@@ -0,0 +1,49 @@
+<samba:parameter name="interfaces"
+ context="G"
+ type="list"
+ basic="1" advanced="1" wizard="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This option allows you to override the default
+ network interfaces list that Samba will use for browsing, name
+ registration and other NBT traffic. By default Samba will query
+ the kernel for the list of all active interfaces and use any
+ interfaces except 127.0.0.1 that are broadcast capable.</para>
+
+ <para>The option takes a list of interface strings. Each string
+ can be in any of the following forms:</para>
+
+ <itemizedlist>
+ <listitem><para>a network interface name (such as eth0).
+ This may include shell-like wildcards so eth* will match
+ any interface starting with the substring &quot;eth&quot;</para></listitem>
+
+ <listitem><para>an IP address. In this case the netmask is
+ determined from the list of interfaces obtained from the
+ kernel</para></listitem>
+
+ <listitem><para>an IP/mask pair. </para></listitem>
+
+ <listitem><para>a broadcast/mask pair.</para></listitem>
+ </itemizedlist>
+
+ <para>The &quot;mask&quot; parameters can either be a bit length (such
+ as 24 for a C class network) or a full netmask in dotted
+ decimal form.</para>
+
+ <para>The &quot;IP&quot; parameters above can either be a full dotted
+ decimal IP address or a hostname which will be looked up via
+ the OS's normal hostname resolution mechanisms.</para>
+
+</description>
+
+<value type="example">
+ <comment>This would configure three network interfaces corresponding
+ to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
+ The netmasks of the latter two interfaces would be set to 255.255.255.0.</comment>
+ eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
+</value>
+
+<related>bind interfaces only</related>
+<value type="default"><comment>all active interfaces except 127.0.0.1 that are broadcast capable</comment></value>
+</samba:parameter>