1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 2011, Nexenta Systems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   5 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH SMB 4 "Sep 25, 2009"












   8 .SH NAME
   9 smb \- configuration properties for Solaris CIFS server
  10 .SH DESCRIPTION
  11 .LP
  12 Behavior of the Solaris CIFS server is defined by property values that are
  13 stored in the Service Management Facility, \fBsmf\fR(5).
  14 .sp
  15 .LP
  16 An authorized user can use the \fBsharectl\fR(1M) command to set global values
  17 for these properties in SMF.
  18 .sp
  19 .LP
  20 The following list describes the properties:
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fBads_site\fR\fR
  25 .ad
  26 .sp .6
  27 .RS 4n

  30 management, which are typically used in large or complex domains.
  31 .sp
  32 The value should not be set if you do not have a local Active Directory site.
  33 By default, no value is set.
  34 .RE
  35 
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBautohome_map\fR\fR
  40 .ad
  41 .sp .6
  42 .RS 4n
  43 Specifies the full path for the SMD autohome map file, \fBsmbautohome\fR. The
  44 default path is \fB/etc\fR.
  45 .RE
  46 
  47 .sp
  48 .ne 2
  49 .na
















  50 \fB\fBdisposition\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 A value that controls whether to disconnect the share or proceed if the map
  55 command fails. The disposition property only has meaning when the map property
  56 has been set. Otherwise it will have no effect.
  57 .sp
  58 .in +2
  59 .nf
  60 disposition = [ continue | terminate ]
  61 .fi
  62 .in -2
  63 .sp
  64 
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBcontinue\fR\fR
  69 .ad

  83 Disconnect the share if the map command fails.
  84 .RE
  85 
  86 .RE
  87 
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBddns_enable\fR\fR
  92 .ad
  93 .sp .6
  94 .RS 4n
  95 Enables or disables dynamic DNS updates. A value of \fBtrue\fR enables dynamic
  96 updates, while a value of \fBfalse\fR disables dynamic updates. By default, the
  97 value is \fBfalse\fR.
  98 .RE
  99 
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBipv6_enabled\fR\fR
 104 .ad
 105 .sp .6
 106 .RS 4n
























 107 Enables IPv6 Internet protocol support within the CIFS Service. Valid values
 108 are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
 109 .RE
 110 
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBkeep_alive\fR\fR
 115 .ad
 116 .sp .6
 117 .RS 4n
 118 Specifies the number of seconds before an idle SMB connection is dropped by the
 119 Solaris CIFS server. If set to 0, idle connections are not dropped. Valid
 120 values are 0 and from 20 seconds and above. The default value is 5400 seconds.
 121 .RE
 122 
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBlmauth_level\fR\fR
 127 .ad
 128 .sp .6
 129 .RS 4n
 130 Specifies the LAN Manager (LM) authentication level. The LM compatibility level
 131 controls the type of user authentication to use in workgroup mode or domain
 132 mode. The default value is 3.
 133 .sp
 134 The following describes the behavior at each level.
 135 .sp
 136 .ne 2
 137 .na
 138 \fB2\fR
 139 .ad
 140 .RS 13n
 141 In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and
 142 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
 143 sends NTLM requests.
 144 .RE
 145 
 146 .sp
 147 .ne 2
 148 .na
 149 \fB3\fR
 150 .ad
 151 .RS 13n
 152 In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and

 299 The UID of the Unix user.
 300 .RE
 301 
 302 .RE
 303 
 304 .sp
 305 .ne 2
 306 .na
 307 \fB\fBmax_protocol\fR\fR
 308 .ad
 309 .sp .6
 310 .RS 4n
 311 Specifies the maximum SMB protocol level that the SMB service
 312 should allow clients to negotiate.  The default value is \fB2.1\fR.
 313 Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR
 314 .RE
 315 
 316 .sp
 317 .ne 2
 318 .na












 319 \fB\fBmax_workers\fR\fR
 320 .ad
 321 .sp .6
 322 .RS 4n
 323 Specifies the maximum number of worker threads that will be launched to process
 324 incoming CIFS requests. The SMB \fBmax_mpx\fR value, which indicates to a
 325 client the maximum number of outstanding SMB requests that it may have pending
 326 on the server, is derived from the \fBmax_workers\fR value. To ensure
 327 compatibility with older versions of Windows the lower 8-bits of \fBmax_mpx\fR
 328 must not be zero. If the lower byte of \fBmax_workers\fR is zero, \fB64\fR is
 329 added to the value. Thus the minimum value is \fB64\fR and the default value,
 330 which appears in \fBsharectl\fR(1M) as \fB1024\fR, is \fB1088\fR.
 331 .RE
 332 
 333 .sp
 334 .ne 2
 335 .na












 336 \fB\fBnetbios_scope\fR\fR
 337 .ad
 338 .sp .6
 339 .RS 4n
 340 Specifies the NetBIOS scope identifier, which identifies logical NetBIOS
 341 networks that are on the same physical network. When you specify a NetBIOS
 342 scope identifier, the server filters the number of machines that are listed in
 343 the browser display to make it easier to find other hosts. The value is a text
 344 string that represents a domain name. By default, no value is set.
 345 .RE
 346 
 347 .sp
 348 .ne 2
 349 .na















 350 \fB\fBpdc\fR\fR
 351 .ad
 352 .sp .6
 353 .RS 4n
 354 Specifies the preferred IP address for the domain controller. This property is
 355 sometimes used when there are multiple domain controllers to indicate which one
 356 is preferred. If the specified domain controller responds, it is chosen even if
 357 the other domain controllers are also available. By default, no value is set.
 358 .RE
 359 
 360 .sp
 361 .ne 2
 362 .na











 363 \fB\fBrestrict_anonymous\fR\fR
 364 .ad
 365 .sp .6
 366 .RS 4n
 367 Disables anonymous access to IPC$, which requires that the client be
 368 authenticated to get access to MSRPC services through IPC$. A value of
 369 \fBtrue\fR disables anonymous access to IPC$, while a value of \fBfalse\fR
 370 enables anonymous access.
 371 .RE
 372 
 373 .sp
 374 .ne 2
 375 .na
 376 \fB\fBsigning_enabled\fR\fR
 377 .ad
 378 .sp .6
 379 .RS 4n
 380 Enables SMB signing. When signing is enabled but not required it is possible
 381 for clients to connect regardless of whether or not the client supports SMB
 382 signing. If a packet has been signed, the signature will be verified. If a
 383 packet has not been signed it will be accepted without signature verification.
 384 Valid values are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
 385 .RE
 386 
 387 .sp
 388 .ne 2
 389 .na
 390 \fB\fBsigning_required\fR\fR
 391 .ad
 392 .sp .6
 393 .RS 4n
 394 When SMB signing is required, all packets must be signed or they will be
 395 rejected, and clients that do not support signing will be unable to connect to
 396 the server. The \fBsigning_required\fR setting is only taken into account when
 397 \fBsigning_enabled\fR is \fBtrue\fR. Valid values are \fBtrue\fR and
 398 \fBfalse\fR. The default value is \fBfalse\fR.
 399 .RE
 400 


 401 .sp
 402 .ne 2
 403 .na
 404 \fB\fBsystem_comment\fR\fR
 405 .ad
 406 .sp .6
 407 .RS 4n
 408 Specifies an optional description for the system, which is a text string. This
 409 property value might appear in various places, such as Network Neighborhood or
 410 Network Places on Windows clients. By default, no value is set.
 411 .RE
 412 
 413 .sp
 414 .ne 2
 415 .na
 416 \fB\fBtraverse_mounts\fR\fR
 417 .ad
 418 .sp .6
 419 .RS 4n
 420 The \fBtraverse_mounts\fR setting determines how the SMB server

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 2017, Nexenta Systems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .TH SMB 4 "Apr 23, 2015"
  20 .SH NAME
  21 smb \- configuration properties for Solaris CIFS server
  22 .SH DESCRIPTION
  23 .LP
  24 Behavior of the Solaris CIFS server is defined by property values that are
  25 stored in the Service Management Facility, \fBsmf\fR(5).
  26 .sp
  27 .LP
  28 An authorized user can use the \fBsharectl\fR(1M) command to set global values
  29 for these properties in SMF.
  30 .sp
  31 .LP
  32 The following list describes the properties:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBads_site\fR\fR
  37 .ad
  38 .sp .6
  39 .RS 4n

  42 management, which are typically used in large or complex domains.
  43 .sp
  44 The value should not be set if you do not have a local Active Directory site.
  45 By default, no value is set.
  46 .RE
  47 
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBautohome_map\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 Specifies the full path for the SMD autohome map file, \fBsmbautohome\fR. The
  56 default path is \fB/etc\fR.
  57 .RE
  58 
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBbypass_traverse_checking\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 When set, allows the SMB server to bypass ACL "traverse" checks.
  67 The default value is \fBtrue\fR, for Windows compatibility.
  68 If this parameter is \fBfalse\fR, ACL checks require that
  69 "traverse" (directory execute) is granted on every directory
  70 above the directory the SMB client tries to access.
  71 Windows shares are normally setup with the higher level
  72 directories not specifically granting such access.
  73 .RE
  74 
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBdisposition\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 A value that controls whether to disconnect the share or proceed if the map
  83 command fails. The disposition property only has meaning when the map property
  84 has been set. Otherwise it will have no effect.
  85 .sp
  86 .in +2
  87 .nf
  88 disposition = [ continue | terminate ]
  89 .fi
  90 .in -2
  91 .sp
  92 
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBcontinue\fR\fR
  97 .ad

 111 Disconnect the share if the map command fails.
 112 .RE
 113 
 114 .RE
 115 
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBddns_enable\fR\fR
 120 .ad
 121 .sp .6
 122 .RS 4n
 123 Enables or disables dynamic DNS updates. A value of \fBtrue\fR enables dynamic
 124 updates, while a value of \fBfalse\fR disables dynamic updates. By default, the
 125 value is \fBfalse\fR.
 126 .RE
 127 
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBencrypt\fR\fR
 132 .ad
 133 .sp .6
 134 .RS 4n
 135 Controls SMB3 Encryption. For requests on a particular share, the server's
 136 behavior is controlled by the stricter of this option and the per-share
 137 "encrypt" option.
 138 .sp
 139 When set to \fBdisabled\fR, the server will not ask clients to encrypt requests.
 140 When set to \fBenabled\fR, the server will ask clients to encrypt requests,
 141 but will not require that they do so. Any message that can be encrypted
 142 will be encrypted.
 143 When set to \fBrequired\fR, the server will deny access to or disconnect
 144 any client that does not support encryption or fails to encrypt requests
 145 that they should.
 146 .sp
 147 In other words, the \fBenabled\fR behavior is that any message that CAN
 148 be encrypted SHOULD be encrypted, while the \fBrequired\fR behavior is that any
 149 message that CAN be encrypted MUST be encrypted.
 150 .RE
 151 
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBipv6_enable\fR\fR
 156 .ad
 157 .sp .6
 158 .RS 4n
 159 Enables IPv6 Internet protocol support within the CIFS Service. Valid values
 160 are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
 161 .RE
 162 
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBkeep_alive\fR\fR
 167 .ad
 168 .sp .6
 169 .RS 4n
 170 Specifies the number of seconds before an idle SMB connection is dropped by the
 171 Solaris CIFS server. If set to 0, idle connections are not dropped. Valid
 172 values are 0 and from 20 seconds and above. The default value is 0.
 173 .RE
 174 
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBlmauth_level\fR\fR
 179 .ad
 180 .sp .6
 181 .RS 4n
 182 Specifies the LAN Manager (LM) authentication level. The LM compatibility level
 183 controls the type of user authentication to use in workgroup mode or domain
 184 mode. The default value is 4.
 185 .sp
 186 The following describes the behavior at each level.
 187 .sp
 188 .ne 2
 189 .na
 190 \fB2\fR
 191 .ad
 192 .RS 13n
 193 In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and
 194 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
 195 sends NTLM requests.
 196 .RE
 197 
 198 .sp
 199 .ne 2
 200 .na
 201 \fB3\fR
 202 .ad
 203 .RS 13n
 204 In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and

 351 The UID of the Unix user.
 352 .RE
 353 
 354 .RE
 355 
 356 .sp
 357 .ne 2
 358 .na
 359 \fB\fBmax_protocol\fR\fR
 360 .ad
 361 .sp .6
 362 .RS 4n
 363 Specifies the maximum SMB protocol level that the SMB service
 364 should allow clients to negotiate.  The default value is \fB2.1\fR.
 365 Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR
 366 .RE
 367 
 368 .sp
 369 .ne 2
 370 .na
 371 \fB\fBmin_protocol\fR\fR
 372 .ad
 373 .sp .6
 374 .RS 4n
 375 Specifies the minimum SMB protocol level that the SMB service
 376 should allow clients to negotiate.  The default value is \fB1\fR.
 377 Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR
 378 .RE
 379 
 380 .sp
 381 .ne 2
 382 .na
 383 \fB\fBmax_workers\fR\fR
 384 .ad
 385 .sp .6
 386 .RS 4n
 387 Specifies the maximum number of worker threads that will be launched to process
 388 incoming CIFS requests. The SMB \fBmax_mpx\fR value, which indicates to a
 389 client the maximum number of outstanding SMB requests that it may have pending
 390 on the server, is derived from the \fBmax_workers\fR value. To ensure
 391 compatibility with older versions of Windows the lower 8-bits of \fBmax_mpx\fR
 392 must not be zero. If the lower byte of \fBmax_workers\fR is zero, \fB64\fR is
 393 added to the value. Thus the minimum value is \fB64\fR and the default value,
 394 which appears in \fBsharectl\fR(1M) as \fB1024\fR, is \fB1088\fR.
 395 .RE
 396 
 397 .sp
 398 .ne 2
 399 .na
 400 \fB\fBnetbios_enable\fR\fR
 401 .ad
 402 .sp .6
 403 .RS 4n
 404 Controls whether NetBIOS services are active, including the NetBIOS
 405 listener (port 139), NetBIOS datagram service (port 138) and the
 406 NetBIOS name service (port 137).  The default value is \fBfalse\fR.
 407 .RE
 408 
 409 .sp
 410 .ne 2
 411 .na
 412 \fB\fBnetbios_scope\fR\fR
 413 .ad
 414 .sp .6
 415 .RS 4n
 416 Specifies the NetBIOS scope identifier, which identifies logical NetBIOS
 417 networks that are on the same physical network. When you specify a NetBIOS
 418 scope identifier, the server filters the number of machines that are listed in
 419 the browser display to make it easier to find other hosts. The value is a text
 420 string that represents a domain name. By default, no value is set.
 421 .RE
 422 
 423 .sp
 424 .ne 2
 425 .na
 426 \fB\fBoplock_enable\fR\fR
 427 .ad
 428 .sp .6
 429 .RS 4n
 430 Controls whether "oplocks" may be granted by the SMB server.
 431 The term "oplock" is short for "opportunistic lock", which is
 432 the legacy name for cache delegations in SMB.
 433 By default, oplocks are enabled.
 434 Note that if oplocks are disabled, file I/O perfrormance may be
 435 severely reduced.
 436 .RE
 437 
 438 .sp
 439 .ne 2
 440 .na
 441 \fB\fBpdc\fR\fR
 442 .ad
 443 .sp .6
 444 .RS 4n
 445 Specifies the host name of the preferred domain controller. This property is
 446 sometimes used when there are multiple domain controllers to indicate which one
 447 is preferred. If the specified domain controller responds, it is chosen even if
 448 the other domain controllers are also available. By default, no value is set.
 449 .RE
 450 
 451 .sp
 452 .ne 2
 453 .na
 454 \fB\fBprint_enable\fR\fR
 455 .ad
 456 .sp .6
 457 .RS 4n
 458 Controls whether the SMB printing service is active.
 459 The default value is \fBfalse\fR.
 460 .RE
 461 
 462 .sp
 463 .ne 2
 464 .na
 465 \fB\fBrestrict_anonymous\fR\fR
 466 .ad
 467 .sp .6
 468 .RS 4n
 469 Disables anonymous access to IPC$, which requires that the client be
 470 authenticated to get access to MSRPC services through IPC$. A value of
 471 \fBtrue\fR disables anonymous access to IPC$, while a value of \fBfalse\fR
 472 enables anonymous access.
 473 .RE
 474 
 475 .sp
 476 .ne 2
 477 .na
 478 \fB\fBsigning_enabled\fR\fR
 479 .ad
 480 .sp .6
 481 .RS 4n
 482 Enables SMB signing. When signing is enabled but not required it is possible
 483 for clients to connect regardless of whether or not the client supports SMB
 484 signing. If a packet has been signed, the signature will be verified. If a
 485 packet has not been signed it will be accepted without signature verification.
 486 Valid values are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
 487 .RE
 488 
 489 .sp
 490 .ne 2
 491 .na
 492 \fB\fBsigning_required\fR\fR
 493 .ad
 494 .sp .6
 495 .RS 4n
 496 When SMB signing is required, all packets must be signed or they will be
 497 rejected, and clients that do not support signing will be unable to connect to
 498 the server. The \fBsigning_required\fR setting is only taken into account when
 499 \fBsigning_enabled\fR is \fBtrue\fR. Valid values are \fBtrue\fR and
 500 \fBfalse\fR. The default value is \fBfalse\fR.
 501 .RE
 502 
 503 .\" There is also: smb2_enable, but the next commit removes it.
 504 
 505 .sp
 506 .ne 2
 507 .na
 508 \fB\fBsystem_comment\fR\fR
 509 .ad
 510 .sp .6
 511 .RS 4n
 512 Specifies an optional description for the system, which is a text string. This
 513 property value might appear in various places, such as Network Neighborhood or
 514 Network Places on Windows clients. By default, no value is set.
 515 .RE
 516 
 517 .sp
 518 .ne 2
 519 .na
 520 \fB\fBtraverse_mounts\fR\fR
 521 .ad
 522 .sp .6
 523 .RS 4n
 524 The \fBtraverse_mounts\fR setting determines how the SMB server