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