summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/protocol/smb3sharecaps.xml
blob: add89f1644a964a17984f87440f3c0e42424d701 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<samba:parameter name="smb3 share cap:CONTINUOUS AVAILABILITY"
                 context="S"
                 type="string"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
	<para>
	The SMB3 protocol introduced the SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY
	flag. It means clients can have different expectations from the
	server (or cluster of servers).
	</para>

	<para>
	Note: this option only applies to disk shares.
	</para>

	<para>In a ctdb cluster shares are continuously available,
	but windows clients mix this with the global persistent
	handles support.
	</para>

	<para>Persistent handles are requested if
	SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is present
	even without SMB2_CAP_PERSISTENT_HANDLES.
	</para>

	<para>And SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is
	required for SMB2_SHARE_CAP_CLUSTER to have
	an effect.
	</para>

	<para>So we better don't announce this by default
	until we support persistent handles.
	</para>

	<para>The <smbconfoption name="smb3 share cap:CONTINUOUS AVAILABILITY"/> option
	can be used to force the announcement of SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY.
	</para>

	<para>
	Warning: only use this if you know what you are doing!
	</para>

	<programlisting>
	smb3 share cap:CONTINUOUS AVAILABILITY = yes
	</programlisting>
</description>
<related>smb3 share cap:CLUSTER</related>
</samba:parameter>

<samba:parameter name="smb3 share cap:SCALE OUT"
                 context="S"
                 type="string"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
	<para>
	The SMB3 protocol introduced the SMB2_SHARE_CAP_SCALEOUT
	flag. It means clients can have different expectations from
	cluster of multiple servers and alters the retry/reconnect
	behavior.
	</para>

	<para>
	Note: this option only applies to disk shares.
	</para>

	<para>In a ctdb cluster we have multiple active nodes,
	so we announce SMB2_SHARE_CAP_SCALEOUT in a cluster.
	</para>

	<para>The <smbconfoption name="smb3 share cap:SCALE OUT"/> option
	can be used to disable the announcement of SMB2_SHARE_CAP_SCALEOUT,
	even if <smbconfoption name="clustering"/> is yes.
	</para>

	<programlisting>
	clustering = yes
	smb3 share cap: SCALE OUT = no
	</programlisting>
</description>
<related>clustering</related>
</samba:parameter>

<samba:parameter name="smb3 share cap:CLUSTER"
                 context="S"
                 type="string"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
	<para>
	The SMB3 protocol introduced the SMB2_SHARE_CAP_CLUSTER
	flag. It means clients can expect that all cluster nodes
	provide a witness service in order to use the [MS-SWN]
	protocol to monitor the server cluster.
	</para>

	<para>
	Note: this option only applies to disk shares.
	</para>

	<para>rpcd_witness is only active if
	<citerefentry><refentrytitle>samba-dcerpcd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	is not started as on demand helper and only in a ctdb cluster.
	</para>

	<para>So we announce SMB2_SHARE_CAP_CLUSTER only if
	<smbconfoption name="clustering"/> is yes and
	<smbconfoption name="rpc start on demand helpers"/> is no.
	</para>

	<para>The <smbconfoption name="smb3 share cap:SCALE OUT"/> option
	can be used to control the announcement of SMB2_SHARE_CAP_CLUSTER
	independent of
	<smbconfoption name="clustering"/> and
	<smbconfoption name="rpc start on demand helpers"/>.
	</para>

	<para>Example to disable the announcement of SMB2_SHARE_CAP_CLUSTER:
	</para>
	<programlisting>
	clustering = yes
	rpc start on demand helpers = no
	smb3 share cap: CLUSTER = no
	</programlisting>

	<para>Example to force the announcement of SMB2_SHARE_CAP_CLUSTER:
	</para>
	<programlisting>
	smb3 share cap: CLUSTER = yes
	</programlisting>

	<para>Example to let Windows clients use the witness service,
	see <smbconfoption name="smb3 share cap:CONTINUOUS AVAILABILITY"/> option
	and USE AT YOUR OWN RISK!:
	</para>

	<programlisting>
	clustering = yes
	rpc start on demand helpers = no
	# This is the default with the above:
	# smb3 share cap: CLUSTER = yes
	#
	# Use at you own risk!
	smb3 share cap: CONTINUOUS AVAILABILITY = yes
	</programlisting>
</description>
<related>clustering</related>
<related>rpc start on demand helpers</related>
<related>smb3 share cap:CONTINUOUS AVAILABILITY</related>
<related>smb3 share cap:ASYMMETRIC</related>
</samba:parameter>

<samba:parameter name="smb3 share cap:ASYMMETRIC"
                 context="S"
                 type="string"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
	<para>
	The SMB3_02 protocol introduced the SMB2_SHARE_CAP_ASYMMETRIC
	flag. It means clients alters its behavior and uses
	isolated transport connections and witness registrations for
	the share. It means a client may connect to different
	cluster nodes for individual shares and
	<command>net witness share-move</command> can be used
	to control the node usage.
	</para>

	<para>
	Note: this option only applies to disk shares.
	</para>

	<para>Shares in a ctdb cluster are symmetric by design,
	so we don't announce SMB2_SHARE_CAP_ASYMMETRIC by default.
	</para>

	<para>The <smbconfoption name="smb3 share cap:ASYMMETRIC"/> option
	can be used to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC.
	</para>

	<para>Example to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC:
	</para>

	<programlisting>
	smb3 share cap: ASYMMETRIC = yes
	</programlisting>

	<para>Example to let Windows clients use the witness service,
	see <smbconfoption name="smb3 share cap:CONTINUOUS AVAILABILITY"/> option
	and USE AT YOUR OWN RISK!:
	</para>

	<programlisting>
	clustering = yes
	rpc start on demand helpers = no
	# This is the default with the above:
	# smb3 share cap: CLUSTER = yes
	#
	# Use at you own risk!
	smb3 share cap: CONTINUOUS AVAILABILITY = yes
	smb3 share cap: ASYMMETRIC = yes
	</programlisting>
</description>
<related>smb3 share cap:CLUSTER</related>
</samba:parameter>