docs-xml/smbdotconf/base/interfaces.xml

   1 <samba:parameter name="interfaces"
   2                  context="G"
   3                  type="cmdlist"
   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>
  11
  12         <para>The option takes a list of interface strings. Each string
  13         can be in any of the following forms:</para>
  14
  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>
  28
  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>
  32
  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>
  36
  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         In order to support SMB3 multi-channel configurations, smbd understands
  44         some extra parameters which can be appended after the actual interface with
  45         this extended syntax (note that the quoting is important in order to handle the ; and ,
  46         characters):
  47         </para>
  48
  49         <para>
  50         &quot;interface[;key1=value1[,key2=value2[...]]]&quot;
  51         </para>
  52
  53         <para>
  54         Known keys are speed, capability, if_index and options. Speed
  55         is specified in bits per second. Known capabilities are RSS and RDMA. The
  56         if_index should be used with care: the values must not coincide with
  57         indexes used by the kernel.
  58         Note that these options are mainly intended for testing and
  59         development rather than for production use. At least on Linux systems,
  60         these values should be auto-detected, but the settings can serve
  61         as last a resort when autodetection is not working or is not available.
  62         The specified values overwrite the auto-detected values.
  63         </para>
  64
  65         <para>
  66         The possible values for options are
  67         &quot;dynamic&quot; and &quot;nodynamic&quot;.
  68         Use this option in combination with setting
  69         <smbconfoption name="bind interfaces only"/>
  70         Use the &quot;dynamic&quot; to have smbd open/close listening sockets on the
  71         interface, when IP addresses are added to or removed from the interface.
  72         Use the &quot;nodynamic&quot; option to ignore any ip add/remove events for
  73         interface.
  74         Please note that when an IP address is removed, connections to that IP address
  75         are also terminated (traditional behaviour has been to keep the TCP flow alive).
  76         </para>
  77
  78         <para>
  79         Note that dynamically opening/closing listening sockets is only available on some
  80         operating systems (currently Linux).
  81         </para>
  82
  83         <para>
  84         The first two example below configures three network interfaces corresponding
  85         to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
  86         The netmasks of the latter two interfaces would be set to 255.255.255.0.
  87         </para>
  88
  89         <para>
  90         The other examples show how per interface extra parameters can be specified.
  91         Notice the possible usage of &quot;,&quot; and &quot;;&quot;, which makes
  92         the double quoting necessary.
  93         </para>
  94 </description>
  95 <related>bind interfaces only</related>
  96
  97 <value type="example">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</value>
  98 <value type="example">eth0, 192.168.2.10/24; 192.168.3.10/255.255.255.0</value>
  99 <value type="example">&quot;eth0;if_index=65,speed=1000000000,capability=RSS&quot;</value>
 100 <value type="example">&quot;lo;speed=1000000000&quot; &quot;eth0;capability=RSS&quot;</value>
 101 <value type="example">&quot;lo;speed=1000000000&quot; , &quot;eth0;capability=RSS&quot;</value>
 102 <value type="example">&quot;eth0;capability=RSS&quot; , &quot;rdma1;capability=RDMA&quot; ; &quot;rdma2;capability=RSS,capability=RDMA&quot;</value>
 103 <value type="example">&quot;eth0;options=dynamic&quot;</value>
 104
 105 <value type="default"/>
 106 </samba:parameter>