docs/docbook/smbdotconf/wins/winshook.xml

   1 <samba:parameter xmlns:samba="http://samba.org/common">
   2                 <term><anchor id="WINSHOOK"/>wins hook (G)</term>
   3                 <listitem><para>When Samba is running as a WINS server this
   4                 allows you to call an external program for all changes to the
   5                 WINS database. The primary use for this option is to allow the
   6                 dynamic update of external name resolution databases such as
   7                 dynamic DNS.</para>
   8
   9                 <para>The wins hook parameter specifies the name of a script
  10                 or executable that will be called as follows:</para>
  11
  12                 <para><command moreinfo="none">wins_hook operation name nametype ttl IP_list
  13                 </command></para>
  14
  15                 <itemizedlist>
  16                         <listitem><para>The first argument is the operation and is one
  17                         of &quot;add&quot;, &quot;delete&quot;, or &quot;refresh&quot;. In most cases the operation can
  18                         be ignored as the rest of the parameters provide sufficient
  19                         information. Note that &quot;refresh&quot; may sometimes be called when the
  20                         name has not previously been added, in that case it should be treated
  21                         as an add.</para></listitem>
  22
  23                         <listitem><para>The second argument is the NetBIOS name. If the
  24                         name is not a legal name then the wins hook is not called.
  25                         Legal names contain only  letters, digits, hyphens, underscores
  26                         and periods.</para></listitem>
  27
  28                         <listitem><para>The third argument is the NetBIOS name
  29                         type as a 2 digit hexadecimal number. </para></listitem>
  30
  31                         <listitem><para>The fourth argument is the TTL (time to live)
  32                         for the name in seconds.</para></listitem>
  33
  34                         <listitem><para>The fifth and subsequent arguments are the IP
  35                         addresses currently registered for that name. If this list is
  36                         empty then the name should be deleted.</para></listitem>
  37                 </itemizedlist>
  38
  39                 <para>An example script that calls the BIND dynamic DNS update
  40                 program <command moreinfo="none">nsupdate</command> is provided in the examples
  41                 directory of the Samba source code. </para>
  42                 </listitem>
  43                 </samba:parameter>