summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/base/interfaces.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/base/interfaces.xml')
-rw-r--r--docs-xml/smbdotconf/base/interfaces.xml87
1 files changed, 87 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/base/interfaces.xml b/docs-xml/smbdotconf/base/interfaces.xml
new file mode 100644
index 0000000..cbc2971
--- /dev/null
+++ b/docs-xml/smbdotconf/base/interfaces.xml
@@ -0,0 +1,87 @@
+<samba:parameter name="interfaces"
+ context="G"
+ type="cmdlist"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This option allows you to override the default
+ network interfaces list that Samba will use for browsing, name
+ registration and other NetBIOS over TCP/IP (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>
+
+ <para>
+ By default Samba enables all active interfaces that are broadcast capable
+ except the loopback adaptor (IP address 127.0.0.1).
+ </para>
+
+ <para>
+ In order to support SMB3 multi-channel configurations, smbd understands
+ some extra parameters which can be appended after the actual interface with
+ this extended syntax (note that the quoting is important in order to handle the ; and ,
+ characters):
+ </para>
+
+ <para>
+ &quot;interface[;key1=value1[,key2=value2[...]]]&quot;
+ </para>
+
+ <para>
+ Known keys are speed, capability, and if_index. Speed is specified in
+ bits per second. Known capabilities are RSS and RDMA. The
+ if_index should be used with care: the values must not coincide with
+ indexes used by the kernel.
+ Note that these options are mainly intended for testing and
+ development rather than for production use. At least on Linux systems,
+ these values should be auto-detected, but the settings can serve
+ as last a resort when autodetection is not working or is not available.
+ The specified values overwrite the auto-detected values.
+ </para>
+
+ <para>
+ The first two example below configures 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.
+ </para>
+
+ <para>
+ The other examples show how per interface extra parameters can be specified.
+ Notice the possible usage of &quot;,&quot; and &quot;;&quot;, which makes
+ the double quoting necessary.
+ </para>
+</description>
+<related>bind interfaces only</related>
+
+<value type="example">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</value>
+<value type="example">eth0, 192.168.2.10/24; 192.168.3.10/255.255.255.0</value>
+<value type="example">&quot;eth0;if_index=65,speed=1000000000,capability=RSS&quot;</value>
+<value type="example">&quot;lo;speed=1000000000&quot; &quot;eth0;capability=RSS&quot;</value>
+<value type="example">&quot;lo;speed=1000000000&quot; , &quot;eth0;capability=RSS&quot;</value>
+<value type="example">&quot;eth0;capability=RSS&quot; , &quot;rdma1;capability=RDMA&quot; ; &quot;rdma2;capability=RSS,capability=RDMA&quot;</value>
+
+<value type="default"/>
+</samba:parameter>