selftest: Add new test to run krb5.kdc.canon against a user with an SPN for a UPN
[Samba.git] / docs-xml / manpages / samba-tool.8.xml
blob2c043b90fcacf084b1c4400c8d7b392822bdb8a1
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">
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>
14 <refnamediv>
15         <refname>samba-tool</refname>
16         <refpurpose>Main Samba administration tool.
17         </refpurpose>
18 </refnamediv>
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>
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>
37 <refsect1>
38         <title>OPTIONS</title>
40         <variablelist>
42         <varlistentry>
43         <term>-h|--help</term>
44         <listitem><para>
45         Show this help message and exit
46         </para></listitem>
47         </varlistentry>
49         <varlistentry>
50         <term>--realm=REALM</term>
51         <listitem><para>
52         Set the realm name
53         </para></listitem>
54         </varlistentry>
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>
63         <varlistentry>
64         <term>--password=PASSWORD</term>
65         <listitem><para>
66         Password
67         </para></listitem>
68         </varlistentry>
70         <varlistentry>
71         <term>-U USERNAME|--username=USERNAME</term>
72         <listitem><para>
73         Username
74         </para></listitem>
75         </varlistentry>
77         <varlistentry>
78         <term>-W WORKGROUP|--workgroup=WORKGROUP</term>
79         <listitem><para>
80         Workgroup
81         </para></listitem>
82         </varlistentry>
84         <varlistentry>
85         <term>-N|--no-pass</term>
86         <listitem><para>
87         Don't ask for a password
88         </para></listitem>
89         </varlistentry>
91         <varlistentry>
92         <term>-k KERBEROS|--kerberos=KERBEROS</term>
93         <listitem><para>
94         Use Kerberos
95         </para></listitem>
96         </varlistentry>
98         <varlistentry>
99         <term>--ipaddress=IPADDRESS</term>
100         <listitem><para>
101         IP address of the server
102         </para></listitem>
103         </varlistentry>
105         &popt.common.samba.client;
107         </variablelist>
108 </refsect1>
110 <refsect1>
111 <title>COMMANDS</title>
113 <refsect3>
114         <title>computer create <replaceable>computername</replaceable> [options]</title>
115         <para>Create a new computer in the Active Directory Domain.</para>
116         <para>The new computer name specified on the command is the
117         sAMAccountName, with or without the trailing dollar sign.</para>
119         <variablelist>
120         <varlistentry>
121         <term>--computerou=COMPUTEROU</term>
122         <listitem><para>
123         DN of alternative location (with or without domainDN counterpart) to
124         default CN=Computers in which new computer object will be created.
125         E.g. 'OU=OUname'.
126         </para></listitem>
127         </varlistentry>
129         <varlistentry>
130         <term>--description=DESCRIPTION</term>
131         <listitem><para>
132         The new computers's description.
133         </para></listitem>
134         </varlistentry>
136         <varlistentry>
137         <term>--ip-address=IP_ADDRESS_LIST</term>
138         <listitem><para>
139         IPv4 address for the computer's A record, or IPv6 address for AAAA record,
140         can be provided multiple times.
141         </para></listitem>
142         </varlistentry>
144         <varlistentry>
145         <term>--service-principal-name=SERVICE_PRINCIPAL_NAME_LIST</term>
146         <listitem><para>
147         Computer's Service Principal Name, can be provided multiple times.
148         </para></listitem>
149         </varlistentry>
151         <varlistentry>
152         <term>--prepare-oldjoin</term>
153         <listitem><para>
154         Prepare enabled machine account for oldjoin mechanism.
155         </para></listitem>
156         </varlistentry>
157         </variablelist>
158 </refsect3>
160 <refsect3>
161         <title>computer delete <replaceable>computername</replaceable> [options]</title>
162         <para>Delete an existing computer account.</para>
163         <para>The computer name specified on the command is the
164         sAMAccountName, with or without the trailing dollar sign.</para>
165 </refsect3>
167 <refsect3>
168         <title>computer list</title>
169         <para>List all computers.</para>
170 </refsect3>
172 <refsect3>
173         <title>computer move <replaceable>computername</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
174         <para>This command moves a computer account into the specified
175         organizational unit or container.</para>
176         <para>The computername specified on the command is the
177         sAMAccountName, with or without the trailing dollar sign.</para>
178         <para>The name of the organizational unit or container can be
179         specified as a full DN or without the domainDN component.</para>
180 </refsect3>
182 <refsect3>
183         <title>computer show <replaceable>computername</replaceable> [options]</title>
184         <para>Display a computer AD object.</para>
185         <para>The computer name specified on the command is the
186         sAMAccountName, with or without the trailing dollar sign.</para>
188         <variablelist>
189         <varlistentry>
190         <term>--attributes=USER_ATTRS</term>
191         <listitem><para>
192         Comma separated list of attributes, which will be printed.
193         </para></listitem>
194         </varlistentry>
195         </variablelist>
196 </refsect3>
198 <refsect2>
199         <title>dbcheck</title>
200         <para>Check the local AD database for errors.</para>
201 </refsect2>
203 <refsect2>
204         <title>delegation</title>
205         <para>Manage Delegations.</para>
206 </refsect2>
208 <refsect3>
209         <title>delegation add-service <replaceable>accountname</replaceable> <replaceable>principal</replaceable> [options]</title>
210         <para>Add a service principal as msDS-AllowedToDelegateTo.</para>
211 </refsect3>
213 <refsect3>
214         <title>delegation del-service <replaceable>accountname</replaceable> <replaceable>principal</replaceable> [options]</title>
215         <para>Delete a service principal as msDS-AllowedToDelegateTo.</para>
216 </refsect3>
218 <refsect3>
219         <title>delegation for-any-protocol <replaceable>accountname</replaceable> [(on|off)] [options]</title>
220         <para>Set/unset UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION (S4U2Proxy)
221         for an account.</para>
222 </refsect3>
224 <refsect3>
225         <title>delegation for-any-service <replaceable>accountname</replaceable> [(on|off)] [options]</title>
226         <para>Set/unset UF_TRUSTED_FOR_DELEGATION for an account.</para>
227 </refsect3>
229 <refsect3>
230         <title>delegation show <replaceable>accountname</replaceable> [options] </title>
231         <para>Show the delegation setting of an account.</para>
232 </refsect3>
234 <refsect2>
235         <title>dns</title>
236         <para>Manage Domain Name Service (DNS).</para>
237 </refsect2>
239 <refsect3>
240         <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>
241         <para>Add a DNS record.</para>
242 </refsect3>
244 <refsect3>
245         <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>
246         <para>Delete a DNS record.</para>
247 </refsect3>
249 <refsect3>
250         <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>
251         <para>Query a name.</para>
252 </refsect3>
254 <refsect3>
255         <title>dns roothints <replaceable>server</replaceable> [<replaceable>name</replaceable>] [options]</title>
256         <para>Query root hints.</para>
257 </refsect3>
259 <refsect3>
260         <title>dns serverinfo <replaceable>server</replaceable> [options]</title>
261         <para>Query server information.</para>
262 </refsect3>
264 <refsect3>
265         <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>
266         <para>Update a DNS record.</para>
267 </refsect3>
269 <refsect3>
270         <title>dns zonecreate <replaceable>server</replaceable> <replaceable>zone</replaceable> [options]</title>
271         <para>Create a zone.</para>
272 </refsect3>
274 <refsect3>
275         <title>dns zonedelete <replaceable>server</replaceable> <replaceable>zone</replaceable> [options]</title>
276         <para>Delete a zone.</para>
277 </refsect3>
279 <refsect3>
280         <title>dns zoneinfo <replaceable>server</replaceable> <replaceable>zone</replaceable> [options]</title>
281         <para>Query zone information.</para>
282 </refsect3>
284 <refsect3>
285         <title>dns zonelist <replaceable>server</replaceable> [options]</title>
286         <para>List zones.</para>
287 </refsect3>
289 <refsect2>
290         <title>domain</title>
291         <para>Manage Domain.</para>
292 </refsect2>
294 <refsect3>
295         <title>domain backup</title>
296         <para>Create or restore a backup of the domain.</para>
297 </refsect3>
299 <refsect3>
300         <title>domain backup offline</title>
301         <para>Backup (with proper locking) local domain directories into a tar file.</para>
302 </refsect3>
304 <refsect3>
305         <title>domain backup online</title>
306         <para>Copy a running DC's current DB into a backup tar file.</para>
307 </refsect3>
309 <refsect3>
310         <title>domain backup rename</title>
311         <para>Copy a running DC's DB to backup file, renaming the domain in the process.</para>
312 </refsect3>
314 <refsect3>
315         <title>domain backup restore</title>
316         <para>Restore the domain's DB from a backup-file.</para>
317 </refsect3>
319 <refsect3>
320         <title>domain classicupgrade [options] <replaceable>classic_smb_conf</replaceable></title>
321         <para>Upgrade from Samba classic (NT4-like) database to Samba AD DC
322         database.</para>
323 </refsect3>
325 <refsect3>
326         <title>domain dcpromo <replaceable>dnsdomain</replaceable> [DC|RODC] [options]</title>
327         <para>Promote an existing domain member or NT4 PDC to an AD DC.</para>
328 </refsect3>
330 <refsect3>
331         <title>domain demote</title>
332         <para>Demote ourselves from the role of domain controller.</para>
333 </refsect3>
335 <refsect3>
336         <title>domain exportkeytab <replaceable>keytab</replaceable> [options]</title>
337         <para>Dumps Kerberos keys of the domain into a keytab.</para>
338 </refsect3>
340 <refsect3>
341         <title>domain info <replaceable>ip_address</replaceable> [options]</title>
342         <para>Print basic info about a domain and the specified DC.
343 </para>
344 </refsect3>
346 <refsect3>
347         <title>domain join <replaceable>dnsdomain</replaceable> [DC|RODC|MEMBER|SUBDOMAIN] [options]</title>
348         <para>Join a domain as either member or backup domain controller.</para>
349 </refsect3>
351 <refsect3>
352         <title>domain level <replaceable>show|raise</replaceable> <replaceable>options</replaceable> [options]</title>
353         <para>Show/raise domain and forest function levels.</para>
354 </refsect3>
356 <refsect3>
357         <title>domain passwordsettings <replaceable>show|set</replaceable> <replaceable>options</replaceable> [options]</title>
358         <para>Show/set password settings.</para>
359 </refsect3>
361 <refsect3>
362         <title>domain passwordsettings pso</title>
363         <para>Manage fine-grained Password Settings Objects (PSOs).</para>
364 </refsect3>
366 <refsect3>
367         <title>domain passwordsettings pso apply <replaceable>pso-name</replaceable> <replaceable>user-or-group-name</replaceable> [options]</title>
368         <para>Applies a PSO's password policy to a user or group.</para>
369 </refsect3>
371 <refsect3>
372         <title>domain passwordsettings pso create <replaceable>pso-name</replaceable> <replaceable>precedence</replaceable> [options]</title>
373         <para>Creates a new Password Settings Object (PSO).</para>
374 </refsect3>
376 <refsect3>
377         <title>domain passwordsettings pso delete <replaceable>pso-name</replaceable> [options]</title>
378         <para>Deletes a Password Settings Object (PSO).</para>
379 </refsect3>
381 <refsect3>
382         <title>domain passwordsettings pso list [options]</title>
383         <para>Lists all Password Settings Objects (PSOs).</para>
384 </refsect3>
386 <refsect3>
387         <title>domain passwordsettings pso set <replaceable>pso-name</replaceable> [options]</title>
388         <para>Modifies a Password Settings Object (PSO).</para>
389 </refsect3>
391 <refsect3>
392         <title>domain passwordsettings pso show <replaceable>user-name</replaceable> [options]</title>
393         <para>Displays a Password Settings Object (PSO).</para>
394 </refsect3>
396 <refsect3>
397         <title>domain passwordsettings pso show-user <replaceable>pso-name</replaceable> [options]</title>
398         <para>Displays the Password Settings that apply to a user.</para>
399 </refsect3>
401 <refsect3>
402         <title>domain passwordsettings pso unapply <replaceable>pso-name</replaceable> <replaceable>user-or-group-name</replaceable> [options]</title>
403         <para>Updates a PSO to no longer apply to a user or group.</para>
404 </refsect3>
406 <refsect3>
407         <title>domain provision</title>
408         <para>Promote an existing domain member or NT4 PDC to an AD DC.</para>
409 </refsect3>
411 <refsect3>
412         <title>domain trust</title>
413         <para>Domain and forest trust management.</para>
414 </refsect3>
416 <refsect3>
417         <title>domain trust create <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
418         <para>Create a domain or forest trust.</para>
419 </refsect3>
421 <refsect3>
422         <title>domain trust delete <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
423         <para>Delete a domain trust.</para>
424 </refsect3>
426 <refsect3>
427         <title>domain trust list <replaceable>options</replaceable> [options]</title>
428         <para>List domain trusts.</para>
429 </refsect3>
431 <refsect3>
432         <title>domain trust namespaces [<replaceable>DOMAIN</replaceable>] <replaceable>options</replaceable> [options]</title>
433         <para>Manage forest trust namespaces.</para>
434 </refsect3>
436 <refsect3>
437         <title>domain trust show <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
438         <para>Show trusted domain details.</para>
439 </refsect3>
441 <refsect3>
442         <title>domain trust validate <replaceable>DOMAIN</replaceable> <replaceable>options</replaceable> [options]</title>
443         <para>Validate a domain trust.</para>
444 </refsect3>
446 <refsect2>
447         <title>drs</title>
448         <para>Manage Directory Replication Services (DRS).</para>
449 </refsect2>
451 <refsect3>
452         <title>drs bind</title>
453         <para>Show DRS capabilities of a server.</para>
454 </refsect3>
456 <refsect3>
457         <title>drs kcc</title>
458         <para>Trigger knowledge consistency center run.</para>
459 </refsect3>
461 <refsect3>
462         <title>drs options</title>
463         <para>Query or change <replaceable>options</replaceable> for NTDS Settings
464         object of a domain controller.</para>
465 </refsect3>
467 <refsect3>
468         <title>drs replicate <replaceable>destination_DC</replaceable> <replaceable>source_DC</replaceable> <replaceable>NC</replaceable> [options]</title>
469         <para>Replicate a naming context between two DCs.</para>
470 </refsect3>
472 <refsect3>
473         <title>drs showrepl</title>
474         <para>Show replication status. The <arg
475         choice="opt">--json</arg> option results in JSON output, and
476         with the <arg choice="opt">--summary</arg> option produces
477         very little output when the replication status seems healthy.
478         </para>
479 </refsect3>
481 <refsect2>
482         <title>dsacl</title>
483         <para>Administer DS ACLs</para>
484 </refsect2>
486 <refsect3>
487         <title>dsacl set</title>
488         <para>Modify access list on a directory object.</para>
489 </refsect3>
491 <refsect2>
492         <title>forest</title>
493         <para>Manage Forest configuration.</para>
494 </refsect2>
496 <refsect3>
497         <title>forest directory_service</title>
498         <para>Manage directory_service behaviour for the forest.</para>
499 </refsect3>
501 <refsect3>
502         <title>forest directory_service dsheuristics <replaceable>VALUE</replaceable></title>
503         <para>Modify dsheuristics directory_service configuration for the forest.</para>
504 </refsect3>
506 <refsect3>
507         <title>forest directory_service show</title>
508         <para>Show current directory_service configuration for the forest.</para>
509 </refsect3>
511 <refsect2>
512         <title>fsmo</title>
513         <para>Manage Flexible Single Master Operations (FSMO).</para>
514 </refsect2>
516 <refsect3>
517         <title>fsmo seize [options]</title>
518         <para>Seize the role.</para>
519 </refsect3>
521 <refsect3>
522         <title>fsmo show</title>
523         <para>Show the roles.</para>
524 </refsect3>
526 <refsect3>
527         <title>fsmo transfer [options]</title>
528         <para>Transfer the role.</para>
529 </refsect3>
531 <refsect2>
532         <title>gpo</title>
533         <para>Manage Group Policy Objects (GPO).</para>
534 </refsect2>
536 <refsect3>
537         <title>gpo create <replaceable>displayname</replaceable> [options]</title>
538         <para>Create an empty GPO.</para>
539 </refsect3>
541 <refsect3>
542         <title>gpo del <replaceable>gpo</replaceable> [options]</title>
543         <para>Delete GPO.</para>
544 </refsect3>
546 <refsect3>
547         <title>gpo dellink <replaceable>container_dn</replaceable> <replaceable>gpo</replaceable> [options]</title>
548         <para>Delete GPO link from a container.</para>
549 </refsect3>
551 <refsect3>
552         <title>gpo fetch <replaceable>gpo</replaceable> [options]</title>
553         <para>Download a GPO.</para>
554 </refsect3>
556 <refsect3>
557         <title>gpo getinheritance <replaceable>container_dn</replaceable> [options]</title>
558         <para>Get inheritance flag for a container.</para>
559 </refsect3>
561 <refsect3>
562         <title>gpo getlink <replaceable>container_dn</replaceable> [options]</title>
563         <para>List GPO Links for a container.</para>
564 </refsect3>
566 <refsect3>
567         <title>gpo list <replaceable>username</replaceable> [options]</title>
568         <para>List GPOs for an account.</para>
569 </refsect3>
571 <refsect3>
572         <title>gpo listall</title>
573         <para>List all GPOs.</para>
574 </refsect3>
576 <refsect3>
577         <title>gpo listcontainers <replaceable>gpo</replaceable> [options]</title>
578         <para>List all linked containers for a GPO.</para>
579 </refsect3>
581 <refsect3>
582         <title>gpo setinheritance <replaceable>container_dn</replaceable> <replaceable>block|inherit</replaceable> [options]</title>
583         <para>Set inheritance flag on a container.</para>
584 </refsect3>
586 <refsect3>
587         <title>gpo setlink <replaceable>container_dn</replaceable> <replaceable>gpo</replaceable> [options]</title>
588         <para>Add or Update a GPO link to a container.</para>
589 </refsect3>
591 <refsect3>
592         <title>gpo show <replaceable>gpo</replaceable> [options]</title>
593         <para>Show information for a GPO.</para>
594 </refsect3>
596 <refsect2>
597         <title>group</title>
598         <para>Manage groups.</para>
599 </refsect2>
601 <refsect3>
602         <title>group add <replaceable>groupname</replaceable> [options]</title>
603         <para>Create a new AD group.</para>
604 </refsect3>
606 <refsect3>
607         <title>group addmembers <replaceable>groupname</replaceable> <replaceable>members</replaceable> [options]</title>
608         <para>Add members to an AD group.</para>
609 </refsect3>
611 <refsect3>
612         <title>group delete <replaceable>groupname</replaceable> [options]</title>
613         <para>Delete an AD group.</para>
614 </refsect3>
616 <refsect3>
617         <title>group list</title>
618         <para>List all groups.</para>
619 </refsect3>
621 <refsect3>
622         <title>group listmembers <replaceable>groupname</replaceable> [options]</title>
623         <para>List all members of the specified AD group.</para>
624 </refsect3>
626 <refsect3>
627         <title>group move <replaceable>groupname</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
628         <para>This command moves a group into the specified organizational unit
629         or container.</para>
630         <para>The groupname specified on the command is the sAMAccountName.
631         </para>
632         <para>The name of the organizational unit or container can be
633         specified as a full DN or without the domainDN component.</para>
634         <para></para>
635 </refsect3>
637 <refsect3>
638         <title>group removemembers <replaceable>groupname</replaceable> <replaceable>members</replaceable> [options]</title>
639         <para>Remove members from the specified AD group.</para>
640 </refsect3>
642 <refsect3>
643         <title>group show <replaceable>groupname</replaceable> [options]</title>
644         <para>Show group object and it's attributes.</para>
645 </refsect3>
647 <refsect2>
648         <title>ldapcmp <replaceable>URL1</replaceable> <replaceable>URL2</replaceable> <replaceable>domain|configuration|schema|dnsdomain|dnsforest</replaceable> [options] </title>
649         <para>Compare two LDAP databases.</para>
650 </refsect2>
652 <refsect2>
653         <title>ntacl</title>
654         <para>Manage NT ACLs.</para>
655 </refsect2>
657 <refsect3>
658         <title>ntacl get <replaceable>file</replaceable> [options]</title>
659         <para>Get ACLs on a file.</para>
660 </refsect3>
662 <refsect3>
663         <title>ntacl set <replaceable>acl</replaceable> <replaceable>file</replaceable> [options]</title>
664         <para>Set ACLs on a file.</para>
665 </refsect3>
667 <refsect3>
668         <title>ntacl sysvolcheck</title>
669         <para>Check sysvol ACLs match defaults (including correct ACLs on GPOs).</para>
670 </refsect3>
672 <refsect3>
673         <title>ntacl sysvolreset</title>
674         <para>Reset sysvol ACLs to defaults (including correct ACLs on GPOs).</para>
675 </refsect3>
677 <refsect3>
678         <title>ou create <replaceable>ou_dn</replaceable> [options]</title>
679         <para>Create an organizational unit.</para>
680         <para>The name of the organizational unit can be specified as a full DN
681         or without the domainDN component.</para>
683         <variablelist>
684         <varlistentry>
685         <term>--description=DESCRIPTION</term>
686         <listitem><para>
687         Specify OU's description.
688         </para></listitem>
689         </varlistentry>
690         </variablelist>
691 </refsect3>
693 <refsect3>
694         <title>ou delete <replaceable>ou_dn</replaceable> [options]</title>
695         <para>Delete an organizational unit.</para>
696         <para>The name of the organizational unit can be specified as a full DN
697         or without the domainDN component.</para>
699         <variablelist>
700         <varlistentry>
701         <term>--force-subtree-delete</term>
702         <listitem><para>
703         Delete organizational unit and all children reclusively.
704         </para></listitem>
705         </varlistentry>
706         </variablelist>
707 </refsect3>
709 <refsect3>
710         <title>ou list [options]</title>
711         <para>List all organizational units.</para>
712         <variablelist>
713         <varlistentry>
714         <term>--full-dn</term>
715         <listitem><para>
716         Display DNs including the base DN.
717         </para></listitem>
718         </varlistentry>
719         </variablelist>
720 </refsect3>
722 <refsect3>
723         <title>ou listobjects <replaceable>ou_dn</replaceable> [options]</title>
724         <para>List all objects in an organizational unit.</para>
725         <para>The name of the organizational unit can be specified as a full DN
726         or without the domainDN component.</para>
728         <variablelist>
729         <varlistentry>
730         <term>--full-dn</term>
731         <listitem><para>
732         Display DNs including the base DN.
733         </para></listitem>
734         </varlistentry>
736         <varlistentry>
737         <term>-r|--recursive</term>
738         <listitem><para>
739         List objects recursively.
740         </para></listitem>
741         </varlistentry>
742         </variablelist>
743 </refsect3>
745 <refsect3>
746         <title>ou move <replaceable>old_ou_dn</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
747         <para>Move an organizational unit.</para>
748         <para>The name of the organizational units can be specified as a full DN
749         or without the domainDN component.</para>
750 </refsect3>
752 <refsect3>
753         <title>ou rename <replaceable>old_ou_dn</replaceable> <replaceable>new_ou_dn</replaceable> [options]</title>
754         <para>Rename an organizational unit.</para>
755         <para>The name of the organizational units can be specified as a full DN
756         or without the domainDN component.</para>
757 </refsect3>
759 <refsect2>
760         <title>rodc</title>
761         <para>Manage Read-Only Domain Controller (RODC).</para>
762 </refsect2>
764 <refsect3>
765         <title>rodc preload <replaceable>SID</replaceable>|<replaceable>DN</replaceable>|<replaceable>accountname</replaceable> [options]</title>
766         <para>Preload one account for an RODC.</para>
767 </refsect3>
769 <refsect2>
770         <title>schema</title>
771         <para>Manage and query schema.</para>
772 </refsect2>
774 <refsect3>
775         <title>schema attribute modify <replaceable>attribute</replaceable> [options]</title>
776         <para>Modify the behaviour of an attribute in schema.</para>
777 </refsect3>
779 <refsect3>
780         <title>schema attribute show <replaceable>attribute</replaceable> [options]</title>
781         <para>Display an attribute schema definition.</para>
782 </refsect3>
784 <refsect3>
785         <title>schema attribute show_oc <replaceable>attribute</replaceable> [options]</title>
786         <para>Show objectclasses that MAY or MUST contain this attribute.</para>
787 </refsect3>
789 <refsect3>
790         <title>schema objectclass show <replaceable>objectclass</replaceable> [options]</title>
791         <para>Display an objectclass schema definition.</para>
792 </refsect3>
794 <refsect2>
795         <title>sites</title>
796         <para>Manage sites.</para>
797 </refsect2>
799 <refsect3>
800         <title>sites create <replaceable>site</replaceable> [options]</title>
801         <para>Create a new site.</para>
802 </refsect3>
804 <refsect3>
805         <title>sites remove <replaceable>site</replaceable> [options]</title>
806         <para>Delete an existing site.</para>
807 </refsect3>
809 <refsect2>
810         <title>spn</title>
811         <para>Manage Service Principal Names (SPN).</para>
812 </refsect2>
814 <refsect3>
815         <title>spn add <replaceable>name</replaceable> <replaceable>user</replaceable> [options]</title>
816         <para>Create a new SPN.</para>
817 </refsect3>
819 <refsect3>
820         <title>spn delete <replaceable>name</replaceable> [<replaceable>user</replaceable>] [options]</title>
821         <para>Delete an existing SPN.</para>
822 </refsect3>
824 <refsect3>
825         <title>spn list <replaceable>user</replaceable> [options]</title>
826         <para>List SPNs of a given user.</para>
827 </refsect3>
829 <refsect2>
830         <title>testparm</title>
831         <para>Check the syntax of the configuration file.</para>
832 </refsect2>
834 <refsect2>
835         <title>time</title>
836         <para>Retrieve the time on a server.</para>
837 </refsect2>
839 <refsect2>
840         <title>user</title>
841         <para>Manage users.</para>
842 </refsect2>
844 <refsect3>
845         <title>user add <replaceable>username</replaceable> [<replaceable>password</replaceable>]</title>
846         <para>Create a new user. Please note that this subcommand is deprecated
847         and available for compatibility reasons only. Please use
848         <command>samba-tool user create</command> instead.</para>
849 </refsect3>
851 <refsect3>
852         <title>user create <replaceable>username</replaceable> [<replaceable>password</replaceable>]</title>
853         <para>Create a new user in the Active Directory Domain.</para>
854 </refsect3>
856 <refsect3>
857         <title>user delete <replaceable>username</replaceable> [options]</title>
858         <para>Delete an existing user account.</para>
859 </refsect3>
861 <refsect3>
862         <title>user disable <replaceable>username</replaceable></title>
863         <para>Disable an user account.</para>
864 </refsect3>
866 <refsect3>
867         <title>user enable <replaceable>username</replaceable></title>
868         <para>Enable an user account.</para>
869 </refsect3>
871 <refsect3>
872         <title>user list</title>
873         <para>List all users.</para>
874 </refsect3>
876 <refsect3>
877         <title>user show <replaceable>username</replaceable> [options]</title>
878         <para>Display a user AD object.</para>
880         <variablelist>
881         <varlistentry>
882         <term>--attributes=USER_ATTRS</term>
883         <listitem><para>
884         Comma separated list of attributes, which will be printed.
885         </para></listitem>
886         </varlistentry>
887         </variablelist>
888 </refsect3>
890 <refsect3>
891         <title>user move <replaceable>username</replaceable> <replaceable>new_parent_dn</replaceable> [options]</title>
892         <para>This command moves a user account into the specified
893         organizational unit or container.</para>
894         <para>The username specified on the command is the
895         sAMAccountName.</para>
896         <para>The name of the organizational unit or container can be
897         specified as a full DN or without the domainDN component.</para>
898 </refsect3>
900 <refsect3>
901         <title>user password [options]</title>
902         <para>Change password for an user account (the one provided in
903         authentication).</para>
904 </refsect3>
906 <refsect3>
907         <title>user setexpiry <replaceable>username</replaceable> [options]</title>
908         <para>Set the expiration of an user account.</para>
909 </refsect3>
911 <refsect3>
912         <title>user setpassword <replaceable>username</replaceable> [options]</title>
913         <para>Sets or resets the password of an user account.</para>
914 </refsect3>
916 <refsect3>
917         <title>user getpassword <replaceable>username</replaceable> [options]</title>
918         <para>Gets the password of an user account.</para>
919 </refsect3>
921 <refsect3>
922         <title>user syncpasswords <replaceable>--cache-ldb-initialize</replaceable> [options]</title>
923         <para>Syncs the passwords of all user accounts, using an optional script.</para>
924         <para>Note that this command should run on a single domain controller only
925         (typically the PDC-emulator).</para>
926 </refsect3>
928 <refsect2>
929         <title>vampire [options] <replaceable>domain</replaceable></title>
930         <para>Join and synchronise a remote AD domain to the local server.
931         Please note that <command>samba-tool vampire</command> is deprecated,
932         please use <command>samba-tool domain join</command> instead.</para>
933 </refsect2>
935 <refsect2>
936         <title>visualize [options] <replaceable>subcommand</replaceable></title>
937         <para>Produce graphical representations of Samba network state.
938         To work out what is happening in a replication graph, it is sometimes
939         helpful to use visualisations.</para>
941         <para>
942         There are two subcommands, two graphical modes, and (roughly) two modes
943         of operation with respect to the location of authority.</para>
945         <refsect3><title>MODES OF OPERATION</title>
946         <varlistentry>
947                 <term>samba-tool visualize ntdsconn</term>
948                 <listitem><para>Looks at NTDS connections.
949                 </para></listitem>
950                 </varlistentry>
952         <varlistentry>
953                 <term>samba-tool visualize reps</term>
954                 <listitem><para>Looks at repsTo and repsFrom objects.
955                 </para></listitem>
956                 </varlistentry>
958         <varlistentry>
959                 <term>samba-tool visualize uptodateness</term>
960                 <listitem><para>Looks at replication lag as shown by the
961                 uptodateness vectors.
962                 </para></listitem>
963                 </varlistentry>
964         </refsect3>
966         <refsect3><title>GRAPHICAL MODES</title>
967         <varlistentry>
968                 <term>--distance</term>
969                 <listitem><para>Distances between DCs are shown in a matrix in
970                  the terminal.
971                 </para></listitem>
972                 </varlistentry>
974         <varlistentry>
975                 <term>--dot</term>
976                 <listitem><para>Generate Graphviz dot output (for
977                 ntdsconn and reps modes). When viewed using dot or
978                 xdot, this shows the network as a graph with DCs as
979                 vertices and connections edges. Certain types of
980                 degenerate edges are shown in different colours or
981                 line-styles. </para></listitem>
982                 </varlistentry>
983         <varlistentry>
984                 <term>--xdot</term>
985                 <listitem><para>Generate Graphviz dot output as with
986                 <arg choice="opt">--dot</arg> and attempt to view it
987                 immediately using <command>/usr/bin/xdot</command>.
988                 </para></listitem>
989                 </varlistentry>
990         </refsect3>
992         <varlistentry>
993                 <term>-r</term>
994                 <listitem><para>Normally,
995                 <command>samba-tool</command> talks to one database;
996                 with the <arg choice="opt">-r</arg> option attempts
997                 are made to contact all the DCs known to the first
998                 database. This is necessary for <command>samba-tool
999                 visualize uptodateness</command> and for
1000                 <command>samba-tool visualize reps</command> because
1001                 the repsFrom/To objects are not replicated, and it can
1002                 reveal replication issues in other modes.
1003                 </para></listitem>
1004                 </varlistentry>
1005 </refsect2>
1007 <refsect2>
1008 <title>help</title>
1009 <para>Gives usage information.</para>
1010 </refsect2>
1012 </refsect1>
1014 <refsect1>
1015         <title>VERSION</title>
1017         <para>This man page is complete for version &doc.version; of the Samba
1018         suite.</para>
1019 </refsect1>
1021 <refsect1>
1022         <title>AUTHOR</title>
1024         <para>The original Samba software and related utilities
1025         were created by Andrew Tridgell. Samba is now developed
1026         by the Samba Team as an Open Source project similar
1027         to the way the Linux kernel is developed.</para>
1028 </refsect1>
1030 </refentry>