docs/manpages/net.8

   1 .\"     Title: net
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 04/28/2009
   5 .\"    Manual: System Administration tools
   6 .\"    Source: Samba 3.3
   7 .\"  Language: English
   8 .\"
   9 .TH "NET" "8" "04/28/2009" "Samba 3\&.3" "System Administration tools"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 net \- Tool for administration of Samba and remote CIFS servers\&.
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\ 'u
 174 \FCnet\F[] {<ads|rap|rpc>} [\-h] [\-w\ workgroup] [\-W\ myworkgroup] [\-U\ user] [\-I\ ip\-address] [\-p\ port] [\-n\ myname] [\-s\ conffile] [\-S\ server] [\-l] [\-P] [\-d\ debuglevel] [\-V] [\-\-request\-timeout\ seconds]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 This tool is part of the
 179 \fBsamba\fR(7)
 180 suite\&.
 181 .PP
 182 The Samba net utility is meant to work just like the net utility available for windows and DOS\&. The first argument should be used to specify the protocol to use when executing a certain command\&. ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) clients and RPC can be used for NT4 and Windows 2000\&. If this argument is omitted, net will try to determine it automatically\&. Not all commands are available on all protocols\&.
 183 .SH "OPTIONS"
 184 .PP
 185 \-h|\-\-help
 186 .RS 4
 187 Print a summary of command line options\&.
 188 .RE
 189 .PP
 190 \-w target\-workgroup
 191 .RS 4
 192 Sets target workgroup or domain\&. You have to specify either this option or the IP address or the name of a server\&.
 193 .RE
 194 .PP
 195 \-W workgroup
 196 .RS 4
 197 Sets client workgroup or domain
 198 .RE
 199 .PP
 200 \-U user
 201 .RS 4
 202 User name to use
 203 .RE
 204 .PP
 205 \-I ip\-address
 206 .RS 4
 207 IP address of target server to use\&. You have to specify either this option or a target workgroup or a target server\&.
 208 .RE
 209 .PP
 210 \-p port
 211 .RS 4
 212 Port on the target server to connect to (usually 139 or 445)\&. Defaults to trying 445 first, then 139\&.
 213 .RE
 214 .PP
 215 \-n <primary NetBIOS name>
 216 .RS 4
 217 This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the
 218 \m[blue]\fBnetbios name\fR\m[]
 219 parameter in the
 220 \FCsmb\&.conf\F[]
 221 file\&. However, a command line setting will take precedence over settings in
 222 \FCsmb\&.conf\F[]\&.
 223 .RE
 224 .PP
 225 \-s <configuration file>
 226 .RS 4
 227 The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See
 228 \FCsmb\&.conf\F[]
 229 for more information\&. The default configuration file name is determined at compile time\&.
 230 .RE
 231 .PP
 232 \-S server
 233 .RS 4
 234 Name of target server\&. You should specify either this option or a target workgroup or a target IP address\&.
 235 .RE
 236 .PP
 237 \-l
 238 .RS 4
 239 When listing data, give more information on each item\&.
 240 .RE
 241 .PP
 242 \-P
 243 .RS 4
 244 Make queries to the external server using the machine account of the local server\&.
 245 .RE
 246 .PP
 247 \-\-request\-timeout 30
 248 .RS 4
 249 Let client requests timeout after 30 seconds the default is 10 seconds\&.
 250 .RE
 251 .PP
 252 \-d|\-\-debuglevel=level
 253 .RS 4
 254 \fIlevel\fR
 255 is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
 256 .sp
 257 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
 258 .sp
 259 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
 260 .sp
 261 Note that specifying this parameter here will override the
 262 \m[blue]\fBlog level\fR\m[]
 263 parameter in the
 264 \FCsmb\&.conf\F[]
 265 file\&.
 266 .RE
 267 .SH "COMMANDS"
 268 .SS "CHANGESECRETPW"
 269 .PP
 270 This command allows the Samba machine account password to be set from an external application to a machine account password that has already been stored in Active Directory\&. DO NOT USE this command unless you know exactly what you are doing\&. The use of this command requires that the force flag (\-f) be used also\&. There will be NO command prompt\&. Whatever information is piped into stdin, either by typing at the command line or otherwise, will be stored as the literal machine password\&. Do NOT use this without care and attention as it will overwrite a legitimate machine password without warning\&. YOU HAVE BEEN WARNED\&.
 271 .SS "TIME"
 272 .PP
 273 The
 274 \FCNET TIME\F[]
 275 command allows you to view the time on a remote server or synchronise the time on the local server with the time on the remote server\&.
 276 .SS "TIME"
 277 .PP
 278 Without any options, the
 279 \FCNET TIME\F[]
 280 command displays the time on the remote server\&.
 281 .SS "TIME SYSTEM"
 282 .PP
 283 Displays the time on the remote server in a format ready for
 284 \FC/bin/date\F[]\&.
 285 .SS "TIME SET"
 286 .PP
 287 Tries to set the date and time of the local server to that on the remote server using
 288 \FC/bin/date\F[]\&.
 289 .SS "TIME ZONE"
 290 .PP
 291 Displays the timezone in hours from GMT on the remote computer\&.
 292 .SS "[RPC|ADS] JOIN [TYPE] [\-U username[%password]] [createupn=UPN] [createcomputer=OU] [options]"
 293 .PP
 294 Join a domain\&. If the account already exists on the server, and [TYPE] is MEMBER, the machine will attempt to join automatically\&. (Assuming that the machine has been created in server manager) Otherwise, a password will be prompted for, and a new account may be created\&.
 295 .PP
 296 [TYPE] may be PDC, BDC or MEMBER to specify the type of server joining the domain\&.
 297 .PP
 298 [UPN] (ADS only) set the principalname attribute during the join\&. The default format is host/netbiosname@REALM\&.
 299 .PP
 300 [OU] (ADS only) Precreate the computer account in a specific OU\&. The OU string reads from top to bottom without RDNs, and is delimited by a \'/\'\&. Please note that \'\e\' is used for escape by both the shell and ldap, so it may need to be doubled or quadrupled to pass through, and it is not used as a delimiter\&.
 301 .SS "[RPC] OLDJOIN [options]"
 302 .PP
 303 Join a domain\&. Use the OLDJOIN option to join the domain using the old style of domain joining \- you need to create a trust account in server manager first\&.
 304 .SS "[RPC|ADS] USER"
 305 .SS "[RPC|ADS] USER"
 306 .PP
 307 List all users
 308 .SS "[RPC|ADS] USER DELETE target"
 309 .PP
 310 Delete specified user
 311 .SS "[RPC|ADS] USER INFO target"
 312 .PP
 313 List the domain groups of the specified user\&.
 314 .SS "[RPC|ADS] USER RENAME oldname newname"
 315 .PP
 316 Rename specified user\&.
 317 .SS "[RPC|ADS] USER ADD name [password] [-F user flags] [-C comment]"
 318 .PP
 319 Add specified user\&.
 320 .SS "[RPC|ADS] GROUP"
 321 .SS "[RPC|ADS] GROUP [misc options] [targets]"
 322 .PP
 323 List user groups\&.
 324 .SS "[RPC|ADS] GROUP DELETE name [misc. options]"
 325 .PP
 326 Delete specified group\&.
 327 .SS "[RPC|ADS] GROUP ADD name [-C comment]"
 328 .PP
 329 Create specified group\&.
 330 .SS "[RAP|RPC] SHARE"
 331 .SS "[RAP|RPC] SHARE [misc. options] [targets]"
 332 .PP
 333 Enumerates all exported resources (network shares) on target server\&.
 334 .SS "[RAP|RPC] SHARE ADD name=serverpath [-C comment] [-M maxusers] [targets]"
 335 .PP
 336 Adds a share from a server (makes the export active)\&. Maxusers specifies the number of users that can be connected to the share simultaneously\&.
 337 .SS "SHARE DELETE sharename"
 338 .PP
 339 Delete specified share\&.
 340 .SS "[RPC|RAP] FILE"
 341 .SS "[RPC|RAP] FILE"
 342 .PP
 343 List all open files on remote server\&.
 344 .SS "[RPC|RAP] FILE CLOSE fileid"
 345 .PP
 346 Close file with specified
 347 \fIfileid\fR
 348 on remote server\&.
 349 .SS "[RPC|RAP] FILE INFO fileid"
 350 .PP
 351 Print information on specified
 352 \fIfileid\fR\&. Currently listed are: file\-id, username, locks, path, permissions\&.
 353 .SS "[RAP|RPC] FILE USER user"
 354 .PP
 355 List files opened by specified
 356 \fIuser\fR\&. Please note that
 357 \FCnet rap file user\F[]
 358 does not work against Samba servers\&.
 359 .SS "SESSION"
 360 .SS "RAP SESSION"
 361 .PP
 362 Without any other options, SESSION enumerates all active SMB/CIFS sessions on the target server\&.
 363 .SS "RAP SESSION DELETE|CLOSE CLIENT_NAME"
 364 .PP
 365 Close the specified sessions\&.
 366 .SS "RAP SESSION INFO CLIENT_NAME"
 367 .PP
 368 Give a list with all the open files in specified session\&.
 369 .SS "RAP SERVER \fIDOMAIN\fR"
 370 .PP
 371 List all servers in specified domain or workgroup\&. Defaults to local domain\&.
 372 .SS "RAP DOMAIN"
 373 .PP
 374 Lists all domains and workgroups visible on the current network\&.
 375 .SS "RAP PRINTQ"
 376 .SS "RAP PRINTQ INFO QUEUE_NAME"
 377 .PP
 378 Lists the specified print queue and print jobs on the server\&. If the
 379 \fIQUEUE_NAME\fR
 380 is omitted, all queues are listed\&.
 381 .SS "RAP PRINTQ DELETE JOBID"
 382 .PP
 383 Delete job with specified id\&.
 384 .SS "RAP VALIDATE \fIuser\fR [\fIpassword\fR]"
 385 .PP
 386 Validate whether the specified user can log in to the remote server\&. If the password is not specified on the commandline, it will be prompted\&.
 387 .if n \{\
 388 .sp
 389 .\}
 390 .RS 4
 391 .BM yellow
 392 .it 1 an-trap
 393 .nr an-no-space-flag 1
 394 .nr an-break-flag 1
 395 .br
 396 .ps +1
 397 \fBNote\fR
 398 .ps -1
 399 .br
 400 .PP
 401 Currently NOT implemented\&.
 402 .sp .5v
 403 .EM yellow
 404 .RE
 405 .SS "RAP GROUPMEMBER"
 406 .SS "RAP GROUPMEMBER LIST GROUP"
 407 .PP
 408 List all members of the specified group\&.
 409 .SS "RAP GROUPMEMBER DELETE GROUP USER"
 410 .PP
 411 Delete member from group\&.
 412 .SS "RAP GROUPMEMBER ADD GROUP USER"
 413 .PP
 414 Add member to group\&.
 415 .SS "RAP ADMIN \fIcommand\fR"
 416 .PP
 417 Execute the specified
 418 \fIcommand\fR
 419 on the remote server\&. Only works with OS/2 servers\&.
 420 .if n \{\
 421 .sp
 422 .\}
 423 .RS 4
 424 .BM yellow
 425 .it 1 an-trap
 426 .nr an-no-space-flag 1
 427 .nr an-break-flag 1
 428 .br
 429 .ps +1
 430 \fBNote\fR
 431 .ps -1
 432 .br
 433 .PP
 434 Currently NOT implemented\&.
 435 .sp .5v
 436 .EM yellow
 437 .RE
 438 .SS "RAP SERVICE"
 439 .SS "RAP SERVICE START NAME [arguments...]"
 440 .PP
 441 Start the specified service on the remote server\&. Not implemented yet\&.
 442 .if n \{\
 443 .sp
 444 .\}
 445 .RS 4
 446 .BM yellow
 447 .it 1 an-trap
 448 .nr an-no-space-flag 1
 449 .nr an-break-flag 1
 450 .br
 451 .ps +1
 452 \fBNote\fR
 453 .ps -1
 454 .br
 455 .PP
 456 Currently NOT implemented\&.
 457 .sp .5v
 458 .EM yellow
 459 .RE
 460 .SS "RAP SERVICE STOP"
 461 .PP
 462 Stop the specified service on the remote server\&.
 463 .if n \{\
 464 .sp
 465 .\}
 466 .RS 4
 467 .BM yellow
 468 .it 1 an-trap
 469 .nr an-no-space-flag 1
 470 .nr an-break-flag 1
 471 .br
 472 .ps +1
 473 \fBNote\fR
 474 .ps -1
 475 .br
 476 .PP
 477 Currently NOT implemented\&.
 478 .sp .5v
 479 .EM yellow
 480 .RE
 481 .SS "RAP PASSWORD \fIUSER\fR \fIOLDPASS\fR \fINEWPASS\fR"
 482 .PP
 483 Change password of
 484 \fIUSER\fR
 485 from
 486 \fIOLDPASS\fR
 487 to
 488 \fINEWPASS\fR\&.
 489 .SS "LOOKUP"
 490 .SS "LOOKUP HOST HOSTNAME [TYPE]"
 491 .PP
 492 Lookup the IP address of the given host with the specified type (netbios suffix)\&. The type defaults to 0x20 (workstation)\&.
 493 .SS "LOOKUP LDAP [DOMAIN]"
 494 .PP
 495 Give IP address of LDAP server of specified
 496 \fIDOMAIN\fR\&. Defaults to local domain\&.
 497 .SS "LOOKUP KDC [REALM]"
 498 .PP
 499 Give IP address of KDC for the specified
 500 \fIREALM\fR\&. Defaults to local realm\&.
 501 .SS "LOOKUP DC [DOMAIN]"
 502 .PP
 503 Give IP\'s of Domain Controllers for specified
 504 \fI DOMAIN\fR\&. Defaults to local domain\&.
 505 .SS "LOOKUP MASTER DOMAIN"
 506 .PP
 507 Give IP of master browser for specified
 508 \fIDOMAIN\fR
 509 or workgroup\&. Defaults to local domain\&.
 510 .SS "CACHE"
 511 .PP
 512 Samba uses a general caching interface called \'gencache\'\&. It can be controlled using \'NET CACHE\'\&.
 513 .PP
 514 All the timeout parameters support the suffixes:
 515 .RS 4
 516 s \- Seconds
 517 .RE
 518 .RS 4
 519 m \- Minutes
 520 .RE
 521 .RS 4
 522 h \- Hours
 523 .RE
 524 .RS 4
 525 d \- Days
 526 .RE
 527 .RS 4
 528 w \- Weeks
 529 .RE
 530 .SS "CACHE ADD key data time-out"
 531 .PP
 532 Add specified key+data to the cache with the given timeout\&.
 533 .SS "CACHE DEL key"
 534 .PP
 535 Delete key from the cache\&.
 536 .SS "CACHE SET key data time-out"
 537 .PP
 538 Update data of existing cache entry\&.
 539 .SS "CACHE SEARCH PATTERN"
 540 .PP
 541 Search for the specified pattern in the cache data\&.
 542 .SS "CACHE LIST"
 543 .PP
 544 List all current items in the cache\&.
 545 .SS "CACHE FLUSH"
 546 .PP
 547 Remove all the current items from the cache\&.
 548 .SS "GETLOCALSID [DOMAIN]"
 549 .PP
 550 Prints the SID of the specified domain, or if the parameter is omitted, the SID of the local server\&.
 551 .SS "SETLOCALSID S\-1\-5\-21\-x\-y\-z"
 552 .PP
 553 Sets SID for the local server to the specified SID\&.
 554 .SS "GETDOMAINSID"
 555 .PP
 556 Prints the local machine SID and the SID of the current domain\&.
 557 .SS "SETDOMAINSID"
 558 .PP
 559 Sets the SID of the current domain\&.
 560 .SS "GROUPMAP"
 561 .PP
 562 Manage the mappings between Windows group SIDs and UNIX groups\&. Common options include:
 563 .sp
 564 .RS 4
 565 .ie n \{\
 566 \h'-04'\(bu\h'+03'\c
 567 .\}
 568 .el \{\
 569 .sp -1
 570 .IP \(bu 2.3
 571 .\}
 572 unixgroup \- Name of the UNIX group
 573 .RE
 574 .sp
 575 .RS 4
 576 .ie n \{\
 577 \h'-04'\(bu\h'+03'\c
 578 .\}
 579 .el \{\
 580 .sp -1
 581 .IP \(bu 2.3
 582 .\}
 583 ntgroup \- Name of the Windows NT group (must be resolvable to a SID
 584 .RE
 585 .sp
 586 .RS 4
 587 .ie n \{\
 588 \h'-04'\(bu\h'+03'\c
 589 .\}
 590 .el \{\
 591 .sp -1
 592 .IP \(bu 2.3
 593 .\}
 594 rid \- Unsigned 32\-bit integer
 595 .RE
 596 .sp
 597 .RS 4
 598 .ie n \{\
 599 \h'-04'\(bu\h'+03'\c
 600 .\}
 601 .el \{\
 602 .sp -1
 603 .IP \(bu 2.3
 604 .\}
 605 sid \- Full SID in the form of "S\-1\-\&.\&.\&."
 606 .RE
 607 .sp
 608 .RS 4
 609 .ie n \{\
 610 \h'-04'\(bu\h'+03'\c
 611 .\}
 612 .el \{\
 613 .sp -1
 614 .IP \(bu 2.3
 615 .\}
 616 type \- Type of the group; either \'domain\', \'local\', or \'builtin\'
 617 .RE
 618 .sp
 619 .RS 4
 620 .ie n \{\
 621 \h'-04'\(bu\h'+03'\c
 622 .\}
 623 .el \{\
 624 .sp -1
 625 .IP \(bu 2.3
 626 .\}
 627 comment \- Freeform text description of the group
 628 .sp
 629 .RE
 630 .SS "GROUPMAP ADD"
 631 .PP
 632 Add a new group mapping entry:
 633 .sp
 634 .if n \{\
 635 .RS 4
 636 .\}
 637 .fam C
 638 .ps -1
 639 .nf
 640 .if t \{\
 641 .sp -1
 642 .\}
 643 .BB lightgray adjust-for-leading-newline
 644 .sp -1
 645
 646 net groupmap add {rid=int|sid=string} unixgroup=string \e
 647         [type={domain|local}] [ntgroup=string] [comment=string]
 648 .EB lightgray adjust-for-leading-newline
 649 .if t \{\
 650 .sp 1
 651 .\}
 652 .fi
 653 .fam
 654 .ps +1
 655 .if n \{\
 656 .RE
 657 .\}
 658 .sp
 659
 660 .SS "GROUPMAP DELETE"
 661 .PP
 662 Delete a group mapping entry\&. If more than one group name matches, the first entry found is deleted\&.
 663 .PP
 664 net groupmap delete {ntgroup=string|sid=SID}
 665 .SS "GROUPMAP MODIFY"
 666 .PP
 667 Update en existing group entry\&.
 668 .PP
 669
 670 .sp
 671 .if n \{\
 672 .RS 4
 673 .\}
 674 .fam C
 675 .ps -1
 676 .nf
 677 .if t \{\
 678 .sp -1
 679 .\}
 680 .BB lightgray adjust-for-leading-newline
 681 .sp -1
 682
 683 net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \e
 684        [comment=string] [type={domain|local}]
 685 .EB lightgray adjust-for-leading-newline
 686 .if t \{\
 687 .sp 1
 688 .\}
 689 .fi
 690 .fam
 691 .ps +1
 692 .if n \{\
 693 .RE
 694 .\}
 695 .sp
 696
 697 .SS "GROUPMAP LIST"
 698 .PP
 699 List existing group mapping entries\&.
 700 .PP
 701 net groupmap list [verbose] [ntgroup=string] [sid=SID]
 702 .SS "MAXRID"
 703 .PP
 704 Prints out the highest RID currently in use on the local server (by the active \'passdb backend\')\&.
 705 .SS "RPC INFO"
 706 .PP
 707 Print information about the domain of the remote server, such as domain name, domain sid and number of users and groups\&.
 708 .SS "[RPC|ADS] TESTJOIN"
 709 .PP
 710 Check whether participation in a domain is still valid\&.
 711 .SS "[RPC|ADS] CHANGETRUSTPW"
 712 .PP
 713 Force change of domain trust password\&.
 714 .SS "RPC TRUSTDOM"
 715 .SS "RPC TRUSTDOM ADD DOMAIN"
 716 .PP
 717 Add a interdomain trust account for
 718 \fIDOMAIN\fR\&. This is in fact a Samba account named
 719 \fIDOMAIN$\fR
 720 with the account flag
 721 \fB\'I\'\fR
 722 (interdomain trust account)\&. If the command is used against localhost it has the same effect as
 723 \FCsmbpasswd \-a \-i DOMAIN\F[]\&. Please note that both commands expect a appropriate UNIX account\&.
 724 .SS "RPC TRUSTDOM DEL DOMAIN"
 725 .PP
 726 Remove interdomain trust account for
 727 \fIDOMAIN\fR\&. If it is used against localhost it has the same effect as
 728 \FCsmbpasswd \-x DOMAIN$\F[]\&.
 729 .SS "RPC TRUSTDOM ESTABLISH DOMAIN"
 730 .PP
 731 Establish a trust relationship to a trusting domain\&. Interdomain account must already be created on the remote PDC\&.
 732 .SS "RPC TRUSTDOM REVOKE DOMAIN"
 733 .PP
 734 Abandon relationship to trusted domain
 735 .SS "RPC TRUSTDOM LIST"
 736 .PP
 737 List all current interdomain trust relationships\&.
 738 .SS "RPC RIGHTS"
 739 .PP
 740 This subcommand is used to view and manage Samba\'s rights assignments (also referred to as privileges)\&. There are three options currently available:
 741 \fIlist\fR,
 742 \fIgrant\fR, and
 743 \fIrevoke\fR\&. More details on Samba\'s privilege model and its use can be found in the Samba\-HOWTO\-Collection\&.
 744 .SS "RPC ABORTSHUTDOWN"
 745 .PP
 746 Abort the shutdown of a remote server\&.
 747 .SS "RPC SHUTDOWN [\-t timeout] [\-r] [\-f] [\-C message]"
 748 .PP
 749 Shut down the remote server\&.
 750 .PP
 751 \-r
 752 .RS 4
 753 Reboot after shutdown\&.
 754 .RE
 755 .PP
 756 \-f
 757 .RS 4
 758 Force shutting down all applications\&.
 759 .RE
 760 .PP
 761 \-t timeout
 762 .RS 4
 763 Timeout before system will be shut down\&. An interactive user of the system can use this time to cancel the shutdown\&.
 764 .RE
 765 \'>
 766 .PP
 767 \-C message
 768 .RS 4
 769 Display the specified message on the screen to announce the shutdown\&.
 770 .RE
 771 .SS "RPC SAMDUMP"
 772 .PP
 773 Print out sam database of remote server\&. You need to run this against the PDC, from a Samba machine joined as a BDC\&.
 774 .SS "RPC VAMPIRE"
 775 .PP
 776 Export users, aliases and groups from remote server to local server\&. You need to run this against the PDC, from a Samba machine joined as a BDC\&.
 777 .SS "RPC VAMPIRE KEYTAB"
 778 .PP
 779 Dump remote SAM database to local Kerberos keytab file\&.
 780 .SS "RPC VAMPIRE LDIF"
 781 .PP
 782 Dump remote SAM database to local LDIF file or standard output\&.
 783 .SS "RPC GETSID"
 784 .PP
 785 Fetch domain SID and store it in the local
 786 \FCsecrets\&.tdb\F[]\&.
 787 .SS "ADS LEAVE"
 788 .PP
 789 Make the remote host leave the domain it is part of\&.
 790 .SS "ADS STATUS"
 791 .PP
 792 Print out status of machine account of the local machine in ADS\&. Prints out quite some debug info\&. Aimed at developers, regular users should use
 793 \FCNET ADS TESTJOIN\F[]\&.
 794 .SS "ADS PRINTER"
 795 .SS "ADS PRINTER INFO [PRINTER] [SERVER]"
 796 .PP
 797 Lookup info for
 798 \fIPRINTER\fR
 799 on
 800 \fISERVER\fR\&. The printer name defaults to "*", the server name defaults to the local host\&.
 801 .SS "ADS PRINTER PUBLISH PRINTER"
 802 .PP
 803 Publish specified printer using ADS\&.
 804 .SS "ADS PRINTER REMOVE PRINTER"
 805 .PP
 806 Remove specified printer from ADS directory\&.
 807 .SS "ADS SEARCH \fIEXPRESSION\fR \fIATTRIBUTES\&.\&.\&.\fR"
 808 .PP
 809 Perform a raw LDAP search on a ADS server and dump the results\&. The expression is a standard LDAP search expression, and the attributes are a list of LDAP fields to show in the results\&.
 810 .PP
 811 Example:
 812 \fBnet ads search \'(objectCategory=group)\' sAMAccountName\fR
 813 .SS "ADS DN \fIDN\fR \fI(attributes)\fR"
 814 .PP
 815 Perform a raw LDAP search on a ADS server and dump the results\&. The DN standard LDAP DN, and the attributes are a list of LDAP fields to show in the result\&.
 816 .PP
 817 Example:
 818 \fBnet ads dn \'CN=administrator,CN=Users,DC=my,DC=domain\' SAMAccountName\fR
 819 .SS "ADS WORKGROUP"
 820 .PP
 821 Print out workgroup name for specified kerberos realm\&.
 822 .SS "SAM CREATEBUILTINGROUP <NAME>"
 823 .PP
 824 (Re)Create a BUILTIN group\&. Only a wellknown set of BUILTIN groups can be created with this command\&. This is the list of currently recognized group names: Administrators, Users, Guests, Power Users, Account Operators, Server Operators, Print Operators, Backup Operators, Replicator, RAS Servers, Pre\-Windows 2000 compatible Access\&. This command requires a running Winbindd with idmap allocation properly configured\&. The group gid will be allocated out of the winbindd range\&.
 825 .SS "SAM CREATELOCALGROUP <NAME>"
 826 .PP
 827 Create a LOCAL group (also known as Alias)\&. This command requires a running Winbindd with idmap allocation properly configured\&. The group gid will be allocated out of the winbindd range\&.
 828 .SS "SAM DELETELOCALGROUP <NAME>"
 829 .PP
 830 Delete an existing LOCAL group (also known as Alias)\&.
 831 .SS "SAM MAPUNIXGROUP <NAME>"
 832 .PP
 833 Map an existing Unix group and make it a Domain Group, the domain group will have the same name\&.
 834 .SS "SAM UNMAPUNIXGROUP <NAME>"
 835 .PP
 836 Remove an existing group mapping entry\&.
 837 .SS "SAM ADDMEM <GROUP> <MEMBER>"
 838 .PP
 839 Add a member to a Local group\&. The group can be specified only by name, the member can be specified by name or SID\&.
 840 .SS "SAM DELMEM <GROUP> <MEMBER>"
 841 .PP
 842 Remove a member from a Local group\&. The group and the member must be specified by name\&.
 843 .SS "SAM LISTMEM <GROUP>"
 844 .PP
 845 List Local group members\&. The group must be specified by name\&.
 846 .SS "SAM LIST <users|groups|localgroups|builtin|workstations> [verbose]"
 847 .PP
 848 List the specified set of accounts by name\&. If verbose is specified, the rid and description is also provided for each account\&.
 849 .SS "SAM SHOW <NAME>"
 850 .PP
 851 Show the full DOMAIN\e\eNAME the SID and the type for the corresponding account\&.
 852 .SS "SAM SET HOMEDIR <NAME> <DIRECTORY>"
 853 .PP
 854 Set the home directory for a user account\&.
 855 .SS "SAM SET PROFILEPATH <NAME> <PATH>"
 856 .PP
 857 Set the profile path for a user account\&.
 858 .SS "SAM SET COMMENT <NAME> <COMMENT>"
 859 .PP
 860 Set the comment for a user or group account\&.
 861 .SS "SAM SET FULLNAME <NAME> <FULL NAME>"
 862 .PP
 863 Set the full name for a user account\&.
 864 .SS "SAM SET LOGONSCRIPT <NAME> <SCRIPT>"
 865 .PP
 866 Set the logon script for a user account\&.
 867 .SS "SAM SET HOMEDRIVE <NAME> <DRIVE>"
 868 .PP
 869 Set the home drive for a user account\&.
 870 .SS "SAM SET WORKSTATIONS <NAME> <WORKSTATIONS>"
 871 .PP
 872 Set the workstations a user account is allowed to log in from\&.
 873 .SS "SAM SET DISABLE <NAME>"
 874 .PP
 875 Set the "disabled" flag for a user account\&.
 876 .SS "SAM SET PWNOTREQ <NAME>"
 877 .PP
 878 Set the "password not required" flag for a user account\&.
 879 .SS "SAM SET AUTOLOCK <NAME>"
 880 .PP
 881 Set the "autolock" flag for a user account\&.
 882 .SS "SAM SET PWNOEXP <NAME>"
 883 .PP
 884 Set the "password do not expire" flag for a user account\&.
 885 .SS "SAM SET PWDMUSTCHANGENOW <NAME> [yes|no]"
 886 .PP
 887 Set or unset the "password must change" flag for a user account\&.
 888 .SS "SAM POLICY LIST"
 889 .PP
 890 List the available account policies\&.
 891 .SS "SAM POLICY SHOW <account policy>"
 892 .PP
 893 Show the account policy value\&.
 894 .SS "SAM POLICY SET <account policy> <value>"
 895 .PP
 896 Set a value for the account policy\&. Valid values can be: "forever", "never", "off", or a number\&.
 897 .SS "SAM PROVISION"
 898 .PP
 899 Only available if ldapsam:editposix is set and winbindd is running\&. Properly populates the ldap tree with the basic accounts (Administrator) and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree\&.
 900 .SS "IDMAP DUMP <local tdb file name>"
 901 .PP
 902 Dumps the mappings contained in the local tdb file specified\&. This command is useful to dump only the mappings produced by the idmap_tdb backend\&.
 903 .SS "IDMAP RESTORE [input file]"
 904 .PP
 905 Restore the mappings from the specified file or stdin\&.
 906 .SS "IDMAP SECRET <DOMAIN>|ALLOC <secret>"
 907 .PP
 908 Store a secret for the specified domain, used primarily for domains that use idmap_ldap as a backend\&. In this case the secret is used as the password for the user DN used to bind to the ldap server\&.
 909 .SS "USERSHARE"
 910 .PP
 911 Starting with version 3\&.0\&.23, a Samba server now supports the ability for non\-root users to add user defined shares to be exported using the "net usershare" commands\&.
 912 .PP
 913 To set this up, first set up your smb\&.conf by adding to the [global] section: usershare path = /usr/local/samba/lib/usershares Next create the directory /usr/local/samba/lib/usershares, change the owner to root and set the group owner to the UNIX group who should have the ability to create usershares, for example a group called "serverops"\&. Set the permissions on /usr/local/samba/lib/usershares to 01770\&. (Owner and group all access, no access for others, plus the sticky bit, which means that a file in that directory can be renamed or deleted only by the owner of the file)\&. Finally, tell smbd how many usershares you will allow by adding to the [global] section of smb\&.conf a line such as : usershare max shares = 100\&. To allow 100 usershare definitions\&. Now, members of the UNIX group "serverops" can create user defined shares on demand using the commands below\&.
 914 .PP
 915 The usershare commands are:
 916 .RS 4
 917 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]] \- to add or change a user defined share\&.
 918 .RE
 919 .RS 4
 920 net usershare delete sharename \- to delete a user defined share\&.
 921 .RE
 922 .RS 4
 923 net usershare info [\-l|\-\-long] [wildcard sharename] \- to print info about a user defined share\&.
 924 .RE
 925 .RS 4
 926 net usershare list [\-l|\-\-long] [wildcard sharename] \- to list user defined shares\&.
 927 .RE
 928 .SS "USERSHARE ADD sharename path [comment] [acl] [guest_ok=[y|n]]"
 929 .PP
 930 Add or replace a new user defined share, with name "sharename"\&.
 931 .PP
 932 "path" specifies the absolute pathname on the system to be exported\&. Restrictions may be put on this, see the global smb\&.conf parameters: "usershare owner only", "usershare prefix allow list", and "usershare prefix deny list"\&.
 933 .PP
 934 The optional "comment" parameter is the comment that will appear on the share when browsed to by a client\&.
 935 .PP
 936 The optional "acl" field specifies which users have read and write access to the entire share\&. Note that guest connections are not allowed unless the smb\&.conf parameter "usershare allow guests" has been set\&. The definition of a user defined share acl is: "user:permission", where user is a valid username on the system and permission can be "F", "R", or "D"\&. "F" stands for "full permissions", ie\&. read and write permissions\&. "D" stands for "deny" for a user, ie\&. prevent this user from accessing this share\&. "R" stands for "read only", ie\&. only allow read access to this share (no creation of new files or directories or writing to files)\&.
 937 .PP
 938 The default if no "acl" is given is "Everyone:R", which means any authenticated user has read\-only access\&.
 939 .PP
 940 The optional "guest_ok" has the same effect as the parameter of the same name in smb\&.conf, in that it allows guest access to this user defined share\&. This parameter is only allowed if the global parameter "usershare allow guests" has been set to true in the smb\&.conf\&.
 941
 942
 943 There is no separate command to modify an existing user defined share,
 944 just use the "net usershare add [sharename]" command using the same
 945 sharename as the one you wish to modify and specify the new options
 946 you wish\&. The Samba smbd daemon notices user defined share modifications
 947 at connect time so will see the change immediately, there is no need
 948 to restart smbd on adding, deleting or changing a user defined share\&.
 949 .SS "USERSHARE DELETE sharename"
 950 .PP
 951 Deletes the user defined share by name\&. The Samba smbd daemon immediately notices this change, although it will not disconnect any users currently connected to the deleted share\&.
 952 .SS "USERSHARE INFO [-l|--long] [wildcard sharename]"
 953 .PP
 954 Get info on user defined shares owned by the current user matching the given pattern, or all users\&.
 955 .PP
 956 net usershare info on its own dumps out info on the user defined shares that were created by the current user, or restricts them to share names that match the given wildcard pattern (\'*\' matches one or more characters, \'?\' matches only one character)\&. If the \'\-l\' or \'\-\-long\' option is also given, it prints out info on user defined shares created by other users\&.
 957 .PP
 958 The information given about a share looks like: [foobar] path=/home/jeremy comment=testme usershare_acl=Everyone:F guest_ok=n And is a list of the current settings of the user defined share that can be modified by the "net usershare add" command\&.
 959 .SS "USERSHARE LIST [-l|--long] wildcard sharename"
 960 .PP
 961 List all the user defined shares owned by the current user matching the given pattern, or all users\&.
 962 .PP
 963 net usershare list on its own list out the names of the user defined shares that were created by the current user, or restricts the list to share names that match the given wildcard pattern (\'*\' matches one or more characters, \'?\' matches only one character)\&. If the \'\-l\' or \'\-\-long\' option is also given, it includes the names of user defined shares created by other users\&.
 964 .SS "CONF"
 965 .PP
 966 Starting with version 3\&.2\&.0, a Samba server can be configured by data stored in registry\&. This configuration data can be edited with the new "net conf" commands\&.
 967 .PP
 968 The deployment of this configuration data can be activated in two levels from the
 969 \fIsmb\&.conf\fR
 970 file: Share definitions from registry are activated by setting
 971 \fIregistry shares\fR
 972 to
 973 \(lqyes\(rq
 974 in the [global] section and global configuration options are activated by setting
 975 \m[blue]\fBinclude = registry\fR\m[]
 976 in the [global] section for a mixed configuration or by setting
 977 \m[blue]\fBconfig backend = registry\fR\m[]
 978 in the [global] section for a registry\-only configuration\&. See the
 979 \fBsmb.conf\fR(5)
 980 manpage for details\&.
 981 .PP
 982 The conf commands are:
 983 .RS 4
 984 net conf list \- Dump the complete configuration in smb\&.conf like
 985 format\&.
 986 .RE
 987 .RS 4
 988 net conf import \- Import configuration from file in smb\&.conf
 989 format\&.
 990 .RE
 991 .RS 4
 992 net conf listshares \- List the registry shares\&.
 993 .RE
 994 .RS 4
 995 net conf drop \- Delete the complete configuration from
 996 registry\&.
 997 .RE
 998 .RS 4
 999 net conf showshare \- Show the definition of a registry share\&.
1000 .RE
1001 .RS 4
1002 net conf addshare \- Create a new registry share\&.
1003 .RE
1004 .RS 4
1005 net conf delshare \- Delete a registry share\&.
1006 .RE
1007 .RS 4
1008 net conf setparm \- Store a parameter\&.
1009 .RE
1010 .RS 4
1011 net conf getparm \- Retrieve the value of a parameter\&.
1012 .RE
1013 .RS 4
1014 net conf delparm \- Delete a parameter\&.
1015 .RE
1016 .RS 4
1017 net conf getincludes \- Show the includes of a share definition\&.
1018 .RE
1019 .RS 4
1020 net conf setincludes \- Set includes for a share\&.
1021 .RE
1022 .RS 4
1023 net conf delincludes \- Delete includes from a share definition\&.
1024 .RE
1025 .SS "CONF LIST"
1026 .PP
1027 Print the configuration data stored in the registry in a smb\&.conf\-like format to standard output\&.
1028 .SS "CONF IMPORT [--test|-T] filename [section]"
1029 .PP
1030 This command imports configuration from a file in smb\&.conf format\&. If a section encountered in the input file is present in registry, its contents is replaced\&. Sections of registry configuration that have no counterpart in the input file are not affected\&. If you want to delete these, you will have to use the "net conf drop" or "net conf delshare" commands\&. Optionally, a section may be specified to restrict the effect of the import command to that specific section\&. A test mode is enabled by specifying the parameter "\-T" on the commandline\&. In test mode, no changes are made to the registry, and the resulting configuration is printed to standard output instead\&.
1031 .SS "CONF LISTSHARES"
1032 .PP
1033 List the names of the shares defined in registry\&.
1034 .SS "CONF DROP"
1035 .PP
1036 Delete the complete configuration data from registry\&.
1037 .SS "CONF SHOWSHARE sharename"
1038 .PP
1039 Show the definition of the share or section specified\&. It is valid to specify "global" as sharename to retrieve the global configuration options from registry\&.
1040 .SS "CONF ADDSHARE sharename path [writeable={y|N} [guest_ok={y|N} [comment]]] "
1041 .PP
1042 Create a new share definition in registry\&. The sharename and path have to be given\&. The share name may
1043 \fInot\fR
1044 be "global"\&. Optionally, values for the very common options "writeable", "guest ok" and a "comment" may be specified\&. The same result may be obtained by a sequence of "net conf setparm" commands\&.
1045 .SS "CONF DELSHARE sharename"
1046 .PP
1047 Delete a share definition from registry\&.
1048 .SS "CONF SETPARM section parameter value"
1049 .PP
1050 Store a parameter in registry\&. The section may be global or a sharename\&. The section is created if it does not exist yet\&.
1051 .SS "CONF GETPARM section parameter"
1052 .PP
1053 Show a parameter stored in registry\&.
1054 .SS "CONF DELPARM section parameter"
1055 .PP
1056 Delete a parameter stored in registry\&.
1057 .SS "CONF GETINCLUDES section"
1058 .PP
1059 Get the list of includes for the provided section (global or share)\&.
1060 .PP
1061 Note that due to the nature of the registry database and the nature of include directives, the includes need special treatment: Parameters are stored in registry by the parameter name as valuename, so there is only ever one instance of a parameter per share\&. Also, a specific order like in a text file is not guaranteed\&. For all real parameters, this is perfectly ok, but the include directive is rather a meta parameter, for which, in the smb\&.conf text file, the place where it is specified between the other parameters is very important\&. This can not be achieved by the simple registry smbconf data model, so there is one ordered list of includes per share, and this list is evaluated after all the parameters of the share\&.
1062 .PP
1063 Further note that currently, only files can be included from registry configuration\&. In the future, there will be the ability to include configuration data from other registry keys\&.
1064 .SS "CONF SETINCLUDES section [filename]+"
1065 .PP
1066 Set the list of includes for the provided section (global or share) to the given list of one or more filenames\&. The filenames may contain the usual smb\&.conf macros like %I\&.
1067 .SS "CONF DELINCLUDES section"
1068 .PP
1069 Delete the list of includes from the provided section (global or share)\&.
1070 .SS "HELP [COMMAND]"
1071 .PP
1072 Gives usage information for the specified command\&.
1073 .SH "VERSION"
1074 .PP
1075 This man page is complete for version 3 of the Samba suite\&.
1076 .SH "AUTHOR"
1077 .PP
1078 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
1079 .PP
1080 The net manpage was written by Jelmer Vernooij\&.