summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/wins
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 17:47:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 17:47:29 +0000
commit4f5791ebd03eaec1c7da0865a383175b05102712 (patch)
tree8ce7b00f7a76baa386372422adebbe64510812d4 /docs-xml/smbdotconf/wins
parentInitial commit. (diff)
downloadsamba-upstream.tar.xz
samba-upstream.zip
Adding upstream version 2:4.17.12+dfsg.upstream/2%4.17.12+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs-xml/smbdotconf/wins')
-rw-r--r--docs-xml/smbdotconf/wins/dnsproxy.xml24
-rw-r--r--docs-xml/smbdotconf/wins/maxwinsttl.xml16
-rw-r--r--docs-xml/smbdotconf/wins/minwinsttl.xml15
-rw-r--r--docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml16
-rw-r--r--docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml19
-rw-r--r--docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml16
-rw-r--r--docs-xml/smbdotconf/wins/winsdb-localowner.xml12
-rw-r--r--docs-xml/smbdotconf/wins/winsdb-nosync.xml11
-rw-r--r--docs-xml/smbdotconf/wins/winshook.xml58
-rw-r--r--docs-xml/smbdotconf/wins/winsproxy.xml12
-rw-r--r--docs-xml/smbdotconf/wins/winsserver.xml34
-rw-r--r--docs-xml/smbdotconf/wins/winssupport.xml16
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml14
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml23
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml11
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml12
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml12
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml12
-rw-r--r--docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml13
19 files changed, 346 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/wins/dnsproxy.xml b/docs-xml/smbdotconf/wins/dnsproxy.xml
new file mode 100644
index 0000000..75d4446
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/dnsproxy.xml
@@ -0,0 +1,24 @@
+<samba:parameter name="dns proxy"
+ context="G"
+ type="boolean"
+ function="wins_dns_proxy"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>Specifies that <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server and
+ finding that a NetBIOS name has not been registered, should treat the
+ NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server
+ for that name on behalf of the name-querying client.</para>
+
+ <para>Note that the maximum length for a NetBIOS name is 15
+ characters, so the DNS name (or DNS alias) can likewise only be
+ 15 characters, maximum.</para>
+
+ <para><command moreinfo="none">nmbd</command> spawns a second copy of itself to do the
+ DNS name lookup requests, as doing a name lookup is a blocking
+ action.</para>
+</description>
+
+<related>wins support</related>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/maxwinsttl.xml b/docs-xml/smbdotconf/wins/maxwinsttl.xml
new file mode 100644
index 0000000..2427eec
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/maxwinsttl.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="max wins ttl"
+ type="integer"
+ context="G"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This option tells <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server
+ (<smbconfoption name="wins support">yes</smbconfoption>) what the maximum
+ 'time to live' of NetBIOS names that <command moreinfo="none">nmbd</command>
+ will grant will be (in seconds). You should never need to change this
+ parameter. The default is 6 days (518400 seconds).</para>
+</description>
+
+<related>min wins ttl</related>
+<value type="default">518400</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/minwinsttl.xml b/docs-xml/smbdotconf/wins/minwinsttl.xml
new file mode 100644
index 0000000..8991757
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/minwinsttl.xml
@@ -0,0 +1,15 @@
+<samba:parameter name="min wins ttl"
+ context="G"
+ type="integer"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry>
+ when acting as a WINS server (<smbconfoption name="wins support">yes</smbconfoption>) what the minimum 'time to live'
+ of NetBIOS names that <command moreinfo="none">nmbd</command> will grant will be (in
+ seconds). You should never need to change this parameter. The default
+ is 6 hours (21600 seconds).</para>
+</description>
+
+<value type="default">21600</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml b/docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml
new file mode 100644
index 0000000..e8d548e
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="nbtd:wins_prepend1Bto1Cqueries"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>Normally queries for 0x1C names (all logon servers for a domain)
+ will return the first address of the 0x1B names (domain master browser
+ and PDC) as first address in the result list. As many client only use
+ the first address in the list by default, all clients will use the same
+ server (the PDC). Windows servers have an option to disable this
+ behavior (since Windows 2000 Service Pack 2).
+ </para>
+</description>
+
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml
new file mode 100644
index 0000000..2566062
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="nbtd:wins_wins_randomize1Clist"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>Normally queries for 0x1C names will return the addresses in the
+ same order as they're stored in the database, that means first all
+ addresses which have been directly registered at the local wins server
+ and then all addresses registered at other servers. Windows servers
+ have an option to change this behavior and randomize the returned
+ addresses. Set this parameter to "yes" and Samba will sort the
+ address list depending on the client address and the matching bits of
+ the addresses, the first address is randomized based on depending on
+ the "nbtd:wins_randomize1Clist_mask" parameter.
+ </para>
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml
new file mode 100644
index 0000000..ea3978c
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="nbtd:wins_randomize1Clist_mask"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>If the "nbtd:wins_randomize1Clist" parameter is set to "yes",
+ then randomizing of the first returned address is based on the
+ specified netmask. If there are addresses which are in the same subnet
+ as the client address, the first returned address is randomly chosen
+ out them. Otherwise the first returned address is randomly chosen out
+ of all addresses.
+ </para>
+</description>
+
+<value type="default">255.255.255.0</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsdb-localowner.xml b/docs-xml/smbdotconf/wins/winsdb-localowner.xml
new file mode 100644
index 0000000..c5a674f
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsdb-localowner.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="winsdb:local_owner"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This specifies the address that is stored in the winsOwner attribute, of
+ locally registered winsRecord-objects.
+ The default is to use the ip-address of the first network interface.
+ </para>
+</description>
+
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsdb-nosync.xml b/docs-xml/smbdotconf/wins/winsdb-nosync.xml
new file mode 100644
index 0000000..d66aa09
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsdb-nosync.xml
@@ -0,0 +1,11 @@
+<samba:parameter name="winsdb:dbnosync"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This parameter disables fsync() after changes of the WINS database.
+ </para>
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winshook.xml b/docs-xml/smbdotconf/wins/winshook.xml
new file mode 100644
index 0000000..3dcf5d7
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winshook.xml
@@ -0,0 +1,58 @@
+<samba:parameter name="wins hook"
+ context="G"
+ type="string"
+ substitution="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <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>
+</description>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsproxy.xml b/docs-xml/smbdotconf/wins/winsproxy.xml
new file mode 100644
index 0000000..d240c21
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsproxy.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wins proxy"
+ context="G"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is a boolean that controls if <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> will respond to broadcast name
+ queries on behalf of other hosts. You may need to set this
+ to <constant>yes</constant> for some older clients.</para>
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsserver.xml b/docs-xml/smbdotconf/wins/winsserver.xml
new file mode 100644
index 0000000..d323b38
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsserver.xml
@@ -0,0 +1,34 @@
+<samba:parameter name="wins server"
+ context="G"
+ type="cmdlist"
+ function="wins_server_list"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This specifies the IP address (or DNS name: IP
+ address for preference) of the WINS server that <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> should register with. If you have a WINS server on
+ your network then you should set this to the WINS server's IP.</para>
+
+ <para>You should point this at your WINS server if you have a
+ multi-subnetted network.</para>
+
+ <para>If you want to work in multiple namespaces, you can
+ give every wins server a 'tag'. For each tag, only one
+ (working) server will be queried for a name. The tag should be
+ separated from the ip address by a colon.
+ </para>
+
+ <note><para>You need to set up Samba to point
+ to a WINS server if you have multiple subnets and wish cross-subnet
+ browsing to work correctly.</para></note>
+ <para>See the chapter in the Samba3-HOWTO on Network Browsing.</para>
+</description>
+
+<value type="default"></value>
+<value type="example">mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61
+ <comment>For this example when querying a certain name, 192.19.200.1 will
+ be asked first and if that doesn't respond 192.168.2.61. If either
+ of those doesn't know the name 192.168.3.199 will be queried.</comment></value>
+
+<value type="example">192.9.200.1 192.168.2.61</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winssupport.xml b/docs-xml/smbdotconf/wins/winssupport.xml
new file mode 100644
index 0000000..c1c7fed
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winssupport.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="wins support"
+ type="boolean"
+ context="G"
+ function="we_are_a_wins_server"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+ <description>
+ <para>This boolean controls if the <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> process in Samba will act as a WINS server. You should
+ not set this to <constant>yes</constant> unless you have a multi-subnetted network and
+ you wish a particular <command moreinfo="none">nmbd</command> to be your WINS server.
+ Note that you should <emphasis>NEVER</emphasis> set this to <constant>yes</constant>
+ on more than one machine in your network.</para>
+
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml
new file mode 100644
index 0000000..a3414e3
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="wreplsrv:periodic_interval"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This maximum interval in seconds between 2 periodically scheduled runs
+ where we check for wins.ldb changes and do push notifications to our
+ push partners. Also wins_config.ldb changes are checked in that
+ interval and partner configuration reloads are done.
+ </para>
+</description>
+
+<value type="default">15</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml b/docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml
new file mode 100644
index 0000000..9633150
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml
@@ -0,0 +1,23 @@
+<samba:parameter name="wreplsrv:propagate name releases"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>If this parameter is enabled, then
+ explicit (from the client) and implicit (via the scavenging) name releases
+ are propagated to the other servers directly, even if there are still other
+ addresses active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3) entries.
+ Also the replication conflict merge algorithm for SPECIAL GROUP (2) entries
+ discards replica addresses where the address owner is the local server,
+ if the address was not stored locally before. The merge result is
+ propagated directly in case an address was discarded.
+ A Windows servers doesn't propagate name releases of SPECIAL GROUP (2)
+ and MULTIHOMED (3) entries directly, which means that Windows servers may
+ return different results to name queries for SPECIAL GROUP (2) and MULTIHOMED (3)
+ names. The option doesn't have much negative impact if Windows servers are
+ around, but be aware that they might return unexpected results.
+ </para>
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml
new file mode 100644
index 0000000..d05170e
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml
@@ -0,0 +1,11 @@
+<samba:parameter name="wreplsrv:scavenging_interval"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is the interval in s between 2 scavenging runs which
+ clean up the WINS database and changes the states of expired name records.
+ Defaults to half of the value of wreplsrv:renew_interval.
+ </para>
+</description>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml
new file mode 100644
index 0000000..2320854
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wreplsrv:tombstone_extra_timeout"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is the time in s the server needs to be up till we'll remove
+ tombstone records from our database. Defaults to 3 days.
+ </para>
+</description>
+
+<value type="default">259200</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml
new file mode 100644
index 0000000..ee7d727
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wreplsrv:tombstone_interval"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is the interval in s till released records of the WINS
+ server become tombstone. Defaults to 6 days.
+ </para>
+</description>
+
+<value type="default">518400</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml
new file mode 100644
index 0000000..b17def9
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wreplsrv:tombstone_timeout"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is the interval in s till tombstone records are deleted from
+ the WINS database. Defaults to 1 day.
+ </para>
+</description>
+
+<value type="default">86400</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml
new file mode 100644
index 0000000..1efd97b
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml
@@ -0,0 +1,13 @@
+<samba:parameter name="wreplsrv:verify_interval"
+ context="G"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This is the interval in s till we verify active replica records
+ with the owning WINS server. Unfortunately not implemented yet.
+ Defaults to 24 days.
+ </para>
+</description>
+
+<value type="default">2073600</value>
+</samba:parameter>