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
  28 Specifies the site configured in DNS to look up Active Directory information.
  29 Sites provide a mechanism to partition or delegate administration and policy
  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
  70 .sp .6
  71 .RS 4n
  72 Proceed with share connection if the map command fails. This is the default in
  73 the event that disposition is not specified.
  74 .RE
  75 
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBterminate\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  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
 153 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
 154 sends LMv2 and NTLMv2 requests.
 155 .RE
 156 
 157 .sp
 158 .ne 2
 159 .na
 160 \fB4\fR
 161 .ad
 162 .RS 13n
 163 In Windows workgroup mode, the Solaris CIFS server accepts NTLM, LMv2, and
 164 NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server
 165 sends LMv2 and NTLMv2 requests.
 166 .RE
 167 
 168 .sp
 169 .ne 2
 170 .na
 171 \fB5\fR
 172 .ad
 173 .RS 13n
 174 In Windows workgroup mode, the Solaris CIFS server accepts LMv2 and NTLMv2
 175 requests. In domain mode, the SMB redirector on the Solaris CIFS server sends
 176 LMv2 and NTLMv2 requests.
 177 .RE
 178 
 179 .RE
 180 
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fBmap\fR\fR
 185 .ad
 186 .sp .6
 187 .RS 4n
 188 The value is a command to be executed when connecting to the share. The command
 189 can take the following arguments, which will be substituted when the command is
 190 exec'd as described below:
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fB%U\fR\fR
 195 .ad
 196 .sp .6
 197 .RS 4n
 198 Windows username.
 199 .RE
 200 
 201 .sp
 202 .ne 2
 203 .na
 204 \fB\fB%D\fR\fR
 205 .ad
 206 .sp .6
 207 .RS 4n
 208 Name of the domain or workgroup of \fB%U\fR.
 209 .RE
 210 
 211 .sp
 212 .ne 2
 213 .na
 214 \fB\fB%h\fR\fR
 215 .ad
 216 .sp .6
 217 .RS 4n
 218 The server hostname.
 219 .RE
 220 
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fB%M\fR\fR
 225 .ad
 226 .sp .6
 227 .RS 4n
 228 The client hostname, or \fB""\fR if not available.
 229 .RE
 230 
 231 .sp
 232 .ne 2
 233 .na
 234 \fB\fB%L\fR\fR
 235 .ad
 236 .sp .6
 237 .RS 4n
 238 The server NetBIOS name.
 239 .RE
 240 
 241 .sp
 242 .ne 2
 243 .na
 244 \fB\fB%m\fR\fR
 245 .ad
 246 .sp .6
 247 .RS 4n
 248 The client NetBIOS name, or \fB""\fR if not available. This option is only
 249 valid for NetBIOS connections (port 139).
 250 .RE
 251 
 252 .sp
 253 .ne 2
 254 .na
 255 \fB\fB%I\fR\fR
 256 .ad
 257 .sp .6
 258 .RS 4n
 259 The IP address of the client machine.
 260 .RE
 261 
 262 .sp
 263 .ne 2
 264 .na
 265 \fB\fB%i\fR\fR
 266 .ad
 267 .sp .6
 268 .RS 4n
 269 The local IP address to which the client is connected.
 270 .RE
 271 
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fB%S\fR\fR
 276 .ad
 277 .sp .6
 278 .RS 4n
 279 The name of the share.
 280 .RE
 281 
 282 .sp
 283 .ne 2
 284 .na
 285 \fB\fB%P\fR\fR
 286 .ad
 287 .sp .6
 288 .RS 4n
 289 The root directory of the share.
 290 .RE
 291 
 292 .sp
 293 .ne 2
 294 .na
 295 \fB\fB%u\fR\fR
 296 .ad
 297 .sp .6
 298 .RS 4n
 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
 421 presents sub-mounts underneath an SMB share.  When \fBtraverse_mounts\fR
 422 is \fBtrue\fR (the default), sub-mounts are presented to SMB clients
 423 like any other subdirectory.   When \fBtraverse_mounts\fR is \fBfalse\fR,
 424 sub-mounts are not shown to SMB clients.
 425 .RE
 426 
 427 .sp
 428 .ne 2
 429 .na
 430 \fB\fBunmap\fR\fR
 431 .ad
 432 .sp .6
 433 .RS 4n
 434 The value is a command to be executed when disconnecting the share. The command
 435 can take the same substitutions listed on the \fBmap\fR property.
 436 .RE
 437 
 438 .sp
 439 .ne 2
 440 .na
 441 \fB\fBwins_exclude\fR\fR
 442 .ad
 443 .sp .6
 444 .RS 4n
 445 Specifies a comma-separated list of network interfaces that should not be
 446 registered with WINS. NetBIOS host announcements are made on excluded
 447 interfaces.
 448 .RE
 449 
 450 .sp
 451 .ne 2
 452 .na
 453 \fB\fBwins_server_1\fR\fR
 454 .ad
 455 .sp .6
 456 .RS 4n
 457 Specifies the IP address of the primary WINS server. By default, no value is
 458 set.
 459 .RE
 460 
 461 .sp
 462 .ne 2
 463 .na
 464 \fB\fBwins_server_2\fR\fR
 465 .ad
 466 .sp .6
 467 .RS 4n
 468 Specifies the IP address of the secondary WINS server. By default, no value is
 469 set.
 470 .RE
 471 
 472 .SH ATTRIBUTES
 473 .LP
 474 See the \fBattributes\fR(5) man page for descriptions of the following
 475 attributes:
 476 .sp
 477 
 478 .sp
 479 .TS
 480 box;
 481 c | c
 482 l | l .
 483 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 484 _
 485 Interface Stability     Uncommitted
 486 .TE
 487 
 488 .SH SEE ALSO
 489 .LP
 490 \fBsharectl\fR(1M), \fBsmbadm\fR(1M), \fBsmbd\fR(1M), \fBsmbstat\fR(1M),
 491 \fBattributes\fR(5), \fBsmf\fR(5)