docs-xml/smbdotconf/protocol/smb3sharecaps.xml

   1 <samba:parameter name="smb3 share cap:CONTINUOUS AVAILABILITY"
   2                  context="S"
   3                  type="string"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>
   7         The SMB3 protocol introduced the SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY
   8         flag. It means clients can have different expectations from the
   9         server (or cluster of servers).
  10         </para>
  11
  12         <para>
  13         Note: this option only applies to disk shares.
  14         </para>
  15
  16         <para>In a ctdb cluster shares are continuously available,
  17         but windows clients mix this with the global persistent
  18         handles support.
  19         </para>
  20
  21         <para>Persistent handles are requested if
  22         SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is present
  23         even without SMB2_CAP_PERSISTENT_HANDLES.
  24         </para>
  25
  26         <para>And SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is
  27         required for SMB2_SHARE_CAP_CLUSTER to have
  28         an effect.
  29         </para>
  30
  31         <para>So we better don't announce this by default
  32         until we support persistent handles.
  33         </para>
  34
  35         <para>The <smbconfoption name="smb3 share cap:CONTINUOUS AVAILABILITY"/> option
  36         can be used to force the announcement of SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY.
  37         </para>
  38
  39         <para>
  40         Warning: only use this if you know what you are doing!
  41         </para>
  42
  43         <programlisting>
  44         smb3 share cap:CONTINUOUS AVAILABILITY = yes
  45         </programlisting>
  46 </description>
  47 <related>smb3 share cap:CLUSTER</related>
  48 </samba:parameter>
  49
  50 <samba:parameter name="smb3 share cap:SCALE OUT"
  51                  context="S"
  52                  type="string"
  53                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
  54 <description>
  55         <para>
  56         The SMB3 protocol introduced the SMB2_SHARE_CAP_SCALEOUT
  57         flag. It means clients can have different expectations from
  58         cluster of multiple servers and alters the retry/reconnect
  59         behavior.
  60         </para>
  61
  62         <para>
  63         Note: this option only applies to disk shares.
  64         </para>
  65
  66         <para>In a ctdb cluster we have multiple active nodes,
  67         so we announce SMB2_SHARE_CAP_SCALEOUT in a cluster.
  68         </para>
  69
  70         <para>The <smbconfoption name="smb3 share cap:SCALE OUT"/> option
  71         can be used to disable the announcement of SMB2_SHARE_CAP_SCALEOUT,
  72         even if <smbconfoption name="clustering"/> is yes.
  73         </para>
  74
  75         <programlisting>
  76         clustering = yes
  77         smb3 share cap: SCALE OUT = no
  78         </programlisting>
  79 </description>
  80 <related>clustering</related>
  81 </samba:parameter>
  82
  83 <samba:parameter name="smb3 share cap:CLUSTER"
  84                  context="S"
  85                  type="string"
  86                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
  87 <description>
  88         <para>
  89         The SMB3 protocol introduced the SMB2_SHARE_CAP_CLUSTER
  90         flag. It means clients can expect that all cluster nodes
  91         provide a witness service in order to use the [MS-SWN]
  92         protocol to monitor the server cluster.
  93         </para>
  94
  95         <para>
  96         Note: this option only applies to disk shares.
  97         </para>
  98
  99         <para>rpcd_witness is only active if
 100         <citerefentry><refentrytitle>samba-dcerpcd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 101         is not started as on demand helper and only in a ctdb cluster.
 102         </para>
 103
 104         <para>So we announce SMB2_SHARE_CAP_CLUSTER only if
 105         <smbconfoption name="clustering"/> is yes and
 106         <smbconfoption name="rpc start on demand helpers"/> is no.
 107         </para>
 108
 109         <para>The <smbconfoption name="smb3 share cap:SCALE OUT"/> option
 110         can be used to control the announcement of SMB2_SHARE_CAP_CLUSTER
 111         independent of
 112         <smbconfoption name="clustering"/> and
 113         <smbconfoption name="rpc start on demand helpers"/>.
 114         </para>
 115
 116         <para>Example to disable the announcement of SMB2_SHARE_CAP_CLUSTER:
 117         </para>
 118         <programlisting>
 119         clustering = yes
 120         rpc start on demand helpers = no
 121         smb3 share cap: CLUSTER = no
 122         </programlisting>
 123
 124         <para>Example to force the announcement of SMB2_SHARE_CAP_CLUSTER:
 125         </para>
 126         <programlisting>
 127         smb3 share cap: CLUSTER = yes
 128         </programlisting>
 129
 130         <para>Example to let Windows clients use the witness service,
 131         see <smbconfoption name="smb3 share cap:CONTINUOUS AVAILABILITY"/> option
 132         and USE AT YOUR OWN RISK!:
 133         </para>
 134
 135         <programlisting>
 136         clustering = yes
 137         rpc start on demand helpers = no
 138         # This is the default with the above:
 139         # smb3 share cap: CLUSTER = yes
 140         #
 141         # Use at you own risk!
 142         smb3 share cap: CONTINUOUS AVAILABILITY = yes
 143         </programlisting>
 144 </description>
 145 <related>clustering</related>
 146 <related>rpc start on demand helpers</related>
 147 <related>smb3 share cap:CONTINUOUS AVAILABILITY</related>
 148 <related>smb3 share cap:ASYMMETRIC</related>
 149 </samba:parameter>
 150
 151 <samba:parameter name="smb3 share cap:ASYMMETRIC"
 152                  context="S"
 153                  type="string"
 154                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 155 <description>
 156         <para>
 157         The SMB3_02 protocol introduced the SMB2_SHARE_CAP_ASYMMETRIC
 158         flag. It means clients alters its behavior and uses
 159         isolated transport connections and witness registrations for
 160         the share. It means a client may connect to different
 161         cluster nodes for individual shares and
 162         <command>net witness share-move</command> can be used
 163         to control the node usage.
 164         </para>
 165
 166         <para>
 167         Note: this option only applies to disk shares.
 168         </para>
 169
 170         <para>Shares in a ctdb cluster are symmetric by design,
 171         so we don't announce SMB2_SHARE_CAP_ASYMMETRIC by default.
 172         </para>
 173
 174         <para>The <smbconfoption name="smb3 share cap:ASYMMETRIC"/> option
 175         can be used to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC.
 176         </para>
 177
 178         <para>Example to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC:
 179         </para>
 180
 181         <programlisting>
 182         smb3 share cap: ASYMMETRIC = yes
 183         </programlisting>
 184
 185         <para>Example to let Windows clients use the witness service,
 186         see <smbconfoption name="smb3 share cap:CONTINUOUS AVAILABILITY"/> option
 187         and USE AT YOUR OWN RISK!:
 188         </para>
 189
 190         <programlisting>
 191         clustering = yes
 192         rpc start on demand helpers = no
 193         # This is the default with the above:
 194         # smb3 share cap: CLUSTER = yes
 195         #
 196         # Use at you own risk!
 197         smb3 share cap: CONTINUOUS AVAILABILITY = yes
 198         smb3 share cap: ASYMMETRIC = yes
 199         </programlisting>
 200 </description>
 201 <related>smb3 share cap:CLUSTER</related>
 202 </samba:parameter>