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 [HOSTNAME [IP [IP.....]]]</title>
1468 <para>Add host dns entry to Active Directory.</para>
1469 </refsect3>
1470
1471 <refsect3>
1472 <title>ADS DNS UNREGISTER &lt;HOSTNAME&gt;</title>
1473 <para>Remove host 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 Creates a new keytab file if one doesn't exist with default entries. Default
1552 entries are kerberos principals created from the machinename of the
1553 client, the UPN (if it exists) and any Windows SPN(s) associated with the
1554 computer AD account for the client. If a keytab file already exists then only
1555 missing kerberos principals from the default entries are added. No changes
1556 are made to the computer AD account.
1557 </para>
1558 </refsect2>
1559
1560 <refsect2>
1561 <title>ADS KEYTAB <replaceable>ADD</replaceable> <replaceable>(principal | machine | serviceclass | windows SPN</replaceable></title>
1562
1563 <para>
1564 Adds a new keytab entry, the entry can be either;
1565   <variablelist>
1566     <varlistentry><term>kerberos principal</term>
1567     <listitem><para>
1568       A kerberos principal (identified by the presence of '@') is just
1569       added to the keytab file.
1570     </para></listitem>
1571     </varlistentry>
1572     <varlistentry><term>machinename</term>
1573     <listitem><para>
1574       A machinename (identified by the trailing '$') is used to create a
1575       a kerberos principal 'machinename@realm' which is added to the
1576       keytab file.
1577     </para></listitem>
1578     </varlistentry>
1579     <varlistentry><term>serviceclass</term>
1580     <listitem><para>
1581     A serviceclass (such as 'cifs', 'html' etc.) is used to create a pair
1582     of kerberos principals 'serviceclass/fully_qualified_dns_name@realm' &amp;
1583     'serviceclass/netbios_name@realm' which are added to the keytab file.
1584     </para></listitem>
1585     </varlistentry>
1586     <varlistentry><term>Windows SPN</term>
1587     <listitem><para>
1588     A Windows SPN is of the format 'serviceclass/host:port', it is used to
1589     create a kerberos principal 'serviceclass/host@realm' which will
1590     be written to the keytab file.
1591     </para></listitem>
1592     </varlistentry>
1593   </variablelist>
1594 </para>
1595 <para>
1596 Unlike old versions no computer AD objects are modified by this command. To
1597 preserve the behaviour of older clients 'net ads keytab ad_update_ads' is
1598 available.
1599 </para>
1600 </refsect2>
1601
1602 <refsect2>
1603 <title>ADS KEYTAB <replaceable>ADD_UPDATE_ADS</replaceable> <replaceable>(principal | machine | serviceclass | windows SPN</replaceable></title>
1604
1605 <para>
1606 Adds a new keytab entry (see section for net ads keytab add). In addition to
1607 adding entries to the keytab file corresponding Windows SPNs are created
1608 from the entry passed to this command. These SPN(s) added to the AD computer
1609 account object associated with the client machine running this command for
1610 the following entry types;
1611   <variablelist>
1612     <varlistentry><term>serviceclass</term>
1613     <listitem><para>
1614     A serviceclass (such as 'cifs', 'html' etc.) is used to create a
1615     pair of Windows SPN(s) 'param/full_qualified_dns' &amp;
1616     'param/netbios_name' which are added to the AD computer account object
1617    for this client.
1618     </para></listitem>
1619     </varlistentry>
1620     <varlistentry><term>Windows SPN</term>
1621     <listitem><para>
1622     A Windows SPN is of the format 'serviceclass/host:port', it is
1623     added as passed to the AD computer account object for this client.
1624     </para></listitem>
1625     </varlistentry>
1626   </variablelist>
1627 </para>
1628 </refsect2>
1629
1630 <refsect2>
1631 <title>ADS setspn <replaceable>SETSPN LIST [machine]</replaceable></title>
1632
1633 <para>
1634    Lists the Windows SPNs stored in the 'machine' Windows AD Computer object.
1635    If 'machine' is not specified then computer account for this client is used
1636    instead.
1637 </para>
1638 </refsect2>
1639
1640 <refsect2>
1641 <title>ADS setspn <replaceable>SETSPN ADD SPN [machine]</replaceable></title>
1642
1643 <para>
1644    Adds the specified Windows SPN to the 'machine' Windows AD Computer object.
1645    If 'machine' is not specified then computer account for this client is used
1646    instead.
1647 </para>
1648 </refsect2>
1649
1650
1651 <refsect2>
1652 <title>ADS setspn <replaceable>SETSPN DELETE SPN [machine]</replaceable></title>
1653
1654 <para>
1655    DELETE the specified Window SPN from the 'machine' Windows AD Computer
1656    object. If 'machine' is not specified then computer account for this
1657    client is used
1658    instead.
1659 </para>
1660
1661 </refsect2>
1662
1663 <refsect2>
1664 <title>ADS WORKGROUP</title>
1665
1666 <para>Print out workgroup name for specified kerberos realm.</para>
1667
1668 </refsect2>
1669
1670 <refsect2>
1671         <title>ADS ENCTYPES</title>
1672
1673 <para>
1674         List, modify or delete the value of the "msDS-SupportedEncryptionTypes" attribute of an account in AD.
1675 </para>
1676
1677 <para>
1678         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:
1679 </para>
1680
1681 <para>0x00000001 DES-CBC-CRC</para>
1682 <para>0x00000002 DES-CBC-MD5</para>
1683 <para>0x00000004 RC4-HMAC</para>
1684 <para>0x00000008 AES128-CTS-HMAC-SHA1-96</para>
1685 <para>0x00000010 AES256-CTS-HMAC-SHA1-96</para>
1686
1687 </refsect2>
1688
1689 <refsect2>
1690         <title>ADS ENCTYPES LIST <replaceable>&lt;ACCOUNTNAME&gt;</replaceable></title>
1691
1692 <para>
1693         List the value of the "msDS-SupportedEncryptionTypes" attribute of a given account.
1694 </para>
1695
1696 <para>Example: <userinput>net ads enctypes list Computername</userinput></para>
1697
1698 </refsect2>
1699
1700 <refsect2>
1701         <title>ADS ENCTYPES SET <replaceable>&lt;ACCOUNTNAME&gt;</replaceable> <replaceable>[enctypes]</replaceable></title>
1702
1703 <para>
1704         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.
1705 </para>
1706
1707 <para>Example: <userinput>net ads enctypes set Computername 24</userinput></para>
1708
1709 </refsect2>
1710
1711 <refsect2>
1712         <title>ADS ENCTYPES DELETE <replaceable>&lt;ACCOUNTNAME&gt;</replaceable></title>
1713
1714 <para>
1715         Deletes the "msDS-SupportedEncryptionTypes" attribute of the LDAP object of ACCOUNTNAME.
1716 </para>
1717
1718 <para>Example: <userinput>net ads enctypes set Computername 24</userinput></para>
1719
1720 </refsect2>
1721
1722
1723 <refsect2>
1724 <title>SAM CREATEBUILTINGROUP &lt;NAME&gt;</title>
1725
1726 <para>
1727 (Re)Create a BUILTIN group.
1728 Only a wellknown set of BUILTIN groups can be created with this command.
1729 This is the list of currently recognized group names: Administrators,
1730 Users, Guests, Power Users, Account Operators, Server Operators, Print
1731 Operators, Backup Operators, Replicator, RAS Servers, Pre-Windows 2000
1732 compatible Access.
1733
1734 This command requires a running Winbindd with idmap allocation properly
1735 configured. The group gid will be allocated out of the winbindd range.
1736 </para>
1737
1738 </refsect2>
1739
1740 <refsect2>
1741 <title>SAM CREATELOCALGROUP &lt;NAME&gt;</title>
1742
1743 <para>
1744 Create a LOCAL group (also known as Alias).
1745
1746 This command requires a running Winbindd with idmap allocation properly
1747 configured. The group gid will be allocated out of the winbindd range.
1748 </para>
1749
1750 </refsect2>
1751
1752 <refsect2>
1753 <title>SAM DELETELOCALGROUP &lt;NAME&gt;</title>
1754
1755 <para>
1756 Delete an existing LOCAL group (also known as Alias).
1757
1758 </para>
1759
1760 </refsect2>
1761
1762 <refsect2>
1763 <title>SAM MAPUNIXGROUP &lt;NAME&gt;</title>
1764
1765 <para>
1766 Map an existing Unix group and make it a Domain Group, the domain group
1767 will have the same name.
1768 </para>
1769
1770 </refsect2>
1771
1772 <refsect2>
1773 <title>SAM UNMAPUNIXGROUP &lt;NAME&gt;</title>
1774
1775 <para>
1776 Remove an existing group mapping entry.
1777 </para>
1778
1779 </refsect2>
1780
1781 <refsect2>
1782 <title>SAM ADDMEM &lt;GROUP&gt; &lt;MEMBER&gt;</title>
1783
1784 <para>
1785 Add a member to a Local group. The group can be specified only by name,
1786 the member can be specified by name or SID.
1787 </para>
1788
1789 </refsect2>
1790
1791 <refsect2>
1792 <title>SAM DELMEM  &lt;GROUP&gt; &lt;MEMBER&gt;</title>
1793
1794 <para>
1795 Remove a member from a Local group. The group and the member must be
1796 specified by name.
1797 </para>
1798
1799 </refsect2>
1800
1801 <refsect2>
1802 <title>SAM LISTMEM &lt;GROUP&gt;</title>
1803
1804 <para>
1805 List Local group members. The group must be specified by name.
1806 </para>
1807
1808 </refsect2>
1809
1810 <refsect2>
1811 <title>SAM LIST &lt;users|groups|localgroups|builtin|workstations&gt; [verbose]</title>
1812
1813 <para>
1814 List the specified set of accounts by name. If verbose is specified,
1815 the rid and description is also provided for each account.
1816 </para>
1817
1818 </refsect2>
1819
1820 <refsect2>
1821 <title>SAM RIGHTS LIST</title>
1822
1823 <para>
1824 List all available privileges.
1825 </para>
1826
1827 </refsect2>
1828
1829 <refsect2>
1830 <title>SAM RIGHTS GRANT &lt;NAME&gt; &lt;PRIVILEGE&gt;</title>
1831
1832 <para>
1833 Grant one or more privileges to a user.
1834 </para>
1835
1836 </refsect2>
1837
1838 <refsect2>
1839 <title>SAM RIGHTS REVOKE &lt;NAME&gt; &lt;PRIVILEGE&gt;</title>
1840
1841 <para>
1842 Revoke one or more privileges from a user.
1843 </para>
1844
1845 </refsect2>
1846
1847 <refsect2>
1848 <title>SAM SHOW &lt;NAME&gt;</title>
1849
1850 <para>
1851 Show the full DOMAIN\\NAME the SID and the type for the corresponding
1852 account.
1853 </para>
1854
1855 </refsect2>
1856
1857 <refsect2>
1858 <title>SAM SET HOMEDIR &lt;NAME&gt; &lt;DIRECTORY&gt;</title>
1859
1860 <para>
1861 Set the home directory for a user account.
1862 </para>
1863
1864 </refsect2>
1865
1866 <refsect2>
1867 <title>SAM SET PROFILEPATH &lt;NAME&gt; &lt;PATH&gt;</title>
1868
1869 <para>
1870 Set the profile path for a user account.
1871 </para>
1872
1873 </refsect2>
1874
1875 <refsect2>
1876 <title>SAM SET COMMENT &lt;NAME&gt; &lt;COMMENT&gt;</title>
1877
1878 <para>
1879 Set the comment for a user or group account.
1880 </para>
1881
1882 </refsect2>
1883
1884 <refsect2>
1885 <title>SAM SET FULLNAME &lt;NAME&gt; &lt;FULL NAME&gt;</title>
1886
1887 <para>
1888 Set the full name for a user account.
1889 </para>
1890
1891 </refsect2>
1892
1893 <refsect2>
1894 <title>SAM SET LOGONSCRIPT &lt;NAME&gt; &lt;SCRIPT&gt;</title>
1895
1896 <para>
1897 Set the logon script for a user account.
1898 </para>
1899
1900 </refsect2>
1901
1902 <refsect2>
1903 <title>SAM SET HOMEDRIVE &lt;NAME&gt; &lt;DRIVE&gt;</title>
1904
1905 <para>
1906 Set the home drive for a user account.
1907 </para>
1908
1909 </refsect2>
1910
1911 <refsect2>
1912 <title>SAM SET WORKSTATIONS &lt;NAME&gt; &lt;WORKSTATIONS&gt;</title>
1913
1914 <para>
1915 Set the workstations a user account is allowed to log in from.
1916 </para>
1917
1918 </refsect2>
1919
1920 <refsect2>
1921 <title>SAM SET DISABLE &lt;NAME&gt;</title>
1922
1923 <para>
1924 Set the "disabled" flag for a user account.
1925 </para>
1926
1927 </refsect2>
1928
1929 <refsect2>
1930 <title>SAM SET PWNOTREQ &lt;NAME&gt;</title>
1931
1932 <para>
1933 Set the "password not required" flag for a user account.
1934 </para>
1935
1936 </refsect2>
1937
1938 <refsect2>
1939 <title>SAM SET AUTOLOCK &lt;NAME&gt;</title>
1940
1941 <para>
1942 Set the "autolock" flag for a user account.
1943 </para>
1944
1945 </refsect2>
1946
1947 <refsect2>
1948 <title>SAM SET PWNOEXP &lt;NAME&gt;</title>
1949
1950 <para>
1951 Set the "password do not expire" flag for a user account.
1952 </para>
1953
1954 </refsect2>
1955
1956 <refsect2>
1957 <title>SAM SET PWDMUSTCHANGENOW &lt;NAME&gt; [yes|no]</title>
1958
1959 <para>
1960 Set or unset the "password must change" flag for a user account.
1961 </para>
1962
1963 </refsect2>
1964
1965 <refsect2>
1966 <title>SAM POLICY LIST</title>
1967
1968 <para>
1969 List the available account policies.
1970 </para>
1971
1972 </refsect2>
1973
1974 <refsect2>
1975 <title>SAM POLICY SHOW &lt;account policy&gt;</title>
1976
1977 <para>
1978 Show the account policy value.
1979 </para>
1980
1981 </refsect2>
1982
1983 <refsect2>
1984 <title>SAM POLICY SET &lt;account policy&gt; &lt;value&gt;</title>
1985
1986 <para>
1987 Set a value for the account policy.
1988 Valid values can be: "forever", "never", "off", or a number.
1989 </para>
1990
1991 </refsect2>
1992
1993 <refsect2>
1994 <title>SAM PROVISION</title>
1995
1996 <para>
1997 Only available if ldapsam:editposix is set and winbindd is running.
1998 Properly populates the ldap tree with the basic accounts (Administrator)
1999 and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree.
2000 </para>
2001
2002 </refsect2>
2003
2004 <refsect2>
2005 <title>IDMAP DUMP &lt;local tdb file name&gt;</title>
2006
2007 <para>
2008 Dumps the mappings contained in the local tdb file specified.
2009 This command is useful to dump only the mappings produced by the idmap_tdb backend.
2010 </para>
2011
2012 </refsect2>
2013
2014 <refsect2>
2015 <title>IDMAP RESTORE [input file]</title>
2016
2017 <para>
2018 Restore the mappings from the specified file or stdin.
2019 </para>
2020
2021 </refsect2>
2022
2023 <refsect2>
2024 <title>IDMAP SET SECRET &lt;DOMAIN&gt; &lt;secret&gt;</title>
2025
2026 <para>
2027 Store a secret for the specified domain, used primarily for domains
2028 that use idmap_ldap as a backend. In this case the secret is used
2029 as the password for the user DN used to bind to the ldap server.
2030 </para>
2031
2032 </refsect2>
2033
2034 <refsect2>
2035 <title>IDMAP SET RANGE &lt;RANGE&gt; &lt;SID&gt; [index] [--db=&lt;DB&gt;]</title>
2036
2037 <para>
2038 Store a domain-range mapping for a given domain (and index) in autorid database.
2039 </para>
2040
2041 </refsect2>
2042
2043 <refsect2>
2044 <title>IDMAP SET CONFIG &lt;config&gt; [--db=&lt;DB&gt;]</title>
2045
2046 <para>
2047 Update CONFIG entry in autorid database.
2048 </para>
2049
2050 </refsect2>
2051
2052 <refsect2>
2053 <title>IDMAP GET RANGE &lt;SID&gt; [index] [--db=&lt;DB&gt;]</title>
2054
2055 <para>
2056 Get the range for a given domain and index from autorid database.
2057 </para>
2058
2059 </refsect2>
2060
2061 <refsect2>
2062 <title>IDMAP GET RANGES [&lt;SID&gt;] [--db=&lt;DB&gt;]</title>
2063
2064 <para>
2065 Get ranges for all domains or for one identified by given SID.
2066 </para>
2067
2068 </refsect2>
2069
2070 <refsect2>
2071 <title>IDMAP GET CONFIG [--db=&lt;DB&gt;]</title>
2072
2073 <para>
2074 Get CONFIG entry from autorid database.
2075 </para>
2076
2077 </refsect2>
2078
2079 <refsect2>
2080
2081 <title>IDMAP DELETE MAPPING [-f] [--db=&lt;DB&gt;] &lt;ID&gt;</title>
2082
2083 <para>
2084 Delete a mapping sid &lt;-&gt; gid or sid &lt;-&gt; uid from the IDMAP database.
2085 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".
2086 Use -f to delete an invalid partial mapping &lt;ID&gt; -&gt; xx
2087 </para>
2088 <para>
2089   Use "smbcontrol all idmap ..." to notify running smbd instances.
2090   See the <citerefentry><refentrytitle>smbcontrol</refentrytitle>
2091   <manvolnum>1</manvolnum></citerefentry> manpage for details.
2092 </para>
2093 </refsect2>
2094
2095 <refsect2>
2096 <title>IDMAP DELETE RANGE [-f] [--db=&lt;TDB&gt;] &lt;RANGE&gt;|(&lt;SID&gt; [&lt;INDEX&gt;])</title>
2097
2098 <para>
2099 Delete a domain range mapping identified by 'RANGE' or "domain SID and INDEX" from autorid database.
2100 Use -f to delete invalid mappings.
2101 </para>
2102
2103 </refsect2>
2104
2105 <refsect2>
2106 <title>IDMAP DELETE RANGES [-f] [--db=&lt;TDB&gt;] &lt;SID&gt;</title>
2107
2108 <para>
2109 Delete all domain range mappings for a domain identified by SID.
2110 Use -f to delete invalid mappings.
2111 </para>
2112
2113 </refsect2>
2114
2115 <refsect2>
2116
2117 <title>IDMAP CHECK [-v] [-r] [-a] [-T] [-f] [-l] [--db=&lt;DB&gt;]</title>
2118
2119 <para>
2120   Check and repair the IDMAP database. If no option is given a read only check
2121   of the database is done. Among others an interactive or automatic repair mode
2122   may be chosen with one of the following options:
2123
2124   <variablelist>
2125     <varlistentry><term>-r|--repair</term>
2126     <listitem><para>
2127       Interactive repair mode, ask a lot of questions.
2128     </para></listitem>
2129     </varlistentry>
2130
2131     <varlistentry><term>-a|--auto</term>
2132     <listitem><para>
2133       Noninteractive repair mode, use default answers.
2134     </para></listitem>
2135     </varlistentry>
2136
2137     <varlistentry><term>-v|--verbose</term>
2138       <listitem><para>
2139         Produce more output.
2140       </para></listitem>
2141     </varlistentry>
2142
2143     <varlistentry><term>-f|--force</term>
2144       <listitem><para>
2145         Try to apply changes, even if they do not apply cleanly.
2146       </para></listitem>
2147     </varlistentry>
2148
2149     <varlistentry><term>-T|--test</term>
2150       <listitem><para>
2151         Dry run, show what changes would be made but don't touch anything.
2152       </para></listitem>
2153     </varlistentry>
2154
2155     <varlistentry><term>-l|--lock</term>
2156       <listitem><para>
2157         Lock the database while doing the check.
2158       </para></listitem>
2159     </varlistentry>
2160
2161     <varlistentry><term>--db &lt;DB&gt;</term>
2162       <listitem><para>
2163         Check the specified database.
2164       </para></listitem>
2165     </varlistentry>
2166     <varlistentry><term></term>
2167       <listitem><para>
2168       </para></listitem>
2169     </varlistentry>
2170   </variablelist>
2171
2172   It reports about the finding of the following errors:
2173
2174   <variablelist>
2175     <varlistentry><term>Missing reverse mapping:</term>
2176     <listitem><para>
2177       A record with mapping A-&gt;B where there is no B-&gt;A. Default action
2178       in repair mode is to "fix" this by adding the reverse mapping.
2179     </para></listitem>
2180     </varlistentry>
2181
2182     <varlistentry><term>Invalid mapping:</term>
2183     <listitem><para>
2184       A record with mapping A-&gt;B where B-&gt;C. Default action
2185       is to "delete" this record.
2186     </para></listitem>
2187   </varlistentry>
2188
2189   <varlistentry><term>Missing or invalid HWM:</term>
2190     <listitem><para>
2191       A high water mark is not at least equal to the largest ID in the
2192       database. Default action is to "fix" this by setting it to the
2193       largest ID found +1.
2194     </para></listitem>
2195   </varlistentry>
2196
2197   <varlistentry><term>Invalid record:</term>
2198     <listitem><para>
2199       Something we failed to parse. Default action is to "edit" it
2200       in interactive and "delete" it in automatic mode.
2201     </para></listitem>
2202   </varlistentry>
2203 </variablelist>
2204 </para>
2205 </refsect2>
2206
2207
2208 <refsect2>
2209 <title>USERSHARE</title>
2210
2211 <para>Starting with version 3.0.23, a Samba server now supports the ability for
2212 non-root users to add user defined shares to be exported using the "net usershare"
2213 commands.
2214 </para>
2215
2216 <para>
2217 To set this up, first set up your &smb.conf; by adding to the [global] section:
2218
2219 usershare path = /usr/local/samba/lib/usershares
2220
2221 Next create the directory /usr/local/samba/lib/usershares, change the owner to root and
2222 set the group owner to the UNIX group who should have the ability to create usershares,
2223 for example a group called "serverops".
2224
2225 Set the permissions on /usr/local/samba/lib/usershares to 01770.
2226
2227 (Owner and group all access, no access for others, plus the sticky bit,
2228 which means that a file in that directory can be renamed or deleted only
2229 by the owner of the file).
2230
2231 Finally, tell smbd how many usershares you will allow by adding to the [global]
2232 section of &smb.conf; a line such as :
2233
2234 usershare max shares = 100.
2235
2236 To allow 100 usershare definitions. Now, members of the UNIX group "serverops"
2237 can create user defined shares on demand using the commands below.
2238 </para>
2239
2240 <para>The usershare commands are:
2241
2242 <simplelist>
2243 <member>net usershare add sharename path [comment [acl] [guest_ok=[y|n]]] - to add or change a user defined share.</member>
2244 <member>net usershare delete sharename - to delete a user defined share.</member>
2245 <member>net usershare info [--long] [wildcard sharename] - to print info about a user defined share.</member>
2246 <member>net usershare list [--long] [wildcard sharename] - to list user defined shares.</member>
2247 </simplelist>
2248
2249 </para>
2250
2251 <refsect3>
2252 <title>USERSHARE ADD <replaceable>sharename</replaceable> <replaceable>path</replaceable> <replaceable>[comment]</replaceable> <replaceable>[acl]</replaceable> <replaceable>[guest_ok=[y|n]]</replaceable></title>
2253
2254 <para>
2255 Add or replace a new user defined share, with name "sharename".
2256 </para>
2257
2258 <para>
2259 "path" specifies the absolute pathname on the system to be exported.
2260 Restrictions may be put on this, see the global &smb.conf; parameters:
2261 "usershare owner only", "usershare prefix allow list", and
2262 "usershare prefix deny list".
2263 </para>
2264
2265 <para>
2266 The optional "comment" parameter is the comment that will appear
2267 on the share when browsed to by a client.
2268 </para>
2269
2270 <para>The optional "acl" field
2271 specifies which users have read and write access to the entire share.
2272 Note that guest connections are not allowed unless the &smb.conf; parameter
2273 "usershare allow guests" has been set. The definition of a user
2274 defined share acl is: "user:permission", where user is a valid
2275 username on the system and permission can be "F", "R", or "D".
2276 "F" stands for "full permissions", ie. read and write permissions.
2277 "D" stands for "deny" for a user, ie. prevent this user from accessing
2278 this share.
2279 "R" stands for "read only", ie. only allow read access to this
2280 share (no creation of new files or directories or writing to files).
2281 </para>
2282
2283 <para>
2284 The default if no "acl" is given is "Everyone:R", which means any
2285 authenticated user has read-only access.
2286 </para>
2287
2288 <para>
2289 The optional "guest_ok" has the same effect as the parameter of the
2290 same name in &smb.conf;, in that it allows guest access to this user
2291 defined share. This parameter is only allowed if the global parameter
2292 "usershare allow guests" has been set to true in the &smb.conf;.
2293 </para>
2294
2295 <para>
2296 There is no separate command to modify an existing user defined share,
2297 just use the "net usershare add [sharename]" command using the same
2298 sharename as the one you wish to modify and specify the new options
2299 you wish. The Samba smbd daemon notices user defined share modifications
2300 at connect time so will see the change immediately, there is no need
2301 to restart smbd on adding, deleting or changing a user defined share.
2302 </para>
2303 </refsect3>
2304
2305 <refsect3>
2306 <title>USERSHARE DELETE <replaceable>sharename</replaceable></title>
2307
2308 <para>
2309 Deletes the user defined share by name. The Samba smbd daemon
2310 immediately notices this change, although it will not disconnect
2311 any users currently connected to the deleted share.
2312 </para>
2313
2314 </refsect3>
2315
2316 <refsect3>
2317 <title>USERSHARE INFO <replaceable>[--long]</replaceable> <replaceable>[wildcard sharename]</replaceable></title>
2318
2319 <para>
2320 Get info on user defined shares owned by the current user matching the given pattern, or all users.
2321 </para>
2322
2323 <para>
2324 net usershare info on its own dumps out info on the user defined shares that were
2325 created by the current user, or restricts them to share names that match the given
2326 wildcard pattern ('*' matches one or more characters, '?' matches only one character).
2327 If the '--long' option is also given, it prints out info on user defined
2328 shares created by other users.
2329 </para>
2330
2331 <para>
2332 The information given about a share looks like:
2333
2334 [foobar]
2335 path=/home/jeremy
2336 comment=testme
2337 usershare_acl=Everyone:F
2338 guest_ok=n
2339
2340 And is a list of the current settings of the user defined share that can be
2341 modified by the "net usershare add" command.
2342 </para>
2343
2344 </refsect3>
2345
2346 <refsect3>
2347 <title>USERSHARE LIST <replaceable>[--long]</replaceable> <replaceable>wildcard sharename</replaceable></title>
2348
2349 <para>
2350 List all the user defined shares owned by the current user matching the given pattern, or all users.
2351 </para>
2352
2353 <para>
2354 net usershare list on its own list out the names of the user defined shares that were
2355 created by the current user, or restricts the list to share names that match the given
2356 wildcard pattern ('*' matches one or more characters, '?' matches only one character).
2357 If the '--long' option is also given, it includes the names of user defined
2358 shares created by other users.
2359 </para>
2360
2361 </refsect3>
2362
2363 </refsect2>
2364
2365 <refsect2>
2366 <title>[RPC] CONF</title>
2367
2368 <para>Starting with version 3.2.0, a Samba server can be configured by data
2369 stored in registry. This configuration data can be edited with the new "net
2370 conf" commands. There is also the possibility to configure a remote Samba server
2371 by enabling the RPC conf mode and specifying the address of the remote server.
2372 </para>
2373
2374 <para>
2375 The deployment of this configuration data can be activated in two levels from the
2376 <emphasis>&smb.conf;</emphasis> file: Share definitions from registry are
2377 activated by setting <parameter>registry shares</parameter> to
2378 <quote>yes</quote> in the [global] section and global configuration options are
2379 activated by setting <smbconfoption name="include">registry</smbconfoption> in
2380 the [global] section for a mixed configuration or by setting
2381 <smbconfoption name="config backend">registry</smbconfoption> in the [global]
2382 section for a registry-only configuration.
2383 See the <citerefentry><refentrytitle>smb.conf</refentrytitle>
2384 <manvolnum>5</manvolnum></citerefentry> manpage for details.
2385 </para>
2386
2387 <para>The conf commands are:
2388 <simplelist>
2389 <member>net [rpc] conf list - Dump the complete configuration in smb.conf like
2390 format.</member>
2391 <member>net [rpc] conf import - Import configuration from file in smb.conf
2392 format.</member>
2393 <member>net [rpc] conf listshares - List the registry shares.</member>
2394 <member>net [rpc] conf drop - Delete the complete configuration from
2395 registry.</member>
2396 <member>net [rpc] conf showshare - Show the definition of a registry share.</member>
2397 <member>net [rpc] conf addshare - Create a new registry share.</member>
2398 <member>net [rpc] conf delshare - Delete a registry share.</member>
2399 <member>net [rpc] conf setparm - Store a parameter.</member>
2400 <member>net [rpc] conf getparm - Retrieve the value of a parameter.</member>
2401 <member>net [rpc] conf delparm - Delete a parameter.</member>
2402 <member>net [rpc] conf getincludes - Show the includes of a share definition.</member>
2403 <member>net [rpc] conf setincludes - Set includes for a share.</member>
2404 <member>net [rpc] conf delincludes - Delete includes from a share definition.</member>
2405 </simplelist>
2406 </para>
2407
2408 <refsect3>
2409 <title>[RPC] CONF LIST</title>
2410
2411 <para>
2412 Print the configuration data stored in the registry in a smb.conf-like format to
2413 standard output.
2414 </para>
2415 </refsect3>
2416
2417 <refsect3>
2418 <title>[RPC] CONF IMPORT <replaceable>[--test|-T]</replaceable> <replaceable>filename</replaceable> <replaceable>[section]</replaceable></title>
2419
2420 <para>
2421 This command imports configuration from a file in smb.conf format.
2422 If a section encountered in the input file is present in registry,
2423 its contents is replaced. Sections of registry configuration that have
2424 no counterpart in the input file are not affected. If you want to delete these,
2425 you will have to use the "net conf drop" or "net conf delshare" commands.
2426 Optionally, a section may be specified to restrict the effect of the
2427 import command to that specific section. A test mode is enabled by specifying
2428 the parameter "-T" on the commandline. In test mode, no changes are made to the
2429 registry, and the resulting configuration is printed to standard output instead.
2430 </para>
2431 </refsect3>
2432
2433 <refsect3>
2434 <title>[RPC] CONF LISTSHARES</title>
2435
2436 <para>
2437 List the names of the shares defined in registry.
2438 </para>
2439 </refsect3>
2440
2441 <refsect3>
2442 <title>[RPC] CONF DROP</title>
2443
2444 <para>
2445 Delete the complete configuration data from registry.
2446 </para>
2447 </refsect3>
2448
2449 <refsect3>
2450 <title>[RPC] CONF SHOWSHARE <replaceable>sharename</replaceable></title>
2451
2452 <para>
2453 Show the definition of the share or section specified. It is valid to specify
2454 "global" as sharename to retrieve the global configuration options from
2455 registry.
2456 </para>
2457 </refsect3>
2458
2459 <refsect3>
2460 <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>
2461
2462 <para>Create a new share definition in registry.
2463 The sharename and path have to be given. The share name may
2464 <emphasis>not</emphasis> be "global". Optionally, values for the very
2465 common options "writeable", "guest ok" and a "comment" may be specified.
2466 The same result may be obtained by a sequence of "net conf setparm"
2467 commands.
2468 </para>
2469 </refsect3>
2470
2471 <refsect3>
2472 <title>[RPC] CONF DELSHARE <replaceable>sharename</replaceable></title>
2473
2474 <para>
2475 Delete a share definition from registry.
2476 </para>
2477 </refsect3>
2478
2479 <refsect3>
2480 <title>[RPC] CONF SETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> <replaceable>value</replaceable></title>
2481
2482 <para>
2483 Store a parameter in registry. The section may be global or a sharename.
2484 The section is created if it does not exist yet.
2485 </para>
2486 </refsect3>
2487
2488 <refsect3>
2489 <title>[RPC] CONF GETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
2490
2491 <para>
2492 Show a parameter stored in registry.
2493 </para>
2494 </refsect3>
2495
2496 <refsect3>
2497 <title>[RPC] CONF DELPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
2498
2499 <para>
2500 Delete a parameter stored in registry.
2501 </para>
2502 </refsect3>
2503
2504 <refsect3>
2505 <title>[RPC] CONF GETINCLUDES <replaceable>section</replaceable></title>
2506
2507 <para>
2508 Get the list of includes for the provided section (global or share).
2509 </para>
2510
2511 <para>
2512 Note that due to the nature of the registry database and the nature of include directives,
2513 the includes need special treatment: Parameters are stored in registry by the parameter
2514 name as valuename, so there is only ever one instance of a parameter per share.
2515 Also, a specific order like in a text file is not guaranteed. For all real
2516 parameters, this is perfectly ok, but the include directive is rather a meta
2517 parameter, for which, in the smb.conf text file, the place where it is specified
2518 between the other parameters is very important. This can not be achieved by the
2519 simple registry smbconf data model, so there is one ordered list of includes
2520 per share, and this list is evaluated after all the parameters of the share.
2521 </para>
2522
2523 <para>
2524 Further note that currently, only files can be included from registry
2525 configuration. In the future, there will be the ability to include configuration
2526 data from other registry keys.
2527 </para>
2528 </refsect3>
2529
2530 <refsect3>
2531 <title>[RPC] CONF SETINCLUDES <replaceable>section</replaceable> [<replaceable>filename</replaceable>]+</title>
2532
2533 <para>
2534 Set the list of includes for the provided section (global or share) to the given
2535 list of one or more filenames. The filenames may contain the usual smb.conf
2536 macros like %I.
2537 </para>
2538 </refsect3>
2539
2540 <refsect3>
2541 <title>[RPC] CONF DELINCLUDES <replaceable>section</replaceable></title>
2542
2543 <para>
2544 Delete the list of includes from the provided section (global or share).
2545 </para>
2546 </refsect3>
2547
2548 </refsect2>
2549
2550 <refsect2>
2551 <title>REGISTRY</title>
2552 <para>
2553 Manipulate Samba's registry.
2554 </para>
2555
2556 <para>The registry commands are:
2557 <simplelist>
2558 <member>net registry enumerate   - Enumerate registry keys and values.</member>
2559 <member>net registry enumerate_recursive - Enumerate registry key and its subkeys.</member>
2560 <member>net registry createkey   - Create a new registry key.</member>
2561 <member>net registry deletekey   - Delete a registry key.</member>
2562 <member>net registry deletekey_recursive - Delete a registry key with subkeys.</member>
2563 <member>net registry getvalue    - Print a registry value.</member>
2564 <member>net registry getvalueraw - Print a registry value (raw format).</member>
2565 <member>net registry setvalue    - Set a new registry value.</member>
2566 <member>net registry increment   - Increment a DWORD registry value under a lock.
2567 </member>
2568 <member>net registry deletevalue - Delete a registry value.</member>
2569 <member>net registry getsd       - Get security descriptor.</member>
2570 <member>net registry getsd_sdd1  - Get security descriptor in sddl format.
2571 </member>
2572 <member>net registry setsd_sdd1  - Set security descriptor from sddl format
2573 string.</member>
2574 <member>net registry import      - Import a registration entries (.reg) file.
2575 </member>
2576 <member>net registry export      - Export a registration entries (.reg) file.
2577 </member>
2578 <member>net registry convert     - Convert a registration entries (.reg) file.
2579 </member>
2580 <member>net registry check       - Check and repair a registry database.
2581 </member>
2582 </simplelist>
2583 </para>
2584
2585 <refsect3>
2586   <title>REGISTRY ENUMERATE <replaceable>key</replaceable> </title>
2587   <para>Enumerate subkeys and values of <emphasis>key</emphasis>.
2588   </para>
2589 </refsect3>
2590
2591 <refsect3>
2592   <title>REGISTRY ENUMERATE_RECURSIVE <replaceable>key</replaceable> </title>
2593   <para>Enumerate values of <emphasis>key</emphasis> and its subkeys.
2594   </para>
2595 </refsect3>
2596
2597 <refsect3>
2598   <title>REGISTRY CREATEKEY <replaceable>key</replaceable> </title>
2599   <para>Create a new <emphasis>key</emphasis> if not yet existing.
2600   </para>
2601 </refsect3>
2602
2603 <refsect3>
2604   <title>REGISTRY DELETEKEY <replaceable>key</replaceable> </title>
2605   <para>Delete the given <emphasis>key</emphasis> and its
2606   values from the registry, if it has no subkeys.
2607   </para>
2608 </refsect3>
2609
2610 <refsect3>
2611   <title>REGISTRY DELETEKEY_RECURSIVE <replaceable>key</replaceable> </title>
2612   <para>Delete the given <emphasis>key</emphasis> and all of its
2613   subkeys and values from the registry.
2614   </para>
2615 </refsect3>
2616
2617 <refsect3>
2618   <title>REGISTRY GETVALUE <replaceable>key</replaceable> <!--
2619   --><replaceable>name</replaceable></title>
2620
2621   <para>Output type and actual value of the value <emphasis>name</emphasis>
2622   of the given <emphasis>key</emphasis>.
2623   </para>
2624 </refsect3>
2625
2626 <refsect3>
2627   <title>REGISTRY GETVALUERAW <replaceable>key</replaceable> <!--
2628   --><replaceable>name</replaceable></title>
2629   <para>Output the actual value of the value <emphasis>name</emphasis>
2630   of the given <emphasis>key</emphasis>.
2631   </para>
2632 </refsect3>
2633
2634 <refsect3>
2635   <title>REGISTRY SETVALUE <replaceable>key</replaceable> <!--
2636   --><replaceable>name</replaceable> <replaceable>type</replaceable> <!--
2637   --><replaceable>value</replaceable> ...<!--
2638   --></title>
2639
2640   <para>Set the value <emphasis>name</emphasis>
2641   of an existing <emphasis>key</emphasis>.
2642   <emphasis>type</emphasis> may be one of
2643   <emphasis>sz</emphasis>, <emphasis>multi_sz</emphasis> or
2644   <emphasis>dword</emphasis>.
2645   In case of <emphasis>multi_sz</emphasis> <replaceable>value</replaceable> may
2646   be given multiple times.
2647   </para>
2648 </refsect3>
2649
2650 <refsect3>
2651   <title>REGISTRY INCREMENT <replaceable>key</replaceable> <!--
2652   --><replaceable>name</replaceable> <replaceable>[inc]</replaceable><!--
2653   --></title>
2654
2655   <para>Increment the DWORD value <emphasis>name</emphasis>
2656   of <emphasis>key</emphasis> by <replaceable>inc</replaceable>
2657   while holding a g_lock.
2658   <emphasis>inc</emphasis> defaults to 1.
2659   </para>
2660 </refsect3>
2661
2662 <refsect3>
2663   <title>REGISTRY DELETEVALUE <replaceable>key</replaceable> <!--
2664   --><replaceable>name</replaceable></title>
2665
2666   <para>Delete the value <emphasis>name</emphasis>
2667   of the given <emphasis>key</emphasis>.
2668   </para>
2669 </refsect3>
2670
2671 <refsect3>
2672   <title>REGISTRY GETSD <replaceable>key</replaceable></title>
2673
2674   <para>Get the security descriptor of the given <emphasis>key</emphasis>.
2675   </para>
2676 </refsect3>
2677
2678 <refsect3>
2679   <title>REGISTRY GETSD_SDDL <replaceable>key</replaceable></title>
2680
2681   <para>Get the security descriptor of the given <emphasis>key</emphasis> as a
2682   Security Descriptor Definition Language (SDDL) string.
2683   </para>
2684 </refsect3>
2685
2686 <refsect3>
2687   <title>REGISTRY SETSD_SDDL <replaceable>key</replaceable><!--
2688   --><replaceable>sd</replaceable></title>
2689
2690   <para>Set the security descriptor of the given <emphasis>key</emphasis> from a
2691   Security Descriptor Definition Language (SDDL) string <emphasis>sd</emphasis>.
2692   </para>
2693 </refsect3>
2694
2695 <refsect3>
2696   <title>REGISTRY IMPORT <replaceable>file</replaceable><!--
2697   --><replaceable> [--precheck &lt;check-file&gt;] [opt]</replaceable></title>
2698   <para>Import a registration entries (.reg) <emphasis>file</emphasis>.</para>
2699   <para>The following options are available:</para>
2700   <variablelist>
2701     <varlistentry><term>--precheck <replaceable>check-file</replaceable></term>
2702     <listitem><para>
2703       This is a mechanism to check the existence or non-existence of
2704       certain keys or values specified in a precheck file before applying
2705       the import file.
2706       The import file will only be applied if the precheck succeeds.
2707     </para>
2708     <para>
2709       The check-file follows the normal registry file syntax with the
2710       following semantics:
2711     </para>
2712       <itemizedlist>
2713         <listitem><para>&lt;value name&gt;=&lt;value&gt; checks whether the
2714           value exists and has the given value.</para></listitem>
2715         <listitem><para>&lt;value name&gt;=- checks whether the value does
2716           not exist.</para></listitem>
2717         <listitem><para>[key] checks whether the key exists.</para>
2718         </listitem>
2719         <listitem><para>[-key] checks whether the key does not exist.</para>
2720         </listitem>
2721       </itemizedlist>
2722     </listitem>
2723     </varlistentry>
2724   </variablelist>
2725 </refsect3>
2726
2727 <refsect3>
2728   <title>REGISTRY EXPORT <replaceable>key</replaceable><!--
2729   --><replaceable>file</replaceable><!--
2730   --><replaceable>[opt]</replaceable></title>
2731
2732   <para>Export a <emphasis>key</emphasis> to a registration entries (.reg)
2733   <emphasis>file</emphasis>.
2734   </para>
2735 </refsect3>
2736
2737 <refsect3>
2738   <title>REGISTRY CONVERT <replaceable>in</replaceable> <!--
2739   --><replaceable>out</replaceable> <!--
2740   --><replaceable>[[inopt] outopt]</replaceable></title>
2741
2742   <para>Convert a registration entries (.reg) file <emphasis>in</emphasis>.
2743   </para>
2744 </refsect3>
2745
2746 <refsect3>
2747   <title>REGISTRY CHECK [-ravTl] [-o &lt;ODB&gt;] [--wipe] [&lt;DB&gt;]</title>
2748   <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
2749
2750   <variablelist>
2751     <varlistentry><term>-r|--repair</term>
2752     <listitem><para>
2753       Interactive repair mode, ask a lot of questions.
2754     </para></listitem>
2755     </varlistentry>
2756
2757     <varlistentry><term>-a|--auto</term>
2758     <listitem><para>
2759       Noninteractive repair mode, use default answers.
2760     </para></listitem>
2761     </varlistentry>
2762
2763     <varlistentry><term>-v|--verbose</term>
2764       <listitem><para>
2765         Produce more output.
2766       </para></listitem>
2767     </varlistentry>
2768
2769     <varlistentry><term>-T|--test</term>
2770       <listitem><para>
2771         Dry run, show what changes would be made but don't touch anything.
2772       </para></listitem>
2773     </varlistentry>
2774
2775     <varlistentry><term>-l|--lock</term>
2776       <listitem><para>
2777         Lock the database while doing the check.
2778       </para></listitem>
2779     </varlistentry>
2780
2781    <varlistentry><term>--reg-version={1,2,3}</term>
2782       <listitem><para>
2783         Specify the format of the registry database. If not given it defaults to
2784         the value of the binary or, if an registry.tdb is explicitly stated at
2785         the commandline, to the value found in the INFO/version record.
2786       </para></listitem>
2787     </varlistentry>
2788
2789     <varlistentry><term>[--db] &lt;DB&gt;</term>
2790       <listitem><para>
2791         Check the specified database.
2792       </para></listitem>
2793     </varlistentry>
2794
2795     <varlistentry><term>-o|--output &lt;ODB&gt;</term>
2796       <listitem><para>
2797         Create a new registry database &lt;ODB&gt; instead of modifying the
2798         input. If &lt;ODB&gt; is already existing --wipe may be used to
2799         overwrite it.
2800       </para></listitem>
2801     </varlistentry>
2802
2803    <varlistentry><term>--wipe</term>
2804       <listitem><para>
2805         Replace the registry database instead of modifying the input or
2806         overwrite an existing output database.
2807       </para></listitem>
2808     </varlistentry>
2809
2810     <varlistentry><term></term>
2811       <listitem><para>
2812       </para></listitem>
2813     </varlistentry>
2814   </variablelist>
2815   </para>
2816 </refsect3>
2817
2818 </refsect2>
2819
2820 <refsect2>
2821 <title>EVENTLOG</title>
2822
2823 <para>Starting with version 3.4.0 net can read, dump, import and export native
2824 win32 eventlog files (usually *.evt). evt files are used by the native Windows eventviewer tools.
2825 </para>
2826
2827 <para>
2828 The import and export of evt files can only succeed when <parameter>eventlog list</parameter> is used in
2829 <emphasis>&smb.conf;</emphasis> file.
2830 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2831 </para>
2832
2833 <para>The eventlog commands are:
2834 <simplelist>
2835 <member>net eventlog dump - Dump a eventlog *.evt file on the screen.</member>
2836 <member>net eventlog import - Import a eventlog *.evt into the samba internal
2837 tdb based representation of eventlogs.</member>
2838 <member>net eventlog export - Export the samba internal tdb based representation
2839 of eventlogs into an eventlog *.evt file.</member>
2840 </simplelist>
2841 </para>
2842
2843 <refsect3>
2844 <title>EVENTLOG DUMP <replaceable>filename</replaceable></title>
2845
2846 <para>
2847 Prints a eventlog *.evt file to standard output.
2848 </para>
2849 </refsect3>
2850
2851 <refsect3>
2852 <title>EVENTLOG IMPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
2853
2854 <para>
2855 Imports a eventlog *.evt file defined by <replaceable>filename</replaceable> into the
2856 samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>.
2857 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
2858 defined in &smb.conf;.
2859 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2860 </para>
2861
2862 </refsect3>
2863
2864 <refsect3>
2865 <title>EVENTLOG EXPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
2866
2867 <para>
2868 Exports the samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>
2869 to a eventlog *.evt file defined by <replaceable>filename</replaceable>.
2870 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
2871 defined in &smb.conf;.
2872 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2873 </para>
2874
2875 </refsect3>
2876
2877 </refsect2>
2878
2879 <refsect2>
2880 <title>DOM</title>
2881
2882 <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.
2883 </para>
2884 <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.
2885 </para>
2886
2887 <para>The client side support for remote join is implemented in the net dom commands which are:
2888 <simplelist>
2889 <member>net dom join - Join a remote computer into a domain.</member>
2890 <member>net dom unjoin - Unjoin a remote computer from a domain.</member>
2891 <member>net dom renamecomputer - Renames a remote computer joined to a domain.</member>
2892 </simplelist>
2893 </para>
2894
2895 <refsect3>
2896 <title>DOM JOIN <replaceable>domain=DOMAIN</replaceable> <replaceable>ou=OU</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2897
2898 <para>
2899 Joins a computer into a domain. This command supports the following additional parameters:
2900 </para>
2901
2902 <itemizedlist>
2903
2904 <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>
2905
2906 <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>
2907
2908 <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>
2909
2910 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2911
2912 <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>
2913
2914 </itemizedlist>
2915
2916 <para>
2917 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.
2918 </para>
2919 <para>
2920         Example:
2921         net dom join -S xp -U XP\\administrator%secret domain=MYDOM account=MYDOM\\administrator password=topsecret reboot.
2922 </para>
2923 <para>
2924 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.
2925 </para>
2926
2927 </refsect3>
2928
2929 <refsect3>
2930 <title>DOM UNJOIN <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2931
2932 <para>
2933 Unjoins a computer from a domain. This command supports the following additional parameters:
2934 </para>
2935
2936 <itemizedlist>
2937
2938 <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>
2939
2940 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2941
2942 <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>
2943
2944 </itemizedlist>
2945
2946 <para>
2947 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.
2948 </para>
2949 <para>
2950         Example:
2951         net dom unjoin -S xp -U XP\\administrator%secret account=MYDOM\\administrator password=topsecret reboot.
2952 </para>
2953 <para>
2954 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.
2955 </para>
2956
2957 </refsect3>
2958
2959 <refsect3>
2960 <title>DOM RENAMECOMPUTER <replaceable>newname=NEWNAME</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2961
2962 <para>
2963 Renames a computer that is joined to a domain. This command supports the following additional parameters:
2964 </para>
2965
2966 <itemizedlist>
2967
2968 <listitem><para><replaceable>NEWNAME</replaceable> defines the new name of the machine in the domain.</para></listitem>
2969
2970 <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>
2971
2972 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2973
2974 <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>
2975
2976 </itemizedlist>
2977
2978 <para>
2979 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.
2980 </para>
2981 <para>
2982         Example:
2983         net dom renamecomputer -S xp -U XP\\administrator%secret newname=XPNEW account=MYDOM\\administrator password=topsecret reboot.
2984 </para>
2985 <para>
2986 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.
2987 </para>
2988
2989 </refsect3>
2990
2991 </refsect2>
2992
2993 <refsect2>
2994 <title>G_LOCK</title>
2995
2996 <para>Manage global locks.</para>
2997
2998 <refsect3>
2999 <title>G_LOCK DO <replaceable>lockname</replaceable> <replaceable>timeout</replaceable> <replaceable>command</replaceable></title>
3000
3001 <para>
3002 Execute a shell command under a global lock. This might be useful to define the
3003 order in which several shell commands will be executed. The locking information
3004 is stored in a file called <filename>g_lock.tdb</filename>. In setups with CTDB
3005 running, the locking information will be available on all cluster nodes.
3006 </para>
3007
3008 <itemizedlist>
3009 <listitem><para><replaceable>LOCKNAME</replaceable> defines the name of the global lock.</para></listitem>
3010 <listitem><para><replaceable>TIMEOUT</replaceable> defines the timeout.</para></listitem>
3011 <listitem><para><replaceable>COMMAND</replaceable> defines the shell command to execute.</para></listitem>
3012 </itemizedlist>
3013 </refsect3>
3014
3015 <refsect3>
3016 <title>G_LOCK LOCKS</title>
3017
3018 <para>
3019 Print a list of all currently existing locknames.
3020 </para>
3021 </refsect3>
3022
3023 <refsect3>
3024 <title>G_LOCK DUMP <replaceable>lockname</replaceable></title>
3025
3026 <para>
3027 Dump the locking table of a certain global lock.
3028 </para>
3029 </refsect3>
3030
3031 </refsect2>
3032
3033 <refsect2>
3034         <title>TDB</title>
3035
3036         <para>Print information from tdb records.</para>
3037
3038         <refsect3>
3039                 <title>TDB LOCKING <replaceable>key</replaceable> [DUMP]</title>
3040
3041                 <para>List sharename, filename and number of share modes
3042                 for a record from locking.tdb. With the optional DUMP options,
3043                 dump the complete record.</para>
3044
3045                 <itemizedlist>
3046                         <listitem>
3047                                 <para><replaceable>KEY</replaceable>
3048                                 Key of the tdb record as hex string.</para>
3049                         </listitem>
3050                 </itemizedlist>
3051
3052         </refsect3>
3053 </refsect2>
3054
3055 <refsect2>
3056   <title>vfs</title>
3057   <para>Access shared filesystem through the VFS.</para>
3058
3059   <refsect3>
3060     <title>vfs stream2abouble [--recursive] [--verbose] [--continue] [--follow-symlinks] <replaceable>share</replaceable> <replaceable>path</replaceable></title>
3061
3062     <para>Convert file streams to AppleDouble files.</para>
3063     <itemizedlist>
3064       <listitem>
3065         <para><replaceable>share</replaceable>
3066         A Samba share.</para>
3067       </listitem>
3068     </itemizedlist>
3069     <itemizedlist>
3070       <listitem>
3071         <para><replaceable>path</replaceable> A relative path of something in
3072         the Samba share. "." can be used for the root directory of the
3073         share.</para>
3074       </listitem>
3075     </itemizedlist>
3076
3077     <para>Options:</para>
3078     <variablelist>
3079       <varlistentry>
3080         <term>--recursive</term>
3081         <listitem><para>Traverse a directory hierarchy.</para></listitem>
3082       </varlistentry>
3083       <varlistentry>
3084         <term>--verbose</term>
3085         <listitem><para>Verbose output.</para></listitem>
3086       </varlistentry>
3087       <varlistentry>
3088         <term>--continue</term>
3089         <listitem><para>Continue traversing a directory hierarchy if a single
3090         conversion fails.</para></listitem>
3091       </varlistentry>
3092       <varlistentry>
3093         <term>--follow-symlinks</term>
3094         <listitem><para>Follow symlinks encountered while traversing a
3095         directory.</para></listitem>
3096       </varlistentry>
3097     </variablelist>
3098   </refsect3>
3099
3100   <refsect3>
3101     <title>vfs getntacl <replaceable>share</replaceable> <replaceable>path</replaceable></title>
3102
3103     <para>Display the security descriptor of a file or directory.</para>
3104     <itemizedlist>
3105       <listitem>
3106         <para><replaceable>share</replaceable>
3107         A Samba share.</para>
3108       </listitem>
3109     </itemizedlist>
3110     <itemizedlist>
3111       <listitem>
3112         <para><replaceable>path</replaceable> A relative path of something in
3113         the Samba share. "." can be used for the root directory of the
3114         share.</para>
3115       </listitem>
3116     </itemizedlist>
3117   </refsect3>
3118
3119 </refsect2>
3120
3121 <refsect2>
3122 <title>OFFLINEJOIN</title>
3123
3124 <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.
3125 </para>
3126
3127 <para>The following offline commands are implemented:
3128 <simplelist>
3129 <member>net offlinejoin provision - Provisions a machine account in AD.</member>
3130 <member>net offlinejoin requestodj - Requests a domain offline join.</member>
3131 </simplelist>
3132 </para>
3133
3134 <refsect3>
3135         <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>
3136
3137 <para>
3138 Provisions a machine account in AD. This command needs network connectivity to the domain controller to succeed. This command supports the following additional parameters:
3139 </para>
3140
3141 <itemizedlist>
3142
3143 <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>
3144
3145 <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>
3146
3147 <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>
3148
3149 <listitem><para><replaceable>DCNAME</replaceable> defines a specific domain controller for creating the machine account in AD.</para></listitem>
3150
3151 <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>
3152
3153 <listitem><para><replaceable>REUSE</replaceable> is an optional parameter that can be set to enforce reusing an existing machine account in AD.</para></listitem>
3154
3155 <listitem><para><replaceable>SAVEFILE</replaceable> is an optional parameter to store the generated provisioning data on disk.</para></listitem>
3156
3157 <listitem><para><replaceable>PRINTBLOB</replaceable> is an optional parameter to print the generated provisioning data on stdout.</para></listitem>
3158
3159 </itemizedlist>
3160
3161 <para>
3162         Example:
3163         net offlinejoin provision -U administrator%secret domain=MYDOM machine_name=MYHOST savefile=provisioning.txt
3164 </para>
3165 </refsect3>
3166
3167 <refsect3>
3168         <title>OFFLINEJOIN REQUESTODJ <replaceable>loadfile=FILENAME</replaceable></title>
3169
3170 <para>
3171 Requests an offline domain join by providing file-based provisioning data. This command supports the following additional parameters:
3172 </para>
3173
3174 <itemizedlist>
3175
3176 <listitem><para><replaceable>LOADFILE</replaceable> is a required parameter to load the provisioning from a file.</para></listitem>
3177
3178 </itemizedlist>
3179
3180 <para>
3181         Example:
3182         net offlinejoin requestodj -U administrator%secret loadfile=provisioning.txt
3183 </para>
3184
3185 </refsect3>
3186
3187 </refsect2>
3188
3189 <refsect2>
3190 <title>WITNESS</title>
3191
3192 <para>Starting with version 4.20 Samba has support for the SMB Witness service in a cluster.
3193 </para>
3194
3195 <para>The following witness commands are implemented:
3196 <simplelist>
3197 <member>
3198 net witness list             List witness registrations from rpcd_witness_registration.tdb.
3199 </member>
3200 <member>
3201 net witness client-move      Generate client move notifications for witness registrations to a new ip or node.
3202 </member>
3203 <member>
3204 net witness share-move       Generate share move notifications for witness registrations to a new ip or node.
3205 </member>
3206 <member>
3207 net witness force-unregister Force unregistrations for witness registrations.
3208 </member>
3209 <member>
3210 net witness force-response   Force an AsyncNotify response based on json input (mostly for testing).
3211 </member>
3212
3213 </simplelist>
3214 </para>
3215
3216 <refsect3>
3217 <title>WITNESS LIST</title>
3218 <para>
3219     List witness registrations from rpcd_witness_registration.tdb
3220 </para>
3221 <para>
3222     Note: Only supported with clustering=yes!
3223 </para>
3224 <para>
3225     Machine readable output can be generated with the following option:
3226 </para>
3227 <para>
3228         --json
3229 </para>
3230 <para>
3231     The selection of registrations can be limited by the following options:
3232 </para>
3233 <para>
3234         --witness-registration=REGISTRATION_UUID
3235 </para>
3236 <para>
3237           This does a direct lookup for REGISTRATION_UUID
3238           instead of doing a database traversal.
3239 </para>
3240 <para>
3241     The following options all take a POSIX Extended Regular Expression,
3242     which can further filter the selection of registrations.
3243     These options are applied as logical AND, but each REGEX
3244     allows specifying multiple strings using the pipe symbol.
3245 </para>
3246 <para>
3247         --witness-net-name=REGEX
3248 </para>
3249 <para>
3250           This specifies the 'server name' the client
3251           registered for monitoring.
3252 </para>
3253 <para>
3254         --witness-share-name=REGEX
3255 </para>
3256 <para>
3257           This specifies the 'share name' the client
3258           registered for monitoring.
3259           Note that the share name is optional in the
3260           registration, otherwise an empty string is
3261           matched.
3262 </para>
3263 <para>
3264         --witness-ip-address=REGEX
3265 </para>
3266 <para>
3267           This specifies the ip address the client
3268           registered for monitoring.
3269 </para>
3270 <para>
3271         --witness-client-computer-name=REGEX
3272 </para>
3273 <para>
3274           This specifies the client computer name the client
3275           specified in the registration.
3276           Note it is just a string chosen by the client itself.
3277 </para>
3278
3279 </refsect3>
3280
3281 <refsect3>
3282 <title>WITNESS CLIENT-MOVE</title>
3283 <para>
3284     Generate client move notifications for witness registrations to a new ip or node
3285 </para>
3286 <para>
3287     Note: Only supported with clustering=yes!
3288 </para>
3289 <para>
3290     Machine readable output can be generated with the following option:
3291 </para>
3292 <para>
3293         --json
3294 </para>
3295 <para>
3296     The selection of registrations can be limited by the following options:
3297 </para>
3298 <para>
3299         --witness-registration=REGISTRATION_UUID
3300 </para>
3301 <para>
3302           This does a direct lookup for REGISTRATION_UUID
3303           instead of doing a database traversal.
3304 </para>
3305 <para>
3306     The following options all take a POSIX Extended Regular Expression,
3307     which can further filter the selection of registrations.
3308     These options are applied as logical AND, but each REGEX
3309     allows specifying multiple strings using the pipe symbol.
3310 </para>
3311 <para>
3312         --witness-net-name=REGEX
3313 </para>
3314 <para>
3315           This specifies the 'server name' the client
3316           registered for monitoring.
3317 </para>
3318 <para>
3319         --witness-share-name=REGEX
3320 </para>
3321 <para>
3322           This specifies the 'share name' the client
3323           registered for monitoring.
3324           Note that the share name is optional in the
3325           registration, otherwise an empty string is
3326           matched.
3327 </para>
3328 <para>
3329         --witness-ip-address=REGEX
3330 </para>
3331 <para>
3332           This specifies the ip address the client
3333           registered for monitoring.
3334 </para>
3335 <para>
3336         --witness-client-computer-name=REGEX
3337 </para>
3338 <para>
3339           This specifies the client computer name the client
3340           specified in the registration.
3341           Note it is just a string chosen by the client itself.
3342 </para>
3343 <para>
3344     If the update should be applied to all registrations
3345     it needs to be explicitly specified:
3346 </para>
3347 <para>
3348         --witness-apply-to-all
3349 </para>
3350 <para>
3351           This selects all registrations.
3352           Note: This is mutual exclusive to the above options.
3353 </para>
3354 <para>
3355     The content of the CLIENT_MOVE notification contains ip addresses
3356     specified by (exactly one) of the following options:
3357 </para>
3358 <para>
3359         --witness-new-node=NODEID
3360 </para>
3361 <para>
3362           By specifying a NODEID all ip addresses
3363           currently available on the given node are
3364           included in the response.
3365           By specifying '-1' as NODEID all ip addresses
3366           of the cluster are included in the response.
3367 </para>
3368 <para>
3369         --witness-new-ip=IPADDRESS
3370 </para>
3371 <para>
3372           By specifying an IPADDRESS only the specified
3373           ip address is included in the response.
3374 </para>
3375
3376 </refsect3>
3377
3378 <refsect3>
3379 <title>WITNESS SHARE-MOVE</title>
3380 <para>
3381     Generate share move notifications for witness registrations to a new ip or node
3382 </para>
3383 <para>
3384     Note: Only supported with clustering=yes!
3385 </para>
3386 <para>
3387     Machine readable output can be generated with the following option:
3388 </para>
3389 <para>
3390         --json
3391 </para>
3392 <para>
3393     The selection of registrations can be limited by the following options:
3394 </para>
3395 <para>
3396         --witness-registration=REGISTRATION_UUID
3397 </para>
3398 <para>
3399           This does a direct lookup for REGISTRATION_UUID
3400           instead of doing a database traversal.
3401 </para>
3402 <para>
3403     The following options all take a POSIX Extended Regular Expression,
3404     which can further filter the selection of registrations.
3405     These options are applied as logical AND, but each REGEX
3406     allows specifying multiple strings using the pipe symbol.
3407 </para>
3408 <para>
3409         --witness-net-name=REGEX
3410 </para>
3411 <para>
3412           This specifies the 'server name' the client
3413           registered for monitoring.
3414 </para>
3415 <para>
3416         --witness-share-name=REGEX
3417 </para>
3418 <para>
3419           This specifies the 'share name' the client
3420           registered for monitoring.
3421           Note that the share name is optional in the
3422           registration, otherwise an empty string is
3423           matched.
3424 </para>
3425 <para>
3426         --witness-ip-address=REGEX
3427 </para>
3428 <para>
3429           This specifies the ip address the client
3430           registered for monitoring.
3431 </para>
3432 <para>
3433         --witness-client-computer-name=REGEX
3434 </para>
3435 <para>
3436           This specifies the client computer name the client
3437           specified in the registration.
3438           Note it is just a string chosen by the client itself.
3439 </para>
3440 <para>
3441     If the update should be applied to all registrations
3442     it needs to be explicitly specified:
3443 </para>
3444 <para>
3445         --witness-apply-to-all
3446 </para>
3447 <para>
3448           This selects all registrations.
3449           Note: This is mutual exclusive to the above options.
3450 </para>
3451 <para>
3452     Note: This only applies to registrations with a non empty share name!
3453 </para>
3454 <para>
3455     The content of the SHARE_MOVE notification contains ip addresses
3456     specified by (exactly one) of the following options:
3457 </para>
3458 <para>
3459         --witness-new-node=NODEID
3460 </para>
3461 <para>
3462           By specifying a NODEID all ip addresses
3463           currently available on the given node are
3464           included in the response.
3465           By specifying '-1' as NODEID all ip addresses
3466           of the cluster are included in the response.
3467 </para>
3468 <para>
3469         --witness-new-ip=IPADDRESS
3470 </para>
3471 <para>
3472           By specifying an IPADDRESS only the specified
3473           ip address is included in the response.
3474 </para>
3475
3476 </refsect3>
3477
3478 <refsect3>
3479 <title>WITNESS FORCE-UNREGISTER</title>
3480 <para>
3481     Force unregistrations for witness registrations
3482 </para>
3483 <para>
3484     Note: Only supported with clustering=yes!
3485 </para>
3486 <para>
3487     Machine readable output can be generated with the following option:
3488 </para>
3489 <para>
3490         --json
3491 </para>
3492 <para>
3493     The selection of registrations can be limited by the following options:
3494 </para>
3495 <para>
3496         --witness-registration=REGISTRATION_UUID
3497 </para>
3498 <para>
3499           This does a direct lookup for REGISTRATION_UUID
3500           instead of doing a database traversal.
3501 </para>
3502 <para>
3503     The following options all take a POSIX Extended Regular Expression,
3504     which can further filter the selection of registrations.
3505     These options are applied as logical AND, but each REGEX
3506     allows specifying multiple strings using the pipe symbol.
3507 </para>
3508 <para>
3509         --witness-net-name=REGEX
3510 </para>
3511 <para>
3512           This specifies the 'server name' the client
3513           registered for monitoring.
3514 </para>
3515 <para>
3516         --witness-share-name=REGEX
3517 </para>
3518 <para>
3519           This specifies the 'share name' the client
3520           registered for monitoring.
3521           Note that the share name is optional in the
3522           registration, otherwise an empty string is
3523           matched.
3524 </para>
3525 <para>
3526         --witness-ip-address=REGEX
3527 </para>
3528 <para>
3529           This specifies the ip address the client
3530           registered for monitoring.
3531 </para>
3532 <para>
3533         --witness-client-computer-name=REGEX
3534 </para>
3535 <para>
3536           This specifies the client computer name the client
3537           specified in the registration.
3538           Note it is just a string chosen by the client itself.
3539 </para>
3540 <para>
3541     If the update should be applied to all registrations
3542     it needs to be explicitly specified:
3543 </para>
3544 <para>
3545         --witness-apply-to-all
3546 </para>
3547 <para>
3548           This selects all registrations.
3549           Note: This is mutual exclusive to the above options.
3550 </para>
3551 <para>
3552     The selected registrations are removed on the server and
3553     any pending AsyncNotify request will get a NOT_FOUND error.
3554 </para>
3555 <para>
3556     Typically this triggers a clean re-registration on the client.
3557 </para>
3558
3559 </refsect3>
3560
3561 <refsect3>
3562 <title>WITNESS FORCE-RESPONSE</title>
3563 <para>
3564     Force an AsyncNotify response based on json input (mostly for testing)
3565 </para>
3566 <para>
3567     Note: Only supported with clustering=yes!
3568 </para>
3569 <para>
3570     Machine readable output can be generated with the following option:
3571 </para>
3572 <para>
3573         --json
3574 </para>
3575 <para>
3576     The selection of registrations can be limited by the following options:
3577 </para>
3578 <para>
3579         --witness-registration=REGISTRATION_UUID
3580 </para>
3581 <para>
3582           This does a direct lookup for REGISTRATION_UUID
3583           instead of doing a database traversal.
3584 </para>
3585 <para>
3586     The following options all take a POSIX Extended Regular Expression,
3587     which can further filter the selection of registrations.
3588     These options are applied as logical AND, but each REGEX
3589     allows specifying multiple strings using the pipe symbol.
3590 </para>
3591 <para>
3592         --witness-net-name=REGEX
3593 </para>
3594 <para>
3595           This specifies the 'server name' the client
3596           registered for monitoring.
3597 </para>
3598 <para>
3599         --witness-share-name=REGEX
3600 </para>
3601 <para>
3602           This specifies the 'share name' the client
3603           registered for monitoring.
3604           Note that the share name is optional in the
3605           registration, otherwise an empty string is
3606           matched.
3607 </para>
3608 <para>
3609         --witness-ip-address=REGEX
3610 </para>
3611 <para>
3612           This specifies the ip address the client
3613           registered for monitoring.
3614 </para>
3615 <para>
3616         --witness-client-computer-name=REGEX
3617 </para>
3618 <para>
3619           This specifies the client computer name the client
3620           specified in the registration.
3621           Note it is just a string chosen by the client itself.
3622 </para>
3623 <para>
3624     If the update should be applied to all registrations
3625     it needs to be explicitly specified:
3626 </para>
3627 <para>
3628         --witness-apply-to-all
3629 </para>
3630 <para>
3631           This selects all registrations.
3632           Note: This is mutual exclusive to the above options.
3633 </para>
3634 <para>
3635     Note this is designed for testing and debugging!
3636 </para>
3637 <para>
3638     In short it is not designed to be used by administrators,
3639     but developers and automated tests.
3640 </para>
3641 <para>
3642     By default an empty response with WERR_OK is generated,
3643     but basically any valid response can be specified by a
3644     specifying a JSON string:
3645 </para>
3646 <para>
3647         --witness-forced-response=JSON
3648 </para>
3649 <para>
3650           This allows the generation of very complex
3651           witness_notifyResponse structures.
3652 </para>
3653 <para>
3654     As this is for developers, please read the code
3655     in order to understand all possible values
3656     of the JSON string format...
3657 </para>
3658 <para>
3659     See 'net help witness force-response' for further details.
3660 </para>
3661
3662 </refsect3>
3663
3664 </refsect2>
3665
3666 <refsect2>
3667 <title>HELP [COMMAND]</title>
3668
3669 <para>Gives usage information for the specified command.</para>
3670
3671 </refsect2>
3672
3673 </refsect1>
3674
3675 <refsect1>
3676         <title>VERSION</title>
3677
3678         <para>This man page is complete for version 3 of the Samba
3679         suite.</para>
3680 </refsect1>
3681
3682 <refsect1>
3683         <title>AUTHOR</title>
3684
3685         <para>The original Samba software and related utilities
3686         were created by Andrew Tridgell. Samba is now developed
3687         by the Samba Team as an Open Source project similar
3688         to the way the Linux kernel is developed.</para>
3689
3690         <para>The net manpage was written by Jelmer Vernooij.</para>
3691
3692 </refsect1>
3693
3694 </refentry>