docs-xml/smbdotconf/locking/smb2leases.xml

   1 <samba:parameter name="smb2 leases"
   2                  context="G"
   3                  type="boolean"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>
   7         This boolean option tells <command moreinfo="none">smbd</command> whether to
   8         globally negotiate SMB2 leases on file open requests. Leasing is an SMB2-only
   9         feature which allows clients to aggressively cache files locally above and
  10         beyond the caching allowed by SMB1 oplocks. This (experimental) parameter is
  11         set to off by default until the SMB2 leasing code is declared fully stable.
  12         </para>
  13
  14         <para>
  15         This is only available with <smbconfoption name="oplocks">yes</smbconfoption>
  16         and <smbconfoption name="kernel oplocks">no</smbconfoption>.
  17         </para>
  18
  19         <para>Note that the write cache won't be used for file handles with a smb2 write lease.</para>
  20
  21         <para>
  22         The Samba implementation of leases is currently marked as experimental!
  23         </para>
  24 </description>
  25
  26 <related>oplocks</related>
  27 <related>kernel oplocks</related>
  28 <related>level2 oplocks</related>
  29 <related>write cache size</related>
  30 <value type="default">no</value>
  31 </samba:parameter>