summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/wins/winshook.xml
diff options
context:
space:
mode:
authorcvs2svn Import User <samba-bugs@samba.org>2003-04-13 13:50:46 +0000
committercvs2svn Import User <samba-bugs@samba.org>2003-04-13 13:50:46 +0000
commita47d06a2c2c67cdc0b1dfc2d32df65f2b1bbeeda (patch)
tree94fc3e2c3166e1fa14849e50468b7b529f9e3385 /docs/docbook/smbdotconf/wins/winshook.xml
parent74b163a83a7c516abe8192e3965832efa2fa64a4 (diff)
parente2996e29c7fb4697b9d95fe17d316bd2dded9d17 (diff)
downloadsamba-a47d06a2c2c67cdc0b1dfc2d32df65f2b1bbeeda.tar.gz
samba-a47d06a2c2c67cdc0b1dfc2d32df65f2b1bbeeda.tar.bz2
samba-a47d06a2c2c67cdc0b1dfc2d32df65f2b1bbeeda.zip
This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to be commit 381649916ecbaddefbb6ee0e6137b7cc73eb54b1)
Diffstat (limited to 'docs/docbook/smbdotconf/wins/winshook.xml')
-rw-r--r--docs/docbook/smbdotconf/wins/winshook.xml57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/wins/winshook.xml b/docs/docbook/smbdotconf/wins/winshook.xml
new file mode 100644
index 0000000000..e38e93f6b5
--- /dev/null
+++ b/docs/docbook/smbdotconf/wins/winshook.xml
@@ -0,0 +1,57 @@
+<samba:parameter name="wins hook"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>When Samba is running as a WINS server this
+ allows you to call an external program for all changes to the
+ WINS database. The primary use for this option is to allow the
+ dynamic update of external name resolution databases such as
+ dynamic DNS.</para>
+
+ <para>The wins hook parameter specifies the name of a script
+ or executable that will be called as follows:</para>
+
+ <para><command moreinfo="none">wins_hook operation name nametype ttl IP_list</command></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The first argument is the operation and is
+ one of &quot;add&quot;, &quot;delete&quot;, or
+ &quot;refresh&quot;. In most cases the operation
+ can be ignored as the rest of the parameters
+ provide sufficient information. Note that
+ &quot;refresh&quot; may sometimes be called when
+ the name has not previously been added, in that
+ case it should be treated as an add.</para>
+ </listitem>
+
+ <listitem>
+ <para>The second argument is the NetBIOS name. If the
+ name is not a legal name then the wins hook is not called.
+ Legal names contain only letters, digits, hyphens, underscores
+ and periods.</para>
+ </listitem>
+
+ <listitem>
+ <para>The third argument is the NetBIOS name
+ type as a 2 digit hexadecimal number. </para>
+ </listitem>
+
+ <listitem>
+ <para>The fourth argument is the TTL (time to live)
+ for the name in seconds.</para>
+ </listitem>
+
+ <listitem>
+ <para>The fifth and subsequent arguments are the IP
+ addresses currently registered for that name. If this list is
+ empty then the name should be deleted.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>An example script that calls the BIND dynamic DNS update
+ program <command moreinfo="none">nsupdate</command> is provided in the examples
+ directory of the Samba source code. </para>
+</listitem>
+</samba:parameter>