usr/src/man/man1m/smbadm.1m

   1 '\" te
   2 .\" Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
   3 .\" Copyright (c) 2009, Sun Microsystems, 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.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH SMBADM 1M "Jan 8, 2009"
   8 .SH NAME
   9 smbadm \- configure and manage CIFS local groups and users, and manage domain
  10 membership
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBsmbadm add-member\fR -m \fImember\fR [[-m \fImember\fR] \&.\|.\|.] \fIgroup\fR
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBsmbadm create\fR [-d \fIdescription\fR] \fIgroup\fR
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBsmbadm delete\fR \fIgroup\fR
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBsmbadm disable-user\fR \fIusername\fR
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBsmbadm enable-user\fR \fIusername\fR
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBsmbadm get\fR [[-p \fIproperty\fR] \&.\|.\|.] \fIgroup\fR
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBsmbadm join\fR -u \fIusername\fR \fIdomain\fR
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBsmbadm join\fR -w \fIworkgroup\fR
  50 .fi
  51
  52 .LP
  53 .nf
  54 \fBsmbadm list\fR
  55 .fi
  56
  57 .LP
  58 .nf
  59 \fBsmbadm lookup\fR \fIaccount-name\fR [\fIaccount-name\fR [\&.\|.\|.]]
  60 .fi
  61
  62 .LP
  63 .nf
  64 \fBsmbadm remove-member\fR -m \fImember\fR [[-m \fImember\fR] \&.\|.\|.] \fIgroup\fR
  65 .fi
  66
  67 .LP
  68 .nf
  69 \fBsmbadm rename\fR \fIgroup\fR \fInew-group\fR
  70 .fi
  71
  72 .LP
  73 .nf
  74 \fBsmbadm set\fR -p \fIproperty\fR=\fIvalue\fR [[-p \fIproperty\fR=\fIvalue\fR] \&.\|.\|.] \fIgroup\fR
  75 .fi
  76
  77 .LP
  78 .nf
  79 \fBsmbadm show\fR [-m] [-p] [\fIgroup\fR]
  80 .fi
  81
  82 .SH DESCRIPTION
  83 .sp
  84 .LP
  85 The \fBsmbadm\fR command is used to configure \fBCIFS\fR local groups and to
  86 manage domain membership. You can also use the \fBsmbadm\fR command to enable
  87 or disable SMB password generation for individual local users.
  88 .sp
  89 .LP
  90 \fBCIFS\fR local groups can be used when Windows accounts must be members of
  91 some local groups and when Windows style privileges must be granted. Solaris
  92 local groups cannot provide these functions.
  93 .sp
  94 .LP
  95 There are two types of local groups: user defined and built-in. Built-in local
  96 groups are predefined local groups to support common administration tasks.
  97 .sp
  98 .LP
  99 In order to provide proper identity mapping between \fBCIFS\fR local groups and
 100 Solaris groups, a \fBCIFS\fR local group must have a corresponding Solaris
 101 group. This requirement has two consequences: first, the group name must
 102 conform to the intersection of the Windows and Solaris group name rules. Thus,
 103 a \fBCIFS\fR local group name can be up to eight (8) characters long and
 104 contain only lowercase characters and numbers. Second, a Solaris local group
 105 has to be created before a \fBCIFS\fR local group can be created.
 106 .sp
 107 .LP
 108 Built-in groups are standard Windows groups and are predefined by the
 109 \fBCIFS\fR service. The built-in groups cannot be added, removed, or renamed,
 110 and these groups do not follow the \fBCIFS\fR local group naming conventions.
 111 .sp
 112 .LP
 113 When the \fBCIFS\fR server is started, the following built-in groups are
 114 available:
 115 .sp
 116 .ne 2
 117 .na
 118 \fBAdministrators\fR
 119 .ad
 120 .sp .6
 121 .RS 4n
 122 Group members can administer the system.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fBBackup Operators\fR
 129 .ad
 130 .sp .6
 131 .RS 4n
 132 Group members can bypass file access controls to back up and restore files.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fBPower Users\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 Group members can share directories.
 143 .RE
 144
 145 .sp
 146 .LP
 147 Solaris local users must have an SMB password for authentication and to gain
 148 access to CIFS resources. This password is created by using the \fBpasswd\fR(1)
 149 command when the \fBpam_smb_password\fR module is added to the system's PAM
 150 configuration. See the \fBpam_smb_passwd\fR(5) man page.
 151 .sp
 152 .LP
 153 The \fBdisable-user\fR and \fBenable-user\fR subcommands control SMB
 154 password-generation for a specified local user. When disabled, the user is
 155 prevented from connecting to the Solaris CIFS service. By default, SMB
 156 password-generation is enabled for all local users.
 157 .sp
 158 .LP
 159 To reenable a disabled user, you must use the \fBenable-user\fR subcommand and
 160 then reset the user's password by using the \fBpasswd\fR command. The
 161 \fBpam_smb_passwd.so.1\fR module must be added to the system's PAM
 162 configuration to generate an SMB password.
 163 .SS "Escaping Backslash Character"
 164 .sp
 165 .LP
 166 For the \fBadd-member\fR, \fBremove-member\fR, and \fBjoin\fR (with \fB-u\fR)
 167 subcommands, the backslash character (\fB\e\fR) is a valid separator between
 168 member or user names and domain names. The backslash character is a shell
 169 special character and must be quoted. For example, you might escape the
 170 backslash character with another backslash character:
 171 \fIdomain\fR\fB\e\e\fR\fIusername\fR. For more information about handling shell
 172 special characters, see the man page for your shell.
 173 .SH OPERANDS
 174 .sp
 175 .LP
 176 The \fBsmbadm\fR command uses the following operands:
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fIdomain\fR\fR
 181 .ad
 182 .sp .6
 183 .RS 4n
 184 Specifies the name of an existing Windows domain to join.
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fIgroup\fR\fR
 191 .ad
 192 .sp .6
 193 .RS 4n
 194 Specifies the name of the \fBCIFS\fR local group.
 195 .RE
 196
 197 .sp
 198 .ne 2
 199 .na
 200 \fB\fIusername\fR\fR
 201 .ad
 202 .sp .6
 203 .RS 4n
 204 Specifies the name of a Solaris local user.
 205 .RE
 206
 207 .SH SUB-COMMANDS
 208 .sp
 209 .LP
 210 The \fBsmbadm\fR command includes these subcommands:
 211 .sp
 212 .ne 2
 213 .na
 214 \fB\fBadd-member\fR -m \fImember\fR [[-m \fImember\fR] \&.\|.\|.]
 215 \fIgroup\fR\fR
 216 .ad
 217 .sp .6
 218 .RS 4n
 219 Adds the specified member to the specified \fBCIFS\fR local group. The \fB-m\fR
 220 \fImember\fR option specifies the name of a \fBCIFS\fR local group member. The
 221 member name must include an existing user name and an optional domain name.
 222 .sp
 223 Specify the member name in either of the following formats:
 224 .sp
 225 .in +2
 226 .nf
 227 [\fIdomain\fR\e]\fIusername\fR
 228 [\fIdomain\fR/]\fIusername\fR
 229 .fi
 230 .in -2
 231 .sp
 232
 233 For example, a valid member name might be \fBsales\eterry\fR or
 234 \fBsales/terry\fR, where \fBsales\fR is the Windows domain name and \fBterry\fR
 235 is the name of a user in the \fBsales\fR domain.
 236 .RE
 237
 238 .sp
 239 .ne 2
 240 .na
 241 \fB\fBcreate\fR [\fB-d\fR \fIdescription\fR] \fIgroup\fR\fR
 242 .ad
 243 .sp .6
 244 .RS 4n
 245 Creates a \fBCIFS\fR local group with the specified name. You can optionally
 246 specify a description of the group by using the \fB-d\fR option.
 247 .RE
 248
 249 .sp
 250 .ne 2
 251 .na
 252 \fB\fBdelete\fR \fIgroup\fR\fR
 253 .ad
 254 .sp .6
 255 .RS 4n
 256 Deletes the specified \fBCIFS\fR local group. The built-in groups cannot be
 257 deleted.
 258 .RE
 259
 260 .sp
 261 .ne 2
 262 .na
 263 \fB\fBdisable\fR \fIusername\fR\fR
 264 .ad
 265 .sp .6
 266 .RS 4n
 267 Disables SMB password-generation capabilities for the specified local user. A
 268 disabled local user is prevented from accessing the system by means of the CIFS
 269 service. When a local user account is disabled, you cannot use the \fBpasswd\fR
 270 command to modify the user's SMB password until the user account is reenabled.
 271 .RE
 272
 273 .sp
 274 .ne 2
 275 .na
 276 \fB\fBenable\fR \fIusername\fR\fR
 277 .ad
 278 .sp .6
 279 .RS 4n
 280 Enables SMB password-generation capabilities for the specified local user.
 281 After the password-generation capabilities are reenabled, you must use the
 282 \fBpasswd\fR command to generate the SMB password for the local user before he
 283 can connect to the CIFS service.
 284 .sp
 285 The \fBpasswd\fR command manages both the Solaris password and SMB password for
 286 this user if the \fBpam_smb_passwd\fR module has been added to the system's PAM
 287 configuration.
 288 .RE
 289
 290 .sp
 291 .ne 2
 292 .na
 293 \fB\fBget\fR [[\fB-p\fR \fIproperty\fR=\fIvalue\fR] \&.\|.\|.] \fIgroup\fR\fR
 294 .ad
 295 .sp .6
 296 .RS 4n
 297 Retrieves property values for the specified group. If no property is specified,
 298 all property values are shown.
 299 .RE
 300
 301 .sp
 302 .ne 2
 303 .na
 304 \fB\fBjoin\fR \fB-u\fR \fIusername\fR \fIdomain\fR\fR
 305 .ad
 306 .sp .6
 307 .RS 4n
 308 Joins a Windows domain or a workgroup.
 309 .sp
 310 The default mode for the \fBCIFS\fR service is workgroup mode, which uses the
 311 default workgroup name, \fBWORKGROUP\fR.
 312 .sp
 313 An authenticated user account is required to join a domain, so you must specify
 314 the Windows administrative user name with the \fB-u\fR option. If the password
 315 is not specified on the command line, the user is prompted for it. This user
 316 should be the domain administrator or any user who has administrative
 317 privileges for the target domain.
 318 .sp
 319 \fIusername\fR and \fIdomain\fR can be entered in any of the following formats:
 320 .sp
 321 .in +2
 322 .nf
 323 \fIusername\fR[+\fIpassword\fR] \fIdomain\fR
 324 \fIdomain\fR\e\fIusername\fR[+\fIpassword\fR]
 325 \fIdomain\fR/\fIusername\fR[+\fIpassword\fR]
 326 \fIusername\fR@\fIdomain\fR
 327 .fi
 328 .in -2
 329 .sp
 330
 331 \&...where \fIdomain\fR can be the NetBIOS or DNS domain name.
 332 .sp
 333 If a machine trust account for the system already exists on a domain
 334 controller, any authenticated user account can be used when joining the domain.
 335 However, if the machine trust account does \fBnot\fR already exist, an account
 336 that has administrative privileges on the domain is required to join the
 337 domain.
 338 .RE
 339
 340 .sp
 341 .ne 2
 342 .na
 343 \fB\fBjoin\fR \fB-w\fR \fIworkgroup\fR\fR
 344 .ad
 345 .sp .6
 346 .RS 4n
 347 Joins a Windows domain or a workgroup.
 348 .sp
 349 The \fB-w\fR \fIworkgroup\fR option specifies the name of the workgroup to join
 350 when using the \fBjoin\fR subcommand.
 351 .RE
 352
 353 .sp
 354 .ne 2
 355 .na
 356 \fB\fBlist\fR\fR
 357 .ad
 358 .sp .6
 359 .RS 4n
 360 Shows information about the current workgroup or domain. The information
 361 typically includes the workgroup name or the primary domain name. When in
 362 domain mode, the information includes domain controller names and trusted
 363 domain names.
 364 .sp
 365 Each entry in the ouput is identified by one of the following tags:
 366 .sp
 367 .ne 2
 368 .na
 369 \fB\fB- [*] -\fR\fR
 370 .ad
 371 .RS 11n
 372 Primary domain
 373 .RE
 374
 375 .sp
 376 .ne 2
 377 .na
 378 \fB\fB- [.] -\fR\fR
 379 .ad
 380 .RS 11n
 381 Local domain
 382 .RE
 383
 384 .sp
 385 .ne 2
 386 .na
 387 \fB\fB- [-] -\fR\fR
 388 .ad
 389 .RS 11n
 390 Other domains
 391 .RE
 392
 393 .sp
 394 .ne 2
 395 .na
 396 \fB\fB- [+] -\fR\fR
 397 .ad
 398 .RS 11n
 399 Selected domain controller
 400 .RE
 401
 402 .RE
 403
 404 .sp
 405 .ne 2
 406 .na
 407 \fB\fBlookup\fR\fR \fIaccount-name\fR [\fIaccount-name\fR [\&.\|.\|.]]
 408
 409 .ad
 410 .sp .6
 411 .RS 4n
 412 Lookup the SID for the given \fIaccount-name\fR, or lookup the
 413 \fIaccount-name\fR for the given SID.  This sub-command is
 414 primarily for diagnostic use, to confirm whether the server
 415 can lookup domain accounts and/or SIDs.
 416 .RE
 417
 418 .sp
 419 .ne 2
 420 .na
 421 \fB\fBremove-member\fR -m \fImember\fR [[-m \fImember\fR] \&.\|.\|.]
 422 \fIgroup\fR\fR
 423 .ad
 424 .sp .6
 425 .RS 4n
 426 Removes the specified member from the specified \fBCIFS\fR local group. The
 427 \fB-m\fR \fImember\fR option specifies the name of a \fBCIFS\fR local group
 428 member. The member name must include an existing user name and an optional
 429 domain name.
 430 .sp
 431 Specify the member name in either of the following formats:
 432 .sp
 433 .in +2
 434 .nf
 435 [\fIdomain\fR\e]\fIusername\fR
 436 [\fIdomain\fR/]\fIusername\fR
 437 .fi
 438 .in -2
 439 .sp
 440
 441 For example, a valid member name might be \fBsales\eterry\fR or
 442 \fBsales/terry\fR, where \fBsales\fR is the Windows domain name and \fBterry\fR
 443 is the name of a user in the \fBsales\fR domain.
 444 .RE
 445
 446 .sp
 447 .ne 2
 448 .na
 449 \fB\fBrename\fR \fIgroup\fR \fInew-group\fR\fR
 450 .ad
 451 .sp .6
 452 .RS 4n
 453 Renames the specified \fBCIFS\fR local group. The group must already exist. The
 454 built-in groups cannot be renamed.
 455 .RE
 456
 457 .sp
 458 .ne 2
 459 .na
 460 \fB\fBset\fR \fB-p\fR \fIproperty\fR=\fIvalue\fR [[\fB-p\fR
 461 \fIproperty\fR=\fIvalue\fR] \&.\|.\|.] \fIgroup\fR\fR
 462 .ad
 463 .sp .6
 464 .RS 4n
 465 Sets configuration properties for a \fBCIFS\fR local group. The description and
 466 the privileges for the built-in groups cannot be changed.
 467 .sp
 468 The \fB-p\fR \fIproperty\fR\fB=\fR\fIvalue\fR option specifies the list of
 469 properties to be set on the specified group.
 470 .sp
 471 The group-related properties are as follows:
 472 .sp
 473 .ne 2
 474 .na
 475 \fB\fBbackup=[on|off]\fR\fR
 476 .ad
 477 .sp .6
 478 .RS 4n
 479 Specifies whether members of the \fBCIFS\fR local group can bypass file access
 480 controls to back up file system objects.
 481 .RE
 482
 483 .sp
 484 .ne 2
 485 .na
 486 \fB\fBdescription=\fR\fIdescription-text\fR\fR
 487 .ad
 488 .sp .6
 489 .RS 4n
 490 Specifies a text description for the \fBCIFS\fR local group.
 491 .RE
 492
 493 .sp
 494 .ne 2
 495 .na
 496 \fB\fBrestore=[on|off]\fR\fR
 497 .ad
 498 .sp .6
 499 .RS 4n
 500 Specifies whether members of the \fBCIFS\fR local group can bypass file access
 501 controls to restore file system objects.
 502 .RE
 503
 504 .sp
 505 .ne 2
 506 .na
 507 \fB\fBtake-ownership=[on|off]\fR\fR
 508 .ad
 509 .sp .6
 510 .RS 4n
 511 Specifies whether members of the \fBCIFS\fR local group can take ownership of
 512 file system objects.
 513 .RE
 514
 515 .RE
 516
 517 .sp
 518 .ne 2
 519 .na
 520 \fB\fBshow\fR [\fB-m\fR] [\fB-p\fR] [\fIgroup\fR]\fR
 521 .ad
 522 .sp .6
 523 .RS 4n
 524 Shows information about the specified \fBCIFS\fR local group or groups. If no
 525 group is specified, information is shown for all groups. If the \fB-m\fR option
 526 is specified, the group members are also shown. If the \fB-p\fR option is
 527 specified, the group privileges are also shown.
 528 .RE
 529
 530 .SH EXIT STATUS
 531 .sp
 532 .LP
 533 The following exit values are returned:
 534 .sp
 535 .ne 2
 536 .na
 537 \fB0\fR
 538 .ad
 539 .RS 13n
 540 Successful completion.
 541 .RE
 542
 543 .sp
 544 .ne 2
 545 .na
 546 \fB>0\fR
 547 .ad
 548 .RS 13n
 549 An error occurred.
 550 .RE
 551
 552 .SH ATTRIBUTES
 553 .sp
 554 .LP
 555 See the \fBattributes\fR(5) man page for descriptions of the following
 556 attributes:
 557 .sp
 558
 559 .sp
 560 .TS
 561 box;
 562 c | c
 563 l | l .
 564 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 565 _
 566 Utility Name and Options        Uncommitted
 567 _
 568 Utility Output Format   Not-An-Interface
 569 _
 570 \fBsmbadm join\fR       Obsolete
 571 .TE
 572
 573 .SH SEE ALSO
 574 .sp
 575 .LP
 576 \fBpasswd\fR(1), \fBgroupadd\fR(1M), \fBidmap\fR(1M), \fBidmapd\fR(1M),
 577 \fBkclient\fR(1M), \fBshare\fR(1M), \fBsharectl\fR(1M), \fBsharemgr\fR(1M),
 578 \fBsmbd\fR(1M), \fBsmbstat\fR(1M), \fBsmb\fR(4), \fBsmbautohome\fR(4),
 579 \fBattributes\fR(5), \fBpam_smb_passwd\fR(5), \fBsmf\fR(5)