From: Stefan Metzmacher <metze@samba.org>
Date: Tue, 23 Jun 2020 15:39:10 +0000 (+0200)
Subject: docs-xml/smbdotconf: add "smb2 disable oplock break retry"
X-Git-Tag: samba-4.13.0rc1~19
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bc10e5039a9056474f0cab03a798d85d62d47254;p=thirdparty%2Fsamba.git

docs-xml/smbdotconf: add "smb2 disable oplock break retry"

Signed-off-by: Stefan Metzmacher <metze@samba.org>
Reviewed-by: Günther Deschner <gd@samba.org>
---

diff --git a/docs-xml/smbdotconf/protocol/smb2_disable_oplock_break_retry.xml b/docs-xml/smbdotconf/protocol/smb2_disable_oplock_break_retry.xml
new file mode 100644
index 00000000000..1b67100b7eb
--- /dev/null
+++ b/docs-xml/smbdotconf/protocol/smb2_disable_oplock_break_retry.xml
@@ -0,0 +1,39 @@
+<samba:parameter name="smb2 disable oplock break retry"
+                 context="G"
+                 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>This boolean parameter controls whether
+    <citerefentry><refentrytitle>smbd</refentrytitle>
+    <manvolnum>8</manvolnum></citerefentry> will trigger
+    smb2 oplock break notification retries when using
+    <smbconfoption name="server multi channel support">yes</smbconfoption>.
+    </para>
+
+    <para>The [MS-SMB2] specification documents that a server should
+    send smb2 oplock break notification retries on all available channel
+    to the given client.</para>
+
+    <para>But Windows Server versions (at least up to 2019) do not send
+    smb2 oplock break notification retries on channel failures.
+    That means they do not implement the behavior specified
+    in [MS-SMB2].</para>
+
+    <para>By default Samba behaves according to the specification
+    and send smb2 oplock break notification retries.</para>
+
+    <para>Warning: Only enable this option if existing clients can't
+    handle possible retries and it turns out that the Windows Server
+    behavior is required.</para>
+
+    <para>Note: it's likely that this option gets removed again
+    if future Windows versions change their behavior.</para>
+
+    <para>Note: this only applies to oplocks and not SMB2 leases.</para>
+</description>
+
+<related>server multi channel support</related>
+
+<value type="default">no</value>
+<value type="example">yes</value>
+</samba:parameter>