Print this page
NEX-15581 SMB keep-alive feature is just noise
Reviewed by: Matt Barden <matt.barden@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
NEX-5665 SMB2 oplock leases
Reviewed by: Matt Barden <matt.barden@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
NEX-15581 SMB keep-alive feature is just noise
Reviewed by: Matt Barden <matt.barden@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
NEX-5665 SMB2 oplock leases
Reviewed by: Matt Barden <matt.barden@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
NEX-9497 SMB should bypass ACL traverse checking
Reviewed by: Evan Layton <evan.layton@nexenta.com>
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
NEX-10019 SMB server min_protocol setting
Reviewed by: Gordon Ross <gordon.ross@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
NEX-5273 SMB 3 Encryption
Reviewed by: Gordon Ross <gordon.ross@nexenta.com>
Reviewed by: Evan Layton <evan.layton@nexenta.com>
Reviewed by: Roman Strashkin <roman.strashkin@nexenta.com>
NEX-3549 smb(4) man page is out of date.
Reviewed by: Yuri Pankov <Yuri.Pankov@nexenta.com>
NEX-3611 CLONE NEX-3550 Replace smb2_enable with max_protocol
Reviewed by: Yuri Pankov <Yuri.Pankov@nexenta.com>

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      -.\" 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"
        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"
   8   20  .SH NAME
   9   21  smb \- configuration properties for Solaris CIFS server
  10   22  .SH DESCRIPTION
  11   23  .LP
  12   24  Behavior of the Solaris CIFS server is defined by property values that are
  13   25  stored in the Service Management Facility, \fBsmf\fR(5).
  14   26  .sp
  15   27  .LP
  16   28  An authorized user can use the \fBsharectl\fR(1M) command to set global values
  17   29  for these properties in SMF.
↓ open down ↓ 22 lines elided ↑ open up ↑
  40   52  .ad
  41   53  .sp .6
  42   54  .RS 4n
  43   55  Specifies the full path for the SMD autohome map file, \fBsmbautohome\fR. The
  44   56  default path is \fB/etc\fR.
  45   57  .RE
  46   58  
  47   59  .sp
  48   60  .ne 2
  49   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
  50   78  \fB\fBdisposition\fR\fR
  51   79  .ad
  52   80  .sp .6
  53   81  .RS 4n
  54   82  A value that controls whether to disconnect the share or proceed if the map
  55   83  command fails. The disposition property only has meaning when the map property
  56   84  has been set. Otherwise it will have no effect.
  57   85  .sp
  58   86  .in +2
  59   87  .nf
↓ open down ↓ 33 lines elided ↑ open up ↑
  93  121  .sp .6
  94  122  .RS 4n
  95  123  Enables or disables dynamic DNS updates. A value of \fBtrue\fR enables dynamic
  96  124  updates, while a value of \fBfalse\fR disables dynamic updates. By default, the
  97  125  value is \fBfalse\fR.
  98  126  .RE
  99  127  
 100  128  .sp
 101  129  .ne 2
 102  130  .na
 103      -\fB\fBipv6_enabled\fR\fR
      131 +\fB\fBencrypt\fR\fR
 104  132  .ad
 105  133  .sp .6
 106  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
 107  159  Enables IPv6 Internet protocol support within the CIFS Service. Valid values
 108  160  are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR.
 109  161  .RE
 110  162  
 111  163  .sp
 112  164  .ne 2
 113  165  .na
 114  166  \fB\fBkeep_alive\fR\fR
 115  167  .ad
 116  168  .sp .6
 117  169  .RS 4n
 118  170  Specifies the number of seconds before an idle SMB connection is dropped by the
 119  171  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.
      172 +values are 0 and from 20 seconds and above. The default value is 0.
 121  173  .RE
 122  174  
 123  175  .sp
 124  176  .ne 2
 125  177  .na
 126  178  \fB\fBlmauth_level\fR\fR
 127  179  .ad
 128  180  .sp .6
 129  181  .RS 4n
 130  182  Specifies the LAN Manager (LM) authentication level. The LM compatibility level
 131  183  controls the type of user authentication to use in workgroup mode or domain
 132      -mode. The default value is 3.
      184 +mode. The default value is 4.
 133  185  .sp
 134  186  The following describes the behavior at each level.
 135  187  .sp
 136  188  .ne 2
 137  189  .na
 138  190  \fB2\fR
 139  191  .ad
 140  192  .RS 13n
 141  193  In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and
 142  194  NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
