docs-xml/manpages/net.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="net.8">
   4
   5 <refmeta>
   6         <refentrytitle>net</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>net</refname>
  16         <refpurpose>Tool for administration of Samba and remote
  17         CIFS servers.
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>net</command>
  24                 <arg choice="req">&lt;ads|rap|rpc&gt;</arg>
  25                 <arg choice="opt">-h|--help</arg>
  26                 <arg choice="opt">-w|--workgroup workgroup</arg>
  27                 <arg choice="opt">-W|--myworkgroup myworkgroup</arg>
  28                 <arg choice="opt">-U|--user user</arg>
  29                 <arg choice="opt">-A|--authentication-file authfile</arg>
  30                 <arg choice="opt">-I|--ipaddress ip-address</arg>
  31                 <arg choice="opt">-p|--port port</arg>
  32                 <arg choice="opt">-n myname</arg>
  33                 <arg choice="opt">-s conffile</arg>
  34                 <arg choice="opt">-S|--server server</arg>
  35                 <arg choice="opt">-l|--long</arg>
  36                 <arg choice="opt">-v|--verbose</arg>
  37                 <arg choice="opt">-f|--force</arg>
  38                 <arg choice="opt">-P|--machine-pass</arg>
  39                 <arg choice="opt">-d debuglevel</arg>
  40                 <arg choice="opt">-V</arg>
  41                 <arg choice="opt">--request-timeout seconds</arg>
  42                 <arg choice="opt">-t|--timeout seconds</arg>
  43                 <arg choice="opt">-i|--stdin</arg>
  44                 <arg choice="opt">--tallocreport</arg>
  45         </cmdsynopsis>
  46 </refsynopsisdiv>
  47
  48 <refsect1>
  49         <title>DESCRIPTION</title>
  50
  51         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  52         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  53
  54         <para>The Samba net utility is meant to work just like the net utility
  55         available for windows and DOS. The first argument should be used
  56         to specify the protocol to use when executing a certain command.
  57         ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3)
  58         clients and RPC can be used for NT4 and Windows 2000. If this
  59         argument is omitted, net will try to determine it automatically.
  60         Not all commands are available on all protocols.
  61         </para>
  62
  63 </refsect1>
  64
  65 <refsect1>
  66         <title>OPTIONS</title>
  67
  68         <variablelist>
  69                 &stdarg.help;
  70                 &stdarg.kerberos;
  71
  72                 <varlistentry>
  73                 <term>-w|--workgroup target-workgroup</term>
  74                 <listitem><para>
  75                 Sets target workgroup or domain. You have to specify
  76                 either this option or the IP address or the name of a server.
  77                 </para></listitem>
  78                 </varlistentry>
  79
  80                 <varlistentry>
  81                 <term>-W|--myworkgroup workgroup</term>
  82                 <listitem><para>
  83                 Sets client workgroup or domain
  84                 </para></listitem>
  85                 </varlistentry>
  86
  87                 <varlistentry>
  88                 <term>-U|--user user</term>
  89                 <listitem><para>
  90                 User name to use
  91                 </para></listitem>
  92                 </varlistentry>
  93
  94                 <varlistentry>
  95                 <term>-I|--ipaddress ip-address</term>
  96                 <listitem><para>
  97                 IP address of target server to use. You have to
  98                 specify either this option or a target workgroup or
  99                 a target server.
 100                 </para></listitem>
 101                 </varlistentry>
 102
 103                 <varlistentry>
 104                 <term>-p|--port port</term>
 105                 <listitem><para>
 106                 Port on the target server to connect to (usually 139 or 445).
 107                 Defaults to trying 445 first, then 139.
 108                 </para></listitem>
 109                 </varlistentry>
 110
 111                 &stdarg.netbios.name;
 112
 113                 <varlistentry>
 114                 <term>-S|--server server</term>
 115                 <listitem><para>
 116                 Name of target server. You should specify either
 117                 this option or a target workgroup or a target IP address.
 118                 </para></listitem>
 119                 </varlistentry>
 120
 121                 <varlistentry>
 122                 <term>-l|--long</term>
 123                 <listitem><para>
 124                 When listing data, give more information on each item.
 125                 </para></listitem>
 126                 </varlistentry>
 127
 128                 <varlistentry>
 129                 <term>-v|--verbose</term>
 130                 <listitem><para>
 131                 When listing data, give more verbose information on each item.
 132                 </para></listitem>
 133                 </varlistentry>
 134
 135                 <varlistentry>
 136                 <term>-f|--force</term>
 137                 <listitem><para>
 138                                 Enforcing a net command.
 139                 </para></listitem>
 140                 </varlistentry>
 141
 142                 <varlistentry>
 143                 <term>-P|--machine-pass</term>
 144                 <listitem><para>
 145                 Make queries to the external server using the machine account of the local server.
 146                 </para></listitem>
 147                 </varlistentry>
 148
 149                 <varlistentry>
 150                 <term>--request-timeout 30</term>
 151                 <listitem><para>
 152                 Let client requests timeout after 30 seconds the default is 10
 153                 seconds.
 154                 </para></listitem>
 155                 </varlistentry>
 156
 157                 <varlistentry>
 158                 <term>-t|--timeout 30</term>
 159                 <listitem><para>
 160                                 Set timeout for client operations to 30 seconds.
 161                 </para></listitem>
 162                 </varlistentry>
 163
 164                 <varlistentry>
 165                 <term>--use-ccache</term>
 166                 <listitem><para>
 167                 Try to use the credentials cached by winbind.
 168                 </para></listitem>
 169                 </varlistentry>
 170
 171                 <varlistentry>
 172                 <term>-i|--stdin</term>
 173                 <listitem><para>
 174                                 Take input for net commands from standard input.
 175                 </para></listitem>
 176                 </varlistentry>
 177
 178                 <varlistentry>
 179                 <term>--tallocreport</term>
 180                 <listitem><para>
 181                                 Generate a talloc report while processing a net
 182                                 command.
 183                 </para></listitem>
 184                 </varlistentry>
 185
 186                 <varlistentry>
 187                 <term>-T|--test</term>
 188                 <listitem><para>Only test command sequence, dry-run.
 189                 </para></listitem>
 190                 </varlistentry>
 191
 192                 <varlistentry>
 193                 <term>-F|--flags FLAGS</term>
 194                 <listitem><para>Pass down integer flags to a net subcommand.
 195                 </para></listitem>
 196                 </varlistentry>
 197
 198                 <varlistentry>
 199                 <term>-C|--comment COMMENT</term>
 200                 <listitem><para>Pass down a comment string to a net subcommand.
 201                 </para></listitem>
 202                 </varlistentry>
 203
 204                 <varlistentry>
 205                 <term>-n|--myname MYNAME</term>
 206                 <listitem><para>Use MYNAME as a requester name for a net subcommand.
 207                 </para></listitem>
 208                 </varlistentry>
 209
 210                 <varlistentry>
 211                 <term>-c|--container CONTAINER</term>
 212                 <listitem><para>Use a specific AD container for net ads operations.
 213                 </para></listitem>
 214                 </varlistentry>
 215
 216                 <varlistentry>
 217                 <term>-M|--maxusers MAXUSERS</term>
 218                 <listitem><para>Fill in the maxusers field in net rpc share operations.
 219                 </para></listitem>
 220                 </varlistentry>
 221
 222                 <varlistentry>
 223                 <term>-r|--reboot</term>
 224                 <listitem><para>Reboot a remote machine after a command has been successfully executed (e.g. in remote join operations).
 225                 </para></listitem>
 226                 </varlistentry>
 227
 228                 <!-- Options for net rpc vampire -->
 229
 230                 <varlistentry>
 231                 <term>--force-full-repl</term>
 232                 <listitem><para>
 233                                 When calling "net rpc vampire keytab" this option
 234                                 enforces a full re-creation of the generated keytab file.
 235                 </para></listitem>
 236                 </varlistentry>
 237
 238                 <varlistentry>
 239                 <term>--single-obj-repl</term>
 240                 <listitem><para>
 241                                 When calling "net rpc vampire keytab" this option
 242                                 allows one to replicate just a single object to the generated keytab file.
 243                 </para></listitem>
 244                 </varlistentry>
 245
 246                 <varlistentry>
 247                 <term>--clean-old-entries</term>
 248                 <listitem><para>
 249                                 When calling "net rpc vampire keytab" this option
 250                                 allows one to cleanup old entries from the generated keytab file.
 251                 </para></listitem>
 252                 </varlistentry>
 253
 254                 <!-- Options for net idmap -->
 255
 256                 <varlistentry>
 257                 <term>--db</term>
 258                 <listitem><para>Define dbfile for "net idmap" commands.
 259                 </para></listitem>
 260                 </varlistentry>
 261
 262                 <varlistentry>
 263                 <term>--lock</term>
 264                 <listitem><para>Activates locking of the dbfile for "net idmap check" command.
 265                 </para></listitem>
 266                 </varlistentry>
 267
 268                 <varlistentry>
 269                 <term>-a|--auto</term>
 270                 <listitem><para>Activates noninteractive mode in "net idmap check".
 271                 </para></listitem>
 272                 </varlistentry>
 273
 274                 <varlistentry>
 275                 <term>--repair</term>
 276                 <listitem><para>Activates repair mode in "net idmap check".
 277                 </para></listitem>
 278                 </varlistentry>
 279
 280                 <!-- Options for net rpc share migrate -->
 281
 282                 <varlistentry>
 283                 <term>--acls</term>
 284                 <listitem><para>Includes ACLs to be copied in "net rpc share migrate".
 285                 </para></listitem>
 286                 </varlistentry>
 287
 288                 <varlistentry>
 289                 <term>--attrs</term>
 290                 <listitem><para>Includes file attributes to be copied in "net rpc share migrate".
 291                 </para></listitem>
 292                 </varlistentry>
 293
 294                 <varlistentry>
 295                 <term>--timestamps</term>
 296                 <listitem><para>Includes timestamps to be copied in "net rpc share migrate".
 297                 </para></listitem>
 298                 </varlistentry>
 299
 300                 <varlistentry>
 301                 <term>-X|--exclude DIRECTORY</term>
 302                 <listitem><para>Allows one to exclude directories when copying with "net rpc share migrate".
 303                 </para></listitem>
 304                 </varlistentry>
 305
 306                 <varlistentry>
 307                 <term>--destination SERVERNAME</term>
 308                 <listitem><para>Defines the target servername of migration process (defaults to localhost).
 309                 </para></listitem>
 310                 </varlistentry>
 311
 312                 <!-- Options for net groupmap set -->
 313
 314                 <varlistentry>
 315                 <term>-L|--local</term>
 316                 <listitem><para>Sets the type of group mapping to local
 317                                 (used in "net groupmap set").
 318                 </para></listitem>
 319                 </varlistentry>
 320
 321                 <varlistentry>
 322                 <term>-D|--domain</term>
 323                 <listitem><para>Sets the type of group mapping to domain
 324                                 (used in "net groupmap set").
 325                 </para></listitem>
 326                 </varlistentry>
 327
 328                 <varlistentry>
 329                 <term>-N|--ntname NTNAME</term>
 330                 <listitem><para>Sets the ntname of a group mapping
 331                                 (used in "net groupmap set").
 332                 </para></listitem>
 333                 </varlistentry>
 334
 335                 <varlistentry>
 336                 <term>-R|--rid RID</term>
 337                 <listitem><para>Sets the rid of a group mapping
 338                                 (used in "net groupmap set").
 339                 </para></listitem>
 340                 </varlistentry>
 341
 342                 <!-- Options for net registry check -->
 343
 344                 <varlistentry>
 345                 <term>--reg-version REG_VERSION</term>
 346                 <listitem><para>Assume database version {n|1,2,3}
 347                                 (used in "net registry check").
 348                 </para></listitem>
 349                 </varlistentry>
 350
 351                 <varlistentry>
 352                 <term>-o|--output FILENAME</term>
 353                 <listitem><para>Output database file
 354                                 (used in "net registry check").
 355                 </para></listitem>
 356                 </varlistentry>
 357
 358                 <varlistentry>
 359                 <term>--wipe</term>
 360                 <listitem><para>Create a new database from scratch
 361                                 (used in "net registry check").
 362                 </para></listitem>
 363                 </varlistentry>
 364
 365                 <!-- Options for net registry import -->
 366
 367                 <varlistentry>
 368                 <term>--precheck PRECHECK_DB_FILENAME</term>
 369                 <listitem><para>Defines filename for database prechecking
 370                                 (used in "net registry import").
 371                 </para></listitem>
 372                 </varlistentry>
 373
 374                 <varlistentry>
 375                 <term>--no-dns-updates</term>
 376                 <listitem><para>Do not perform DNS updates as part of
 377                 "net ads join".
 378                 </para></listitem>
 379                 </varlistentry>
 380
 381                 <varlistentry>
 382                 <term>--keep-account</term>
 383                 <listitem><para>Prevent the machine account removal as
 384                 part of "net ads leave".
 385                 </para></listitem>
 386                 </varlistentry>
 387
 388                 <varlistentry>
 389                 <term>--json</term>
 390                 <listitem><para>Report results in JSON format for
 391                 "net ads info" and "net ads lookup".
 392                 </para></listitem>
 393                 </varlistentry>
 394
 395                 <!-- Options for net vfs stream2abouble -->
 396
 397                 <varlistentry>
 398                 <term>--recursive</term>
 399                 <listitem><para>Traverse a directory
 400                 hierarchy.</para></listitem>
 401                 </varlistentry>
 402
 403                 <varlistentry>
 404                 <term>--continue</term>
 405                 <listitem><para>Continue traversing a directory hierarchy in
 406                 case conversion of one file fails.</para></listitem>
 407                 </varlistentry>
 408
 409                 <varlistentry>
 410                 <term>--follow-symlinks</term>
 411                 <listitem><para>Follow symlinks encountered while traversing a
 412                 directory.</para></listitem>
 413                 </varlistentry>
 414
 415                 &stdarg.encrypt;
 416                 &popt.common.samba.client;
 417
 418         </variablelist>
 419 </refsect1>
 420
 421 <refsect1>
 422 <title>COMMANDS</title>
 423
 424 <refsect2>
 425 <title>CHANGESECRETPW</title>
 426
 427 <para>This command allows the Samba machine account password to be set from an external application
 428 to a machine account password that has already been stored in Active Directory. DO NOT USE this command
 429 unless you know exactly what you are doing. The use of this command requires that the force flag (-f)
 430 be used also. There will be NO command prompt. Whatever information is piped into stdin, either by
 431 typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use
 432 this without care and attention as it will overwrite a legitimate machine password without warning.
 433 YOU HAVE BEEN WARNED.
 434 </para>
 435
 436 </refsect2>
 437
 438 <refsect2>
 439         <title>TIME</title>
 440
 441         <para>The <command>NET TIME</command> command allows you to view the time on a remote server
 442         or synchronise the time on the local server with the time on the remote server.</para>
 443
 444 <refsect3>
 445 <title>TIME</title>
 446
 447 <para>Without any options, the <command>NET TIME</command> command
 448 displays the time on the remote server. The remote server must be
 449 specified with the -S option.
 450 </para>
 451
 452 </refsect3>
 453
 454 <refsect3>
 455 <title>TIME SYSTEM</title>
 456
 457 <para>Displays the time on the remote server in a format ready for <command>/bin/date</command>.
 458 The remote server must be specified with the -S option.
 459 </para>
 460
 461 </refsect3>
 462
 463 <refsect3>
 464 <title>TIME SET</title>
 465 <para>Tries to set the date and time of the local server to that on
 466 the remote server using <command>/bin/date</command>.
 467 The remote server must be specified with the -S option.
 468 </para>
 469
 470 </refsect3>
 471
 472 <refsect3>
 473 <title>TIME ZONE</title>
 474
 475 <para>Displays the timezone in hours from GMT on the remote server.
 476 The remote server must be specified with the -S option.
 477 </para>
 478
 479 </refsect3>
 480 </refsect2>
 481
 482 <refsect2>
 483 <title>[RPC|ADS] JOIN [TYPE] [--no-dns-updates] [-U username[%password]]
 484 [createupn=UPN] [createcomputer=OU] [machinepass=PASS]
 485 [osName=string osVer=string] [options]</title>
 486
 487 <para>
 488 Join a domain.  If the account already exists on the server, and
 489 [TYPE] is MEMBER, the machine will attempt to join automatically.
 490 (Assuming that the machine has been created in server manager)
 491 Otherwise, a password will be prompted for, and a new account may
 492 be created.</para>
 493
 494 <para>
 495 [TYPE] may be PDC, BDC or MEMBER to specify the type of server
 496 joining the domain.
 497 </para>
 498
 499 <para>
 500 [UPN] (ADS only) set the principalname attribute during the join.  The default
 501 format is host/netbiosname@REALM.
 502 </para>
 503
 504 <para>
 505 [OU] (ADS only) Precreate the computer account in a specific OU.  The
 506 OU string reads from top to bottom without RDNs, and is delimited by
 507 a '/'.  Please note that '\' is used for escape by both the shell
 508 and ldap, so it may need to be doubled or quadrupled to pass through,
 509 and it is not used as a delimiter.
 510 </para>
 511 <para>
 512 [PASS] (ADS only) Set a specific password on the computer account
 513 being created by the join.
 514 </para>
 515 <para>
 516 [osName=string osVer=String] (ADS only) Set the operatingSystem and
 517 operatingSystemVersion attribute during the join.  Both parameters
 518 must be specified for either to take effect.
 519 </para>
 520 </refsect2>
 521
 522 <refsect2>
 523 <title>[RPC] OLDJOIN [options]</title>
 524
 525 <para>Join a domain. Use the OLDJOIN option to join the domain
 526 using the old style of domain joining - you need to create a trust
 527 account in server manager first.</para>
 528 </refsect2>
 529
 530 <refsect2>
 531 <title>[RPC|ADS] USER</title>
 532
 533 <refsect3>
 534 <title>[RPC|ADS] USER</title>
 535
 536 <para>List all users</para>
 537
 538 </refsect3>
 539
 540 <refsect3>
 541 <title>[RPC|ADS] USER DELETE <replaceable>target</replaceable></title>
 542
 543 <para>Delete specified user</para>
 544
 545 </refsect3>
 546
 547 <refsect3>
 548 <title>[RPC|ADS] USER INFO <replaceable>target</replaceable></title>
 549
 550 <para>List the domain groups of the specified user.</para>
 551
 552 </refsect3>
 553
 554 <refsect3>
 555 <title>[RPC|ADS] USER RENAME <replaceable>oldname</replaceable> <replaceable>newname</replaceable></title>
 556
 557 <para>Rename specified user.</para>
 558
 559 </refsect3>
 560
 561 <refsect3>
 562 <title>[RPC|ADS] USER ADD <replaceable>name</replaceable> [password] [-F user flags] [-C comment]</title>
 563
 564 <para>Add specified user.</para>
 565 </refsect3>
 566 </refsect2>
 567
 568 <refsect2>
 569 <title>[RPC|ADS] GROUP</title>
 570
 571 <refsect3>
 572 <title>[RPC|ADS] GROUP [misc options] [targets]</title>
 573 <para>List user groups.</para>
 574 </refsect3>
 575
 576 <refsect3>
 577 <title>[RPC|ADS] GROUP DELETE <replaceable>name</replaceable> [misc. options]</title>
 578
 579 <para>Delete specified group.</para>
 580
 581 </refsect3>
 582
 583 <refsect3>
 584 <title>[RPC|ADS] GROUP ADD <replaceable>name</replaceable> [-C comment]</title>
 585
 586 <para>Create specified group.</para>
 587
 588 </refsect3>
 589 <refsect3>
 590 <title>[ADS] LOOKUP</title>
 591
 592 <para>Lookup the closest Domain Controller in our domain and retrieve server information about it.</para>
 593
 594 </refsect3>
 595 </refsect2>
 596
 597 <refsect2>
 598 <title>[RAP|RPC] SHARE</title>
 599
 600 <refsect3>
 601 <title>[RAP|RPC] SHARE [misc. options] [targets]</title>
 602
 603 <para>Enumerates all exported resources (network shares) on target server.</para>
 604
 605 </refsect3>
 606
 607 <refsect3>
 608 <title>[RAP|RPC] SHARE ADD <replaceable>name=serverpath</replaceable> [-C comment] [-M maxusers] [targets]</title>
 609
 610 <para>Adds a share from a server (makes the export active). Maxusers
 611 specifies the number of users that can be connected to the
 612 share simultaneously.</para>
 613
 614 </refsect3>
 615
 616 <refsect3>
 617 <title>SHARE DELETE <replaceable>sharename</replaceable></title>
 618
 619 <para>Delete specified share.</para>
 620 </refsect3>
 621 </refsect2>
 622
 623 <refsect2>
 624 <title>[RPC|RAP] FILE</title>
 625
 626 <refsect3>
 627 <title>[RPC|RAP] FILE</title>
 628
 629 <para>List all open files on remote server.</para>
 630
 631 </refsect3>
 632
 633 <refsect3>
 634 <title>[RPC|RAP] FILE CLOSE <replaceable>fileid</replaceable></title>
 635
 636 <para>Close file with specified <replaceable>fileid</replaceable> on
 637 remote server.</para>
 638
 639 </refsect3>
 640
 641 <refsect3>
 642 <title>[RPC|RAP] FILE INFO <replaceable>fileid</replaceable></title>
 643
 644 <para>
 645 Print information on specified <replaceable>fileid</replaceable>.
 646 Currently listed are: file-id, username, locks, path, permissions.
 647 </para>
 648
 649 </refsect3>
 650
 651 <refsect3>
 652 <title>[RAP|RPC] FILE USER <replaceable>user</replaceable></title>
 653
 654 <para>
 655 List files opened by specified <replaceable>user</replaceable>.
 656 Please note that <command>net rap file user</command> does not work
 657 against Samba servers.
 658 </para>
 659
 660 </refsect3>
 661
 662 </refsect2>
 663
 664 <refsect2>
 665 <title>SESSION</title>
 666
 667 <refsect3>
 668 <title>RAP SESSION</title>
 669
 670 <para>Without any other options, SESSION enumerates all active SMB/CIFS
 671 sessions on the target server.</para>
 672
 673 </refsect3>
 674
 675 <refsect3>
 676 <title>RAP SESSION DELETE|CLOSE <replaceable>CLIENT_NAME</replaceable></title>
 677
 678 <para>Close the specified sessions.</para>
 679
 680 </refsect3>
 681
 682 <refsect3>
 683 <title>RAP SESSION INFO <replaceable>CLIENT_NAME</replaceable></title>
 684
 685 <para>Give a list with all the open files in specified session.</para>
 686
 687 </refsect3>
 688
 689 </refsect2>
 690
 691 <refsect2>
 692 <title>RAP SERVER <replaceable>DOMAIN</replaceable></title>
 693
 694 <para>List all servers in specified domain or workgroup. Defaults
 695 to local domain.</para>
 696
 697 </refsect2>
 698
 699 <refsect2>
 700 <title>RAP DOMAIN</title>
 701
 702 <para>Lists all domains and workgroups visible on the
 703 current network.</para>
 704
 705 </refsect2>
 706
 707 <refsect2>
 708 <title>RAP PRINTQ</title>
 709
 710 <refsect3>
 711 <title>RAP PRINTQ INFO <replaceable>QUEUE_NAME</replaceable></title>
 712
 713 <para>Lists the specified print queue and print jobs on the server.
 714 If the <replaceable>QUEUE_NAME</replaceable> is omitted, all
 715 queues are listed.</para>
 716
 717 </refsect3>
 718
 719 <refsect3>
 720 <title>RAP PRINTQ DELETE <replaceable>JOBID</replaceable></title>
 721
 722 <para>Delete job with specified id.</para>
 723
 724 </refsect3>
 725
 726 </refsect2>
 727
 728 <refsect2>
 729 <title>RAP VALIDATE <replaceable>user</replaceable> [<replaceable>password</replaceable>]</title>
 730
 731 <para>
 732 Validate whether the specified user can log in to the
 733 remote server. If the password is not specified on the commandline, it
 734 will be prompted.
 735 </para>
 736
 737 &not.implemented;
 738
 739 </refsect2>
 740
 741 <refsect2>
 742 <title>RAP GROUPMEMBER</title>
 743
 744 <refsect3>
 745 <title>RAP GROUPMEMBER LIST <replaceable>GROUP</replaceable></title>
 746
 747 <para>List all members of the specified group.</para>
 748
 749 </refsect3>
 750
 751 <refsect3>
 752 <title>RAP GROUPMEMBER DELETE <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title>
 753
 754 <para>Delete member from group.</para>
 755
 756 </refsect3>
 757
 758 <refsect3>
 759 <title>RAP GROUPMEMBER ADD <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title>
 760
 761 <para>Add member to group.</para>
 762
 763 </refsect3>
 764
 765 </refsect2>
 766
 767 <refsect2>
 768 <title>RAP ADMIN <replaceable>command</replaceable></title>
 769
 770 <para>Execute the specified <replaceable>command</replaceable> on
 771 the remote server. Only works with OS/2 servers.
 772 </para>
 773
 774 &not.implemented;
 775
 776 </refsect2>
 777
 778 <refsect2>
 779 <title>RAP SERVICE</title>
 780
 781 <refsect3>
 782 <title>RAP SERVICE START <replaceable>NAME</replaceable> [arguments...]</title>
 783
 784 <para>Start the specified service on the remote server. Not implemented yet.</para>
 785
 786 &not.implemented;
 787
 788 </refsect3>
 789
 790 <refsect3>
 791 <title>RAP SERVICE STOP</title>
 792
 793 <para>Stop the specified service on the remote server.</para>
 794
 795 &not.implemented;
 796
 797 </refsect3>
 798
 799 </refsect2>
 800
 801 <refsect2>
 802 <title>RAP PASSWORD <replaceable>USER</replaceable> <replaceable>OLDPASS</replaceable> <replaceable>NEWPASS</replaceable></title>
 803
 804 <para>
 805 Change password of <replaceable>USER</replaceable> from <replaceable>OLDPASS</replaceable> to <replaceable>NEWPASS</replaceable>.
 806 </para>
 807
 808 </refsect2>
 809
 810 <refsect2>
 811 <title>LOOKUP</title>
 812
 813 <refsect3>
 814 <title>LOOKUP HOST <replaceable>HOSTNAME</replaceable> [<replaceable>TYPE</replaceable>]</title>
 815
 816 <para>
 817 Lookup the IP address of the given host with the specified type (netbios suffix).
 818 The type defaults to 0x20 (workstation).
 819 </para>
 820
 821 </refsect3>
 822
 823 <refsect3>
 824 <title>LOOKUP LDAP [<replaceable>DOMAIN</replaceable>]</title>
 825
 826 <para>Give IP address of LDAP server of specified <replaceable>DOMAIN</replaceable>. Defaults to local domain.</para>
 827
 828 </refsect3>
 829
 830 <refsect3>
 831 <title>LOOKUP KDC [<replaceable>REALM</replaceable>]</title>
 832
 833 <para>Give IP address of KDC for the specified <replaceable>REALM</replaceable>.
 834 Defaults to local realm.</para>
 835
 836 </refsect3>
 837
 838 <refsect3>
 839 <title>LOOKUP DC [<replaceable>DOMAIN</replaceable>]</title>
 840
 841 <para>Give IP's of Domain Controllers for specified <replaceable>
 842 DOMAIN</replaceable>. Defaults to local domain.</para>
 843
 844 </refsect3>
 845
 846 <refsect3>
 847 <title>LOOKUP MASTER <replaceable>DOMAIN</replaceable></title>
 848
 849 <para>Give IP of master browser for specified <replaceable>DOMAIN</replaceable>
 850 or workgroup. Defaults to local domain.</para>
 851
 852 </refsect3>
 853
 854 <refsect3>
 855 <title>LOOKUP NAME [<replaceable>NAME</replaceable>]</title>
 856
 857 <para>Lookup username's sid and type for specified <replaceable>NAME</replaceable>
 858 </para>
 859
 860 </refsect3>
 861
 862 <refsect3>
 863 <title>LOOKUP SID [<replaceable>SID</replaceable>]</title>
 864
 865 <para>Give sid's name and type for specified <replaceable>SID</replaceable>
 866 </para>
 867
 868 </refsect3>
 869
 870 <refsect3>
 871 <title>LOOKUP DSGETDCNAME [<replaceable>NAME</replaceable>] [<replaceable>FLAGS</replaceable>] [<replaceable>SITENAME</replaceable>]</title>
 872
 873 <para>Give Domain Controller information for specified domain <replaceable>NAME</replaceable>
 874 </para>
 875
 876 </refsect3>
 877
 878 </refsect2>
 879
 880 <refsect2>
 881 <title>CACHE</title>
 882
 883 <para>Samba uses a general caching interface called 'gencache'. It
 884 can be controlled using 'NET CACHE'.</para>
 885
 886 <para>All the timeout parameters support the suffixes:
 887
 888 <simplelist>
 889 <member>s - Seconds</member>
 890 <member>m - Minutes</member>
 891 <member>h - Hours</member>
 892 <member>d - Days</member>
 893 <member>w - Weeks</member>
 894 </simplelist>
 895
 896 </para>
 897
 898 <refsect3>
 899 <title>CACHE ADD <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
 900
 901 <para>Add specified key+data to the cache with the given timeout.</para>
 902
 903 </refsect3>
 904
 905 <refsect3>
 906 <title>CACHE DEL <replaceable>key</replaceable></title>
 907
 908 <para>Delete key from the cache.</para>
 909
 910 </refsect3>
 911
 912 <refsect3>
 913 <title>CACHE SET <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
 914
 915 <para>Update data of existing cache entry.</para>
 916
 917 </refsect3>
 918
 919 <refsect3>
 920 <title>CACHE SEARCH <replaceable>PATTERN</replaceable></title>
 921
 922 <para>Search for the specified pattern in the cache data.</para>
 923
 924 </refsect3>
 925
 926 <refsect3>
 927 <title>CACHE LIST</title>
 928
 929 <para>
 930 List all current items in the cache.
 931 </para>
 932
 933 </refsect3>
 934
 935 <refsect3>
 936 <title>CACHE FLUSH</title>
 937
 938 <para>Remove all the current items from the cache.</para>
 939
 940 </refsect3>
 941
 942 </refsect2>
 943
 944 <refsect2>
 945 <title>GETLOCALSID [DOMAIN]</title>
 946
 947 <para>Prints the SID of the specified domain, or if the parameter is
 948 omitted, the SID of the local server.</para>
 949
 950 </refsect2>
 951
 952 <refsect2>
 953 <title>SETLOCALSID S-1-5-21-x-y-z</title>
 954
 955 <para>Sets SID for the local server to the specified SID.</para>
 956
 957 </refsect2>
 958
 959 <refsect2>
 960 <title>GETDOMAINSID</title>
 961
 962 <para>Prints the local machine SID and the SID of the current
 963 domain.</para>
 964
 965 </refsect2>
 966
 967 <refsect2>
 968 <title>SETDOMAINSID</title>
 969
 970 <para>Sets the SID of the current domain.</para>
 971
 972 </refsect2>
 973
 974 <refsect2>
 975 <title>GROUPMAP</title>
 976
 977 <para>Manage the mappings between Windows group SIDs and UNIX groups.
 978 Common options include:</para>
 979
 980 <itemizedlist>
 981 <listitem><para>unixgroup - Name of the UNIX group</para></listitem>
 982 <listitem><para>ntgroup - Name of the Windows NT group (must be
 983   resolvable to a SID</para></listitem>
 984 <listitem><para>rid - Unsigned 32-bit integer</para></listitem>
 985 <listitem><para>sid - Full SID in the form of "S-1-..."</para></listitem>
 986 <listitem><para>type - Type of the group; either 'domain', 'local',
 987   or 'builtin'</para></listitem>
 988 <listitem><para>comment - Freeform text description of the group</para></listitem>
 989 </itemizedlist>
 990
 991 <refsect3>
 992 <title>GROUPMAP ADD</title>
 993
 994 <para>
 995 Add a new group mapping entry:
 996 <programlisting>
 997 net groupmap add {rid=int|sid=string} unixgroup=string \
 998         [type={domain|local}] [ntgroup=string] [comment=string]
 999 </programlisting>
1000 </para>
1001
1002 </refsect3>
1003
1004 <refsect3>
1005 <title>GROUPMAP DELETE</title>
1006
1007 <para>Delete a group mapping entry. If more than one group name matches, the first entry found is deleted.</para>
1008
1009 <para>net groupmap delete {ntgroup=string|sid=SID}</para>
1010
1011 </refsect3>
1012
1013 <refsect3>
1014 <title>GROUPMAP MODIFY</title>
1015
1016 <para>Update an existing group entry.</para>
1017
1018 <para>
1019 <programlisting>
1020 net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \
1021        [comment=string] [type={domain|local}]
1022 </programlisting>
1023 </para>
1024 </refsect3>
1025
1026 <refsect3>
1027 <title>GROUPMAP LIST</title>
1028
1029 <para>List existing group mapping entries.</para>
1030
1031 <para>net groupmap list [verbose] [ntgroup=string] [sid=SID]</para>
1032
1033 </refsect3>
1034 </refsect2>
1035
1036
1037
1038 <refsect2>
1039 <title>MAXRID</title>
1040
1041 <para>Prints out the highest RID currently in use on the local
1042 server (by the active 'passdb backend').
1043 </para>
1044
1045 </refsect2>
1046
1047 <refsect2>
1048 <title>RPC INFO</title>
1049
1050 <para>Print information about the domain of the remote server,
1051 such as domain name, domain sid and number of users and groups.
1052 </para>
1053
1054 </refsect2>
1055
1056 <refsect2>
1057 <title>[RPC|ADS] TESTJOIN</title>
1058
1059 <para>Check whether participation in a domain is still valid.</para>
1060
1061 </refsect2>
1062
1063 <refsect2>
1064 <title>[RPC|ADS] CHANGETRUSTPW</title>
1065
1066 <para>Force change of domain trust password.</para>
1067
1068 </refsect2>
1069
1070 <refsect2>
1071 <title>RPC TRUSTDOM</title>
1072
1073 <refsect3>
1074 <title>RPC TRUSTDOM ADD <replaceable>DOMAIN</replaceable></title>
1075
1076 <para>Add a interdomain trust account for <replaceable>DOMAIN</replaceable>.
1077 This is in fact a Samba account named <replaceable>DOMAIN$</replaceable>
1078 with the account flag <constant>'I'</constant> (interdomain trust account).
1079 This is required for incoming trusts to work. It makes Samba be a
1080 trusted domain of the foreign (trusting) domain.
1081 Users of the Samba domain will be made available in the foreign domain.
1082 If the command is used against localhost it has the same effect as
1083 <command>smbpasswd -a -i DOMAIN</command>. Please note that both commands
1084 expect a appropriate UNIX account.
1085 </para>
1086
1087 </refsect3>
1088
1089 <refsect3>
1090 <title>RPC TRUSTDOM DEL <replaceable>DOMAIN</replaceable></title>
1091
1092 <para>Remove interdomain trust account for
1093 <replaceable>DOMAIN</replaceable>. If it is used against localhost
1094 it has the same effect as <command>smbpasswd -x DOMAIN$</command>.
1095 </para>
1096
1097 </refsect3>
1098
1099 <refsect3>
1100 <title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title>
1101
1102 <para>
1103 Establish a trust relationship to a trusted domain.
1104 Interdomain account must already be created on the remote PDC.
1105 This is required for outgoing trusts to work. It makes Samba be a
1106 trusting domain of a foreign (trusted) domain.
1107 Users of the foreign domain will be made available in our domain.
1108 You'll need winbind and a working idmap config to make them
1109 appear in your system.
1110 </para>
1111
1112 </refsect3>
1113
1114 <refsect3>
1115 <title>RPC TRUSTDOM REVOKE <replaceable>DOMAIN</replaceable></title>
1116 <para>Abandon relationship to trusted domain</para>
1117
1118 </refsect3>
1119
1120 <refsect3>
1121 <title>RPC TRUSTDOM LIST</title>
1122
1123 <para>List all interdomain trust relationships.</para>
1124
1125 </refsect3>
1126 </refsect2>
1127
1128 <refsect2>
1129 <title>RPC TRUST</title>
1130
1131 <refsect3>
1132 <title>RPC TRUST CREATE</title>
1133
1134 <para>Create a trust object by calling lsaCreateTrustedDomainEx2.
1135 The can be done on a single server or on two servers at once with the
1136 possibility to use a random trust password.</para>
1137
1138 <variablelist><title>Options:</title>
1139 <varlistentry>
1140 <term>otherserver</term>
1141 <listitem><para>Domain controller of the second domain</para></listitem>
1142 </varlistentry>
1143
1144 <varlistentry>
1145 <term>otheruser</term>
1146 <listitem><para>Admin user in the second domain</para></listitem>
1147 </varlistentry>
1148
1149 <varlistentry>
1150 <term>otherdomainsid</term>
1151 <listitem><para>SID of the second domain</para></listitem>
1152 </varlistentry>
1153
1154 <varlistentry>
1155 <term>other_netbios_domain</term>
1156 <listitem><para>NetBIOS (short) name of the second domain</para></listitem>
1157 </varlistentry>
1158
1159 <varlistentry>
1160 <term>otherdomain</term>
1161 <listitem><para>DNS (full) name of the second domain</para></listitem>
1162 </varlistentry>
1163
1164 <varlistentry>
1165 <term>trustpw</term>
1166 <listitem><para>Trust password</para></listitem>
1167 </varlistentry>
1168 </variablelist>
1169
1170 <variablelist><title>Examples:</title>
1171 <varlistentry>
1172 <term>Create a trust object on srv1.dom1.dom for the domain dom2</term>
1173 <listitem><literallayout>
1174 net rpc trust create \
1175     otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
1176     other_netbios_domain=dom2 \
1177     otherdomain=dom2.dom \
1178     trustpw=12345678 \
1179     -S srv1.dom1.dom
1180 </literallayout></listitem>
1181 </varlistentry>
1182 <varlistentry>
1183 <term>Create a trust relationship between dom1 and dom2</term>
1184 <listitem><literallayout>
1185 net rpc trust create \
1186     otherserver=srv2.dom2.test \
1187     otheruser=dom2adm \
1188     -S srv1.dom1.dom
1189 </literallayout></listitem>
1190 </varlistentry>
1191 </variablelist>
1192 </refsect3>
1193
1194 <refsect3>
1195 <title>RPC TRUST DELETE</title>
1196
1197 <para>Delete a trust object by calling lsaDeleteTrustedDomain.
1198 The can be done on a single server or on two servers at once.</para>
1199
1200 <variablelist><title>Options:</title>
1201 <varlistentry>
1202 <term>otherserver</term>
1203 <listitem><para>Domain controller of the second domain</para></listitem>
1204 </varlistentry>
1205
1206 <varlistentry>
1207 <term>otheruser</term>
1208 <listitem><para>Admin user in the second domain</para></listitem>
1209 </varlistentry>
1210
1211 <varlistentry>
1212 <term>otherdomainsid</term>
1213 <listitem><para>SID of the second domain</para></listitem>
1214 </varlistentry>
1215 </variablelist>
1216
1217 <variablelist><title>Examples:</title>
1218 <varlistentry>
1219 <term>Delete a trust object on srv1.dom1.dom for the domain dom2</term>
1220 <listitem><literallayout>
1221 net rpc trust delete \
1222     otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
1223     -S srv1.dom1.dom
1224 </literallayout></listitem>
1225 </varlistentry>
1226 <varlistentry>
1227 <term>Delete a trust relationship between dom1 and dom2</term>
1228 <listitem><literallayout>
1229 net rpc trust delete \
1230     otherserver=srv2.dom2.test \
1231     otheruser=dom2adm \
1232     -S srv1.dom1.dom
1233 </literallayout></listitem>
1234 </varlistentry>
1235 </variablelist>
1236 </refsect3>
1237
1238 </refsect2>
1239
1240 <refsect2>
1241 <refsect3>
1242 <title>RPC RIGHTS</title>
1243
1244 <para>This subcommand is used to view and manage Samba's rights assignments (also
1245 referred to as privileges).  There are three options currently available:
1246 <parameter>list</parameter>, <parameter>grant</parameter>, and
1247 <parameter>revoke</parameter>.  More details on Samba's privilege model and its use
1248 can be found in the Samba-HOWTO-Collection.</para>
1249
1250 </refsect3>
1251
1252
1253 </refsect2>
1254
1255 <refsect2>
1256 <title>RPC ABORTSHUTDOWN</title>
1257
1258 <para>Abort the shutdown of a remote server.</para>
1259
1260 </refsect2>
1261
1262 <refsect2>
1263 <title>RPC SHUTDOWN [-t timeout] [-r] [-f] [-C message]</title>
1264
1265 <para>Shut down the remote server.</para>
1266
1267 <variablelist>
1268 <varlistentry>
1269 <term>-r</term>
1270 <listitem><para>
1271 Reboot after shutdown.
1272 </para></listitem>
1273 </varlistentry>
1274
1275 <varlistentry>
1276 <term>-f</term>
1277 <listitem><para>
1278 Force shutting down all applications.
1279 </para></listitem>
1280 </varlistentry>
1281
1282 <varlistentry>
1283 <term>-t timeout</term>
1284 <listitem><para>
1285 Timeout before system will be shut down. An interactive
1286 user of the system can use this time to cancel the shutdown.
1287 </para></listitem>
1288 </varlistentry>
1289
1290 <varlistentry>
1291 <term>-C message</term>
1292 <listitem><para>Display the specified message on the screen to
1293 announce the shutdown.</para></listitem>
1294 </varlistentry>
1295 </variablelist>
1296
1297 </refsect2>
1298
1299 <refsect2>
1300 <title>RPC SAMDUMP</title>
1301
1302 <para>Print out sam database of remote server. You need
1303 to run this against the PDC, from a Samba machine joined as a BDC. </para>
1304 </refsect2>
1305
1306 <refsect2>
1307 <title>RPC VAMPIRE</title>
1308
1309 <para>Export users, aliases and groups from remote server to
1310 local server.  You need to run this against the PDC, from a Samba machine joined as a BDC.
1311 This vampire command cannot be used against an Active Directory, only
1312 against an NT4 Domain Controller.
1313 </para>
1314 </refsect2>
1315
1316 <refsect2>
1317 <title>RPC VAMPIRE KEYTAB</title>
1318
1319 <para>Dump remote SAM database to local Kerberos keytab file.
1320 </para>
1321 </refsect2>
1322
1323 <refsect2>
1324 <title>RPC VAMPIRE LDIF</title>
1325
1326 <para>Dump remote SAM database to local LDIF file or standard output.
1327 </para>
1328 </refsect2>
1329
1330 <refsect2>
1331 <title>RPC GETSID</title>
1332
1333 <para>Fetch domain SID and store it in the local <filename>secrets.tdb</filename>. </para>
1334
1335 </refsect2>
1336
1337 <refsect2>
1338 <title>ADS LEAVE [--keep-account]</title>
1339
1340 <para>Make the remote host leave the domain it is part of. </para>
1341
1342 </refsect2>
1343
1344 <refsect2>
1345 <title>ADS STATUS</title>
1346
1347 <para>Print out status of machine account of the local machine in ADS.
1348 Prints out quite some debug info. Aimed at developers, regular
1349 users should use <command>NET ADS TESTJOIN</command>.</para>
1350
1351 </refsect2>
1352
1353 <refsect2>
1354 <title>ADS PRINTER</title>
1355
1356 <refsect3>
1357 <title>ADS PRINTER INFO [<replaceable>PRINTER</replaceable>] [<replaceable>SERVER</replaceable>]</title>
1358
1359 <para>
1360 Lookup info for <replaceable>PRINTER</replaceable> on <replaceable>SERVER</replaceable>. The printer name defaults to "*", the
1361 server name defaults to the local host.</para>
1362
1363 </refsect3>
1364
1365 <refsect3>
1366 <title>ADS PRINTER PUBLISH <replaceable>PRINTER</replaceable></title>
1367
1368 <para>Publish specified printer using ADS.</para>
1369
1370 </refsect3>
1371
1372 <refsect3>
1373 <title>ADS PRINTER REMOVE <replaceable>PRINTER</replaceable></title>
1374
1375 <para>Remove specified printer from ADS directory.</para>
1376
1377 </refsect3>
1378
1379 </refsect2>
1380
1381 <refsect2>
1382 <title>ADS SEARCH <replaceable>EXPRESSION</replaceable> <replaceable>ATTRIBUTES...</replaceable></title>
1383
1384 <para>Perform a raw LDAP search on a ADS server and dump the results. The
1385 expression is a standard LDAP search expression, and the
1386 attributes are a list of LDAP fields to show in the results.</para>
1387
1388 <para>Example: <userinput>net ads search '(objectCategory=group)' sAMAccountName</userinput>
1389 </para>
1390
1391 </refsect2>
1392
1393 <refsect2>
1394 <title>ADS DN <replaceable>DN</replaceable> <replaceable>(attributes)</replaceable></title>
1395
1396 <para>
1397 Perform a raw LDAP search on a ADS server and dump the results. The
1398 DN standard LDAP DN, and the attributes are a list of LDAP fields
1399 to show in the result.
1400 </para>
1401
1402 <para>Example: <userinput>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</userinput></para>
1403
1404 </refsect2>
1405
1406 <refsect2>
1407 <title>ADS KEYTAB <replaceable>CREATE</replaceable></title>
1408
1409 <para>
1410 Creates a new keytab file if one doesn't exist with default entries. Default
1411 entries are kerberos principals created from the machinename of the
1412 client, the UPN (if it exists) and any Windows SPN(s) associated with the
1413 computer AD account for the client. If a keytab file already exists then only
1414 missing kerberos principals from the default entries are added. No changes
1415 are made to the computer AD account.
1416 </para>
1417 </refsect2>
1418
1419 <refsect2>
1420 <title>ADS KEYTAB <replaceable>ADD</replaceable> <replaceable>(principal | machine | serviceclass | windows SPN</replaceable></title>
1421
1422 <para>
1423 Adds a new keytab entry, the entry can be either;
1424   <variablelist>
1425     <varlistentry><term>kerberos principal</term>
1426     <listitem><para>
1427       A kerberos principal (identified by the presence of '@') is just
1428       added to the keytab file.
1429     </para></listitem>
1430     </varlistentry>
1431     <varlistentry><term>machinename</term>
1432     <listitem><para>
1433       A machinename (identified by the trailing '$') is used to create a
1434       a kerberos principal 'machinename@realm' which is added to the
1435       keytab file.
1436     </para></listitem>
1437     </varlistentry>
1438     <varlistentry><term>serviceclass</term>
1439     <listitem><para>
1440     A serviceclass (such as 'cifs', 'html' etc.) is used to create a pair
1441     of kerberos principals 'serviceclass/fully_qualified_dns_name@realm' &amp;
1442     'serviceclass/netbios_name@realm' which are added to the keytab file.
1443     </para></listitem>
1444     </varlistentry>
1445     <varlistentry><term>Windows SPN</term>
1446     <listitem><para>
1447     A Windows SPN is of the format 'serviceclass/host:port', it is used to
1448     create a kerberos principal 'serviceclass/host@realm' which will
1449     be written to the keytab file.
1450     </para></listitem>
1451     </varlistentry>
1452   </variablelist>
1453 </para>
1454 <para>
1455 Unlike old versions no computer AD objects are modified by this command. To
1456 preserve the bevhaviour of older clients 'net ads keytab ad_update_ads' is
1457 available.
1458 </para>
1459 </refsect2>
1460
1461 <refsect2>
1462 <title>ADS KEYTAB <replaceable>ADD_UPDATE_ADS</replaceable> <replaceable>(principal | machine | serviceclass | windows SPN</replaceable></title>
1463
1464 <para>
1465 Adds a new keytab entry (see section for net ads keytab add). In addition to
1466 adding entries to the keytab file corrosponding Windows SPNs are created
1467 from the entry passed to this command. These SPN(s) added to the AD computer
1468 account object associated with the client machine running this command for
1469 the following entry types;
1470   <variablelist>
1471     <varlistentry><term>serviceclass</term>
1472     <listitem><para>
1473     A serviceclass (such as 'cifs', 'html' etc.) is used to create a
1474     pair of Windows SPN(s) 'param/full_qualified_dns' &amp;
1475     'param/netbios_name' which are added to the AD computer account object
1476    for this client.
1477     </para></listitem>
1478     </varlistentry>
1479     <varlistentry><term>Windows SPN</term>
1480     <listitem><para>
1481     A Windows SPN is of the format 'serviceclass/host:port', it is
1482     added as passed to the AD computer account object for this client.
1483     </para></listitem>
1484     </varlistentry>
1485   </variablelist>
1486 </para>
1487 </refsect2>
1488
1489 <refsect2>
1490 <title>ADS setspn <replaceable>SETSPN LIST [machine]</replaceable></title>
1491
1492 <para>
1493    Lists the Windows SPNs stored in the 'machine' Windows AD Computer object.
1494    If 'machine' is not specified then computer account for this client is used
1495    instead.
1496 </para>
1497 </refsect2>
1498
1499 <refsect2>
1500 <title>ADS setspn <replaceable>SETSPN ADD SPN [machine]</replaceable></title>
1501
1502 <para>
1503    Adds the specified Windows SPN to the 'machine' Windows AD Computer object.
1504    If 'machine' is not specified then computer account for this client is used
1505    instead.
1506 </para>
1507 </refsect2>
1508
1509
1510 <refsect2>
1511 <title>ADS setspn <replaceable>SETSPN DELETE SPN [machine]</replaceable></title>
1512
1513 <para>
1514    DELETE the specified Window SPN from the 'machine' Windows AD Computer
1515    object. If 'machine' is not specified then computer account for this
1516    client is used
1517    instead.
1518 </para>
1519
1520 </refsect2>
1521
1522 <refsect2>
1523 <title>ADS WORKGROUP</title>
1524
1525 <para>Print out workgroup name for specified kerberos realm.</para>
1526
1527 </refsect2>
1528
1529 <refsect2>
1530         <title>ADS ENCTYPES</title>
1531
1532 <para>
1533         List, modify or delete the value of the "msDS-SupportedEncryptionTypes" attribute of an account in AD.
1534 </para>
1535
1536 <para>
1537         This attribute allows one to control which Kerberos encryption types are used for the generation of initial and service tickets. The value consists of an integer bitmask with the following values:
1538 </para>
1539
1540 <para>0x00000001 DES-CBC-CRC</para>
1541 <para>0x00000002 DES-CBC-MD5</para>
1542 <para>0x00000004 RC4-HMAC</para>
1543 <para>0x00000008 AES128-CTS-HMAC-SHA1-96</para>
1544 <para>0x00000010 AES256-CTS-HMAC-SHA1-96</para>
1545
1546 </refsect2>
1547
1548 <refsect2>
1549         <title>ADS ENCTYPES LIST <replaceable>&lt;ACCOUNTNAME&gt;</replaceable></title>
1550
1551 <para>
1552         List the value of the "msDS-SupportedEncryptionTypes" attribute of a given account.
1553 </para>
1554
1555 <para>Example: <userinput>net ads enctypes list Computername</userinput></para>
1556
1557 </refsect2>
1558
1559 <refsect2>
1560         <title>ADS ENCTYPES SET <replaceable>&lt;ACCOUNTNAME&gt;</replaceable> <replaceable>[enctypes]</replaceable></title>
1561
1562 <para>
1563         Set the value of the "msDS-SupportedEncryptionTypes" attribute of the LDAP object of ACCOUNTNAME to a given value. If the value is omitted, the value is set to 31 which enables all the currently supported encryption types.
1564 </para>
1565
1566 <para>Example: <userinput>net ads enctypes set Computername 24</userinput></para>
1567
1568 </refsect2>
1569
1570 <refsect2>
1571         <title>ADS ENCTYPES DELETE <replaceable>&lt;ACCOUNTNAME&gt;</replaceable></title>
1572
1573 <para>
1574         Deletes the "msDS-SupportedEncryptionTypes" attribute of the LDAP object of ACCOUNTNAME.
1575 </para>
1576
1577 <para>Example: <userinput>net ads enctypes set Computername 24</userinput></para>
1578
1579 </refsect2>
1580
1581
1582 <refsect2>
1583 <title>SAM CREATEBUILTINGROUP &lt;NAME&gt;</title>
1584
1585 <para>
1586 (Re)Create a BUILTIN group.
1587 Only a wellknown set of BUILTIN groups can be created with this command.
1588 This is the list of currently recognized group names: Administrators,
1589 Users, Guests, Power Users, Account Operators, Server Operators, Print
1590 Operators, Backup Operators, Replicator, RAS Servers, Pre-Windows 2000
1591 compatible Access.
1592
1593 This command requires a running Winbindd with idmap allocation properly
1594 configured. The group gid will be allocated out of the winbindd range.
1595 </para>
1596
1597 </refsect2>
1598
1599 <refsect2>
1600 <title>SAM CREATELOCALGROUP &lt;NAME&gt;</title>
1601
1602 <para>
1603 Create a LOCAL group (also known as Alias).
1604
1605 This command requires a running Winbindd with idmap allocation properly
1606 configured. The group gid will be allocated out of the winbindd range.
1607 </para>
1608
1609 </refsect2>
1610
1611 <refsect2>
1612 <title>SAM DELETELOCALGROUP &lt;NAME&gt;</title>
1613
1614 <para>
1615 Delete an existing LOCAL group (also known as Alias).
1616
1617 </para>
1618
1619 </refsect2>
1620
1621 <refsect2>
1622 <title>SAM MAPUNIXGROUP &lt;NAME&gt;</title>
1623
1624 <para>
1625 Map an existing Unix group and make it a Domain Group, the domain group
1626 will have the same name.
1627 </para>
1628
1629 </refsect2>
1630
1631 <refsect2>
1632 <title>SAM UNMAPUNIXGROUP &lt;NAME&gt;</title>
1633
1634 <para>
1635 Remove an existing group mapping entry.
1636 </para>
1637
1638 </refsect2>
1639
1640 <refsect2>
1641 <title>SAM ADDMEM &lt;GROUP&gt; &lt;MEMBER&gt;</title>
1642
1643 <para>
1644 Add a member to a Local group. The group can be specified only by name,
1645 the member can be specified by name or SID.
1646 </para>
1647
1648 </refsect2>
1649
1650 <refsect2>
1651 <title>SAM DELMEM  &lt;GROUP&gt; &lt;MEMBER&gt;</title>
1652
1653 <para>
1654 Remove a member from a Local group. The group and the member must be
1655 specified by name.
1656 </para>
1657
1658 </refsect2>
1659
1660 <refsect2>
1661 <title>SAM LISTMEM &lt;GROUP&gt;</title>
1662
1663 <para>
1664 List Local group members. The group must be specified by name.
1665 </para>
1666
1667 </refsect2>
1668
1669 <refsect2>
1670 <title>SAM LIST &lt;users|groups|localgroups|builtin|workstations&gt; [verbose]</title>
1671
1672 <para>
1673 List the specified set of accounts by name. If verbose is specified,
1674 the rid and description is also provided for each account.
1675 </para>
1676
1677 </refsect2>
1678
1679 <refsect2>
1680 <title>SAM RIGHTS LIST</title>
1681
1682 <para>
1683 List all available privileges.
1684 </para>
1685
1686 </refsect2>
1687
1688 <refsect2>
1689 <title>SAM RIGHTS GRANT &lt;NAME&gt; &lt;PRIVILEGE&gt;</title>
1690
1691 <para>
1692 Grant one or more privileges to a user.
1693 </para>
1694
1695 </refsect2>
1696
1697 <refsect2>
1698 <title>SAM RIGHTS REVOKE &lt;NAME&gt; &lt;PRIVILEGE&gt;</title>
1699
1700 <para>
1701 Revoke one or more privileges from a user.
1702 </para>
1703
1704 </refsect2>
1705
1706 <refsect2>
1707 <title>SAM SHOW &lt;NAME&gt;</title>
1708
1709 <para>
1710 Show the full DOMAIN\\NAME the SID and the type for the corresponding
1711 account.
1712 </para>
1713
1714 </refsect2>
1715
1716 <refsect2>
1717 <title>SAM SET HOMEDIR &lt;NAME&gt; &lt;DIRECTORY&gt;</title>
1718
1719 <para>
1720 Set the home directory for a user account.
1721 </para>
1722
1723 </refsect2>
1724
1725 <refsect2>
1726 <title>SAM SET PROFILEPATH &lt;NAME&gt; &lt;PATH&gt;</title>
1727
1728 <para>
1729 Set the profile path for a user account.
1730 </para>
1731
1732 </refsect2>
1733
1734 <refsect2>
1735 <title>SAM SET COMMENT &lt;NAME&gt; &lt;COMMENT&gt;</title>
1736
1737 <para>
1738 Set the comment for a user or group account.
1739 </para>
1740
1741 </refsect2>
1742
1743 <refsect2>
1744 <title>SAM SET FULLNAME &lt;NAME&gt; &lt;FULL NAME&gt;</title>
1745
1746 <para>
1747 Set the full name for a user account.
1748 </para>
1749
1750 </refsect2>
1751
1752 <refsect2>
1753 <title>SAM SET LOGONSCRIPT &lt;NAME&gt; &lt;SCRIPT&gt;</title>
1754
1755 <para>
1756 Set the logon script for a user account.
1757 </para>
1758
1759 </refsect2>
1760
1761 <refsect2>
1762 <title>SAM SET HOMEDRIVE &lt;NAME&gt; &lt;DRIVE&gt;</title>
1763
1764 <para>
1765 Set the home drive for a user account.
1766 </para>
1767
1768 </refsect2>
1769
1770 <refsect2>
1771 <title>SAM SET WORKSTATIONS &lt;NAME&gt; &lt;WORKSTATIONS&gt;</title>
1772
1773 <para>
1774 Set the workstations a user account is allowed to log in from.
1775 </para>
1776
1777 </refsect2>
1778
1779 <refsect2>
1780 <title>SAM SET DISABLE &lt;NAME&gt;</title>
1781
1782 <para>
1783 Set the "disabled" flag for a user account.
1784 </para>
1785
1786 </refsect2>
1787
1788 <refsect2>
1789 <title>SAM SET PWNOTREQ &lt;NAME&gt;</title>
1790
1791 <para>
1792 Set the "password not required" flag for a user account.
1793 </para>
1794
1795 </refsect2>
1796
1797 <refsect2>
1798 <title>SAM SET AUTOLOCK &lt;NAME&gt;</title>
1799
1800 <para>
1801 Set the "autolock" flag for a user account.
1802 </para>
1803
1804 </refsect2>
1805
1806 <refsect2>
1807 <title>SAM SET PWNOEXP &lt;NAME&gt;</title>
1808
1809 <para>
1810 Set the "password do not expire" flag for a user account.
1811 </para>
1812
1813 </refsect2>
1814
1815 <refsect2>
1816 <title>SAM SET PWDMUSTCHANGENOW &lt;NAME&gt; [yes|no]</title>
1817
1818 <para>
1819 Set or unset the "password must change" flag for a user account.
1820 </para>
1821
1822 </refsect2>
1823
1824 <refsect2>
1825 <title>SAM POLICY LIST</title>
1826
1827 <para>
1828 List the available account policies.
1829 </para>
1830
1831 </refsect2>
1832
1833 <refsect2>
1834 <title>SAM POLICY SHOW &lt;account policy&gt;</title>
1835
1836 <para>
1837 Show the account policy value.
1838 </para>
1839
1840 </refsect2>
1841
1842 <refsect2>
1843 <title>SAM POLICY SET &lt;account policy&gt; &lt;value&gt;</title>
1844
1845 <para>
1846 Set a value for the account policy.
1847 Valid values can be: "forever", "never", "off", or a number.
1848 </para>
1849
1850 </refsect2>
1851
1852 <refsect2>
1853 <title>SAM PROVISION</title>
1854
1855 <para>
1856 Only available if ldapsam:editposix is set and winbindd is running.
1857 Properly populates the ldap tree with the basic accounts (Administrator)
1858 and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree.
1859 </para>
1860
1861 </refsect2>
1862
1863 <refsect2>
1864 <title>IDMAP DUMP &lt;local tdb file name&gt;</title>
1865
1866 <para>
1867 Dumps the mappings contained in the local tdb file specified.
1868 This command is useful to dump only the mappings produced by the idmap_tdb backend.
1869 </para>
1870
1871 </refsect2>
1872
1873 <refsect2>
1874 <title>IDMAP RESTORE [input file]</title>
1875
1876 <para>
1877 Restore the mappings from the specified file or stdin.
1878 </para>
1879
1880 </refsect2>
1881
1882 <refsect2>
1883 <title>IDMAP SET SECRET &lt;DOMAIN&gt; &lt;secret&gt;</title>
1884
1885 <para>
1886 Store a secret for the specified domain, used primarily for domains
1887 that use idmap_ldap as a backend. In this case the secret is used
1888 as the password for the user DN used to bind to the ldap server.
1889 </para>
1890
1891 </refsect2>
1892
1893 <refsect2>
1894 <title>IDMAP SET RANGE &lt;RANGE&gt; &lt;SID&gt; [index] [--db=&lt;DB&gt;]</title>
1895
1896 <para>
1897 Store a domain-range mapping for a given domain (and index) in autorid database.
1898 </para>
1899
1900 </refsect2>
1901
1902 <refsect2>
1903 <title>IDMAP SET CONFIG &lt;config&gt; [--db=&lt;DB&gt;]</title>
1904
1905 <para>
1906 Update CONFIG entry in autorid database.
1907 </para>
1908
1909 </refsect2>
1910
1911 <refsect2>
1912 <title>IDMAP GET RANGE &lt;SID&gt; [index] [--db=&lt;DB&gt;]</title>
1913
1914 <para>
1915 Get the range for a given domain and index from autorid database.
1916 </para>
1917
1918 </refsect2>
1919
1920 <refsect2>
1921 <title>IDMAP GET RANGES [&lt;SID&gt;] [--db=&lt;DB&gt;]</title>
1922
1923 <para>
1924 Get ranges for all domains or for one identified by given SID.
1925 </para>
1926
1927 </refsect2>
1928
1929 <refsect2>
1930 <title>IDMAP GET CONFIG [--db=&lt;DB&gt;]</title>
1931
1932 <para>
1933 Get CONFIG entry from autorid database.
1934 </para>
1935
1936 </refsect2>
1937
1938 <refsect2>
1939
1940 <title>IDMAP DELETE MAPPING [-f] [--db=&lt;DB&gt;] &lt;ID&gt;</title>
1941
1942 <para>
1943 Delete a mapping sid &lt;-&gt; gid or sid &lt;-&gt; uid from the IDMAP database.
1944 The mapping is given by &lt;ID&gt; which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
1945 Use -f to delete an invalid partial mapping &lt;ID&gt; -&gt; xx
1946 </para>
1947 <para>
1948   Use "smbcontrol all idmap ..." to notify running smbd instances.
1949   See the <citerefentry><refentrytitle>smbcontrol</refentrytitle>
1950   <manvolnum>1</manvolnum></citerefentry> manpage for details.
1951 </para>
1952 </refsect2>
1953
1954 <refsect2>
1955 <title>IDMAP DELETE RANGE [-f] [--db=&lt;TDB&gt;] &lt;RANGE&gt;|(&lt;SID&gt; [&lt;INDEX&gt;])</title>
1956
1957 <para>
1958 Delete a domain range mapping identified by 'RANGE' or "domain SID and INDEX" from autorid database.
1959 Use -f to delete invalid mappings.
1960 </para>
1961
1962 </refsect2>
1963
1964 <refsect2>
1965 <title>IDMAP DELETE RANGES [-f] [--db=&lt;TDB&gt;] &lt;SID&gt;</title>
1966
1967 <para>
1968 Delete all domain range mappings for a domain identified by SID.
1969 Use -f to delete invalid mappings.
1970 </para>
1971
1972 </refsect2>
1973
1974 <refsect2>
1975
1976 <title>IDMAP CHECK [-v] [-r] [-a] [-T] [-f] [-l] [--db=&lt;DB&gt;]</title>
1977
1978 <para>
1979   Check and repair the IDMAP database. If no option is given a read only check
1980   of the database is done. Among others an interactive or automatic repair mode
1981   may be chosen with one of the following options:
1982
1983   <variablelist>
1984     <varlistentry><term>-r|--repair</term>
1985     <listitem><para>
1986       Interactive repair mode, ask a lot of questions.
1987     </para></listitem>
1988     </varlistentry>
1989
1990     <varlistentry><term>-a|--auto</term>
1991     <listitem><para>
1992       Noninteractive repair mode, use default answers.
1993     </para></listitem>
1994     </varlistentry>
1995
1996     <varlistentry><term>-v|--verbose</term>
1997       <listitem><para>
1998         Produce more output.
1999       </para></listitem>
2000     </varlistentry>
2001
2002     <varlistentry><term>-f|--force</term>
2003       <listitem><para>
2004         Try to apply changes, even if they do not apply cleanly.
2005       </para></listitem>
2006     </varlistentry>
2007
2008     <varlistentry><term>-T|--test</term>
2009       <listitem><para>
2010         Dry run, show what changes would be made but don't touch anything.
2011       </para></listitem>
2012     </varlistentry>
2013
2014     <varlistentry><term>-l|--lock</term>
2015       <listitem><para>
2016         Lock the database while doing the check.
2017       </para></listitem>
2018     </varlistentry>
2019
2020     <varlistentry><term>--db &lt;DB&gt;</term>
2021       <listitem><para>
2022         Check the specified database.
2023       </para></listitem>
2024     </varlistentry>
2025     <varlistentry><term></term>
2026       <listitem><para>
2027       </para></listitem>
2028     </varlistentry>
2029   </variablelist>
2030
2031   It reports about the finding of the following errors:
2032
2033   <variablelist>
2034     <varlistentry><term>Missing reverse mapping:</term>
2035     <listitem><para>
2036       A record with mapping A-&gt;B where there is no B-&gt;A. Default action
2037       in repair mode is to "fix" this by adding the reverse mapping.
2038     </para></listitem>
2039     </varlistentry>
2040
2041     <varlistentry><term>Invalid mapping:</term>
2042     <listitem><para>
2043       A record with mapping A-&gt;B where B-&gt;C. Default action
2044       is to "delete" this record.
2045     </para></listitem>
2046   </varlistentry>
2047
2048   <varlistentry><term>Missing or invalid HWM:</term>
2049     <listitem><para>
2050       A high water mark is not at least equal to the largest ID in the
2051       database. Default action is to "fix" this by setting it to the
2052       largest ID found +1.
2053     </para></listitem>
2054   </varlistentry>
2055
2056   <varlistentry><term>Invalid record:</term>
2057     <listitem><para>
2058       Something we failed to parse. Default action is to "edit" it
2059       in interactive and "delete" it in automatic mode.
2060     </para></listitem>
2061   </varlistentry>
2062 </variablelist>
2063 </para>
2064 </refsect2>
2065
2066
2067 <refsect2>
2068 <title>USERSHARE</title>
2069
2070 <para>Starting with version 3.0.23, a Samba server now supports the ability for
2071 non-root users to add user defined shares to be exported using the "net usershare"
2072 commands.
2073 </para>
2074
2075 <para>
2076 To set this up, first set up your smb.conf by adding to the [global] section:
2077
2078 usershare path = /usr/local/samba/lib/usershares
2079
2080 Next create the directory /usr/local/samba/lib/usershares, change the owner to root and
2081 set the group owner to the UNIX group who should have the ability to create usershares,
2082 for example a group called "serverops".
2083
2084 Set the permissions on /usr/local/samba/lib/usershares to 01770.
2085
2086 (Owner and group all access, no access for others, plus the sticky bit,
2087 which means that a file in that directory can be renamed or deleted only
2088 by the owner of the file).
2089
2090 Finally, tell smbd how many usershares you will allow by adding to the [global]
2091 section of smb.conf a line such as :
2092
2093 usershare max shares = 100.
2094
2095 To allow 100 usershare definitions. Now, members of the UNIX group "serverops"
2096 can create user defined shares on demand using the commands below.
2097 </para>
2098
2099 <para>The usershare commands are:
2100
2101 <simplelist>
2102 <member>net usershare add sharename path [comment [acl] [guest_ok=[y|n]]] - to add or change a user defined share.</member>
2103 <member>net usershare delete sharename - to delete a user defined share.</member>
2104 <member>net usershare info [-l|--long] [wildcard sharename] - to print info about a user defined share.</member>
2105 <member>net usershare list [-l|--long] [wildcard sharename] - to list user defined shares.</member>
2106 </simplelist>
2107
2108 </para>
2109
2110 <refsect3>
2111 <title>USERSHARE ADD <replaceable>sharename</replaceable> <replaceable>path</replaceable> <replaceable>[comment]</replaceable> <replaceable>[acl]</replaceable> <replaceable>[guest_ok=[y|n]]</replaceable></title>
2112
2113 <para>
2114 Add or replace a new user defined share, with name "sharename".
2115 </para>
2116
2117 <para>
2118 "path" specifies the absolute pathname on the system to be exported.
2119 Restrictions may be put on this, see the global smb.conf parameters:
2120 "usershare owner only", "usershare prefix allow list", and
2121 "usershare prefix deny list".
2122 </para>
2123
2124 <para>
2125 The optional "comment" parameter is the comment that will appear
2126 on the share when browsed to by a client.
2127 </para>
2128
2129 <para>The optional "acl" field
2130 specifies which users have read and write access to the entire share.
2131 Note that guest connections are not allowed unless the smb.conf parameter
2132 "usershare allow guests" has been set. The definition of a user
2133 defined share acl is: "user:permission", where user is a valid
2134 username on the system and permission can be "F", "R", or "D".
2135 "F" stands for "full permissions", ie. read and write permissions.
2136 "D" stands for "deny" for a user, ie. prevent this user from accessing
2137 this share.
2138 "R" stands for "read only", ie. only allow read access to this
2139 share (no creation of new files or directories or writing to files).
2140 </para>
2141
2142 <para>
2143 The default if no "acl" is given is "Everyone:R", which means any
2144 authenticated user has read-only access.
2145 </para>
2146
2147 <para>
2148 The optional "guest_ok" has the same effect as the parameter of the
2149 same name in smb.conf, in that it allows guest access to this user
2150 defined share. This parameter is only allowed if the global parameter
2151 "usershare allow guests" has been set to true in the smb.conf.
2152 </para>
2153
2154 There is no separate command to modify an existing user defined share,
2155 just use the "net usershare add [sharename]" command using the same
2156 sharename as the one you wish to modify and specify the new options
2157 you wish. The Samba smbd daemon notices user defined share modifications
2158 at connect time so will see the change immediately, there is no need
2159 to restart smbd on adding, deleting or changing a user defined share.
2160 </refsect3>
2161
2162 <refsect3>
2163 <title>USERSHARE DELETE <replaceable>sharename</replaceable></title>
2164
2165 <para>
2166 Deletes the user defined share by name. The Samba smbd daemon
2167 immediately notices this change, although it will not disconnect
2168 any users currently connected to the deleted share.
2169 </para>
2170
2171 </refsect3>
2172
2173 <refsect3>
2174 <title>USERSHARE INFO <replaceable>[-l|--long]</replaceable> <replaceable>[wildcard sharename]</replaceable></title>
2175
2176 <para>
2177 Get info on user defined shares owned by the current user matching the given pattern, or all users.
2178 </para>
2179
2180 <para>
2181 net usershare info on its own dumps out info on the user defined shares that were
2182 created by the current user, or restricts them to share names that match the given
2183 wildcard pattern ('*' matches one or more characters, '?' matches only one character).
2184 If the '-l' or '--long' option is also given, it prints out info on user defined
2185 shares created by other users.
2186 </para>
2187
2188 <para>
2189 The information given about a share looks like:
2190
2191 [foobar]
2192 path=/home/jeremy
2193 comment=testme
2194 usershare_acl=Everyone:F
2195 guest_ok=n
2196
2197 And is a list of the current settings of the user defined share that can be
2198 modified by the "net usershare add" command.
2199 </para>
2200
2201 </refsect3>
2202
2203 <refsect3>
2204 <title>USERSHARE LIST <replaceable>[-l|--long]</replaceable> <replaceable>wildcard sharename</replaceable></title>
2205
2206 <para>
2207 List all the user defined shares owned by the current user matching the given pattern, or all users.
2208 </para>
2209
2210 <para>
2211 net usershare list on its own list out the names of the user defined shares that were
2212 created by the current user, or restricts the list to share names that match the given
2213 wildcard pattern ('*' matches one or more characters, '?' matches only one character).
2214 If the '-l' or '--long' option is also given, it includes the names of user defined
2215 shares created by other users.
2216 </para>
2217
2218 </refsect3>
2219
2220 </refsect2>
2221
2222 <refsect2>
2223 <title>[RPC] CONF</title>
2224
2225 <para>Starting with version 3.2.0, a Samba server can be configured by data
2226 stored in registry. This configuration data can be edited with the new "net
2227 conf" commands. There is also the possibility to configure a remote Samba server
2228 by enabling the RPC conf mode and specifying the address of the remote server.
2229 </para>
2230
2231 <para>
2232 The deployment of this configuration data can be activated in two levels from the
2233 <emphasis>smb.conf</emphasis> file: Share definitions from registry are
2234 activated by setting <parameter>registry shares</parameter> to
2235 <quote>yes</quote> in the [global] section and global configuration options are
2236 activated by setting <smbconfoption name="include">registry</smbconfoption> in
2237 the [global] section for a mixed configuration or by setting
2238 <smbconfoption name="config backend">registry</smbconfoption> in the [global]
2239 section for a registry-only configuration.
2240 See the <citerefentry><refentrytitle>smb.conf</refentrytitle>
2241 <manvolnum>5</manvolnum></citerefentry> manpage for details.
2242 </para>
2243
2244 <para>The conf commands are:
2245 <simplelist>
2246 <member>net [rpc] conf list - Dump the complete configuration in smb.conf like
2247 format.</member>
2248 <member>net [rpc] conf import - Import configuration from file in smb.conf
2249 format.</member>
2250 <member>net [rpc] conf listshares - List the registry shares.</member>
2251 <member>net [rpc] conf drop - Delete the complete configuration from
2252 registry.</member>
2253 <member>net [rpc] conf showshare - Show the definition of a registry share.</member>
2254 <member>net [rpc] conf addshare - Create a new registry share.</member>
2255 <member>net [rpc] conf delshare - Delete a registry share.</member>
2256 <member>net [rpc] conf setparm - Store a parameter.</member>
2257 <member>net [rpc] conf getparm - Retrieve the value of a parameter.</member>
2258 <member>net [rpc] conf delparm - Delete a parameter.</member>
2259 <member>net [rpc] conf getincludes - Show the includes of a share definition.</member>
2260 <member>net [rpc] conf setincludes - Set includes for a share.</member>
2261 <member>net [rpc] conf delincludes - Delete includes from a share definition.</member>
2262 </simplelist>
2263 </para>
2264
2265 <refsect3>
2266 <title>[RPC] CONF LIST</title>
2267
2268 <para>
2269 Print the configuration data stored in the registry in a smb.conf-like format to
2270 standard output.
2271 </para>
2272 </refsect3>
2273
2274 <refsect3>
2275 <title>[RPC] CONF IMPORT <replaceable>[--test|-T]</replaceable> <replaceable>filename</replaceable> <replaceable>[section]</replaceable></title>
2276
2277 <para>
2278 This command imports configuration from a file in smb.conf format.
2279 If a section encountered in the input file is present in registry,
2280 its contents is replaced. Sections of registry configuration that have
2281 no counterpart in the input file are not affected. If you want to delete these,
2282 you will have to use the "net conf drop" or "net conf delshare" commands.
2283 Optionally, a section may be specified to restrict the effect of the
2284 import command to that specific section. A test mode is enabled by specifying
2285 the parameter "-T" on the commandline. In test mode, no changes are made to the
2286 registry, and the resulting configuration is printed to standard output instead.
2287 </para>
2288 </refsect3>
2289
2290 <refsect3>
2291 <title>[RPC] CONF LISTSHARES</title>
2292
2293 <para>
2294 List the names of the shares defined in registry.
2295 </para>
2296 </refsect3>
2297
2298 <refsect3>
2299 <title>[RPC] CONF DROP</title>
2300
2301 <para>
2302 Delete the complete configuration data from registry.
2303 </para>
2304 </refsect3>
2305
2306 <refsect3>
2307 <title>[RPC] CONF SHOWSHARE <replaceable>sharename</replaceable></title>
2308
2309 <para>
2310 Show the definition of the share or section specified. It is valid to specify
2311 "global" as sharename to retrieve the global configuration options from
2312 registry.
2313 </para>
2314 </refsect3>
2315
2316 <refsect3>
2317 <title>[RPC] CONF ADDSHARE <replaceable>sharename</replaceable> <replaceable>path</replaceable> [<replaceable>writeable={y|N}</replaceable> [<replaceable>guest_ok={y|N}</replaceable> [<replaceable>comment</replaceable>]]] </title>
2318
2319 <para>Create a new share definition in registry.
2320 The sharename and path have to be given. The share name may
2321 <emphasis>not</emphasis> be "global". Optionally, values for the very
2322 common options "writeable", "guest ok" and a "comment" may be specified.
2323 The same result may be obtained by a sequence of "net conf setparm"
2324 commands.
2325 </para>
2326 </refsect3>
2327
2328 <refsect3>
2329 <title>[RPC] CONF DELSHARE <replaceable>sharename</replaceable></title>
2330
2331 <para>
2332 Delete a share definition from registry.
2333 </para>
2334 </refsect3>
2335
2336 <refsect3>
2337 <title>[RPC] CONF SETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> <replaceable>value</replaceable></title>
2338
2339 <para>
2340 Store a parameter in registry. The section may be global or a sharename.
2341 The section is created if it does not exist yet.
2342 </para>
2343 </refsect3>
2344
2345 <refsect3>
2346 <title>[RPC] CONF GETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
2347
2348 <para>
2349 Show a parameter stored in registry.
2350 </para>
2351 </refsect3>
2352
2353 <refsect3>
2354 <title>[RPC] CONF DELPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
2355
2356 <para>
2357 Delete a parameter stored in registry.
2358 </para>
2359 </refsect3>
2360
2361 <refsect3>
2362 <title>[RPC] CONF GETINCLUDES <replaceable>section</replaceable></title>
2363
2364 <para>
2365 Get the list of includes for the provided section (global or share).
2366 </para>
2367
2368 <para>
2369 Note that due to the nature of the registry database and the nature of include directives,
2370 the includes need special treatment: Parameters are stored in registry by the parameter
2371 name as valuename, so there is only ever one instance of a parameter per share.
2372 Also, a specific order like in a text file is not guaranteed. For all real
2373 parameters, this is perfectly ok, but the include directive is rather a meta
2374 parameter, for which, in the smb.conf text file, the place where it is specified
2375 between the other parameters is very important. This can not be achieved by the
2376 simple registry smbconf data model, so there is one ordered list of includes
2377 per share, and this list is evaluated after all the parameters of the share.
2378 </para>
2379
2380 <para>
2381 Further note that currently, only files can be included from registry
2382 configuration. In the future, there will be the ability to include configuration
2383 data from other registry keys.
2384 </para>
2385 </refsect3>
2386
2387 <refsect3>
2388 <title>[RPC] CONF SETINCLUDES <replaceable>section</replaceable> [<replaceable>filename</replaceable>]+</title>
2389
2390 <para>
2391 Set the list of includes for the provided section (global or share) to the given
2392 list of one or more filenames. The filenames may contain the usual smb.conf
2393 macros like %I.
2394 </para>
2395 </refsect3>
2396
2397 <refsect3>
2398 <title>[RPC] CONF DELINCLUDES <replaceable>section</replaceable></title>
2399
2400 <para>
2401 Delete the list of includes from the provided section (global or share).
2402 </para>
2403 </refsect3>
2404
2405 </refsect2>
2406
2407 <refsect2>
2408 <title>REGISTRY</title>
2409 <para>
2410 Manipulate Samba's registry.
2411 </para>
2412
2413 <para>The registry commands are:
2414 <simplelist>
2415 <member>net registry enumerate   - Enumerate registry keys and values.</member>
2416 <member>net registry enumerate_recursive - Enumerate registry key and its subkeys.</member>
2417 <member>net registry createkey   - Create a new registry key.</member>
2418 <member>net registry deletekey   - Delete a registry key.</member>
2419 <member>net registry deletekey_recursive - Delete a registry key with subkeys.</member>
2420 <member>net registry getvalue    - Print a registry value.</member>
2421 <member>net registry getvalueraw - Print a registry value (raw format).</member>
2422 <member>net registry setvalue    - Set a new registry value.</member>
2423 <member>net registry increment   - Increment a DWORD registry value under a lock.
2424 </member>
2425 <member>net registry deletevalue - Delete a registry value.</member>
2426 <member>net registry getsd       - Get security descriptor.</member>
2427 <member>net registry getsd_sdd1  - Get security descriptor in sddl format.
2428 </member>
2429 <member>net registry setsd_sdd1  - Set security descriptor from sddl format
2430 string.</member>
2431 <member>net registry import      - Import a registration entries (.reg) file.
2432 </member>
2433 <member>net registry export      - Export a registration entries (.reg) file.
2434 </member>
2435 <member>net registry convert     - Convert a registration entries (.reg) file.
2436 </member>
2437 <member>net registry check       - Check and repair a registry database.
2438 </member>
2439 </simplelist>
2440 </para>
2441
2442 <refsect3>
2443   <title>REGISTRY ENUMERATE <replaceable>key</replaceable> </title>
2444   <para>Enumerate subkeys and values of <emphasis>key</emphasis>.
2445   </para>
2446 </refsect3>
2447
2448 <refsect3>
2449   <title>REGISTRY ENUMERATE_RECURSIVE <replaceable>key</replaceable> </title>
2450   <para>Enumerate values of <emphasis>key</emphasis> and its subkeys.
2451   </para>
2452 </refsect3>
2453
2454 <refsect3>
2455   <title>REGISTRY CREATEKEY <replaceable>key</replaceable> </title>
2456   <para>Create a new <emphasis>key</emphasis> if not yet existing.
2457   </para>
2458 </refsect3>
2459
2460 <refsect3>
2461   <title>REGISTRY DELETEKEY <replaceable>key</replaceable> </title>
2462   <para>Delete the given <emphasis>key</emphasis> and its
2463   values from the registry, if it has no subkeys.
2464   </para>
2465 </refsect3>
2466
2467 <refsect3>
2468   <title>REGISTRY DELETEKEY_RECURSIVE <replaceable>key</replaceable> </title>
2469   <para>Delete the given <emphasis>key</emphasis> and all of its
2470   subkeys and values from the registry.
2471   </para>
2472 </refsect3>
2473
2474 <refsect3>
2475   <title>REGISTRY GETVALUE <replaceable>key</replaceable> <!--
2476   --><replaceable>name</replaceable></title>
2477
2478   <para>Output type and actual value of the value <emphasis>name</emphasis>
2479   of the given <emphasis>key</emphasis>.
2480   </para>
2481 </refsect3>
2482
2483 <refsect3>
2484   <title>REGISTRY GETVALUERAW <replaceable>key</replaceable> <!--
2485   --><replaceable>name</replaceable></title>
2486   <para>Output the actual value of the value <emphasis>name</emphasis>
2487   of the given <emphasis>key</emphasis>.
2488   </para>
2489 </refsect3>
2490
2491 <refsect3>
2492   <title>REGISTRY SETVALUE <replaceable>key</replaceable> <!--
2493   --><replaceable>name</replaceable> <replaceable>type</replaceable> <!--
2494   --><replaceable>value</replaceable> ...<!--
2495   --></title>
2496
2497   <para>Set the value <emphasis>name</emphasis>
2498   of an existing <emphasis>key</emphasis>.
2499   <emphasis>type</emphasis> may be one of
2500   <emphasis>sz</emphasis>, <emphasis>multi_sz</emphasis> or
2501   <emphasis>dword</emphasis>.
2502   In case of <emphasis>multi_sz</emphasis> <replaceable>value</replaceable> may
2503   be given multiple times.
2504   </para>
2505 </refsect3>
2506
2507 <refsect3>
2508   <title>REGISTRY INCREMENT <replaceable>key</replaceable> <!--
2509   --><replaceable>name</replaceable> <replaceable>[inc]</replaceable><!--
2510   --></title>
2511
2512   <para>Increment the DWORD value <emphasis>name</emphasis>
2513   of <emphasis>key</emphasis> by <replaceable>inc</replaceable>
2514   while holding a g_lock.
2515   <emphasis>inc</emphasis> defaults to 1.
2516   </para>
2517 </refsect3>
2518
2519 <refsect3>
2520   <title>REGISTRY DELETEVALUE <replaceable>key</replaceable> <!--
2521   --><replaceable>name</replaceable></title>
2522
2523   <para>Delete the value <emphasis>name</emphasis>
2524   of the given <emphasis>key</emphasis>.
2525   </para>
2526 </refsect3>
2527
2528 <refsect3>
2529   <title>REGISTRY GETSD <replaceable>key</replaceable></title>
2530
2531   <para>Get the security descriptor of the given <emphasis>key</emphasis>.
2532   </para>
2533 </refsect3>
2534
2535 <refsect3>
2536   <title>REGISTRY GETSD_SDDL <replaceable>key</replaceable></title>
2537
2538   <para>Get the security descriptor of the given <emphasis>key</emphasis> as a
2539   Security Descriptor Definition Language (SDDL) string.
2540   </para>
2541 </refsect3>
2542
2543 <refsect3>
2544   <title>REGISTRY SETSD_SDDL <replaceable>key</replaceable><!--
2545   --><replaceable>sd</replaceable></title>
2546
2547   <para>Set the security descriptor of the given <emphasis>key</emphasis> from a
2548   Security Descriptor Definition Language (SDDL) string <emphasis>sd</emphasis>.
2549   </para>
2550 </refsect3>
2551
2552 <refsect3>
2553   <title>REGISTRY IMPORT <replaceable>file</replaceable><!--
2554   --><replaceable> [--precheck &lt;check-file&gt;] [opt]</replaceable></title>
2555   <para>Import a registration entries (.reg) <emphasis>file</emphasis>.</para>
2556   <para>The following options are available:</para>
2557   <variablelist>
2558     <varlistentry><term>--precheck <replaceable>check-file</replaceable></term>
2559     <listitem><para>
2560       This is a mechanism to check the existence or non-existence of
2561       certain keys or values specified in a precheck file before applying
2562       the import file.
2563       The import file will only be applied if the precheck succeeds.
2564     </para>
2565     <para>
2566       The check-file follows the normal registry file syntax with the
2567       following semantics:
2568     </para>
2569       <itemizedlist>
2570         <listitem><para>&lt;value name&gt;=&lt;value&gt; checks whether the
2571           value exists and has the given value.</para></listitem>
2572         <listitem><para>&lt;value name&gt;=- checks whether the value does
2573           not exist.</para></listitem>
2574         <listitem><para>[key] checks whether the key exists.</para>
2575         </listitem>
2576         <listitem><para>[-key] checks whether the key does not exist.</para>
2577         </listitem>
2578       </itemizedlist>
2579     </listitem>
2580     </varlistentry>
2581   </variablelist>
2582 </refsect3>
2583
2584 <refsect3>
2585   <title>REGISTRY EXPORT <replaceable>key</replaceable><!--
2586   --><replaceable>file</replaceable><!--
2587   --><replaceable>[opt]</replaceable></title>
2588
2589   <para>Export a <emphasis>key</emphasis> to a registration entries (.reg)
2590   <emphasis>file</emphasis>.
2591   </para>
2592 </refsect3>
2593
2594 <refsect3>
2595   <title>REGISTRY CONVERT <replaceable>in</replaceable> <!--
2596   --><replaceable>out</replaceable> <!--
2597   --><replaceable>[[inopt] outopt]</replaceable></title>
2598
2599   <para>Convert a registration entries (.reg) file <emphasis>in</emphasis>.
2600   </para>
2601 </refsect3>
2602
2603 <refsect3>
2604   <title>REGISTRY CHECK [-ravTl] [-o &lt;ODB&gt;] [--wipe] [&lt;DB&gt;]</title>
2605   <para>Check and repair the registry database. If no option is given a read only check of the database is done. Among others an interactive or automatic repair mode may be chosen with one of the following options
2606
2607   <variablelist>
2608     <varlistentry><term>-r|--repair</term>
2609     <listitem><para>
2610       Interactive repair mode, ask a lot of questions.
2611     </para></listitem>
2612     </varlistentry>
2613
2614     <varlistentry><term>-a|--auto</term>
2615     <listitem><para>
2616       Noninteractive repair mode, use default answers.
2617     </para></listitem>
2618     </varlistentry>
2619
2620     <varlistentry><term>-v|--verbose</term>
2621       <listitem><para>
2622         Produce more output.
2623       </para></listitem>
2624     </varlistentry>
2625
2626     <varlistentry><term>-T|--test</term>
2627       <listitem><para>
2628         Dry run, show what changes would be made but don't touch anything.
2629       </para></listitem>
2630     </varlistentry>
2631
2632     <varlistentry><term>-l|--lock</term>
2633       <listitem><para>
2634         Lock the database while doing the check.
2635       </para></listitem>
2636     </varlistentry>
2637
2638    <varlistentry><term>--reg-version={1,2,3}</term>
2639       <listitem><para>
2640         Specify the format of the registry database. If not given it defaults to
2641         the value of the binary or, if an registry.tdb is explizitly stated at
2642         the commandline, to the value found in the INFO/version record.
2643       </para></listitem>
2644     </varlistentry>
2645
2646     <varlistentry><term>[--db] &lt;DB&gt;</term>
2647       <listitem><para>
2648         Check the specified database.
2649       </para></listitem>
2650     </varlistentry>
2651
2652     <varlistentry><term>-o|--output &lt;ODB&gt;</term>
2653       <listitem><para>
2654         Create a new registry database &lt;ODB&gt; instead of modifying the
2655         input. If &lt;ODB&gt; is already existing --wipe may be used to
2656         overwrite it.
2657       </para></listitem>
2658     </varlistentry>
2659
2660    <varlistentry><term>--wipe</term>
2661       <listitem><para>
2662         Replace the registry database instead of modifying the input or
2663         overwrite an existing output database.
2664       </para></listitem>
2665     </varlistentry>
2666
2667     <varlistentry><term></term>
2668       <listitem><para>
2669       </para></listitem>
2670     </varlistentry>
2671   </variablelist>
2672   </para>
2673 </refsect3>
2674
2675 </refsect2>
2676
2677 <refsect2>
2678 <title>EVENTLOG</title>
2679
2680 <para>Starting with version 3.4.0 net can read, dump, import and export native
2681 win32 eventlog files (usually *.evt). evt files are used by the native Windows eventviewer tools.
2682 </para>
2683
2684 <para>
2685 The import and export of evt files can only succeed when <parameter>eventlog list</parameter> is used in
2686 <emphasis>smb.conf</emphasis> file.
2687 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2688 </para>
2689
2690 <para>The eventlog commands are:
2691 <simplelist>
2692 <member>net eventlog dump - Dump a eventlog *.evt file on the screen.</member>
2693 <member>net eventlog import - Import a eventlog *.evt into the samba internal
2694 tdb based representation of eventlogs.</member>
2695 <member>net eventlog export - Export the samba internal tdb based representation
2696 of eventlogs into an eventlog *.evt file.</member>
2697 </simplelist>
2698 </para>
2699
2700 <refsect3>
2701 <title>EVENTLOG DUMP <replaceable>filename</replaceable></title>
2702
2703 <para>
2704 Prints a eventlog *.evt file to standard output.
2705 </para>
2706 </refsect3>
2707
2708 <refsect3>
2709 <title>EVENTLOG IMPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
2710
2711 <para>
2712 Imports a eventlog *.evt file defined by <replaceable>filename</replaceable> into the
2713 samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>.
2714 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
2715 defined in smb.conf.
2716 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2717 </para>
2718
2719 </refsect3>
2720
2721 <refsect3>
2722 <title>EVENTLOG EXPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
2723
2724 <para>
2725 Exports the samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>
2726 to a eventlog *.evt file defined by <replaceable>filename</replaceable>.
2727 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
2728 defined in smb.conf.
2729 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2730 </para>
2731
2732 </refsect3>
2733
2734 </refsect2>
2735
2736 <refsect2>
2737 <title>DOM</title>
2738
2739 <para>Starting with version 3.2.0 Samba has support for remote join and unjoin APIs, both client and server-side. Windows supports remote join capabilities since Windows 2000.
2740 </para>
2741 <para>In order for Samba to be joined or unjoined remotely an account must be used that is either member of the Domain Admins group, a member of the local Administrators group or a user that is granted the SeMachineAccountPrivilege privilege.
2742 </para>
2743
2744 <para>The client side support for remote join is implemented in the net dom commands which are:
2745 <simplelist>
2746 <member>net dom join - Join a remote computer into a domain.</member>
2747 <member>net dom unjoin - Unjoin a remote computer from a domain.</member>
2748 <member>net dom renamecomputer - Renames a remote computer joined to a domain.</member>
2749 </simplelist>
2750 </para>
2751
2752 <refsect3>
2753 <title>DOM JOIN <replaceable>domain=DOMAIN</replaceable> <replaceable>ou=OU</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2754
2755 <para>
2756 Joins a computer into a domain. This command supports the following additional parameters:
2757 </para>
2758
2759 <itemizedlist>
2760
2761 <listitem><para><replaceable>DOMAIN</replaceable> can be a NetBIOS domain name (also known as short domain name) or a DNS domain name for Active Directory Domains. As in Windows, it is also possible to control which Domain Controller to use. This can be achieved by appending the DC name using the \ separator character. Example: MYDOM\MYDC. The <replaceable>DOMAIN</replaceable> parameter cannot be NULL.</para></listitem>
2762
2763 <listitem><para><replaceable>OU</replaceable> can be set to a RFC 1779 LDAP DN, like <emphasis>ou=mymachines,cn=Users,dc=example,dc=com</emphasis> in order to create the machine account in a non-default LDAP container. This optional parameter is only supported when joining Active Directory Domains.</para></listitem>
2764
2765 <listitem><para><replaceable>ACCOUNT</replaceable> defines a domain account that will be used to join the machine to the domain. This domain account needs to have sufficient privileges to join machines.</para></listitem>
2766
2767 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2768
2769 <listitem><para><replaceable>REBOOT</replaceable> is an optional parameter that can be set to reboot the remote machine after successful join to the domain.</para></listitem>
2770
2771 </itemizedlist>
2772
2773 <para>
2774 Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to join. These additional parameters include: -S computer and -U user.
2775 </para>
2776 <para>
2777         Example:
2778         net dom join -S xp -U XP\\administrator%secret domain=MYDOM account=MYDOM\\administrator password=topsecret reboot.
2779 </para>
2780 <para>
2781 This example would connect to a computer named XP as the local administrator using password secret, and join the computer into a domain called MYDOM using the MYDOM domain administrator account and password topsecret. After successful join, the computer would reboot.
2782 </para>
2783
2784 </refsect3>
2785
2786 <refsect3>
2787 <title>DOM UNJOIN <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2788
2789 <para>
2790 Unjoins a computer from a domain. This command supports the following additional parameters:
2791 </para>
2792
2793 <itemizedlist>
2794
2795 <listitem><para><replaceable>ACCOUNT</replaceable> defines a domain account that will be used to unjoin the machine from the domain. This domain account needs to have sufficient privileges to unjoin machines.</para></listitem>
2796
2797 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2798
2799 <listitem><para><replaceable>REBOOT</replaceable> is an optional parameter that can be set to reboot the remote machine after successful unjoin from the domain.</para></listitem>
2800
2801 </itemizedlist>
2802
2803 <para>
2804 Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to unjoin. These additional parameters include: -S computer and -U user.
2805 </para>
2806 <para>
2807         Example:
2808         net dom unjoin -S xp -U XP\\administrator%secret account=MYDOM\\administrator password=topsecret reboot.
2809 </para>
2810 <para>
2811 This example would connect to a computer named XP as the local administrator using password secret, and unjoin the computer from the domain using the MYDOM domain administrator account and password topsecret. After successful unjoin, the computer would reboot.
2812 </para>
2813
2814 </refsect3>
2815
2816 <refsect3>
2817 <title>DOM RENAMECOMPUTER <replaceable>newname=NEWNAME</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2818
2819 <para>
2820 Renames a computer that is joined to a domain. This command supports the following additional parameters:
2821 </para>
2822
2823 <itemizedlist>
2824
2825 <listitem><para><replaceable>NEWNAME</replaceable> defines the new name of the machine in the domain.</para></listitem>
2826
2827 <listitem><para><replaceable>ACCOUNT</replaceable> defines a domain account that will be used to rename the machine in the domain. This domain account needs to have sufficient privileges to rename machines.</para></listitem>
2828
2829 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2830
2831 <listitem><para><replaceable>REBOOT</replaceable> is an optional parameter that can be set to reboot the remote machine after successful rename in the domain.</para></listitem>
2832
2833 </itemizedlist>
2834
2835 <para>
2836 Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to rename in the domain. These additional parameters include: -S computer and -U user.
2837 </para>
2838 <para>
2839         Example:
2840         net dom renamecomputer -S xp -U XP\\administrator%secret newname=XPNEW account=MYDOM\\administrator password=topsecret reboot.
2841 </para>
2842 <para>
2843 This example would connect to a computer named XP as the local administrator using password secret, and rename the joined computer to XPNEW using the MYDOM domain administrator account and password topsecret. After successful rename, the computer would reboot.
2844 </para>
2845
2846 </refsect3>
2847
2848 </refsect2>
2849
2850 <refsect2>
2851 <title>G_LOCK</title>
2852
2853 <para>Manage global locks.</para>
2854
2855 <refsect3>
2856 <title>G_LOCK DO <replaceable>lockname</replaceable> <replaceable>timeout</replaceable> <replaceable>command</replaceable></title>
2857
2858 <para>
2859 Execute a shell command under a global lock. This might be useful to define the
2860 order in which several shell commands will be executed. The locking information
2861 is stored in a file called <filename>g_lock.tdb</filename>. In setups with CTDB
2862 running, the locking information will be available on all cluster nodes.
2863 </para>
2864
2865 <itemizedlist>
2866 <listitem><para><replaceable>LOCKNAME</replaceable> defines the name of the global lock.</para></listitem>
2867 <listitem><para><replaceable>TIMEOUT</replaceable> defines the timeout.</para></listitem>
2868 <listitem><para><replaceable>COMMAND</replaceable> defines the shell command to execute.</para></listitem>
2869 </itemizedlist>
2870 </refsect3>
2871
2872 <refsect3>
2873 <title>G_LOCK LOCKS</title>
2874
2875 <para>
2876 Print a list of all currently existing locknames.
2877 </para>
2878 </refsect3>
2879
2880 <refsect3>
2881 <title>G_LOCK DUMP <replaceable>lockname</replaceable></title>
2882
2883 <para>
2884 Dump the locking table of a certain global lock.
2885 </para>
2886 </refsect3>
2887
2888 </refsect2>
2889
2890 <refsect2>
2891         <title>TDB</title>
2892
2893         <para>Print information from tdb records.</para>
2894
2895         <refsect3>
2896                 <title>TDB LOCKING <replaceable>key</replaceable> [DUMP]</title>
2897
2898                 <para>List sharename, filename and number of share modes
2899                 for a record from locking.tdb. With the optional DUMP options,
2900                 dump the complete record.</para>
2901
2902                 <itemizedlist>
2903                         <listitem>
2904                                 <para><replaceable>KEY</replaceable>
2905                                 Key of the tdb record as hex string.</para>
2906                         </listitem>
2907                 </itemizedlist>
2908
2909         </refsect3>
2910 </refsect2>
2911
2912 <refsect2>
2913   <title>vfs</title>
2914   <para>Access shared filesystem through the VFS.</para>
2915
2916   <refsect3>
2917     <title>vfs stream2abouble [--recursive] [--verbose] [--continue] [--follow-symlinks] <replaceable>share</replaceable> <replaceable>path</replaceable></title>
2918
2919     <para>Convert file streams to AppleDouble files.</para>
2920     <itemizedlist>
2921       <listitem>
2922         <para><replaceable>share</replaceable>
2923         A Samba share.</para>
2924       </listitem>
2925     </itemizedlist>
2926     <itemizedlist>
2927       <listitem>
2928         <para><replaceable>path</replaceable> A relative path of something in
2929         the Samba share. "." can be used for the root directory of the
2930         share.</para>
2931       </listitem>
2932     </itemizedlist>
2933
2934     <para>Options:</para>
2935     <variablelist>
2936       <varlistentry>
2937         <term>--recursive</term>
2938         <listitem><para>Traverse a directory hierarchy.</para></listitem>
2939       </varlistentry>
2940       <varlistentry>
2941         <term>--verbose</term>
2942         <listitem><para>Verbose output.</para></listitem>
2943       </varlistentry>
2944       <varlistentry>
2945         <term>--continue</term>
2946         <listitem><para>Continue traversing a directory hierarchy if a single
2947         conversion fails.</para></listitem>
2948       </varlistentry>
2949       <varlistentry>
2950         <term>--follow-symlinks</term>
2951         <listitem><para>Follow symlinks encountered while traversing a
2952         directory.</para></listitem>
2953       </varlistentry>
2954     </variablelist>
2955   </refsect3>
2956
2957   <refsect3>
2958     <title>vfs getntacl <replaceable>share</replaceable> <replaceable>path</replaceable></title>
2959
2960     <para>Display the security descriptor of a file or directory.</para>
2961     <itemizedlist>
2962       <listitem>
2963         <para><replaceable>share</replaceable>
2964         A Samba share.</para>
2965       </listitem>
2966     </itemizedlist>
2967     <itemizedlist>
2968       <listitem>
2969         <para><replaceable>path</replaceable> A relative path of something in
2970         the Samba share. "." can be used for the root directory of the
2971         share.</para>
2972       </listitem>
2973     </itemizedlist>
2974   </refsect3>
2975
2976 </refsect2>
2977
2978 <refsect2>
2979 <title>HELP [COMMAND]</title>
2980
2981 <para>Gives usage information for the specified command.</para>
2982
2983 </refsect2>
2984
2985 </refsect1>
2986
2987 <refsect1>
2988         <title>VERSION</title>
2989
2990         <para>This man page is complete for version 3 of the Samba
2991         suite.</para>
2992 </refsect1>
2993
2994 <refsect1>
2995         <title>AUTHOR</title>
2996
2997         <para>The original Samba software and related utilities
2998         were created by Andrew Tridgell. Samba is now developed
2999         by the Samba Team as an Open Source project similar
3000         to the way the Linux kernel is developed.</para>
3001
3002         <para>The net manpage was written by Jelmer Vernooij.</para>
3003
3004 </refsect1>
3005
3006 </refentry>