docs-xml/manpages/samba-tool.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="samba-tool.8">
   4
   5 <refmeta>
   6         <refentrytitle>samba-tool</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>samba-tool</refname>
  16         <refpurpose>Main Samba administration tool.
  17         </refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21         <cmdsynopsis>
  22                 <command>samba-tool</command>
  23                 <arg choice="opt">-h</arg>
  24                 <arg choice="opt">-W myworkgroup</arg>
  25                 <arg choice="opt">-U user</arg>
  26                 <arg choice="opt">-d debuglevel</arg>
  27                 <arg choice="opt">--v</arg>
  28         </cmdsynopsis>
  29 </refsynopsisdiv>
  30
  31 <refsect1>
  32         <title>DESCRIPTION</title>
  33         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  34         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  35 </refsect1>
  36
  37 <refsect1>
  38         <title>OPTIONS</title>
  39
  40         <variablelist>
  41
  42         <varlistentry>
  43         <term>-h|--help</term>
  44         <listitem><para>
  45         Show this help message and exit
  46         </para></listitem>
  47         </varlistentry>
  48
  49         <varlistentry>
  50         <term>--realm=REALM</term>
  51         <listitem><para>
  52         Set the realm name
  53         </para></listitem>
  54         </varlistentry>
  55
  56         <varlistentry>
  57         <term>--simple-bind-dn=DN</term>
  58         <listitem><para>
  59         DN to use for a simple bind
  60         </para></listitem>
  61         </varlistentry>
  62
  63         <varlistentry>
  64         <term>--password=PASSWORD</term>
  65         <listitem><para>
  66         Password
  67         </para></listitem>
  68         </varlistentry>
  69
  70         <varlistentry>
  71         <term>-U USERNAME|--username=USERNAME</term>
  72         <listitem><para>
  73         Username
  74         </para></listitem>
  75         </varlistentry>
  76
  77         <varlistentry>
  78         <term>-W WORKGROUP|--workgroup=WORKGROUP</term>
  79         <listitem><para>
  80         Workgroup
  81         </para></listitem>
  82         </varlistentry>
  83
  84         <varlistentry>
  85         <term>-N|--no-pass</term>
  86         <listitem><para>
  87         Don't ask for a password
  88         </para></listitem>
  89         </varlistentry>
  90
  91         <varlistentry>
  92         <term>-k KERBEROS|--kerberos=KERBEROS</term>
  93         <listitem><para>
  94         Use Kerberos
  95         </para></listitem>
  96         </varlistentry>
  97
  98         <varlistentry>
  99         <term>--ipaddress=IPADDRESS</term>
 100         <listitem><para>
 101         IP address of the server
 102         </para></listitem>
 103         </varlistentry>
 104
 105         &popt.common.samba.client;
 106
 107         </variablelist>
 108 </refsect1>
 109
 110 <refsect1>
 111 <title>COMMANDS</title>
 112
 113 <refsect2>
 114         <title>computer</title>
 115         <para>Manage computer accounts.</para>
 116 </refsect2>
 117
 118 <refsect3>
 119         <title>computer add <replaceable>computername</replaceable> [options]</title>
 120         <para>Add a new computer to the Active Directory Domain.</para>
 121         <para>The new computer name specified on the command is the
 122         sAMAccountName, with or without the trailing dollar sign.</para>
 123
 124         <variablelist>
 125         <varlistentry>
 126         <term>--computerou=COMPUTEROU</term>
 127         <listitem><para>
 128         DN of alternative location (with or without domainDN counterpart) to
 129         default CN=Computers in which new computer object will be created.
 130         E.g. 'OU=OUname'.
 131         </para></listitem>
 132         </varlistentry>
 133
 134         <varlistentry>
 135         <term>--description=DESCRIPTION</term>
 136         <listitem><para>
 137         The new computers's description.
 138         </para></listitem>
 139         </varlistentry>
 140
 141         <varlistentry>
 142         <term>--ip-address=IP_ADDRESS_LIST</term>
 143         <listitem><para>
 144         IPv4 address for the computer's A record, or IPv6 address for AAAA record,
 145         can be provided multiple times.
 146         </para></listitem>
 147         </varlistentry>
 148
 149         <varlistentry>
 150         <term>--service-principal-name=SERVICE_PRINCIPAL_NAME_LIST</term>
 151         <listitem><para>
 152         Computer's Service Principal Name, can be provided multiple times.
 153         </para></listitem>
 154         </varlistentry>
 155
 156         <varlistentry>
 157         <term>--prepare-oldjoin</term>
 158         <listitem><para>
 159         Prepare enabled machine account for oldjoin mechanism.
 160         </para></listitem>
 161         </varlistentry>
 162         </variablelist>
 163 </refsect3>
 164
 165 <refsect3>
 166         <title>computer create <replaceable>computername</replaceable> [options]</title>
 167         <para>Add a new computer. This is a synonym for the
 168         <command>samba-tool computer add</command> command and is available
 169         for compatibility reasons only. Please use
 170         <command>samba-tool computer add</command> instead.</para>
 171 </refsect3>
 172
 173 <refsect3>
 174         <title>computer delete <replaceable>computername</replaceable> [options]</title>
 175         <para>Delete an existing computer account.</para>
 176         <para>The computer name specified on the command is the
 177         sAMAccountName, with or without the trailing dollar sign.</para>
 178 </refsect3>
 179
 180 <refsect3>
 181         <title>computer edit <replaceable>computername</replaceable></title>
 182         <para>Edit a computer AD object.</para>
 183         <para>The computer name specified on the command is the
 184         sAMAccountName, with or without the trailing dollar sign.</para>
 185
 186         <variablelist>
 187         <varlistentry>
 188         <term>--editor=EDITOR</term>
 189         <listitem><para>
 190         Specifies the editor to use instead of the system default, or 'vi' if no
 191         system default is set.
 192         </para></listitem>
 193         </varlistentry>
 194         </variablelist>
 195 </refsect3>
 196
 197 <refsect3>
 198         <title>computer list</title>
 199         <para>List all computers.</para>
 200 </refsect3>
 201
 202 <refsect3>
 203         <title>computer move <replaceable>computername</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
 204         <para>This command moves a computer account into the specified
 205         organizational unit or container.</para>
 206         <para>The computername specified on the command is the
 207         sAMAccountName, with or without the trailing dollar sign.</para>
 208         <para>The name of the organizational unit or container can be
 209         specified as a full DN or without the domainDN component.</para>
 210 </refsect3>
 211
 212 <refsect3>
 213         <title>computer show <replaceable>computername</replaceable> [options]</title>
 214         <para>Display a computer AD object.</para>
 215         <para>The computer name specified on the command is the
 216         sAMAccountName, with or without the trailing dollar sign.</para>
 217
 218         <variablelist>
 219         <varlistentry>
 220         <term>--attributes=USER_ATTRS</term>
 221         <listitem><para>
 222         Comma separated list of attributes, which will be printed.
 223         </para></listitem>
 224         </varlistentry>
 225         </variablelist>
 226 </refsect3>
 227
 228 <refsect2>
 229         <title>contact</title>
 230         <para>Manage contacts.</para>
 231 </refsect2>
 232
 233 <refsect3>
 234         <title>contact add [<replaceable>contactname</replaceable>] [options]</title>
 235         <para>Add a new contact to the Active Directory Domain.</para>
 236         <para>The name of the new contact can be specified by the first
 237         argument 'contactname' or the --given-name, --initial and --surname
 238         arguments. If no 'contactname' is given, contact's name will be made
 239         up of the given arguments by combining the given-name, initials and
 240         surname. Each argument is optional. A dot ('.') will be appended to
 241         the initials automatically.</para>
 242
 243         <variablelist>
 244         <varlistentry>
 245         <term>--ou=OU</term>
 246         <listitem><para>
 247         DN of alternative location (with or without domainDN counterpart) in
 248         which the new contact will be created.
 249         E.g. 'OU=OUname'.
 250         Default is the domain base.
 251         </para></listitem>
 252         </varlistentry>
 253
 254         <varlistentry>
 255         <term>--description=DESCRIPTION</term>
 256         <listitem><para>
 257         The new contacts's description.
 258         </para></listitem>
 259         </varlistentry>
 260
 261         <varlistentry>
 262         <term>--surname=SURNAME</term>
 263         <listitem><para>
 264         Contact's surname.
 265         </para></listitem>
 266         </varlistentry>
 267
 268         <varlistentry>
 269         <term>--given-name=GIVEN_NAME</term>
 270         <listitem><para>
 271         Contact's given name.
 272         </para></listitem>
 273         </varlistentry>
 274
 275         <varlistentry>
 276         <term>--initials=INITIALS</term>
 277         <listitem><para>
 278         Contact's initials.
 279         </para></listitem>
 280         </varlistentry>
 281
 282         <varlistentry>
 283         <term>--display-name=DISPLAY_NAME</term>
 284         <listitem><para>
 285         Contact's display name.
 286         </para></listitem>
 287         </varlistentry>
 288
 289         <varlistentry>
 290         <term>--job-title=JOB_TITLE</term>
 291         <listitem><para>
 292         Contact's job title.
 293         </para></listitem>
 294         </varlistentry>
 295
 296         <varlistentry>
 297         <term>--department=DEPARTMENT</term>
 298         <listitem><para>
 299         Contact's department.
 300         </para></listitem>
 301         </varlistentry>
 302
 303         <varlistentry>
 304         <term>--company=COMPANY</term>
 305         <listitem><para>
 306         Contact's company.
 307         </para></listitem>
 308         </varlistentry>
 309
 310         <varlistentry>
 311         <term>--mail-address=MAIL_ADDRESS</term>
 312         <listitem><para>
 313         Contact's email address.
 314         </para></listitem>
 315         </varlistentry>
 316
 317         <varlistentry>
 318         <term>--internet-address=INTERNET_ADDRESS</term>
 319         <listitem><para>
 320         Contact's home page.
 321         </para></listitem>
 322         </varlistentry>
 323
 324         <varlistentry>
 325         <term>--telephone-number=TELEPHONE_NUMBER</term>
 326         <listitem><para>
 327         Contact's phone number.
 328         </para></listitem>
 329         </varlistentry>
 330
 331         <varlistentry>
 332         <term>--mobile-number=MOBILE_NUMBER</term>
 333         <listitem><para>
 334         Contact's mobile phone number.
 335         </para></listitem>
 336         </varlistentry>
 337
 338         <varlistentry>
 339         <term>--physical-delivery-office=PHYSICAL_DELIVERY_OFFICE</term>
 340         <listitem><para>
 341         Contact's office location.
 342         </para></listitem>
 343         </varlistentry>
 344
 345         </variablelist>
 346 </refsect3>
 347
 348 <refsect3>
 349         <title>contact create [<replaceable>contactname</replaceable>] [options]</title>
 350         <para>Add a new contact. This is a synonym for the
 351         <command>samba-tool contact add</command> command and is available
 352         for compatibility reasons only. Please use
 353         <command>samba-tool contact add</command> instead.</para>
 354 </refsect3>
 355
 356 <refsect3>
 357         <title>contact delete <replaceable>contactname</replaceable> [options]</title>
 358         <para>Delete an existing contact.</para>
 359         <para>The contactname specified on the command is the common name or the
 360         distinguished name of the contact object. The distinguished name of the
 361         contact can be specified with or without the domainDN component.</para>
 362 </refsect3>
 363
 364 <refsect3>
 365         <title>contact edit <replaceable>contactname</replaceable></title>
 366         <para>Modify a contact AD object.</para>
 367         <para>The contactname specified on the command is the common name or the
 368         distinguished name of the contact object. The distinguished name of the
 369         contact can be specified with or without the domainDN component.</para>
 370
 371         <variablelist>
 372         <varlistentry>
 373         <term>--editor=EDITOR</term>
 374         <listitem><para>
 375         Specifies the editor to use instead of the system default, or 'vi' if no
 376         system default is set.
 377         </para></listitem>
 378         </varlistentry>
 379         </variablelist>
 380 </refsect3>
 381
 382 <refsect3>
 383         <title>contact list [options]</title>
 384         <para>List all contacts.</para>
 385
 386         <variablelist>
 387         <varlistentry>
 388         <term>--full-dn</term>
 389         <listitem><para>
 390         Display contact's full DN instead of the name.
 391         </para></listitem>
 392         </varlistentry>
 393         </variablelist>
 394 </refsect3>
 395
 396 <refsect3>
 397         <title>contact move <replaceable>contactname</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
 398         <para>This command moves a contact into the specified organizational
 399         unit or container.</para>
 400         <para>The contactname specified on the command is the common name or the
 401         distinguished name of the contact object. The distinguished name of the
 402         contact can be specified with or without the domainDN component.</para>
 403 </refsect3>
 404
 405 <refsect3>
 406         <title>contact show <replaceable>contactname</replaceable> [options]</title>
 407         <para>Display a contact AD object.</para>
 408         <para>The contactname specified on the command is the common name or the
 409         distinguished name of the contact object. The distinguished name of the
 410         contact can be specified with or without the domainDN component.</para>
 411
 412         <variablelist>
 413         <varlistentry>
 414         <term>--attributes=CONTACT_ATTRS</term>
 415         <listitem><para>
 416         Comma separated list of attributes, which will be printed.
 417         </para></listitem>
 418         </varlistentry>
 419         </variablelist>
 420 </refsect3>
 421
 422 <refsect3>
 423         <title>contact rename <replaceable>contactname</replaceable> [options]</title>
 424         <para>Rename a contact and related attributes.</para>
 425         <para>This command allows to set the contact's name related attributes. The contact's
 426         CN will be renamed automatically.
 427         The contact's new CN will be made up by combining the given-name, initials
 428         and surname. A dot ('.') will be appended to the initials automatically,
 429         if required.
 430         Use the --force-new-cn option to specify the new CN manually and --reset-cn
 431         to reset this change.</para>
 432         <para>Use an empty attribute value to remove the specified attribute.</para>
 433         <para>The contact name specified on the command is the CN.</para>
 434
 435         <variablelist>
 436         <varlistentry>
 437         <term>--surname=SURNAME</term>
 438         <listitem><para>
 439         New surname.
 440         </para></listitem>
 441         </varlistentry>
 442
 443         <varlistentry>
 444         <term>--given-name=GIVEN_NAME</term>
 445         <listitem><para>
 446         New given name.
 447         </para></listitem>
 448         </varlistentry>
 449
 450         <varlistentry>
 451         <term>--initials=INITIALS</term>
 452         <listitem><para>
 453         New initials.
 454         </para></listitem>
 455         </varlistentry>
 456
 457         <varlistentry>
 458         <term>--force-new-cn=NEW_CN</term>
 459         <listitem><para>
 460         Specify a new CN (RDN) instead of using a combination
 461         of the given name, initials and surname.
 462         </para></listitem>
 463         </varlistentry>
 464
 465         <varlistentry>
 466         <term>--reset-cn</term>
 467         <listitem><para>
 468         Set the CN to the default combination of given name,
 469         initials and surname.
 470         </para></listitem>
 471         </varlistentry>
 472
 473         <varlistentry>
 474         <term>--display-name=DISPLAY_NAME</term>
 475         <listitem><para>
 476         New display name.
 477         </para></listitem>
 478         </varlistentry>
 479
 480         <varlistentry>
 481         <term>--mail-address=MAIL_ADDRESS</term>
 482         <listitem><para>
 483         New email address.
 484         </para></listitem>
 485         </varlistentry>
 486         </variablelist>
 487 </refsect3>
 488
 489 <refsect2>
 490         <title>dbcheck</title>
 491         <para>Check the local AD database for errors.</para>
 492 </refsect2>
 493
 494 <refsect2>
 495         <title>delegation</title>
 496         <para>Manage Delegations.</para>
 497 </refsect2>
 498
 499 <refsect3>
 500         <title>delegation add-service <replaceable>accountname</replaceable> <replaceable>principal</replaceable> [options]</title>
 501         <para>Add a service principal as msDS-AllowedToDelegateTo.</para>
 502 </refsect3>
 503
 504 <refsect3>
 505         <title>delegation del-service <replaceable>accountname</replaceable> <replaceable>principal</replaceable> [options]</title>
 506         <para>Delete a service principal as msDS-AllowedToDelegateTo.</para>
 507 </refsect3>
 508
 509 <refsect3>
 510         <title>delegation for-any-protocol <replaceable>accountname</replaceable> [(on|off)] [options]</title>
 511         <para>Set/unset UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION (S4U2Proxy)
 512         for an account.</para>
 513 </refsect3>
 514
 515 <refsect3>
 516         <title>delegation for-any-service <replaceable>accountname</replaceable> [(on|off)] [options]</title>
 517         <para>Set/unset UF_TRUSTED_FOR_DELEGATION for an account.</para>
 518 </refsect3>
 519
 520 <refsect3>
 521         <title>delegation show <replaceable>accountname</replaceable> [options] </title>
 522         <para>Show the delegation setting of an account.</para>
 523 </refsect3>
 524
 525 <refsect2>
 526         <title>dns</title>
 527         <para>Manage Domain Name Service (DNS).</para>
 528 </refsect2>
 529
 530 <refsect3>
 531         <title>dns add <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT</replaceable> <replaceable>data</replaceable></title>
 532         <para>Add a DNS record.</para>
 533 </refsect3>
 534
 535 <refsect3>
 536         <title>dns delete <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT</replaceable> <replaceable>data</replaceable></title>
 537         <para>Delete a DNS record.</para>
 538 </refsect3>
 539
 540 <refsect3>
 541         <title>dns query <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT|ALL</replaceable> [options] <replaceable>data</replaceable></title>
 542         <para>Query a name.</para>
 543 </refsect3>
 544
 545 <refsect3>
 546         <title>dns roothints <replaceable>server</replaceable> [<replaceable>name</replaceable>] [options]</title>
 547         <para>Query root hints.</para>
 548 </refsect3>
 549
 550 <refsect3>
 551         <title>dns serverinfo <replaceable>server</replaceable> [options]</title>
 552         <para>Query server information.</para>
 553 </refsect3>
 554
 555 <refsect3>
 556         <title>dns update <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT</replaceable> <replaceable>olddata</replaceable> <replaceable>newdata</replaceable></title>
 557         <para>Update a DNS record.</para>
 558 </refsect3>
 559
 560 <refsect3>
 561         <title>dns zonecreate <replaceable>server</replaceable> <replaceable>zone</replaceable> [options]</title>
 562         <para>Create a zone.</para>
 563 </refsect3>
 564
 565 <refsect3>
 566         <title>dns zonedelete <replaceable>server</replaceable> <replaceable>zone</replaceable> [options]</title>
 567         <para>Delete a zone.</para>
 568 </refsect3>
 569
 570 <refsect3>
 571         <title>dns zoneinfo <replaceable>server</replaceable> <replaceable>zone</replaceable> [options]</title>
 572         <para>Query zone information.</para>
 573 </refsect3>
 574
 575 <refsect3>
 576         <title>dns zonelist <replaceable>server</replaceable> [options]</title>
 577         <para>List zones.</para>
 578 </refsect3>
 579
 580 <refsect2>
 581         <title>domain</title>
 582         <para>Manage Domain.</para>
 583 </refsect2>
 584
 585 <refsect3>
 586         <title>domain backup</title>
 587         <para>Create or restore a backup of the domain.</para>
 588 </refsect3>
 589
 590 <refsect3>
 591         <title>domain backup offline</title>
 592         <para>Backup (with proper locking) local domain directories into a tar file.</para>
 593 </refsect3>
 594
 595 <refsect3>
 596         <title>domain backup online</title>
 597         <para>Copy a running DC's current DB into a backup tar file.</para>
 598 </refsect3>
 599
 600 <refsect3>
 601         <title>domain backup rename</title>
 602         <para>Copy a running DC's DB to backup file, renaming the domain in the process.</para>
 603 </refsect3>
 604
 605 <refsect3>
 606         <title>domain backup restore</title>
 607         <para>Restore the domain's DB from a backup-file.</para>
 608 </refsect3>
 609
 610 <refsect3>
 611         <title>domain classicupgrade [options] <replaceable>classic_smb_conf</replaceable></title>
 612         <para>Upgrade from Samba classic (NT4-like) database to Samba AD DC
 613         database.</para>
 614 </refsect3>
 615
 616 <refsect3>
 617         <title>domain dcpromo <replaceable>dnsdomain</replaceable> [DC|RODC] [options]</title>
 618         <para>Promote an existing domain member or NT4 PDC to an AD DC.</para>
 619 </refsect3>
 620
 621 <refsect3>
 622         <title>domain demote</title>
 623         <para>Demote ourselves from the role of domain controller.</para>
 624 </refsect3>
 625
 626 <refsect3>
 627         <title>domain exportkeytab <replaceable>keytab</replaceable> [options]</title>
 628         <para>Dumps Kerberos keys of the domain into a keytab.</para>
 629 </refsect3>
 630
 631 <refsect3>
 632         <title>domain info <replaceable>ip_address</replaceable> [options]</title>
 633         <para>Print basic info about a domain and the specified DC.
 634 </para>
 635 </refsect3>
 636
 637 <refsect3>
 638         <title>domain join <replaceable>dnsdomain</replaceable> [DC|RODC|MEMBER|SUBDOMAIN] [options]</title>
 639         <para>Join a domain as either member or backup domain controller.</para>
 640 </refsect3>
 641
 642 <refsect3>
 643         <title>domain level <replaceable>show|raise</replaceable> <replaceable>options</replaceable> [options]</title>
 644         <para>Show/raise domain and forest function levels.</para>
 645 </refsect3>
 646
 647 <refsect3>
 648         <title>domain passwordsettings <replaceable>show|set</replaceable> <replaceable>options</replaceable> [options]</title>
 649         <para>Show/set password settings.</para>
 650 </refsect3>
 651
 652 <refsect3>
 653         <title>domain passwordsettings pso</title>
 654         <para>Manage fine-grained Password Settings Objects (PSOs).</para>
 655 </refsect3>
 656
 657 <refsect3>
 658         <title>domain passwordsettings pso apply <replaceable>pso-name</replaceable> <replaceable>user-or-group-name</replaceable> [options]</title>
 659         <para>Applies a PSO's password policy to a user or group.</para>
 660 </refsect3>
 661
 662 <refsect3>
 663         <title>domain passwordsettings pso create <replaceable>pso-name</replaceable> <replaceable>precedence</replaceable> [options]</title>
 664         <para>Creates a new Password Settings Object (PSO).</para>
 665 </refsect3>
 666
 667 <refsect3>
 668         <title>domain passwordsettings pso delete <replaceable>pso-name</replaceable> [options]</title>
 669         <para>Deletes a Password Settings Object (PSO).</para>
 670 </refsect3>
 671
 672 <refsect3>
 673         <title>domain passwordsettings pso list [options]</title>
 674         <para>Lists all Password Settings Objects (PSOs).</para>
 675 </refsect3>
 676
 677 <refsect3>
 678         <title>domain passwordsettings pso set <replaceable>pso-name</replaceable> [options]</title>
 679         <para>Modifies a Password Settings Object (PSO).</para>
 680 </refsect3>
 681
 682 <refsect3>
 683         <title>domain passwordsettings pso show <replaceable>user-name</replaceable> [options]</title>
 684         <para>Displays a Password Settings Object (PSO).</para>
 685 </refsect3>
 686
 687 <refsect3>
 688         <title>domain passwordsettings pso show-user <replaceable>pso-name</replaceable> [options]</title>
 689         <para>Displays the Password Settings that apply to a user.</para>
 690 </refsect3>
 691
 692 <refsect3>
 693         <title>domain passwordsettings pso unapply <replaceable>pso-name</replaceable> <replaceable>user-or-group-name</replaceable> [options]</title>
 694         <para>Updates a PSO to no longer apply to a user or group.</para>
 695 </refsect3>
 696
 697 <refsect3>
 698         <title>domain provision</title>
 699         <para>Promote an existing domain member or NT4 PDC to an AD DC.</para>
 700 </refsect3>
 701
 702 <refsect3>
 703         <title>domain trust</title>
 704         <para>Domain and forest trust management.</para>
 705 </refsect3>
 706
 707 <refsect3>
 708         <title>domain trust create <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
 709         <para>Create a domain or forest trust.</para>
 710 </refsect3>
 711
 712 <refsect3>
 713         <title>domain trust delete <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
 714         <para>Delete a domain trust.</para>
 715 </refsect3>
 716
 717 <refsect3>
 718         <title>domain trust list <replaceable>options</replaceable> [options]</title>
 719         <para>List domain trusts.</para>
 720 </refsect3>
 721
 722 <refsect3>
 723         <title>domain trust namespaces [<replaceable>DOMAIN</replaceable>] <replaceable>options</replaceable> [options]</title>
 724         <para>Manage forest trust namespaces.</para>
 725 </refsect3>
 726
 727 <refsect3>
 728         <title>domain trust show <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
 729         <para>Show trusted domain details.</para>
 730 </refsect3>
 731
 732 <refsect3>
 733         <title>domain trust validate <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
 734         <para>Validate a domain trust.</para>
 735 </refsect3>
 736
 737 <refsect2>
 738         <title>drs</title>
 739         <para>Manage Directory Replication Services (DRS).</para>
 740 </refsect2>
 741
 742 <refsect3>
 743         <title>drs bind</title>
 744         <para>Show DRS capabilities of a server.</para>
 745 </refsect3>
 746
 747 <refsect3>
 748         <title>drs kcc</title>
 749         <para>Trigger knowledge consistency center run.</para>
 750 </refsect3>
 751
 752 <refsect3>
 753         <title>drs options</title>
 754         <para>Query or change <replaceable>options</replaceable> for NTDS Settings
 755         object of a domain controller.</para>
 756 </refsect3>
 757
 758 <refsect3>
 759         <title>drs replicate <replaceable>destination_DC</replaceable> <replaceable>source_DC</replaceable> <replaceable>NC</replaceable> [options]</title>
 760         <para>Replicate a naming context between two DCs.</para>
 761 </refsect3>
 762
 763 <refsect3>
 764         <title>drs showrepl</title>
 765         <para>Show replication status. The <arg
 766         choice="opt">--json</arg> option results in JSON output, and
 767         with the <arg choice="opt">--summary</arg> option produces
 768         very little output when the replication status seems healthy.
 769         </para>
 770 </refsect3>
 771
 772 <refsect2>
 773         <title>dsacl</title>
 774         <para>Administer DS ACLs</para>
 775 </refsect2>
 776
 777 <refsect3>
 778         <title>dsacl set</title>
 779         <para>Modify access list on a directory object.</para>
 780 </refsect3>
 781
 782 <refsect2>
 783         <title>forest</title>
 784         <para>Manage Forest configuration.</para>
 785 </refsect2>
 786
 787 <refsect3>
 788         <title>forest directory_service</title>
 789         <para>Manage directory_service behaviour for the forest.</para>
 790 </refsect3>
 791
 792 <refsect3>
 793         <title>forest directory_service dsheuristics <replaceable>VALUE</replaceable></title>
 794         <para>Modify dsheuristics directory_service configuration for the forest.</para>
 795 </refsect3>
 796
 797 <refsect3>
 798         <title>forest directory_service show</title>
 799         <para>Show current directory_service configuration for the forest.</para>
 800 </refsect3>
 801
 802 <refsect2>
 803         <title>fsmo</title>
 804         <para>Manage Flexible Single Master Operations (FSMO).</para>
 805 </refsect2>
 806
 807 <refsect3>
 808         <title>fsmo seize [options]</title>
 809         <para>Seize the role.</para>
 810 </refsect3>
 811
 812 <refsect3>
 813         <title>fsmo show</title>
 814         <para>Show the roles.</para>
 815 </refsect3>
 816
 817 <refsect3>
 818         <title>fsmo transfer [options]</title>
 819         <para>Transfer the role.</para>
 820 </refsect3>
 821
 822 <refsect2>
 823         <title>gpo</title>
 824         <para>Manage Group Policy Objects (GPO).</para>
 825 </refsect2>
 826
 827 <refsect3>
 828         <title>gpo create <replaceable>displayname</replaceable> [options]</title>
 829         <para>Create an empty GPO.</para>
 830 </refsect3>
 831
 832 <refsect3>
 833         <title>gpo del <replaceable>gpo</replaceable> [options]</title>
 834         <para>Delete GPO.</para>
 835 </refsect3>
 836
 837 <refsect3>
 838         <title>gpo dellink <replaceable>container_dn</replaceable> <replaceable>gpo</replaceable> [options]</title>
 839         <para>Delete GPO link from a container.</para>
 840 </refsect3>
 841
 842 <refsect3>
 843         <title>gpo fetch <replaceable>gpo</replaceable> [options]</title>
 844         <para>Download a GPO.</para>
 845 </refsect3>
 846
 847 <refsect3>
 848         <title>gpo getinheritance <replaceable>container_dn</replaceable> [options]</title>
 849         <para>Get inheritance flag for a container.</para>
 850 </refsect3>
 851
 852 <refsect3>
 853         <title>gpo getlink <replaceable>container_dn</replaceable> [options]</title>
 854         <para>List GPO Links for a container.</para>
 855 </refsect3>
 856
 857 <refsect3>
 858         <title>gpo list <replaceable>username</replaceable> [options]</title>
 859         <para>List GPOs for an account.</para>
 860 </refsect3>
 861
 862 <refsect3>
 863         <title>gpo listall</title>
 864         <para>List all GPOs.</para>
 865 </refsect3>
 866
 867 <refsect3>
 868         <title>gpo listcontainers <replaceable>gpo</replaceable> [options]</title>
 869         <para>List all linked containers for a GPO.</para>
 870 </refsect3>
 871
 872 <refsect3>
 873         <title>gpo setinheritance <replaceable>container_dn</replaceable> <replaceable>block|inherit</replaceable> [options]</title>
 874         <para>Set inheritance flag on a container.</para>
 875 </refsect3>
 876
 877 <refsect3>
 878         <title>gpo setlink <replaceable>container_dn</replaceable> <replaceable>gpo</replaceable> [options]</title>
 879         <para>Add or Update a GPO link to a container.</para>
 880 </refsect3>
 881
 882 <refsect3>
 883         <title>gpo show <replaceable>gpo</replaceable> [options]</title>
 884         <para>Show information for a GPO.</para>
 885 </refsect3>
 886
 887 <refsect2>
 888         <title>group</title>
 889         <para>Manage groups.</para>
 890 </refsect2>
 891
 892 <refsect3>
 893         <title>group add <replaceable>groupname</replaceable> [options]</title>
 894         <para>Create a new AD group.</para>
 895 </refsect3>
 896
 897 <refsect3>
 898         <title>group create <replaceable>groupname</replaceable> [options]</title>
 899         <para>Add a new AD group. This is a synonym for the
 900         <command>samba-tool group add</command> command and is available
 901         for compatibility reasons only. Please use
 902         <command>samba-tool group add</command> instead.</para>
 903 </refsect3>
 904
 905 <refsect3>
 906         <title>group addmembers <replaceable>groupname</replaceable> <replaceable>members</replaceable> [options]</title>
 907         <para>Add members to an AD group.</para>
 908 </refsect3>
 909
 910 <refsect3>
 911         <title>group delete <replaceable>groupname</replaceable> [options]</title>
 912         <para>Delete an AD group.</para>
 913 </refsect3>
 914
 915 <refsect3>
 916         <title>group edit <replaceable>groupname</replaceable></title>
 917         <para>Edit a group AD object.</para>
 918
 919         <variablelist>
 920         <varlistentry>
 921         <term>--editor=EDITOR</term>
 922         <listitem><para>
 923         Specifies the editor to use instead of the system default, or 'vi' if no
 924         system default is set.
 925         </para></listitem>
 926         </varlistentry>
 927         </variablelist>
 928 </refsect3>
 929
 930 <refsect3>
 931         <title>group list</title>
 932         <para>List all groups.</para>
 933 </refsect3>
 934
 935 <refsect3>
 936         <title>group listmembers <replaceable>groupname</replaceable> [options]</title>
 937         <para>List all members of the specified AD group.</para>
 938 </refsect3>
 939
 940 <refsect3>
 941         <title>group move <replaceable>groupname</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
 942         <para>This command moves a group into the specified organizational unit
 943         or container.</para>
 944         <para>The groupname specified on the command is the sAMAccountName.
 945         </para>
 946         <para>The name of the organizational unit or container can be
 947         specified as a full DN or without the domainDN component.</para>
 948         <para></para>
 949 </refsect3>
 950
 951 <refsect3>
 952         <title>group removemembers <replaceable>groupname</replaceable> <replaceable>members</replaceable> [options]</title>
 953         <para>Remove members from the specified AD group.</para>
 954 </refsect3>
 955
 956 <refsect3>
 957         <title>group show <replaceable>groupname</replaceable> [options]</title>
 958         <para>Show group object and it's attributes.</para>
 959 </refsect3>
 960
 961 <refsect3>
 962         <title>group stats [options]</title>
 963         <para>Show statistics for overall groups and group memberships.</para>
 964 </refsect3>
 965
 966 <refsect3>
 967         <title>group rename <replaceable>groupname</replaceable> [options]</title>
 968         <para>Rename a group and related attributes.</para>
 969         <para>This command allows to set the group's name related attributes. The
 970         group's CN will be renamed automatically.
 971         The group's CN will be the sAMAccountName.
 972         Use the --force-new-cn option to specify the new CN manually and the
 973         --reset-cn to reset this change.</para>
 974         <para>Use an empty attribute value to remove the specified attribute.</para>
 975         <para>The groupname specified on the command is the sAMAccountName.</para>
 976
 977         <variablelist>
 978         <varlistentry>
 979         <term>--force-new-cn=NEW_CN</term>
 980         <listitem><para>
 981         Specify a new CN (RDN) instead of using the sAMAccountName.
 982         </para></listitem>
 983         </varlistentry>
 984
 985         <varlistentry>
 986         <term>--reset-cn</term>
 987         <listitem><para>
 988         Set the CN to the sAMAccountName.
 989         </para></listitem>
 990         </varlistentry>
 991
 992         <varlistentry>
 993         <term>--mail-address=MAIL_ADDRESS</term>
 994         <listitem><para>
 995         New mail address
 996         </para></listitem>
 997         </varlistentry>
 998
 999         <varlistentry>
1000         <term>--samaccountname=SAMACCOUNTNAME</term>
1001         <listitem><para>
1002         New account name (sAMAccountName/logon name)
1003         </para></listitem>
1004         </varlistentry>
1005         </variablelist>
1006 </refsect3>
1007
1008 <refsect2>
1009         <title>ldapcmp <replaceable>URL1</replaceable> <replaceable>URL2</replaceable> <replaceable>domain|configuration|schema|dnsdomain|dnsforest</replaceable> [options] </title>
1010         <para>Compare two LDAP databases.</para>
1011 </refsect2>
1012
1013 <refsect2>
1014         <title>ntacl</title>
1015         <para>Manage NT ACLs.</para>
1016 </refsect2>
1017
1018 <refsect3>
1019         <title>ntacl changedomsid <replaceable>original-domain-SID</replaceable> <replaceable>new-domain-SID</replaceable> <replaceable>file</replaceable> [options]</title>
1020         <para>Change the domain SID for ACLs.
1021         Can be used to change all entries in acl_xattr when the machine's SID
1022         has accidentally changed or the data set has been copied
1023         to another machine either via backup/restore or rsync.</para>
1024
1025         <variablelist>
1026         <varlistentry>
1027         <term>--use-ntvfs</term>
1028         <listitem><para>
1029         Set the ACLs directly to the TDB or xattr. The POSIX permissions will
1030         NOT be changed, only the NT ACL will be stored.
1031         </para></listitem>
1032         </varlistentry>
1033
1034         <varlistentry>
1035         <term>--service=SERVICE</term>
1036         <listitem><para>
1037         Specify the name of the smb.conf service to use. This option is
1038         required in combination with the --use-s3fs option.
1039         </para></listitem>
1040         </varlistentry>
1041
1042         <varlistentry>
1043         <term>--use-s3fs</term>
1044         <listitem><para>
1045         Set the ACLs for use with the default s3fs file server via the VFS
1046         layer. This option requires a smb.conf service, specified by the
1047         --service=SERVICE option.
1048         </para></listitem>
1049         </varlistentry>
1050
1051         <varlistentry>
1052         <term>--xattr-backend=[native|tdb]</term>
1053         <listitem><para>
1054         Specify the xattr backend type (native fs or tdb).
1055         </para></listitem>
1056         </varlistentry>
1057
1058         <varlistentry>
1059         <term>--eadb-file=EADB_FILE</term>
1060         <listitem><para>
1061         Name of the tdb file where attributes are stored.
1062         </para></listitem>
1063         </varlistentry>
1064
1065         <varlistentry>
1066         <term>--recursive</term>
1067         <listitem><para>
1068         Set the ACLs for directories and their contents recursively.
1069         </para></listitem>
1070         </varlistentry>
1071
1072         <varlistentry>
1073         <term>--follow-symlinks</term>
1074         <listitem><para>
1075         Follow symlinks when --recursive is specified.
1076         </para></listitem>
1077         </varlistentry>
1078
1079         <varlistentry>
1080         <term>--verbose</term>
1081         <listitem><para>
1082         Verbosely list files and ACLs which are being processed.
1083         </para></listitem>
1084         </varlistentry>
1085         </variablelist>
1086 </refsect3>
1087
1088
1089 <refsect3>
1090         <title>ntacl get <replaceable>file</replaceable> [options]</title>
1091         <para>Get ACLs on a file.</para>
1092 </refsect3>
1093
1094 <refsect3>
1095         <title>ntacl set <replaceable>acl</replaceable> <replaceable>file</replaceable> [options]</title>
1096         <para>Set ACLs on a file.</para>
1097 </refsect3>
1098
1099 <refsect3>
1100         <title>ntacl sysvolcheck</title>
1101         <para>Check sysvol ACLs match defaults (including correct ACLs on GPOs).</para>
1102 </refsect3>
1103
1104 <refsect3>
1105         <title>ntacl sysvolreset</title>
1106         <para>Reset sysvol ACLs to defaults (including correct ACLs on GPOs).</para>
1107 </refsect3>
1108
1109 <refsect2>
1110         <title>ou</title>
1111         <para>Manage organizational units (OUs).</para>
1112 </refsect2>
1113
1114 <refsect3>
1115         <title>ou add <replaceable>ou_dn</replaceable> [options]</title>
1116         <para>Add a new organizational unit.</para>
1117         <para>The name of the organizational unit can be specified as a full DN
1118         or without the domainDN component.</para>
1119
1120         <variablelist>
1121         <varlistentry>
1122         <term>--description=DESCRIPTION</term>
1123         <listitem><para>
1124         Specify OU's description.
1125         </para></listitem>
1126         </varlistentry>
1127         </variablelist>
1128 </refsect3>
1129
1130 <refsect3>
1131         <title>ou create <replaceable>ou_dn</replaceable> [options]</title>
1132         <para>Add a new organizational unit. This is a synonym for the
1133         <command>samba-tool ou add</command> command and is available
1134         for compatibility reasons only. Please use
1135         <command>samba-tool ou add</command> instead.</para>
1136 </refsect3>
1137
1138 <refsect3>
1139         <title>ou delete <replaceable>ou_dn</replaceable> [options]</title>
1140         <para>Delete an organizational unit.</para>
1141         <para>The name of the organizational unit can be specified as a full DN
1142         or without the domainDN component.</para>
1143
1144         <variablelist>
1145         <varlistentry>
1146         <term>--force-subtree-delete</term>
1147         <listitem><para>
1148         Delete organizational unit and all children reclusively.
1149         </para></listitem>
1150         </varlistentry>
1151         </variablelist>
1152 </refsect3>
1153
1154 <refsect3>
1155         <title>ou list [options]</title>
1156         <para>List all organizational units.</para>
1157         <variablelist>
1158         <varlistentry>
1159         <term>--full-dn</term>
1160         <listitem><para>
1161         Display DNs including the base DN.
1162         </para></listitem>
1163         </varlistentry>
1164         </variablelist>
1165 </refsect3>
1166
1167 <refsect3>
1168         <title>ou listobjects <replaceable>ou_dn</replaceable> [options]</title>
1169         <para>List all objects in an organizational unit.</para>
1170         <para>The name of the organizational unit can be specified as a full DN
1171         or without the domainDN component.</para>
1172
1173         <variablelist>
1174         <varlistentry>
1175         <term>--full-dn</term>
1176         <listitem><para>
1177         Display DNs including the base DN.
1178         </para></listitem>
1179         </varlistentry>
1180
1181         <varlistentry>
1182         <term>-r|--recursive</term>
1183         <listitem><para>
1184         List objects recursively.
1185         </para></listitem>
1186         </varlistentry>
1187         </variablelist>
1188 </refsect3>
1189
1190 <refsect3>
1191         <title>ou move <replaceable>old_ou_dn</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
1192         <para>Move an organizational unit.</para>
1193         <para>The name of the organizational units can be specified as a full DN
1194         or without the domainDN component.</para>
1195 </refsect3>
1196
1197 <refsect3>
1198         <title>ou rename <replaceable>old_ou_dn</replaceable> <replaceable>new_ou_dn</replaceable> [options]</title>
1199         <para>Rename an organizational unit.</para>
1200         <para>The name of the organizational units can be specified as a full DN
1201         or without the domainDN component.</para>
1202 </refsect3>
1203
1204 <refsect2>
1205         <title>rodc</title>
1206         <para>Manage Read-Only Domain Controller (RODC).</para>
1207 </refsect2>
1208
1209 <refsect3>
1210         <title>rodc preload <replaceable>SID</replaceable>|<replaceable>DN</replaceable>|<replaceable>accountname</replaceable> [options]</title>
1211         <para>Preload one account for an RODC.</para>
1212 </refsect3>
1213
1214 <refsect2>
1215         <title>schema</title>
1216         <para>Manage and query schema.</para>
1217 </refsect2>
1218
1219 <refsect3>
1220         <title>schema attribute modify <replaceable>attribute</replaceable> [options]</title>
1221         <para>Modify the behaviour of an attribute in schema.</para>
1222 </refsect3>
1223
1224 <refsect3>
1225         <title>schema attribute show <replaceable>attribute</replaceable> [options]</title>
1226         <para>Display an attribute schema definition.</para>
1227 </refsect3>
1228
1229 <refsect3>
1230         <title>schema attribute show_oc <replaceable>attribute</replaceable> [options]</title>
1231         <para>Show objectclasses that MAY or MUST contain this attribute.</para>
1232 </refsect3>
1233
1234 <refsect3>
1235         <title>schema objectclass show <replaceable>objectclass</replaceable> [options]</title>
1236         <para>Display an objectclass schema definition.</para>
1237 </refsect3>
1238
1239 <refsect2>
1240         <title>sites</title>
1241         <para>Manage sites.</para>
1242 </refsect2>
1243
1244 <refsect3>
1245         <title>sites create <replaceable>site</replaceable> [options]</title>
1246         <para>Create a new site.</para>
1247 </refsect3>
1248
1249 <refsect3>
1250         <title>sites remove <replaceable>site</replaceable> [options]</title>
1251         <para>Delete an existing site.</para>
1252 </refsect3>
1253
1254 <refsect2>
1255         <title>spn</title>
1256         <para>Manage Service Principal Names (SPN).</para>
1257 </refsect2>
1258
1259 <refsect3>
1260         <title>spn add <replaceable>name</replaceable> <replaceable>user</replaceable> [options]</title>
1261         <para>Create a new SPN.</para>
1262 </refsect3>
1263
1264 <refsect3>
1265         <title>spn delete <replaceable>name</replaceable> [<replaceable>user</replaceable>] [options]</title>
1266         <para>Delete an existing SPN.</para>
1267 </refsect3>
1268
1269 <refsect3>
1270         <title>spn list <replaceable>user</replaceable> [options]</title>
1271         <para>List SPNs of a given user.</para>
1272 </refsect3>
1273
1274 <refsect2>
1275         <title>testparm</title>
1276         <para>Check the syntax of the configuration file.</para>
1277 </refsect2>
1278
1279 <refsect2>
1280         <title>time</title>
1281         <para>Retrieve the time on a server.</para>
1282 </refsect2>
1283
1284 <refsect2>
1285         <title>user</title>
1286         <para>Manage users.</para>
1287 </refsect2>
1288
1289 <refsect3>
1290         <title>user add <replaceable>username</replaceable> [<replaceable>password</replaceable>]</title>
1291         <para>Add a new user to the Active Directory Domain.</para>
1292 </refsect3>
1293
1294 <refsect3>
1295         <title>user create <replaceable>username</replaceable> [<replaceable>password</replaceable>]</title>
1296         <para>Add a new user. This is a synonym for the
1297         <command>samba-tool user add</command> command and is available
1298         for compatibility reasons only. Please use
1299         <command>samba-tool user add</command> instead.</para>
1300 </refsect3>
1301
1302 <refsect3>
1303         <title>user delete <replaceable>username</replaceable> [options]</title>
1304         <para>Delete an existing user account.</para>
1305 </refsect3>
1306
1307 <refsect3>
1308         <title>user disable <replaceable>username</replaceable></title>
1309         <para>Disable a user account.</para>
1310 </refsect3>
1311
1312 <refsect3>
1313         <title>user edit <replaceable>username</replaceable></title>
1314         <para>Edit a user account AD object.</para>
1315
1316         <variablelist>
1317         <varlistentry>
1318         <term>--editor=EDITOR</term>
1319         <listitem><para>
1320         Specifies the editor to use instead of the system default, or 'vi' if no
1321         system default is set.
1322         </para></listitem>
1323         </varlistentry>
1324         </variablelist>
1325 </refsect3>
1326
1327 <refsect3>
1328         <title>user enable <replaceable>username</replaceable></title>
1329         <para>Enable a user account.</para>
1330 </refsect3>
1331
1332 <refsect3>
1333         <title>user list</title>
1334         <para>List all users.</para>
1335 </refsect3>
1336
1337 <refsect3>
1338         <title>user setprimarygroup <replaceable>username</replaceable> <replaceable>primarygroupname</replaceable></title>
1339         <para>Set the primary group a user account.</para>
1340 </refsect3>
1341
1342 <refsect3>
1343         <title>user getgroups <replaceable>username</replaceable></title>
1344         <para>Get the direct group memberships of a user account.</para>
1345 </refsect3>
1346
1347 <refsect3>
1348         <title>user show <replaceable>username</replaceable> [options]</title>
1349         <para>Display a user AD object.</para>
1350
1351         <variablelist>
1352         <varlistentry>
1353         <term>--attributes=USER_ATTRS</term>
1354         <listitem><para>
1355         Comma separated list of attributes, which will be printed.
1356         </para></listitem>
1357         </varlistentry>
1358         </variablelist>
1359 </refsect3>
1360
1361 <refsect3>
1362         <title>user move <replaceable>username</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
1363         <para>This command moves a user account into the specified
1364         organizational unit or container.</para>
1365         <para>The username specified on the command is the
1366         sAMAccountName.</para>
1367         <para>The name of the organizational unit or container can be
1368         specified as a full DN or without the domainDN component.</para>
1369 </refsect3>
1370
1371 <refsect3>
1372         <title>user password [options]</title>
1373         <para>Change password for a user account (the one provided in
1374         authentication).</para>
1375 </refsect3>
1376
1377 <refsect3>
1378         <title>user rename <replaceable>username</replaceable> [options]</title>
1379         <para>Rename a user and related attributes.</para>
1380         <para>This command allows to set the user's name related attributes. The user's
1381         CN will be renamed automatically.
1382         The user's new CN will be made up by combining the given-name, initials
1383         and surname. A dot ('.') will be appended to the initials automatically,
1384         if required.
1385         Use the --force-new-cn option to specify the new CN manually and --reset-cn
1386         to reset this change.</para>
1387         <para>Use an empty attribute value to remove the specified attribute.</para>
1388         <para>The username specified on the command is the sAMAccountName.</para>
1389
1390         <variablelist>
1391         <varlistentry>
1392         <term>--surname=SURNAME</term>
1393         <listitem><para>
1394         New surname
1395         </para></listitem>
1396         </varlistentry>
1397
1398         <varlistentry>
1399         <term>--given-name=GIVEN_NAME</term>
1400         <listitem><para>
1401         New given name
1402         </para></listitem>
1403         </varlistentry>
1404
1405         <varlistentry>
1406         <term>--initials=INITIALS</term>
1407         <listitem><para>
1408         New initials
1409         </para></listitem>
1410         </varlistentry>
1411
1412         <varlistentry>
1413         <term>--force-new-cn=NEW_CN</term>
1414         <listitem><para>
1415         Specify a new CN (RDN) instead of using a combination
1416         of the given name, initials and surname.
1417         </para></listitem>
1418         </varlistentry>
1419
1420         <varlistentry>
1421         <term>--reset-cn</term>
1422         <listitem><para>
1423         Set the CN to the default combination of given name,
1424         initials and surname.
1425         </para></listitem>
1426         </varlistentry>
1427
1428         <varlistentry>
1429         <term>--display-name=DISPLAY_NAME</term>
1430         <listitem><para>
1431         New display name
1432         </para></listitem>
1433         </varlistentry>
1434
1435         <varlistentry>
1436         <term>--mail-address=MAIL_ADDRESS</term>
1437         <listitem><para>
1438         New email address
1439         </para></listitem>
1440         </varlistentry>
1441
1442         <varlistentry>
1443         <term>--samaccountname=SAMACCOUNTNAME</term>
1444         <listitem><para>
1445         New account name (sAMAccountName/logon name)
1446         </para></listitem>
1447         </varlistentry>
1448
1449         <varlistentry>
1450         <term>--upn=UPN</term>
1451         <listitem><para>
1452         New user principal name
1453         </para></listitem>
1454         </varlistentry>
1455         </variablelist>
1456 </refsect3>
1457
1458 <refsect3>
1459         <title>user setexpiry <replaceable>username</replaceable> [options]</title>
1460         <para>Set the expiration of a user account.</para>
1461 </refsect3>
1462
1463 <refsect3>
1464         <title>user setpassword <replaceable>username</replaceable> [options]</title>
1465         <para>Sets or resets the password of a user account.</para>
1466 </refsect3>
1467
1468 <refsect3>
1469         <title>user unlock <replaceable>username</replaceable> [options]</title>
1470         <para>This command unlocks a user account in the Active Directory
1471         domain.</para>
1472 </refsect3>
1473
1474 <refsect3>
1475         <title>user getpassword <replaceable>username</replaceable> [options]</title>
1476         <para>Gets the password of a user account.</para>
1477 </refsect3>
1478
1479 <refsect3>
1480         <title>user syncpasswords <replaceable>--cache-ldb-initialize</replaceable> [options]</title>
1481         <para>Syncs the passwords of all user accounts, using an optional script.</para>
1482         <para>Note that this command should run on a single domain controller only
1483         (typically the PDC-emulator).</para>
1484 </refsect3>
1485
1486 <refsect2>
1487         <title>vampire [options] <replaceable>domain</replaceable></title>
1488         <para>Join and synchronise a remote AD domain to the local server.
1489         Please note that <command>samba-tool vampire</command> is deprecated,
1490         please use <command>samba-tool domain join</command> instead.</para>
1491 </refsect2>
1492
1493 <refsect2>
1494         <title>visualize [options] <replaceable>subcommand</replaceable></title>
1495         <para>Produce graphical representations of Samba network state.
1496         To work out what is happening in a replication graph, it is sometimes
1497         helpful to use visualisations.</para>
1498
1499         <para>
1500         There are two subcommands, two graphical modes, and (roughly) two modes
1501         of operation with respect to the location of authority.</para>
1502
1503         <refsect3><title>MODES OF OPERATION</title>
1504         <varlistentry>
1505                 <term>samba-tool visualize ntdsconn</term>
1506                 <listitem><para>Looks at NTDS connections.
1507                 </para></listitem>
1508                 </varlistentry>
1509
1510         <varlistentry>
1511                 <term>samba-tool visualize reps</term>
1512                 <listitem><para>Looks at repsTo and repsFrom objects.
1513                 </para></listitem>
1514                 </varlistentry>
1515
1516         <varlistentry>
1517                 <term>samba-tool visualize uptodateness</term>
1518                 <listitem><para>Looks at replication lag as shown by the
1519                 uptodateness vectors.
1520                 </para></listitem>
1521                 </varlistentry>
1522         </refsect3>
1523
1524         <refsect3><title>GRAPHICAL MODES</title>
1525         <varlistentry>
1526                 <term>--distance</term>
1527                 <listitem><para>Distances between DCs are shown in a matrix in
1528                  the terminal.
1529                 </para></listitem>
1530                 </varlistentry>
1531
1532         <varlistentry>
1533                 <term>--dot</term>
1534                 <listitem><para>Generate Graphviz dot output (for
1535                 ntdsconn and reps modes). When viewed using dot or
1536                 xdot, this shows the network as a graph with DCs as
1537                 vertices and connections edges. Certain types of
1538                 degenerate edges are shown in different colours or
1539                 line-styles. </para></listitem>
1540                 </varlistentry>
1541         <varlistentry>
1542                 <term>--xdot</term>
1543                 <listitem><para>Generate Graphviz dot output as with
1544                 <arg choice="opt">--dot</arg> and attempt to view it
1545                 immediately using <command>/usr/bin/xdot</command>.
1546                 </para></listitem>
1547                 </varlistentry>
1548         </refsect3>
1549
1550         <varlistentry>
1551                 <term>-r</term>
1552                 <listitem><para>Normally,
1553                 <command>samba-tool</command> talks to one database;
1554                 with the <arg choice="opt">-r</arg> option attempts
1555                 are made to contact all the DCs known to the first
1556                 database. This is necessary for <command>samba-tool
1557                 visualize uptodateness</command> and for
1558                 <command>samba-tool visualize reps</command> because
1559                 the repsFrom/To objects are not replicated, and it can
1560                 reveal replication issues in other modes.
1561                 </para></listitem>
1562                 </varlistentry>
1563 </refsect2>
1564
1565 <refsect2>
1566 <title>help</title>
1567 <para>Gives usage information.</para>
1568 </refsect2>
1569
1570 </refsect1>
1571
1572 <refsect1>
1573         <title>VERSION</title>
1574
1575         <para>This man page is complete for version &doc.version; of the Samba
1576         suite.</para>
1577 </refsect1>
1578
1579 <refsect1>
1580         <title>AUTHOR</title>
1581
1582         <para>The original Samba software and related utilities
1583         were created by Andrew Tridgell. Samba is now developed
1584         by the Samba Team as an Open Source project similar
1585         to the way the Linux kernel is developed.</para>
1586 </refsect1>
1587
1588 </refentry>