↓ open down ↓ 166 lines elided ↑ open up ↑
 309  361  .sp .6
 310  362  .RS 4n
 311  363  Specifies the maximum SMB protocol level that the SMB service
 312  364  should allow clients to negotiate.  The default value is \fB2.1\fR.
 313  365  Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR
 314  366  .RE
 315  367  
 316  368  .sp
 317  369  .ne 2
 318  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
 319  383  \fB\fBmax_workers\fR\fR
 320  384  .ad
 321  385  .sp .6
 322  386  .RS 4n
 323  387  Specifies the maximum number of worker threads that will be launched to process
 324  388  incoming CIFS requests. The SMB \fBmax_mpx\fR value, which indicates to a
 325  389  client the maximum number of outstanding SMB requests that it may have pending
 326  390  on the server, is derived from the \fBmax_workers\fR value. To ensure
 327  391  compatibility with older versions of Windows the lower 8-bits of \fBmax_mpx\fR
 328  392  must not be zero. If the lower byte of \fBmax_workers\fR is zero, \fB64\fR is
 329  393  added to the value. Thus the minimum value is \fB64\fR and the default value,
 330  394  which appears in \fBsharectl\fR(1M) as \fB1024\fR, is \fB1088\fR.
 331  395  .RE
 332  396  
 333  397  .sp
 334  398  .ne 2
 335  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
 336  412  \fB\fBnetbios_scope\fR\fR
 337  413  .ad
 338  414  .sp .6
 339  415  .RS 4n
 340  416  Specifies the NetBIOS scope identifier, which identifies logical NetBIOS
 341  417  networks that are on the same physical network. When you specify a NetBIOS
 342  418  scope identifier, the server filters the number of machines that are listed in
 343  419  the browser display to make it easier to find other hosts. The value is a text
 344  420  string that represents a domain name. By default, no value is set.
 345  421  .RE
 346  422  
 347  423  .sp
 348  424  .ne 2
 349  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
 350  441  \fB\fBpdc\fR\fR
 351  442  .ad
 352  443  .sp .6
 353  444  .RS 4n
 354      -Specifies the preferred IP address for the domain controller. This property is
      445 +Specifies the host name of the preferred domain controller. This property is
 355  446  sometimes used when there are multiple domain controllers to indicate which one
 356  447  is preferred. If the specified domain controller responds, it is chosen even if
 357  448  the other domain controllers are also available. By default, no value is set.
 358  449  .RE
 359  450  
 360  451  .sp
 361  452  .ne 2
 362  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
 363  465  \fB\fBrestrict_anonymous\fR\fR
 364  466  .ad
 365  467  .sp .6
 366  468  .RS 4n
 367  469  Disables anonymous access to IPC$, which requires that the client be
 368  470  authenticated to get access to MSRPC services through IPC$. A value of
 369  471  \fBtrue\fR disables anonymous access to IPC$, while a value of \fBfalse\fR
 370  472  enables anonymous access.
 371  473  .RE
 372  474  
↓ open down ↓ 18 lines elided ↑ open up ↑
 391  493  .ad
 392  494  .sp .6
 393  495  .RS 4n
 394  496  When SMB signing is required, all packets must be signed or they will be
 395  497  rejected, and clients that do not support signing will be unable to connect to
 396  498  the server. The \fBsigning_required\fR setting is only taken into account when
 397  499  \fBsigning_enabled\fR is \fBtrue\fR. Valid values are \fBtrue\fR and
 398  500  \fBfalse\fR. The default value is \fBfalse\fR.
 399  501  .RE
 400  502  
      503 +.\" There is also: smb2_enable, but the next commit removes it.
      504 +
 401  505  .sp
 402  506  .ne 2
 403  507  .na
 404  508  \fB\fBsystem_comment\fR\fR
 405  509  .ad
 406  510  .sp .6
 407  511  .RS 4n
 408  512  Specifies an optional description for the system, which is a text string. This
 409  513  property value might appear in various places, such as Network Neighborhood or
 410  514  Network Places on Windows clients. By default, no value is set.
↓ open down ↓ 81 lines elided ↑ open up ↑
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX