docs-xml/smbdotconf/wins/winshook.xml

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