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