docs-xml/smbdotconf/wins/winshook.xml

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