Print this page
12743 man page spelling mistakes
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man4/smb.4
+++ new/usr/src/man/man4/smb.4
1 1 '\" te
2 2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 3 .\" Copyright 2017, Nexenta Systems, Inc. All Rights Reserved.
4 4 .\" The contents of this file are subject to the terms of the
5 5 .\" Common Development and Distribution License (the "License").
6 6 .\" You may not use this file except in compliance with the License.
7 7 .\"
8 8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
↓ open down ↓ |
8 lines elided |
↑ open up ↑ |
9 9 .\" or http://www.opensolaris.org/os/licensing.
10 10 .\" See the License for the specific language governing permissions
11 11 .\" and limitations under the License.
12 12 .\"
13 13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 .\" If applicable, add the following below this CDDL HEADER, with the
16 16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
18 18 .\"
19 -.TH SMB 4 "Apr 23, 2015"
19 +.TH SMB 4 "May 16, 2020"
20 20 .SH NAME
21 21 smb \- configuration properties for Solaris CIFS server
22 22 .SH DESCRIPTION
23 -.LP
24 23 Behavior of the Solaris CIFS server is defined by property values that are
25 24 stored in the Service Management Facility, \fBsmf\fR(5).
26 25 .sp
27 26 .LP
28 27 An authorized user can use the \fBsharectl\fR(1M) command to set global values
29 28 for these properties in SMF.
30 29 .sp
31 30 .LP
32 31 The following list describes the properties:
33 32 .sp
34 33 .ne 2
35 34 .na
36 35 \fB\fBads_site\fR\fR
37 36 .ad
38 37 .sp .6
39 38 .RS 4n
40 39 Specifies the site configured in DNS to look up Active Directory information.
41 40 Sites provide a mechanism to partition or delegate administration and policy
42 41 management, which are typically used in large or complex domains.
43 42 .sp
44 43 The value should not be set if you do not have a local Active Directory site.
45 44 By default, no value is set.
46 45 .RE
47 46
48 47 .sp
49 48 .ne 2
50 49 .na
51 50 \fB\fBautohome_map\fR\fR
52 51 .ad
53 52 .sp .6
54 53 .RS 4n
55 54 Specifies the full path for the SMD autohome map file, \fBsmbautohome\fR. The
56 55 default path is \fB/etc\fR.
57 56 .RE
58 57
59 58 .sp
60 59 .ne 2
61 60 .na
62 61 \fB\fBbypass_traverse_checking\fR\fR
63 62 .ad
64 63 .sp .6
65 64 .RS 4n
66 65 When set, allows the SMB server to bypass ACL "traverse" checks.
67 66 The default value is \fBtrue\fR, for Windows compatibility.
68 67 If this parameter is \fBfalse\fR, ACL checks require that
69 68 "traverse" (directory execute) is granted on every directory
70 69 above the directory the SMB client tries to access.
71 70 Windows shares are normally setup with the higher level
72 71 directories not specifically granting such access.
73 72 .RE
74 73
75 74 .sp
76 75 .ne 2
77 76 .na
78 77 \fB\fBdisposition\fR\fR
79 78 .ad
80 79 .sp .6
81 80 .RS 4n
82 81 A value that controls whether to disconnect the share or proceed if the map
83 82 command fails. The disposition property only has meaning when the map property
84 83 has been set. Otherwise it will have no effect.
85 84 .sp
86 85 .in +2
87 86 .nf
88 87 disposition = [ continue | terminate ]
89 88 .fi
90 89 .in -2
91 90 .sp
92 91
93 92 .sp
94 93 .ne 2
95 94 .na
96 95 \fB\fBcontinue\fR\fR
97 96 .ad
98 97 .sp .6
99 98 .RS 4n
100 99 Proceed with share connection if the map command fails. This is the default in
101 100 the event that disposition is not specified.
102 101 .RE
103 102
104 103 .sp
105 104 .ne 2
106 105 .na
107 106 \fB\fBterminate\fR\fR
108 107 .ad
109 108 .sp .6
110 109 .RS 4n
111 110 Disconnect the share if the map command fails.
112 111 .RE
113 112
114 113 .RE
115 114
116 115 .sp
117 116 .ne 2
118 117 .na
119 118 \fB\fBddns_enable\fR\fR
120 119 .ad
121 120 .sp .6
122 121 .RS 4n
123 122 Enables or disables dynamic DNS updates. A value of \fBtrue\fR enables dynamic
124 123 updates, while a value of \fBfalse\fR disables dynamic updates. By default, the
125 124 value is \fBfalse\fR.
126 125 .RE
127 126
128 127 .sp
129 128 .ne 2
130 129 .na
131 130 \fB\fBencrypt\fR\fR
132 131 .ad
133 132 .sp .6
134 133 .RS 4n
135 134 Controls SMB3 Encryption. For requests on a particular share, the server's
136 135 behavior is controlled by the stricter of this option and the per-share
137 136 "encrypt" option.
138 137 .sp
139 138 When set to \fBdisabled\fR, the server will not ask clients to encrypt requests.
140 139 When set to \fBenabled\fR, the server will ask clients to encrypt requests,
141 140 but will not require that they do so. Any message that can be encrypted
142 141 will be encrypted.
143 142 When set to \fBrequired\fR, the server will deny access to or disconnect
144 143 any client that does not support encryption or fails to encrypt requests
145 144 that they should.
146 145 .sp
147 146 In other words, the \fBenabled\fR behavior is that any message that CAN
148 147 be encrypted SHOULD be encrypted, while the \fBrequired\fR behavior is that any
149 148 message that CAN be encrypted MUST be encrypted.
150 149 .RE
151 150
152 151 .sp
153 152 .ne 2
154 153 .na
155 154 \fB\fBipv6_enable\fR\fR
156 155 .ad
157 156 .sp .6
158 157 .RS 4n
159 158 Enables IPv6 Internet protocol support within the CIFS Service. Valid values
160 159 are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
161 160 .RE
162 161
163 162 .sp
164 163 .ne 2
165 164 .na
166 165 \fB\fBkeep_alive\fR\fR
167 166 .ad
168 167 .sp .6
169 168 .RS 4n
170 169 Specifies the number of seconds before an idle SMB connection is dropped by the
171 170 Solaris CIFS server. If set to 0, idle connections are not dropped. Valid
172 171 values are 0 and from 20 seconds and above. The default value is 0.
173 172 .RE
174 173
175 174 .sp
176 175 .ne 2
177 176 .na
178 177 \fB\fBlmauth_level\fR\fR
179 178 .ad
180 179 .sp .6
181 180 .RS 4n
182 181 Specifies the LAN Manager (LM) authentication level. The LM compatibility level
183 182 controls the type of user authentication to use in workgroup mode or domain
184 183 mode. The default value is 3.
185 184 .sp
186 185 The following describes the behavior at each level.
187 186 .sp
188 187 .ne 2
189 188 .na
190 189 \fB2\fR
191 190 .ad
192 191 .RS 13n
193 192 In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and
194 193 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
195 194 sends NTLM requests.
196 195 .RE
197 196
198 197 .sp
199 198 .ne 2
200 199 .na
201 200 \fB3\fR
202 201 .ad
203 202 .RS 13n
204 203 In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and
205 204 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
206 205 sends LMv2 and NTLMv2 requests.
207 206 .RE
208 207
209 208 .sp
210 209 .ne 2
211 210 .na
212 211 \fB4\fR
213 212 .ad
214 213 .RS 13n
215 214 In Windows workgroup mode, the Solaris CIFS server accepts NTLM, LMv2, and
216 215 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
217 216 sends LMv2 and NTLMv2 requests.
218 217 .RE
219 218
220 219 .sp
221 220 .ne 2
222 221 .na
223 222 \fB5\fR
224 223 .ad
225 224 .RS 13n
226 225 In Windows workgroup mode, the Solaris CIFS server accepts LMv2 and NTLMv2
227 226 requests. In domain mode, the SMB redirector on the Solaris CIFS server sends
228 227 LMv2 and NTLMv2 requests.
229 228 .RE
230 229
231 230 .RE
232 231
233 232 .sp
234 233 .ne 2
235 234 .na
236 235 \fB\fBmap\fR\fR
237 236 .ad
238 237 .sp .6
239 238 .RS 4n
240 239 The value is a command to be executed when connecting to the share. The command
241 240 can take the following arguments, which will be substituted when the command is
242 241 exec'd as described below:
243 242 .sp
244 243 .ne 2
245 244 .na
246 245 \fB\fB%U\fR\fR
247 246 .ad
248 247 .sp .6
249 248 .RS 4n
250 249 Windows username.
251 250 .RE
252 251
253 252 .sp
254 253 .ne 2
255 254 .na
256 255 \fB\fB%D\fR\fR
257 256 .ad
258 257 .sp .6
259 258 .RS 4n
260 259 Name of the domain or workgroup of \fB%U\fR.
261 260 .RE
262 261
263 262 .sp
264 263 .ne 2
265 264 .na
266 265 \fB\fB%h\fR\fR
267 266 .ad
268 267 .sp .6
269 268 .RS 4n
270 269 The server hostname.
271 270 .RE
272 271
273 272 .sp
274 273 .ne 2
275 274 .na
276 275 \fB\fB%M\fR\fR
277 276 .ad
278 277 .sp .6
279 278 .RS 4n
280 279 The client hostname, or \fB""\fR if not available.
281 280 .RE
282 281
283 282 .sp
284 283 .ne 2
285 284 .na
286 285 \fB\fB%L\fR\fR
287 286 .ad
288 287 .sp .6
289 288 .RS 4n
290 289 The server NetBIOS name.
291 290 .RE
292 291
293 292 .sp
294 293 .ne 2
295 294 .na
296 295 \fB\fB%m\fR\fR
297 296 .ad
298 297 .sp .6
299 298 .RS 4n
300 299 The client NetBIOS name, or \fB""\fR if not available. This option is only
301 300 valid for NetBIOS connections (port 139).
302 301 .RE
303 302
304 303 .sp
305 304 .ne 2
306 305 .na
307 306 \fB\fB%I\fR\fR
308 307 .ad
309 308 .sp .6
310 309 .RS 4n
311 310 The IP address of the client machine.
312 311 .RE
313 312
314 313 .sp
315 314 .ne 2
316 315 .na
317 316 \fB\fB%i\fR\fR
318 317 .ad
319 318 .sp .6
320 319 .RS 4n
321 320 The local IP address to which the client is connected.
322 321 .RE
323 322
324 323 .sp
325 324 .ne 2
326 325 .na
327 326 \fB\fB%S\fR\fR
328 327 .ad
329 328 .sp .6
330 329 .RS 4n
331 330 The name of the share.
332 331 .RE
333 332
334 333 .sp
335 334 .ne 2
336 335 .na
337 336 \fB\fB%P\fR\fR
338 337 .ad
339 338 .sp .6
340 339 .RS 4n
341 340 The root directory of the share.
342 341 .RE
343 342
344 343 .sp
345 344 .ne 2
346 345 .na
347 346 \fB\fB%u\fR\fR
348 347 .ad
349 348 .sp .6
350 349 .RS 4n
351 350 The UID of the Unix user.
352 351 .RE
353 352
354 353 .RE
355 354
356 355 .sp
357 356 .ne 2
358 357 .na
359 358 \fB\fBmax_protocol\fR\fR
360 359 .ad
361 360 .sp .6
362 361 .RS 4n
363 362 Specifies the maximum SMB protocol level that the SMB service
364 363 should allow clients to negotiate. The default value is \fB2.1\fR.
365 364 Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR
366 365 .RE
367 366
368 367 .sp
369 368 .ne 2
370 369 .na
371 370 \fB\fBmin_protocol\fR\fR
372 371 .ad
373 372 .sp .6
374 373 .RS 4n
375 374 Specifies the minimum SMB protocol level that the SMB service
376 375 should allow clients to negotiate. The default value is \fB1\fR.
377 376 Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR
378 377 .RE
379 378
380 379 .sp
381 380 .ne 2
382 381 .na
383 382 \fB\fBmax_workers\fR\fR
384 383 .ad
385 384 .sp .6
386 385 .RS 4n
387 386 Specifies the maximum number of worker threads that will be launched to process
388 387 incoming CIFS requests. The SMB \fBmax_mpx\fR value, which indicates to a
389 388 client the maximum number of outstanding SMB requests that it may have pending
390 389 on the server, is derived from the \fBmax_workers\fR value. To ensure
391 390 compatibility with older versions of Windows the lower 8-bits of \fBmax_mpx\fR
392 391 must not be zero. If the lower byte of \fBmax_workers\fR is zero, \fB64\fR is
393 392 added to the value. Thus the minimum value is \fB64\fR and the default value,
394 393 which appears in \fBsharectl\fR(1M) as \fB1024\fR, is \fB1088\fR.
395 394 .RE
396 395
397 396 .sp
398 397 .ne 2
399 398 .na
400 399 \fB\fBnetbios_scope\fR\fR
401 400 .ad
402 401 .sp .6
403 402 .RS 4n
404 403 Specifies the NetBIOS scope identifier, which identifies logical NetBIOS
405 404 networks that are on the same physical network. When you specify a NetBIOS
406 405 scope identifier, the server filters the number of machines that are listed in
407 406 the browser display to make it easier to find other hosts. The value is a text
408 407 string that represents a domain name. By default, no value is set.
409 408 .RE
410 409
411 410 .sp
|
↓ open down ↓ |
378 lines elided |
↑ open up ↑ |
412 411 .ne 2
413 412 .na
414 413 \fB\fBoplock_enable\fR\fR
415 414 .ad
416 415 .sp .6
417 416 .RS 4n
418 417 Controls whether "oplocks" may be granted by the SMB server.
419 418 The term "oplock" is short for "opportunistic lock", which is
420 419 the legacy name for cache delegations in SMB.
421 420 By default, oplocks are enabled.
422 -Note that if oplocks are disabled, file I/O perfrormance may be
421 +Note that if oplocks are disabled, file I/O performance may be
423 422 severely reduced.
424 423 .RE
425 424
426 425 .sp
427 426 .ne 2
428 427 .na
429 428 \fB\fBpdc\fR\fR
430 429 .ad
431 430 .sp .6
432 431 .RS 4n
433 432 Specifies the preferred IP address for the domain controller. This property is
434 433 sometimes used when there are multiple domain controllers to indicate which one
435 434 is preferred. If the specified domain controller responds, it is chosen even if
436 435 the other domain controllers are also available. By default, no value is set.
437 436 .RE
438 437
439 438 .sp
440 439 .ne 2
441 440 .na
442 441 \fB\fBrestrict_anonymous\fR\fR
443 442 .ad
444 443 .sp .6
445 444 .RS 4n
446 445 Disables anonymous access to IPC$, which requires that the client be
447 446 authenticated to get access to MSRPC services through IPC$. A value of
448 447 \fBtrue\fR disables anonymous access to IPC$, while a value of \fBfalse\fR
449 448 enables anonymous access.
450 449 .RE
451 450
452 451 .sp
453 452 .ne 2
454 453 .na
455 454 \fB\fBsigning_enabled\fR\fR
456 455 .ad
457 456 .sp .6
458 457 .RS 4n
459 458 Enables SMB signing. When signing is enabled but not required it is possible
460 459 for clients to connect regardless of whether or not the client supports SMB
461 460 signing. If a packet has been signed, the signature will be verified. If a
462 461 packet has not been signed it will be accepted without signature verification.
463 462 Valid values are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
464 463 .RE
465 464
466 465 .sp
467 466 .ne 2
468 467 .na
469 468 \fB\fBsigning_required\fR\fR
470 469 .ad
471 470 .sp .6
472 471 .RS 4n
473 472 When SMB signing is required, all packets must be signed or they will be
474 473 rejected, and clients that do not support signing will be unable to connect to
475 474 the server. The \fBsigning_required\fR setting is only taken into account when
476 475 \fBsigning_enabled\fR is \fBtrue\fR. Valid values are \fBtrue\fR and
477 476 \fBfalse\fR. The default value is \fBfalse\fR.
478 477 .RE
479 478
480 479 .sp
481 480 .ne 2
482 481 .na
483 482 \fB\fBsystem_comment\fR\fR
484 483 .ad
485 484 .sp .6
486 485 .RS 4n
487 486 Specifies an optional description for the system, which is a text string. This
488 487 property value might appear in various places, such as Network Neighborhood or
489 488 Network Places on Windows clients. By default, no value is set.
490 489 .RE
491 490
492 491 .sp
493 492 .ne 2
494 493 .na
495 494 \fB\fBtraverse_mounts\fR\fR
496 495 .ad
497 496 .sp .6
498 497 .RS 4n
499 498 The \fBtraverse_mounts\fR setting determines how the SMB server
500 499 presents sub-mounts underneath an SMB share. When \fBtraverse_mounts\fR
501 500 is \fBtrue\fR (the default), sub-mounts are presented to SMB clients
502 501 like any other subdirectory. When \fBtraverse_mounts\fR is \fBfalse\fR,
503 502 sub-mounts are not shown to SMB clients.
504 503 .RE
505 504
506 505 .sp
507 506 .ne 2
508 507 .na
509 508 \fB\fBunmap\fR\fR
510 509 .ad
511 510 .sp .6
512 511 .RS 4n
513 512 The value is a command to be executed when disconnecting the share. The command
514 513 can take the same substitutions listed on the \fBmap\fR property.
515 514 .RE
516 515
517 516 .sp
518 517 .ne 2
519 518 .na
520 519 \fB\fBwins_exclude\fR\fR
521 520 .ad
522 521 .sp .6
523 522 .RS 4n
524 523 Specifies a comma-separated list of network interfaces that should not be
525 524 registered with WINS. NetBIOS host announcements are made on excluded
526 525 interfaces.
527 526 .RE
528 527
529 528 .sp
530 529 .ne 2
531 530 .na
532 531 \fB\fBwins_server_1\fR\fR
533 532 .ad
534 533 .sp .6
535 534 .RS 4n
536 535 Specifies the IP address of the primary WINS server. By default, no value is
537 536 set.
538 537 .RE
539 538
540 539 .sp
541 540 .ne 2
|
↓ open down ↓ |
109 lines elided |
↑ open up ↑ |
542 541 .na
543 542 \fB\fBwins_server_2\fR\fR
544 543 .ad
545 544 .sp .6
546 545 .RS 4n
547 546 Specifies the IP address of the secondary WINS server. By default, no value is
548 547 set.
549 548 .RE
550 549
551 550 .SH ATTRIBUTES
552 -.LP
553 551 See the \fBattributes\fR(5) man page for descriptions of the following
554 552 attributes:
555 553 .sp
556 554
557 555 .sp
558 556 .TS
559 557 box;
560 558 c | c
561 559 l | l .
562 560 ATTRIBUTE TYPE ATTRIBUTE VALUE
563 561 _
564 562 Interface Stability Uncommitted
565 563 .TE
566 564
567 565 .SH SEE ALSO
568 -.LP
569 566 \fBsharectl\fR(1M), \fBsmbadm\fR(1M), \fBsmbd\fR(1M), \fBsmbstat\fR(1M),
570 567 \fBattributes\fR(5), \fBsmf\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX