docs: add net idmap specific options in net manpage.
[Samba.git] / docs-xml / manpages / net.8.xml
blob5cc623f9f4090f5d41f27bf612b8b160708f9732
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="net.8">
5 <refmeta>
6         <refentrytitle>net</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.1</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>net</refname>
16         <refpurpose>Tool for administration of Samba and remote
17         CIFS servers.
18         </refpurpose>
19 </refnamediv>
21 <refsynopsisdiv>
22         <cmdsynopsis>
23                 <command>net</command>
24                 <arg choice="req">&lt;ads|rap|rpc&gt;</arg>
25                 <arg choice="opt">-h|--help</arg>
26                 <arg choice="opt">-w|--workgroup workgroup</arg>
27                 <arg choice="opt">-W|--myworkgroup myworkgroup</arg>
28                 <arg choice="opt">-U|--user user</arg>
29                 <arg choice="opt">-I|--ipaddress ip-address</arg>
30                 <arg choice="opt">-p|--port port</arg>
31                 <arg choice="opt">-n myname</arg>
32                 <arg choice="opt">-s conffile</arg>
33                 <arg choice="opt">-S|--server server</arg>
34                 <arg choice="opt">-l|--long</arg>
35                 <arg choice="opt">-v|--verbose</arg>
36                 <arg choice="opt">-f|--force</arg>
37                 <arg choice="opt">-P|--machine-pass</arg>
38                 <arg choice="opt">-d debuglevel</arg>
39                 <arg choice="opt">-V</arg>
40                 <arg choice="opt">--request-timeout seconds</arg>
41                 <arg choice="opt">-t|--timeout seconds</arg>
42                 <arg choice="opt">-i|--stdin</arg>
43                 <arg choice="opt">--tallocreport</arg>
44         </cmdsynopsis>
45 </refsynopsisdiv>
47 <refsect1>
48         <title>DESCRIPTION</title>
50         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
51         <manvolnum>7</manvolnum></citerefentry> suite.</para>
53         <para>The Samba net utility is meant to work just like the net utility 
54         available for windows and DOS. The first argument should be used 
55         to specify the protocol to use when executing a certain command. 
56         ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) 
57         clients and RPC can be used for NT4 and Windows 2000. If this 
58         argument is omitted, net will try to determine it automatically. 
59         Not all commands are available on all protocols.
60         </para>
62 </refsect1>
64 <refsect1>
65         <title>OPTIONS</title>
67         <variablelist>
68                 &stdarg.help;
69                 &stdarg.kerberos;
70                 
71                 <varlistentry>
72                 <term>-w|--workgroup target-workgroup</term>
73                 <listitem><para>
74                 Sets target workgroup or domain. You have to specify 
75                 either this option or the IP address or the name of a server.
76                 </para></listitem>
77                 </varlistentry>
79                 <varlistentry>
80                 <term>-W|--myworkgroup workgroup</term>
81                 <listitem><para>
82                 Sets client workgroup or domain
83                 </para></listitem>
84                 </varlistentry>
86                 <varlistentry>
87                 <term>-U|--user user</term>
88                 <listitem><para>
89                 User name to use
90                 </para></listitem>
91                 </varlistentry>
93                 <varlistentry>
94                 <term>-I|--ipaddress ip-address</term>
95                 <listitem><para>
96                 IP address of target server to use. You have to
97                 specify either this option or a target workgroup or
98                 a target server.
99                 </para></listitem>
100                 </varlistentry>
102                 <varlistentry>
103                 <term>-p|--port port</term>
104                 <listitem><para>
105                 Port on the target server to connect to (usually 139 or 445). 
106                 Defaults to trying 445 first, then 139.
107                 </para></listitem>
108                 </varlistentry>
110                 &stdarg.netbios.name;
111                 &stdarg.configfile;
113                 <varlistentry>
114                 <term>-S|--server server</term>
115                 <listitem><para>
116                 Name of target server. You should specify either 
117                 this option or a target workgroup or a target IP address.
118                 </para></listitem>
119                 </varlistentry>
121                 <varlistentry>
122                 <term>-l|--long</term>
123                 <listitem><para>
124                 When listing data, give more information on each item.
125                 </para></listitem>
126                 </varlistentry>
128                 <varlistentry>
129                 <term>-v|--verbose</term>
130                 <listitem><para>
131                 When listing data, give more verbose information on each item.
132                 </para></listitem>
133                 </varlistentry>
135                 <varlistentry>
136                 <term>-f|--force</term>
137                 <listitem><para>
138                                 Enforcing a net command.
139                 </para></listitem>
140                 </varlistentry>
142                 <varlistentry>
143                 <term>-P|--machine-pass</term>
144                 <listitem><para>
145                 Make queries to the external server using the machine account of the local server.
146                 </para></listitem>
147                 </varlistentry>
149                 <varlistentry>
150                 <term>--request-timeout 30</term>
151                 <listitem><para>
152                 Let client requests timeout after 30 seconds the default is 10
153                 seconds.
154                 </para></listitem>
155                 </varlistentry>
157                 <varlistentry>
158                 <term>-t|--timeout 30</term>
159                 <listitem><para>
160                                 Set timeout for client operations to 30 seconds.
161                 </para></listitem>
162                 </varlistentry>
164                 <varlistentry>
165                 <term>--use-ccache</term>
166                 <listitem><para>
167                 Try to use the credentials cached by winbind.
168                 </para></listitem>
169                 </varlistentry>
171                 <varlistentry>
172                 <term>-i|--stdin</term>
173                 <listitem><para>
174                                 Take input for net commands from standard input.
175                 </para></listitem>
176                 </varlistentry>
178                 <varlistentry>
179                 <term>--tallocreport</term>
180                 <listitem><para>
181                                 Generate a talloc report while processing a net
182                                 command.
183                 </para></listitem>
184                 </varlistentry>
186                 <!-- Options for net rpc vampire -->
188                 <varlistentry>
189                 <term>--force-full-repl</term>
190                 <listitem><para>
191                                 When calling "net rpc vampire keytab" this option
192                                 enforces a full re-creation of the generated keytab file.
193                 </para></listitem>
194                 </varlistentry>
196                 <varlistentry>
197                 <term>--single-obj-repl</term>
198                 <listitem><para>
199                                 When calling "net rpc vampire keytab" this option
200                                 allows to replicate just a single object to the generated keytab file.
201                 </para></listitem>
202                 </varlistentry>
204                 <varlistentry>
205                 <term>--clean-old-entries</term>
206                 <listitem><para>
207                                 When calling "net rpc vampire keytab" this option
208                                 allows to cleanup old entries from the generated keytab file.
209                 </para></listitem>
210                 </varlistentry>
212                 <!-- Options for net idmap -->
214                 <varlistentry>
215                 <term>--db</term>
216                 <listitem><para>Define dbfile for "net idmap" commands.
217                 </para></listitem>
218                 </varlistentry>
220                 <varlistentry>
221                 <term>--lock</term>
222                 <listitem><para>Activates locking of the dbfile for "net idmap check" command.
223                 </para></listitem>
224                 </varlistentry>
226                 <varlistentry>
227                 <term>-a|--auto</term>
228                 <listitem><para>Activates noninteractive mode in "net idmap check".
229                 </para></listitem>
230                 </varlistentry>
232                 <varlistentry>
233                 <term>--repair</term>
234                 <listitem><para>Activates repair mode in "net idmap check".
235                 </para></listitem>
236                 </varlistentry>
238                 &stdarg.encrypt;
239                 &popt.common.samba.client;
241         </variablelist>
242 </refsect1>
244 <refsect1>
245 <title>COMMANDS</title>
247 <refsect2>
248 <title>CHANGESECRETPW</title>
250 <para>This command allows the Samba machine account password to be set from an external application
251 to a machine account password that has already been stored in Active Directory. DO NOT USE this command
252 unless you know exactly what you are doing. The use of this command requires that the force flag (-f)
253 be used also. There will be NO command prompt. Whatever information is piped into stdin, either by
254 typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use
255 this without care and attention as it will overwrite a legitimate machine password without warning.
256 YOU HAVE BEEN WARNED.
257 </para>
259 </refsect2>
261 <refsect2>
262         <title>TIME</title>
264         <para>The <command>NET TIME</command> command allows you to view the time on a remote server
265         or synchronise the time on the local server with the time on the remote server.</para>
267 <refsect3>
268 <title>TIME</title>
270 <para>Without any options, the <command>NET TIME</command> command 
271 displays the time on the remote server.
272 </para>
274 </refsect3>
276 <refsect3>
277 <title>TIME SYSTEM</title>
279 <para>Displays the time on the remote server in a format ready for <command>/bin/date</command>.</para>
281 </refsect3>
283 <refsect3>
284 <title>TIME SET</title>
285 <para>Tries to set the date and time of the local server to that on 
286 the remote server using <command>/bin/date</command>. </para>
288 </refsect3>
290 <refsect3>
291 <title>TIME ZONE</title>
293 <para>Displays the timezone in hours from GMT on the remote computer.</para>
295 </refsect3>
296 </refsect2>
298 <refsect2>
299 <title>[RPC|ADS] JOIN [TYPE] [-U username[%password]] [createupn=UPN]
300 [createcomputer=OU] [machinepass=PASS] [osName=string osVer=string] [options]</title>
302 <para>
303 Join a domain.  If the account already exists on the server, and 
304 [TYPE] is MEMBER, the machine will attempt to join automatically. 
305 (Assuming that the machine has been created in server manager)
306 Otherwise, a password will be prompted for, and a new account may
307 be created.</para>
309 <para>
310 [TYPE] may be PDC, BDC or MEMBER to specify the type of server
311 joining the domain.
312 </para>
314 <para>
315 [UPN] (ADS only) set the principalname attribute during the join.  The default
316 format is host/netbiosname@REALM.
317 </para>
319 <para>
320 [OU] (ADS only) Precreate the computer account in a specific OU.  The
321 OU string reads from top to bottom without RDNs, and is delimited by
322 a '/'.  Please note that '\' is used for escape by both the shell
323 and ldap, so it may need to be doubled or quadrupled to pass through, 
324 and it is not used as a delimiter.
325 </para>
326 <para>
327 [PASS] (ADS only) Set a specific password on the computer account
328 being created by the join.
329 </para>
330 <para>
331 [osName=string osVer=String] (ADS only) Set the operatingSystem and
332 operatingSystemVersion attribute during the join.  Both parameters
333 must be specified for either to take effect.
334 </para>
335 </refsect2>
337 <refsect2>
338 <title>[RPC] OLDJOIN [options]</title>
340 <para>Join a domain. Use the OLDJOIN option to join the domain 
341 using the old style of domain joining - you need to create a trust 
342 account in server manager first.</para>
343 </refsect2>
345 <refsect2>
346 <title>[RPC|ADS] USER</title>
348 <refsect3>
349 <title>[RPC|ADS] USER</title>
351 <para>List all users</para>
353 </refsect3>
355 <refsect3>
356 <title>[RPC|ADS] USER DELETE <replaceable>target</replaceable></title>
358 <para>Delete specified user</para>
360 </refsect3>
362 <refsect3>
363 <title>[RPC|ADS] USER INFO <replaceable>target</replaceable></title>
365 <para>List the domain groups of the specified user.</para>
367 </refsect3>
369 <refsect3>
370 <title>[RPC|ADS] USER RENAME <replaceable>oldname</replaceable> <replaceable>newname</replaceable></title>
372 <para>Rename specified user.</para>
374 </refsect3>
376 <refsect3>
377 <title>[RPC|ADS] USER ADD <replaceable>name</replaceable> [password] [-F user flags] [-C comment]</title>
379 <para>Add specified user.</para>
380 </refsect3>
381 </refsect2>
383 <refsect2>
384 <title>[RPC|ADS] GROUP</title>
386 <refsect3>
387 <title>[RPC|ADS] GROUP [misc options] [targets]</title>
388 <para>List user groups.</para>
389 </refsect3>
391 <refsect3>
392 <title>[RPC|ADS] GROUP DELETE <replaceable>name</replaceable> [misc. options]</title>
394 <para>Delete specified group.</para>
396 </refsect3>
398 <refsect3>
399 <title>[RPC|ADS] GROUP ADD <replaceable>name</replaceable> [-C comment]</title>
401 <para>Create specified group.</para>
403 </refsect3>
404 </refsect2>
406 <refsect2>
407 <title>[RAP|RPC] SHARE</title>
409 <refsect3>
410 <title>[RAP|RPC] SHARE [misc. options] [targets]</title>
412 <para>Enumerates all exported resources (network shares) on target server.</para>
414 </refsect3>
416 <refsect3>
417 <title>[RAP|RPC] SHARE ADD <replaceable>name=serverpath</replaceable> [-C comment] [-M maxusers] [targets]</title>
419 <para>Adds a share from a server (makes the export active). Maxusers 
420 specifies the number of users that can be connected to the 
421 share simultaneously.</para>
423 </refsect3>
425 <refsect3>
426 <title>SHARE DELETE <replaceable>sharename</replaceable></title>
428 <para>Delete specified share.</para>
429 </refsect3>
430 </refsect2>
432 <refsect2>
433 <title>[RPC|RAP] FILE</title>
435 <refsect3>
436 <title>[RPC|RAP] FILE</title>
438 <para>List all open files on remote server.</para>
440 </refsect3>
442 <refsect3>
443 <title>[RPC|RAP] FILE CLOSE <replaceable>fileid</replaceable></title>
445 <para>Close file with specified <replaceable>fileid</replaceable> on 
446 remote server.</para>
448 </refsect3>
450 <refsect3>
451 <title>[RPC|RAP] FILE INFO <replaceable>fileid</replaceable></title>
453 <para>
454 Print information on specified <replaceable>fileid</replaceable>. 
455 Currently listed are: file-id, username, locks, path, permissions.
456 </para>
458 </refsect3>
460 <refsect3>
461 <title>[RAP|RPC] FILE USER <replaceable>user</replaceable></title>
463 <para>
464 List files opened by specified <replaceable>user</replaceable>.
465 Please note that <command>net rap file user</command> does not work
466 against Samba servers. 
467 </para>
469 </refsect3>
471 </refsect2>
473 <refsect2>
474 <title>SESSION</title>
476 <refsect3>
477 <title>RAP SESSION</title>
479 <para>Without any other options, SESSION enumerates all active SMB/CIFS 
480 sessions on the target server.</para>
482 </refsect3>
484 <refsect3>
485 <title>RAP SESSION DELETE|CLOSE <replaceable>CLIENT_NAME</replaceable></title>
487 <para>Close the specified sessions.</para>
489 </refsect3>
491 <refsect3>
492 <title>RAP SESSION INFO <replaceable>CLIENT_NAME</replaceable></title>
494 <para>Give a list with all the open files in specified session.</para>
496 </refsect3>
498 </refsect2>
500 <refsect2>
501 <title>RAP SERVER <replaceable>DOMAIN</replaceable></title>
503 <para>List all servers in specified domain or workgroup. Defaults
504 to local domain.</para>
506 </refsect2>
508 <refsect2>
509 <title>RAP DOMAIN</title>
511 <para>Lists all domains and workgroups visible on the 
512 current network.</para>
514 </refsect2>
516 <refsect2>
517 <title>RAP PRINTQ</title>
519 <refsect3>
520 <title>RAP PRINTQ INFO <replaceable>QUEUE_NAME</replaceable></title>
522 <para>Lists the specified print queue and print jobs on the server.
523 If the <replaceable>QUEUE_NAME</replaceable> is omitted, all 
524 queues are listed.</para>
526 </refsect3>
528 <refsect3>
529 <title>RAP PRINTQ DELETE <replaceable>JOBID</replaceable></title>
531 <para>Delete job with specified id.</para>
533 </refsect3>
535 </refsect2>
537 <refsect2>
538 <title>RAP VALIDATE <replaceable>user</replaceable> [<replaceable>password</replaceable>]</title>
540 <para>
541 Validate whether the specified user can log in to the 
542 remote server. If the password is not specified on the commandline, it 
543 will be prompted. 
544 </para>
546 &not.implemented;
548 </refsect2>
550 <refsect2>
551 <title>RAP GROUPMEMBER</title>
553 <refsect3>
554 <title>RAP GROUPMEMBER LIST <replaceable>GROUP</replaceable></title>
556 <para>List all members of the specified group.</para>
558 </refsect3>
560 <refsect3>
561 <title>RAP GROUPMEMBER DELETE <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title>
563 <para>Delete member from group.</para>
565 </refsect3>
567 <refsect3>
568 <title>RAP GROUPMEMBER ADD <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title>
570 <para>Add member to group.</para>
572 </refsect3>
574 </refsect2>
576 <refsect2>
577 <title>RAP ADMIN <replaceable>command</replaceable></title>
579 <para>Execute the specified <replaceable>command</replaceable> on 
580 the remote server. Only works with OS/2 servers.
581 </para>
583 &not.implemented;
585 </refsect2>
587 <refsect2>
588 <title>RAP SERVICE</title>
590 <refsect3>
591 <title>RAP SERVICE START <replaceable>NAME</replaceable> [arguments...]</title>
593 <para>Start the specified service on the remote server. Not implemented yet.</para>
595 &not.implemented;
597 </refsect3>
599 <refsect3>
600 <title>RAP SERVICE STOP</title>
602 <para>Stop the specified service on the remote server.</para>
604 &not.implemented;
606 </refsect3>
608 </refsect2>
610 <refsect2>
611 <title>RAP PASSWORD <replaceable>USER</replaceable> <replaceable>OLDPASS</replaceable> <replaceable>NEWPASS</replaceable></title>
613 <para>
614 Change password of <replaceable>USER</replaceable> from <replaceable>OLDPASS</replaceable> to <replaceable>NEWPASS</replaceable>.
615 </para>
617 </refsect2>
619 <refsect2>
620 <title>LOOKUP</title>
622 <refsect3>
623 <title>LOOKUP HOST <replaceable>HOSTNAME</replaceable> [<replaceable>TYPE</replaceable>]</title>
625 <para>
626 Lookup the IP address of the given host with the specified type (netbios suffix). 
627 The type defaults to 0x20 (workstation).
628 </para>
630 </refsect3>
632 <refsect3>
633 <title>LOOKUP LDAP [<replaceable>DOMAIN</replaceable>]</title>
635 <para>Give IP address of LDAP server of specified <replaceable>DOMAIN</replaceable>. Defaults to local domain.</para>
637 </refsect3>
639 <refsect3>
640 <title>LOOKUP KDC [<replaceable>REALM</replaceable>]</title>
642 <para>Give IP address of KDC for the specified <replaceable>REALM</replaceable>.
643 Defaults to local realm.</para>
645 </refsect3>
647 <refsect3>
648 <title>LOOKUP DC [<replaceable>DOMAIN</replaceable>]</title>
650 <para>Give IP's of Domain Controllers for specified <replaceable>
651 DOMAIN</replaceable>. Defaults to local domain.</para>
653 </refsect3>
655 <refsect3>
656 <title>LOOKUP MASTER <replaceable>DOMAIN</replaceable></title>
658 <para>Give IP of master browser for specified <replaceable>DOMAIN</replaceable>
659 or workgroup. Defaults to local domain.</para>
661 </refsect3>
663 </refsect2>
665 <refsect2>
666 <title>CACHE</title>
668 <para>Samba uses a general caching interface called 'gencache'. It 
669 can be controlled using 'NET CACHE'.</para>
671 <para>All the timeout parameters support the suffixes:
673 <simplelist>
674 <member>s - Seconds</member>
675 <member>m - Minutes</member>
676 <member>h - Hours</member>
677 <member>d - Days</member>
678 <member>w - Weeks</member>
679 </simplelist>
681 </para>
683 <refsect3>
684 <title>CACHE ADD <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
686 <para>Add specified key+data to the cache with the given timeout.</para>
688 </refsect3>
690 <refsect3>
691 <title>CACHE DEL <replaceable>key</replaceable></title>
693 <para>Delete key from the cache.</para>
695 </refsect3>
697 <refsect3>
698 <title>CACHE SET <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
700 <para>Update data of existing cache entry.</para>
702 </refsect3>
704 <refsect3>
705 <title>CACHE SEARCH <replaceable>PATTERN</replaceable></title>
707 <para>Search for the specified pattern in the cache data.</para>
709 </refsect3>
711 <refsect3>
712 <title>CACHE LIST</title>
714 <para>
715 List all current items in the cache.
716 </para>
718 </refsect3>
720 <refsect3>
721 <title>CACHE FLUSH</title>
723 <para>Remove all the current items from the cache.</para>
725 </refsect3>
727 </refsect2>
729 <refsect2>
730 <title>GETLOCALSID [DOMAIN]</title>
732 <para>Prints the SID of the specified domain, or if the parameter is
733 omitted, the SID of the local server.</para>
735 </refsect2>
737 <refsect2>
738 <title>SETLOCALSID S-1-5-21-x-y-z</title>
740 <para>Sets SID for the local server to the specified SID.</para>
742 </refsect2>
744 <refsect2>
745 <title>GETDOMAINSID</title>
747 <para>Prints the local machine SID and the SID of the current 
748 domain.</para>
750 </refsect2>
752 <refsect2>
753 <title>SETDOMAINSID</title>
755 <para>Sets the SID of the current domain.</para>
757 </refsect2>
759 <refsect2>
760 <title>GROUPMAP</title>
762 <para>Manage the mappings between Windows group SIDs and UNIX groups.
763 Common options include:</para>
765 <itemizedlist>
766 <listitem><para>unixgroup - Name of the UNIX group</para></listitem>
767 <listitem><para>ntgroup - Name of the Windows NT group (must be
768   resolvable to a SID</para></listitem>
769 <listitem><para>rid - Unsigned 32-bit integer</para></listitem>
770 <listitem><para>sid - Full SID in the form of "S-1-..."</para></listitem>
771 <listitem><para>type - Type of the group; either 'domain', 'local',
772   or 'builtin'</para></listitem>
773 <listitem><para>comment - Freeform text description of the group</para></listitem>
774 </itemizedlist>
776 <refsect3>
777 <title>GROUPMAP ADD</title>
779 <para>
780 Add a new group mapping entry:
781 <programlisting>
782 net groupmap add {rid=int|sid=string} unixgroup=string \
783         [type={domain|local}] [ntgroup=string] [comment=string]
784 </programlisting>
785 </para>
787 </refsect3>
789 <refsect3>
790 <title>GROUPMAP DELETE</title>
792 <para>Delete a group mapping entry. If more than one group name matches, the first entry found is deleted.</para>
794 <para>net groupmap delete {ntgroup=string|sid=SID}</para>
796 </refsect3>
798 <refsect3>
799 <title>GROUPMAP MODIFY</title>
801 <para>Update an existing group entry.</para>
803 <para>
804 <programlisting>
805 net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \
806        [comment=string] [type={domain|local}]
807 </programlisting>
808 </para>
809 </refsect3>
811 <refsect3>
812 <title>GROUPMAP LIST</title>
814 <para>List existing group mapping entries.</para>
816 <para>net groupmap list [verbose] [ntgroup=string] [sid=SID]</para>
818 </refsect3>
819 </refsect2>
823 <refsect2>
824 <title>MAXRID</title>
826 <para>Prints out the highest RID currently in use on the local
827 server (by the active 'passdb backend').
828 </para>
830 </refsect2>
832 <refsect2>
833 <title>RPC INFO</title>
835 <para>Print information about the domain of the remote server,
836 such as domain name, domain sid and number of users and groups.
837 </para>
839 </refsect2>
841 <refsect2>
842 <title>[RPC|ADS] TESTJOIN</title>
844 <para>Check whether participation in a domain is still valid.</para>
846 </refsect2>
848 <refsect2>
849 <title>[RPC|ADS] CHANGETRUSTPW</title>
851 <para>Force change of domain trust password.</para>
853 </refsect2>
855 <refsect2>
856 <title>RPC TRUSTDOM</title>
858 <refsect3>
859 <title>RPC TRUSTDOM ADD <replaceable>DOMAIN</replaceable></title>
861 <para>Add a interdomain trust account for <replaceable>DOMAIN</replaceable>. 
862 This is in fact a Samba account named <replaceable>DOMAIN$</replaceable> 
863 with the account flag <constant>'I'</constant> (interdomain trust account). 
864 This is required for incoming trusts to work. It makes Samba be a
865 trusted domain of the foreign (trusting) domain.
866 Users of the Samba domain will be made available in the foreign domain.
867 If the command is used against localhost it has the same effect as 
868 <command>smbpasswd -a -i DOMAIN</command>. Please note that both commands
869 expect a appropriate UNIX account. 
870 </para>
872 </refsect3>
874 <refsect3>
875 <title>RPC TRUSTDOM DEL <replaceable>DOMAIN</replaceable></title>
877 <para>Remove interdomain trust account for 
878 <replaceable>DOMAIN</replaceable>. If it is used against localhost 
879 it has the same effect as <command>smbpasswd -x DOMAIN$</command>. 
880 </para>
882 </refsect3>
884 <refsect3>
885 <title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title>
887 <para>
888 Establish a trust relationship to a trusted domain. 
889 Interdomain account must already be created on the remote PDC.
890 This is required for outgoing trusts to work. It makes Samba be a
891 trusting domain of a foreign (trusted) domain.
892 Users of the foreign domain will be made available in our domain.
893 You'll need winbind and a working idmap config to make them
894 appear in your system.
895 </para>
897 </refsect3>
899 <refsect3>
900 <title>RPC TRUSTDOM REVOKE <replaceable>DOMAIN</replaceable></title>
901 <para>Abandon relationship to trusted domain</para>
903 </refsect3>
905 <refsect3>
906 <title>RPC TRUSTDOM LIST</title>
908 <para>List all interdomain trust relationships.</para>
910 </refsect3>
911 </refsect2>
913 <refsect2>
914 <title>RPC TRUST</title>
916 <refsect3>
917 <title>RPC TRUST CREATE</title>
919 <para>Create a trust object by calling lsaCreateTrustedDomainEx2.
920 The can be done on a single server or on two servers at once with the
921 possibility to use a random trust password.</para>
923 <variablelist><title>Options:</title>
924 <varlistentry>
925 <term>otherserver</term>
926 <listitem><para>Domain controller of the second domain</para></listitem>
927 </varlistentry>
929 <varlistentry>
930 <term>otheruser</term>
931 <listitem><para>Admin user in the second domain</para></listitem>
932 </varlistentry>
934 <varlistentry>
935 <term>otherdomainsid</term>
936 <listitem><para>SID of the second domain</para></listitem>
937 </varlistentry>
939 <varlistentry>
940 <term>other_netbios_domain</term>
941 <listitem><para>NetBIOS (short) name of the second domain</para></listitem>
942 </varlistentry>
944 <varlistentry>
945 <term>otherdomain</term>
946 <listitem><para>DNS (full) name of the second domain</para></listitem>
947 </varlistentry>
949 <varlistentry>
950 <term>trustpw</term>
951 <listitem><para>Trust password</para></listitem>
952 </varlistentry>
953 </variablelist>
955 <variablelist><title>Examples:</title>
956 <varlistentry>
957 <term>Create a trust object on srv1.dom1.dom for the domain dom2</term>
958 <listitem><literallayout>
959 net rpc trust create \
960     otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
961     other_netbios_domain=dom2 \
962     otherdomain=dom2.dom \
963     trustpw=12345678 \
964     -S srv1.dom1.dom
965 </literallayout></listitem>
966 </varlistentry>
967 <varlistentry>
968 <term>Create a trust relationship between dom1 and dom2</term>
969 <listitem><literallayout>
970 net rpc trust create \
971     otherserver=srv2.dom2.test \
972     otheruser=dom2adm \
973     -S srv1.dom1.dom
974 </literallayout></listitem>
975 </varlistentry>
976 </variablelist>
977 </refsect3>
979 <refsect3>
980 <title>RPC TRUST DELETE</title>
982 <para>Delete a trust object by calling lsaDeleteTrustedDomain.
983 The can be done on a single server or on two servers at once.</para>
985 <variablelist><title>Options:</title>
986 <varlistentry>
987 <term>otherserver</term>
988 <listitem><para>Domain controller of the second domain</para></listitem>
989 </varlistentry>
991 <varlistentry>
992 <term>otheruser</term>
993 <listitem><para>Admin user in the second domain</para></listitem>
994 </varlistentry>
996 <varlistentry>
997 <term>otherdomainsid</term>
998 <listitem><para>SID of the second domain</para></listitem>
999 </varlistentry>
1000 </variablelist>
1002 <variablelist><title>Examples:</title>
1003 <varlistentry>
1004 <term>Delete a trust object on srv1.dom1.dom for the domain dom2</term>
1005 <listitem><literallayout>
1006 net rpc trust delete \
1007     otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
1008     -S srv1.dom1.dom
1009 </literallayout></listitem>
1010 </varlistentry>
1011 <varlistentry>
1012 <term>Delete a trust relationship between dom1 and dom2</term>
1013 <listitem><literallayout>
1014 net rpc trust delete \
1015     otherserver=srv2.dom2.test \
1016     otheruser=dom2adm \
1017     -S srv1.dom1.dom
1018 </literallayout></listitem>
1019 </varlistentry>
1020 </variablelist>
1021 </refsect3>
1023 </refsect2>
1025 <refsect2>
1026 <refsect3>
1027 <title>RPC RIGHTS</title>
1029 <para>This subcommand is used to view and manage Samba's rights assignments (also 
1030 referred to as privileges).  There are three options currently available: 
1031 <parameter>list</parameter>, <parameter>grant</parameter>, and 
1032 <parameter>revoke</parameter>.  More details on Samba's privilege model and its use
1033 can be found in the Samba-HOWTO-Collection.</para>
1035 </refsect3>
1038 </refsect2>
1040 <refsect2>
1041 <title>RPC ABORTSHUTDOWN</title>
1043 <para>Abort the shutdown of a remote server.</para>
1045 </refsect2>
1047 <refsect2>
1048 <title>RPC SHUTDOWN [-t timeout] [-r] [-f] [-C message]</title>
1050 <para>Shut down the remote server.</para>
1052 <variablelist>
1053 <varlistentry>
1054 <term>-r</term>
1055 <listitem><para>
1056 Reboot after shutdown.
1057 </para></listitem>
1058 </varlistentry>
1060 <varlistentry>
1061 <term>-f</term>
1062 <listitem><para>
1063 Force shutting down all applications.
1064 </para></listitem>
1065 </varlistentry>
1067 <varlistentry>
1068 <term>-t timeout</term>
1069 <listitem><para>
1070 Timeout before system will be shut down. An interactive 
1071 user of the system can use this time to cancel the shutdown.
1072 </para></listitem>
1073 </varlistentry>
1075 <varlistentry>
1076 <term>-C message</term>
1077 <listitem><para>Display the specified message on the screen to 
1078 announce the shutdown.</para></listitem>
1079 </varlistentry>
1080 </variablelist>
1082 </refsect2>
1084 <refsect2>
1085 <title>RPC SAMDUMP</title>
1087 <para>Print out sam database of remote server. You need
1088 to run this against the PDC, from a Samba machine joined as a BDC. </para>
1089 </refsect2>
1091 <refsect2>
1092 <title>RPC VAMPIRE</title>
1094 <para>Export users, aliases and groups from remote server to 
1095 local server.  You need to run this against the PDC, from a Samba machine joined as a BDC. 
1096 </para>
1097 </refsect2>
1099 <refsect2>
1100 <title>RPC VAMPIRE KEYTAB</title>
1102 <para>Dump remote SAM database to local Kerberos keytab file.
1103 </para>
1104 </refsect2>
1106 <refsect2>
1107 <title>RPC VAMPIRE LDIF</title>
1109 <para>Dump remote SAM database to local LDIF file or standard output.
1110 </para>
1111 </refsect2>
1113 <refsect2>
1114 <title>RPC GETSID</title>
1116 <para>Fetch domain SID and store it in the local <filename>secrets.tdb</filename> (or <filename>secrets.ntdb</filename>). </para>
1118 </refsect2>
1120 <refsect2>
1121 <title>ADS LEAVE</title>
1123 <para>Make the remote host leave the domain it is part of. </para>
1125 </refsect2>
1127 <refsect2>
1128 <title>ADS STATUS</title>
1130 <para>Print out status of machine account of the local machine in ADS.
1131 Prints out quite some debug info. Aimed at developers, regular 
1132 users should use <command>NET ADS TESTJOIN</command>.</para>
1134 </refsect2>
1136 <refsect2>
1137 <title>ADS PRINTER</title>
1139 <refsect3>
1140 <title>ADS PRINTER INFO [<replaceable>PRINTER</replaceable>] [<replaceable>SERVER</replaceable>]</title>
1142 <para>
1143 Lookup info for <replaceable>PRINTER</replaceable> on <replaceable>SERVER</replaceable>. The printer name defaults to "*", the 
1144 server name defaults to the local host.</para>
1146 </refsect3>
1148 <refsect3>
1149 <title>ADS PRINTER PUBLISH <replaceable>PRINTER</replaceable></title>
1151 <para>Publish specified printer using ADS.</para>
1153 </refsect3>
1155 <refsect3>
1156 <title>ADS PRINTER REMOVE <replaceable>PRINTER</replaceable></title>
1158 <para>Remove specified printer from ADS directory.</para>
1160 </refsect3>
1162 </refsect2>
1164 <refsect2>
1165 <title>ADS SEARCH <replaceable>EXPRESSION</replaceable> <replaceable>ATTRIBUTES...</replaceable></title>
1167 <para>Perform a raw LDAP search on a ADS server and dump the results. The 
1168 expression is a standard LDAP search expression, and the 
1169 attributes are a list of LDAP fields to show in the results.</para>
1171 <para>Example: <userinput>net ads search '(objectCategory=group)' sAMAccountName</userinput>
1172 </para>
1174 </refsect2>
1176 <refsect2>
1177 <title>ADS DN <replaceable>DN</replaceable> <replaceable>(attributes)</replaceable></title>
1179 <para>
1180 Perform a raw LDAP search on a ADS server and dump the results. The 
1181 DN standard LDAP DN, and the attributes are a list of LDAP fields 
1182 to show in the result. 
1183 </para>
1185 <para>Example: <userinput>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</userinput></para>
1187 </refsect2>
1189 <refsect2>
1190 <title>ADS WORKGROUP</title>
1192 <para>Print out workgroup name for specified kerberos realm.</para>
1194 </refsect2>
1196 <refsect2>
1197 <title>SAM CREATEBUILTINGROUP &lt;NAME&gt;</title>
1199 <para>
1200 (Re)Create a BUILTIN group.
1201 Only a wellknown set of BUILTIN groups can be created with this command.
1202 This is the list of currently recognized group names: Administrators,
1203 Users, Guests, Power Users, Account Operators, Server Operators, Print
1204 Operators, Backup Operators, Replicator, RAS Servers, Pre-Windows 2000
1205 compatible Access.
1207 This command requires a running Winbindd with idmap allocation properly
1208 configured. The group gid will be allocated out of the winbindd range.
1209 </para>
1211 </refsect2>
1213 <refsect2>
1214 <title>SAM CREATELOCALGROUP &lt;NAME&gt;</title>
1216 <para>
1217 Create a LOCAL group (also known as Alias).
1219 This command requires a running Winbindd with idmap allocation properly
1220 configured. The group gid will be allocated out of the winbindd range.
1221 </para>
1223 </refsect2>
1225 <refsect2>
1226 <title>SAM DELETELOCALGROUP &lt;NAME&gt;</title>
1228 <para>
1229 Delete an existing LOCAL group (also known as Alias).
1231 </para>
1233 </refsect2>
1235 <refsect2>
1236 <title>SAM MAPUNIXGROUP &lt;NAME&gt;</title>
1238 <para>
1239 Map an existing Unix group and make it a Domain Group, the domain group
1240 will have the same name.
1241 </para>
1243 </refsect2>
1245 <refsect2>
1246 <title>SAM UNMAPUNIXGROUP &lt;NAME&gt;</title>
1248 <para>
1249 Remove an existing group mapping entry.
1250 </para>
1252 </refsect2>
1254 <refsect2>
1255 <title>SAM ADDMEM &lt;GROUP&gt; &lt;MEMBER&gt;</title>
1257 <para>
1258 Add a member to a Local group. The group can be specified only by name,
1259 the member can be specified by name or SID.
1260 </para>
1262 </refsect2>
1264 <refsect2>
1265 <title>SAM DELMEM  &lt;GROUP&gt; &lt;MEMBER&gt;</title>
1267 <para>
1268 Remove a member from a Local group. The group and the member must be
1269 specified by name.
1270 </para>
1272 </refsect2>
1274 <refsect2>
1275 <title>SAM LISTMEM &lt;GROUP&gt;</title>
1277 <para>
1278 List Local group members. The group must be specified by name.
1279 </para>
1281 </refsect2>
1283 <refsect2>
1284 <title>SAM LIST &lt;users|groups|localgroups|builtin|workstations&gt; [verbose]</title>
1286 <para>
1287 List the specified set of accounts by name. If verbose is specified,
1288 the rid and description is also provided for each account.
1289 </para>
1291 </refsect2>
1293 <refsect2>
1294 <title>SAM RIGHTS LIST</title>
1296 <para>
1297 List all available privileges.
1298 </para>
1300 </refsect2>
1302 <refsect2>
1303 <title>SAM RIGHTS GRANT &lt;NAME&gt; &lt;PRIVILEGE&gt;</title>
1305 <para>
1306 Grant one or more privileges to a user.
1307 </para>
1309 </refsect2>
1311 <refsect2>
1312 <title>SAM RIGHTS REVOKE &lt;NAME&gt; &lt;PRIVILEGE&gt;</title>
1314 <para>
1315 Revoke one or more privileges from a user.
1316 </para>
1318 </refsect2>
1320 <refsect2>
1321 <title>SAM SHOW &lt;NAME&gt;</title>
1323 <para>
1324 Show the full DOMAIN\\NAME the SID and the type for the corresponding
1325 account.
1326 </para>
1328 </refsect2>
1330 <refsect2>
1331 <title>SAM SET HOMEDIR &lt;NAME&gt; &lt;DIRECTORY&gt;</title>
1333 <para>
1334 Set the home directory for a user account.
1335 </para>
1337 </refsect2>
1339 <refsect2>
1340 <title>SAM SET PROFILEPATH &lt;NAME&gt; &lt;PATH&gt;</title>
1342 <para>
1343 Set the profile path for a user account.
1344 </para>
1346 </refsect2>
1348 <refsect2>
1349 <title>SAM SET COMMENT &lt;NAME&gt; &lt;COMMENT&gt;</title>
1351 <para>
1352 Set the comment for a user or group account.
1353 </para>
1355 </refsect2>
1357 <refsect2>
1358 <title>SAM SET FULLNAME &lt;NAME&gt; &lt;FULL NAME&gt;</title>
1360 <para>
1361 Set the full name for a user account.
1362 </para>
1364 </refsect2>
1366 <refsect2>
1367 <title>SAM SET LOGONSCRIPT &lt;NAME&gt; &lt;SCRIPT&gt;</title>
1369 <para>
1370 Set the logon script for a user account.
1371 </para>
1373 </refsect2>
1375 <refsect2>
1376 <title>SAM SET HOMEDRIVE &lt;NAME&gt; &lt;DRIVE&gt;</title>
1378 <para>
1379 Set the home drive for a user account.
1380 </para>
1382 </refsect2>
1384 <refsect2>
1385 <title>SAM SET WORKSTATIONS &lt;NAME&gt; &lt;WORKSTATIONS&gt;</title>
1387 <para>
1388 Set the workstations a user account is allowed to log in from.
1389 </para>
1391 </refsect2>
1393 <refsect2>
1394 <title>SAM SET DISABLE &lt;NAME&gt;</title>
1396 <para>
1397 Set the "disabled" flag for a user account.
1398 </para>
1400 </refsect2>
1402 <refsect2>
1403 <title>SAM SET PWNOTREQ &lt;NAME&gt;</title>
1405 <para>
1406 Set the "password not required" flag for a user account.
1407 </para>
1409 </refsect2>
1411 <refsect2>
1412 <title>SAM SET AUTOLOCK &lt;NAME&gt;</title>
1414 <para>
1415 Set the "autolock" flag for a user account.
1416 </para>
1418 </refsect2>
1420 <refsect2>
1421 <title>SAM SET PWNOEXP &lt;NAME&gt;</title>
1423 <para>
1424 Set the "password do not expire" flag for a user account.
1425 </para>
1427 </refsect2>
1429 <refsect2>
1430 <title>SAM SET PWDMUSTCHANGENOW &lt;NAME&gt; [yes|no]</title>
1432 <para>
1433 Set or unset the "password must change" flag for a user account.
1434 </para>
1436 </refsect2>
1438 <refsect2>
1439 <title>SAM POLICY LIST</title>
1441 <para>
1442 List the available account policies.
1443 </para>
1445 </refsect2>
1447 <refsect2>
1448 <title>SAM POLICY SHOW &lt;account policy&gt;</title>
1450 <para>
1451 Show the account policy value.
1452 </para>
1454 </refsect2>
1456 <refsect2>
1457 <title>SAM POLICY SET &lt;account policy&gt; &lt;value&gt;</title>
1459 <para>
1460 Set a value for the account policy.
1461 Valid values can be: "forever", "never", "off", or a number.
1462 </para>
1464 </refsect2>
1466 <refsect2>
1467 <title>SAM PROVISION</title>
1469 <para>
1470 Only available if ldapsam:editposix is set and winbindd is running.
1471 Properly populates the ldap tree with the basic accounts (Administrator)
1472 and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree.
1473 </para>
1475 </refsect2>
1477 <refsect2>
1478 <title>IDMAP DUMP &lt;local tdb file name&gt;</title>
1480 <para>
1481 Dumps the mappings contained in the local tdb file specified.
1482 This command is useful to dump only the mappings produced by the idmap_tdb backend.
1483 </para>
1485 </refsect2>
1487 <refsect2>
1488 <title>IDMAP RESTORE [input file]</title>
1490 <para>
1491 Restore the mappings from the specified file or stdin.
1492 </para>
1494 </refsect2>
1496 <refsect2>
1497 <title>IDMAP SET SECRET &lt;DOMAIN&gt; &lt;secret&gt;</title>
1499 <para>
1500 Store a secret for the specified domain, used primarily for domains
1501 that use idmap_ldap as a backend. In this case the secret is used
1502 as the password for the user DN used to bind to the ldap server.
1503 </para>
1505 </refsect2>
1507 <refsect2>
1508 <title>IDMAP SET RANGE &lt;RANGE&gt; &lt;SID&gt; [index] [--db=&lt;DB&gt;]</title>
1510 <para>
1511 Store a domain-range mapping for a given domain (and index) in autorid database.
1512 </para>
1514 </refsect2>
1516 <refsect2>
1517 <title>IDMAP SET CONFIG &lt;config&gt; [--db=&lt;DB&gt;]</title>
1519 <para>
1520 Update CONFIG entry in autorid database.
1521 </para>
1523 </refsect2>
1525 <refsect2>
1526 <title>IDMAP GET RANGE &lt;SID&gt; [index] [--db=&lt;DB&gt;]</title>
1528 <para>
1529 Get the range for a given domain and index from autorid database.
1530 </para>
1532 </refsect2>
1534 <refsect2>
1535 <title>IDMAP GET RANGES [&lt;SID&gt;] [--db=&lt;DB&gt;]</title>
1537 <para>
1538 Get ranges for all domains or for one identified by given SID.
1539 </para>
1541 </refsect2>
1543 <refsect2>
1544 <title>IDMAP GET CONFIG [--db=&lt;DB&gt;]</title>
1546 <para>
1547 Get CONFIG entry from autorid database.
1548 </para>
1550 </refsect2>
1552 <refsect2>
1554 <title>IDMAP DELETE MAPPING [-f] [--db=&lt;DB&gt;] &lt;ID&gt;</title>
1556 <para>
1557 Delete a mapping sid &lt;-&gt; gid or sid &lt;-&gt; uid from the IDMAP database.
1558 The mapping is given by &lt;ID&gt; which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
1559 Use -f to delete an invalid partial mapping &lt;ID&gt; -&gt; xx
1560 </para>
1561 <para>
1562   Use "smbcontrol all idmap ..." to notify running smbd instances.
1563   See the <citerefentry><refentrytitle>smbcontrol</refentrytitle>
1564   <manvolnum>1</manvolnum></citerefentry> manpage for details.
1565 </para>
1566 </refsect2>
1568 <refsect2>
1569 <title>IDMAP DELETE RANGE [-f] [--db=&lt;TDB&gt;] &lt;RANGE&gt;|(&lt;SID&gt; [&lt;INDEX&gt;])</title>
1571 <para>
1572 Delete a domain range mapping identified by 'RANGE' or "domain SID and INDEX" from autorid database.
1573 Use -f to delete invalid mappings.
1574 </para>
1576 </refsect2>
1578 <refsect2>
1579 <title>IDMAP DELETE RANGES [-f] [--db=&lt;TDB&gt;] &lt;SID&gt;</title>
1581 <para>
1582 Delete all domain range mappings for a domain identified by SID.
1583 Use -f to delete invalid mappings.
1584 </para>
1586 </refsect2>
1588 <refsect2>
1590 <title>IDMAP CHECK [-v] [-r] [-a] [-T] [-f] [-l] [--db=&lt;DB&gt;]</title>
1592 <para>
1593   Check and repair the IDMAP database. If no option is given a read only check
1594   of the database is done. Among others an interactive or automatic repair mode
1595   may be chosen with one of the following options:
1597   <variablelist>
1598     <varlistentry><term>-r|--repair</term>
1599     <listitem><para>
1600       Interactive repair mode, ask a lot of questions.
1601     </para></listitem>
1602     </varlistentry>
1604     <varlistentry><term>-a|--auto</term>
1605     <listitem><para>
1606       Noninteractive repair mode, use default answers.
1607     </para></listitem>
1608     </varlistentry>
1610     <varlistentry><term>-v|--verbose</term>
1611       <listitem><para>
1612         Produce more output.
1613       </para></listitem>
1614     </varlistentry>
1616     <varlistentry><term>-f|--force</term>
1617       <listitem><para>
1618         Try to apply changes, even if they do not apply cleanly.
1619       </para></listitem>
1620     </varlistentry>
1622     <varlistentry><term>-T|--test</term>
1623       <listitem><para>
1624         Dry run, show what changes would be made but don't touch anything.
1625       </para></listitem>
1626     </varlistentry>
1628     <varlistentry><term>-l|--lock</term>
1629       <listitem><para>
1630         Lock the database while doing the check.
1631       </para></listitem>
1632     </varlistentry>
1634     <varlistentry><term>--db &lt;DB&gt;</term>
1635       <listitem><para>
1636         Check the specified database.
1637       </para></listitem>
1638     </varlistentry>
1639     <varlistentry><term></term>
1640       <listitem><para>
1641       </para></listitem>
1642     </varlistentry>
1643   </variablelist>
1645   It reports about the finding of the following errors:
1647   <variablelist>
1648     <varlistentry><term>Missing reverse mapping:</term>
1649     <listitem><para>
1650       A record with mapping A-&gt;B where there is no B-&gt;A. Default action
1651       in repair mode is to "fix" this by adding the reverse mapping.
1652     </para></listitem>
1653     </varlistentry>
1655     <varlistentry><term>Invalid mapping:</term>
1656     <listitem><para>
1657       A record with mapping A-&gt;B where B-&gt;C. Default action
1658       is to "delete" this record.
1659     </para></listitem>
1660   </varlistentry>
1662   <varlistentry><term>Missing or invalid HWM:</term>
1663     <listitem><para>
1664       A high water mark is not at least equal to the largest ID in the
1665       database. Default action is to "fix" this by setting it to the
1666       largest ID found +1.
1667     </para></listitem>
1668   </varlistentry>
1670   <varlistentry><term>Invalid record:</term>
1671     <listitem><para>
1672       Something we failed to parse. Default action is to "edit" it
1673       in interactive and "delete" it in automatic mode.
1674     </para></listitem>
1675   </varlistentry>
1676 </variablelist>
1677 </para>
1678 </refsect2>
1681 <refsect2>
1682 <title>USERSHARE</title>
1684 <para>Starting with version 3.0.23, a Samba server now supports the ability for
1685 non-root users to add user defined shares to be exported using the "net usershare"
1686 commands.
1687 </para>
1689 <para>
1690 To set this up, first set up your smb.conf by adding to the [global] section:
1692 usershare path = /usr/local/samba/lib/usershares
1694 Next create the directory /usr/local/samba/lib/usershares, change the owner to root and
1695 set the group owner to the UNIX group who should have the ability to create usershares,
1696 for example a group called "serverops".
1698 Set the permissions on /usr/local/samba/lib/usershares to 01770.
1700 (Owner and group all access, no access for others, plus the sticky bit,
1701 which means that a file in that directory can be renamed or deleted only
1702 by the owner of the file).
1704 Finally, tell smbd how many usershares you will allow by adding to the [global]
1705 section of smb.conf a line such as :
1707 usershare max shares = 100.
1709 To allow 100 usershare definitions. Now, members of the UNIX group "serverops"
1710 can create user defined shares on demand using the commands below.
1711 </para>
1713 <para>The usershare commands are:
1715 <simplelist>
1716 <member>net usershare add sharename path [comment [acl] [guest_ok=[y|n]]] - to add or change a user defined share.</member>
1717 <member>net usershare delete sharename - to delete a user defined share.</member>
1718 <member>net usershare info [-l|--long] [wildcard sharename] - to print info about a user defined share.</member>
1719 <member>net usershare list [-l|--long] [wildcard sharename] - to list user defined shares.</member>
1720 </simplelist>
1722 </para>
1724 <refsect3>
1725 <title>USERSHARE ADD <replaceable>sharename</replaceable> <replaceable>path</replaceable> <replaceable>[comment]</replaceable> <replaceable>[acl]</replaceable> <replaceable>[guest_ok=[y|n]]</replaceable></title>
1727 <para>
1728 Add or replace a new user defined share, with name "sharename".
1729 </para>
1731 <para>
1732 "path" specifies the absolute pathname on the system to be exported.
1733 Restrictions may be put on this, see the global smb.conf parameters:
1734 "usershare owner only", "usershare prefix allow list", and
1735 "usershare prefix deny list".
1736 </para>
1738 <para>
1739 The optional "comment" parameter is the comment that will appear
1740 on the share when browsed to by a client.
1741 </para>
1743 <para>The optional "acl" field
1744 specifies which users have read and write access to the entire share.
1745 Note that guest connections are not allowed unless the smb.conf parameter
1746 "usershare allow guests" has been set. The definition of a user
1747 defined share acl is: "user:permission", where user is a valid
1748 username on the system and permission can be "F", "R", or "D".
1749 "F" stands for "full permissions", ie. read and write permissions.
1750 "D" stands for "deny" for a user, ie. prevent this user from accessing
1751 this share.
1752 "R" stands for "read only", ie. only allow read access to this
1753 share (no creation of new files or directories or writing to files).
1754 </para>
1756 <para>
1757 The default if no "acl" is given is "Everyone:R", which means any 
1758 authenticated user has read-only access.
1759 </para>
1761 <para>
1762 The optional "guest_ok" has the same effect as the parameter of the
1763 same name in smb.conf, in that it allows guest access to this user
1764 defined share. This parameter is only allowed if the global parameter
1765 "usershare allow guests" has been set to true in the smb.conf.
1766 </para>
1768 There is no separate command to modify an existing user defined share,
1769 just use the "net usershare add [sharename]" command using the same
1770 sharename as the one you wish to modify and specify the new options
1771 you wish. The Samba smbd daemon notices user defined share modifications
1772 at connect time so will see the change immediately, there is no need
1773 to restart smbd on adding, deleting or changing a user defined share.
1774 </refsect3>
1776 <refsect3>
1777 <title>USERSHARE DELETE <replaceable>sharename</replaceable></title>
1779 <para>
1780 Deletes the user defined share by name. The Samba smbd daemon
1781 immediately notices this change, although it will not disconnect
1782 any users currently connected to the deleted share.
1783 </para>
1785 </refsect3>
1787 <refsect3>
1788 <title>USERSHARE INFO <replaceable>[-l|--long]</replaceable> <replaceable>[wildcard sharename]</replaceable></title>
1790 <para>
1791 Get info on user defined shares owned by the current user matching the given pattern, or all users.
1792 </para>
1794 <para>
1795 net usershare info on its own dumps out info on the user defined shares that were
1796 created by the current user, or restricts them to share names that match the given
1797 wildcard pattern ('*' matches one or more characters, '?' matches only one character).
1798 If the '-l' or '--long' option is also given, it prints out info on user defined
1799 shares created by other users.
1800 </para>
1802 <para>
1803 The information given about a share looks like:
1805 [foobar]
1806 path=/home/jeremy
1807 comment=testme
1808 usershare_acl=Everyone:F
1809 guest_ok=n
1811 And is a list of the current settings of the user defined share that can be
1812 modified by the "net usershare add" command.
1813 </para>
1815 </refsect3>
1817 <refsect3>
1818 <title>USERSHARE LIST <replaceable>[-l|--long]</replaceable> <replaceable>wildcard sharename</replaceable></title>
1820 <para>
1821 List all the user defined shares owned by the current user matching the given pattern, or all users.
1822 </para>
1824 <para>
1825 net usershare list on its own list out the names of the user defined shares that were
1826 created by the current user, or restricts the list to share names that match the given
1827 wildcard pattern ('*' matches one or more characters, '?' matches only one character).
1828 If the '-l' or '--long' option is also given, it includes the names of user defined
1829 shares created by other users.
1830 </para>
1832 </refsect3>
1834 </refsect2>
1836 <refsect2>
1837 <title>[RPC] CONF</title>
1839 <para>Starting with version 3.2.0, a Samba server can be configured by data
1840 stored in registry. This configuration data can be edited with the new "net
1841 conf" commands. There is also the possibility to configure a remote Samba server
1842 by enabling the RPC conf mode and specifying the address of the remote server.
1843 </para>
1845 <para>
1846 The deployment of this configuration data can be activated in two levels from the
1847 <emphasis>smb.conf</emphasis> file: Share definitions from registry are
1848 activated by setting <parameter>registry shares</parameter> to
1849 <quote>yes</quote> in the [global] section and global configuration options are
1850 activated by setting <smbconfoption name="include">registry</smbconfoption> in
1851 the [global] section for a mixed configuration or by setting
1852 <smbconfoption name="config backend">registry</smbconfoption> in the [global]
1853 section for a registry-only configuration.
1854 See the <citerefentry><refentrytitle>smb.conf</refentrytitle>
1855 <manvolnum>5</manvolnum></citerefentry> manpage for details.
1856 </para>
1858 <para>The conf commands are:
1859 <simplelist>
1860 <member>net [rpc] conf list - Dump the complete configuration in smb.conf like
1861 format.</member>
1862 <member>net [rpc] conf import - Import configuration from file in smb.conf
1863 format.</member>
1864 <member>net [rpc] conf listshares - List the registry shares.</member>
1865 <member>net [rpc] conf drop - Delete the complete configuration from
1866 registry.</member>
1867 <member>net [rpc] conf showshare - Show the definition of a registry share.</member>
1868 <member>net [rpc] conf addshare - Create a new registry share.</member>
1869 <member>net [rpc] conf delshare - Delete a registry share.</member>
1870 <member>net [rpc] conf setparm - Store a parameter.</member>
1871 <member>net [rpc] conf getparm - Retrieve the value of a parameter.</member>
1872 <member>net [rpc] conf delparm - Delete a parameter.</member>
1873 <member>net [rpc] conf getincludes - Show the includes of a share definition.</member>
1874 <member>net [rpc] conf setincludes - Set includes for a share.</member>
1875 <member>net [rpc] conf delincludes - Delete includes from a share definition.</member>
1876 </simplelist>
1877 </para>
1879 <refsect3>
1880 <title>[RPC] CONF LIST</title>
1882 <para>
1883 Print the configuration data stored in the registry in a smb.conf-like format to
1884 standard output.
1885 </para>
1886 </refsect3>
1888 <refsect3>
1889 <title>[RPC] CONF IMPORT <replaceable>[--test|-T]</replaceable> <replaceable>filename</replaceable> <replaceable>[section]</replaceable></title>
1891 <para>
1892 This command imports configuration from a file in smb.conf format.
1893 If a section encountered in the input file is present in registry,
1894 its contents is replaced. Sections of registry configuration that have
1895 no counterpart in the input file are not affected. If you want to delete these,
1896 you will have to use the "net conf drop" or "net conf delshare" commands.
1897 Optionally, a section may be specified to restrict the effect of the
1898 import command to that specific section. A test mode is enabled by specifying
1899 the parameter "-T" on the commandline. In test mode, no changes are made to the
1900 registry, and the resulting configuration is printed to standard output instead.
1901 </para>
1902 </refsect3>
1904 <refsect3>
1905 <title>[RPC] CONF LISTSHARES</title>
1907 <para>
1908 List the names of the shares defined in registry.
1909 </para>
1910 </refsect3>
1912 <refsect3>
1913 <title>[RPC] CONF DROP</title>
1915 <para>
1916 Delete the complete configuration data from registry.
1917 </para>
1918 </refsect3>
1920 <refsect3>
1921 <title>[RPC] CONF SHOWSHARE <replaceable>sharename</replaceable></title>
1923 <para>
1924 Show the definition of the share or section specified. It is valid to specify
1925 "global" as sharename to retrieve the global configuration options from
1926 registry.
1927 </para>
1928 </refsect3>
1930 <refsect3>
1931 <title>[RPC] CONF ADDSHARE <replaceable>sharename</replaceable> <replaceable>path</replaceable> [<replaceable>writeable={y|N}</replaceable> [<replaceable>guest_ok={y|N}</replaceable> [<replaceable>comment</replaceable>]]] </title>
1933 <para>Create a new share definition in registry.
1934 The sharename and path have to be given. The share name may
1935 <emphasis>not</emphasis> be "global". Optionally, values for the very
1936 common options "writeable", "guest ok" and a "comment" may be specified.
1937 The same result may be obtained by a sequence of "net conf setparm"
1938 commands.
1939 </para>
1940 </refsect3>
1942 <refsect3>
1943 <title>[RPC] CONF DELSHARE <replaceable>sharename</replaceable></title>
1945 <para>
1946 Delete a share definition from registry.
1947 </para>
1948 </refsect3>
1950 <refsect3>
1951 <title>[RPC] CONF SETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> <replaceable>value</replaceable></title>
1953 <para>
1954 Store a parameter in registry. The section may be global or a sharename.
1955 The section is created if it does not exist yet.
1956 </para>
1957 </refsect3>
1959 <refsect3>
1960 <title>[RPC] CONF GETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
1962 <para>
1963 Show a parameter stored in registry.
1964 </para>
1965 </refsect3>
1967 <refsect3>
1968 <title>[RPC] CONF DELPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
1970 <para>
1971 Delete a parameter stored in registry.
1972 </para>
1973 </refsect3>
1975 <refsect3>
1976 <title>[RPC] CONF GETINCLUDES <replaceable>section</replaceable></title>
1978 <para>
1979 Get the list of includes for the provided section (global or share).
1980 </para>
1982 <para>
1983 Note that due to the nature of the registry database and the nature of include directives,
1984 the includes need special treatment: Parameters are stored in registry by the parameter
1985 name as valuename, so there is only ever one instance of a parameter per share.
1986 Also, a specific order like in a text file is not guaranteed. For all real
1987 parameters, this is perfectly ok, but the include directive is rather a meta
1988 parameter, for which, in the smb.conf text file, the place where it is specified
1989 between the other parameters is very important. This can not be achieved by the
1990 simple registry smbconf data model, so there is one ordered list of includes
1991 per share, and this list is evaluated after all the parameters of the share.
1992 </para>
1994 <para>
1995 Further note that currently, only files can be included from registry
1996 configuration. In the future, there will be the ability to include configuration
1997 data from other registry keys.
1998 </para>
1999 </refsect3>
2001 <refsect3>
2002 <title>[RPC] CONF SETINCLUDES <replaceable>section</replaceable> [<replaceable>filename</replaceable>]+</title>
2004 <para>
2005 Set the list of includes for the provided section (global or share) to the given
2006 list of one or more filenames. The filenames may contain the usual smb.conf
2007 macros like %I.
2008 </para>
2009 </refsect3>
2011 <refsect3>
2012 <title>[RPC] CONF DELINCLUDES <replaceable>section</replaceable></title>
2014 <para>
2015 Delete the list of includes from the provided section (global or share).
2016 </para>
2017 </refsect3>
2019 </refsect2>
2021 <refsect2>
2022 <title>REGISTRY</title>
2023 <para>
2024 Manipulate Samba's registry.
2025 </para>
2027 <para>The registry commands are:
2028 <simplelist>
2029 <member>net registry enumerate   - Enumerate registry keys and values.</member>
2030 <member>net registry enumerate_recursive - Enumerate registry key and its subkeys.</member>
2031 <member>net registry createkey   - Create a new registry key.</member>
2032 <member>net registry deletekey   - Delete a registry key.</member>
2033 <member>net registry deletekey_recursive - Delete a registry key with subkeys.</member>
2034 <member>net registry getvalue    - Print a registry value.</member>
2035 <member>net registry getvalueraw - Print a registry value (raw format).</member>
2036 <member>net registry setvalue    - Set a new registry value.</member>
2037 <member>net registry increment   - Increment a DWORD registry value under a lock.
2038 </member>
2039 <member>net registry deletevalue - Delete a registry value.</member>
2040 <member>net registry getsd       - Get security descriptor.</member>
2041 <member>net registry getsd_sdd1  - Get security descriptor in sddl format.
2042 </member>
2043 <member>net registry setsd_sdd1  - Set security descriptor from sddl format
2044 string.</member>
2045 <member>net registry import      - Import a registration entries (.reg) file.
2046 </member>
2047 <member>net registry export      - Export a registration entries (.reg) file.
2048 </member>
2049 <member>net registry convert     - Convert a registration entries (.reg) file.
2050 </member>
2051 <member>net registry check       - Check and repair a registry database.
2052 </member>
2053 </simplelist>
2054 </para>
2056 <refsect3>
2057   <title>REGISTRY ENUMERATE <replaceable>key</replaceable> </title>
2058   <para>Enumerate subkeys and values of <emphasis>key</emphasis>.
2059   </para>
2060 </refsect3>
2062 <refsect3>
2063   <title>REGISTRY ENUMERATE_RECURSIVE <replaceable>key</replaceable> </title>
2064   <para>Enumerate values of <emphasis>key</emphasis> and its subkeys.
2065   </para>
2066 </refsect3>
2068 <refsect3>
2069   <title>REGISTRY CREATEKEY <replaceable>key</replaceable> </title>
2070   <para>Create a new <emphasis>key</emphasis> if not yet existing.
2071   </para>
2072 </refsect3>
2074 <refsect3>
2075   <title>REGISTRY DELETEKEY <replaceable>key</replaceable> </title>
2076   <para>Delete the given <emphasis>key</emphasis> and its
2077   values from the registry, if it has no subkeys.
2078   </para>
2079 </refsect3>
2081 <refsect3>
2082   <title>REGISTRY DELETEKEY_RECURSIVE <replaceable>key</replaceable> </title>
2083   <para>Delete the given <emphasis>key</emphasis> and all of its
2084   subkeys and values from the registry.
2085   </para>
2086 </refsect3>
2088 <refsect3>
2089   <title>REGISTRY GETVALUE <replaceable>key</replaceable> <!--
2090   --><replaceable>name</replaceable></title>
2092   <para>Output type and actual value of the value <emphasis>name</emphasis>
2093   of the given <emphasis>key</emphasis>.
2094   </para>
2095 </refsect3>
2097 <refsect3>
2098   <title>REGISTRY GETVALUERAW <replaceable>key</replaceable> <!--
2099   --><replaceable>name</replaceable></title>
2100   <para>Output the actual value of the value <emphasis>name</emphasis>
2101   of the given <emphasis>key</emphasis>.
2102   </para>
2103 </refsect3>
2105 <refsect3>
2106   <title>REGISTRY SETVALUE <replaceable>key</replaceable> <!--
2107   --><replaceable>name</replaceable> <replaceable>type</replaceable> <!--
2108   --><replaceable>value</replaceable> ...<!--
2109   --></title>
2111   <para>Set the value <emphasis>name</emphasis>
2112   of an existing <emphasis>key</emphasis>.
2113   <emphasis>type</emphasis> may be one of
2114   <emphasis>sz</emphasis>, <emphasis>multi_sz</emphasis> or
2115   <emphasis>dword</emphasis>.
2116   In case of <emphasis>multi_sz</emphasis> <replaceable>value</replaceable> may
2117   be given multiple times.
2118   </para>
2119 </refsect3>
2121 <refsect3>
2122   <title>REGISTRY INCREMENT <replaceable>key</replaceable> <!--
2123   --><replaceable>name</replaceable> <replaceable>[inc]</replaceable><!--
2124   --></title>
2126   <para>Increment the DWORD value <emphasis>name</emphasis>
2127   of <emphasis>key</emphasis> by <replaceable>inc</replaceable>
2128   while holding a g_lock.
2129   <emphasis>inc</emphasis> defaults to 1.
2130   </para>
2131 </refsect3>
2133 <refsect3>
2134   <title>REGISTRY DELETEVALUE <replaceable>key</replaceable> <!--
2135   --><replaceable>name</replaceable></title>
2137   <para>Delete the value <emphasis>name</emphasis>
2138   of the given <emphasis>key</emphasis>.
2139   </para>
2140 </refsect3>
2142 <refsect3>
2143   <title>REGISTRY GETSD <replaceable>key</replaceable></title>
2145   <para>Get the security descriptor of the given <emphasis>key</emphasis>.
2146   </para>
2147 </refsect3>
2149 <refsect3>
2150   <title>REGISTRY GETSD_SDDL <replaceable>key</replaceable></title>
2152   <para>Get the security descriptor of the given <emphasis>key</emphasis> as a
2153   Security Descriptor Definition Language (SDDL) string.
2154   </para>
2155 </refsect3>
2157 <refsect3>
2158   <title>REGISTRY SETSD_SDDL <replaceable>key</replaceable><!--
2159   --><replaceable>sd</replaceable></title>
2161   <para>Set the security descriptor of the given <emphasis>key</emphasis> from a
2162   Security Descriptor Definition Language (SDDL) string <emphasis>sd</emphasis>.
2163   </para>
2164 </refsect3>
2166 <refsect3>
2167   <title>REGISTRY IMPORT <replaceable>file</replaceable><!--
2168   --><replaceable> [--precheck &lt;check-file&gt;] [opt]</replaceable></title>
2169   <para>Import a registration entries (.reg) <emphasis>file</emphasis>.</para>
2170   <para>The following options are available:</para>
2171   <variablelist>
2172     <varlistentry><term>--precheck <replaceable>check-file</replaceable></term>
2173     <listitem><para>
2174       This is a mechanism to check the existence or non-existence of
2175       certain keys or values specified in a precheck file before applying
2176       the import file.
2177       The import file will only be applied if the precheck succeeds.
2178     </para>
2179     <para>
2180       The check-file follows the normal registry file syntax with the
2181       following semantics:
2182     </para>
2183       <itemizedlist>
2184         <listitem><para>&lt;value name&gt;=&lt;value&gt; checks whether the
2185           value exists and has the given value.</para></listitem>
2186         <listitem><para>&lt;value name&gt;=- checks whether the value does
2187           not exist.</para></listitem>
2188         <listitem><para>[key] checks whether the key exists.</para>
2189         </listitem>
2190         <listitem><para>[-key] checks whether the key does not exist.</para>
2191         </listitem>
2192       </itemizedlist>
2193     </listitem>
2194     </varlistentry>
2195   </variablelist>
2196 </refsect3>
2198 <refsect3>
2199   <title>REGISTRY EXPORT <replaceable>key</replaceable><!--
2200   --><replaceable>file</replaceable><!--
2201   --><replaceable>[opt]</replaceable></title>
2203   <para>Export a <emphasis>key</emphasis> to a registration entries (.reg)
2204   <emphasis>file</emphasis>.
2205   </para>
2206 </refsect3>
2208 <refsect3>
2209   <title>REGISTRY CONVERT <replaceable>in</replaceable> <!--
2210   --><replaceable>out</replaceable> <!--
2211   --><replaceable>[[inopt] outopt]</replaceable></title>
2213   <para>Convert a registration entries (.reg) file <emphasis>in</emphasis>.
2214   </para>
2215 </refsect3>
2217 <refsect3>
2218   <title>REGISTRY CHECK [-ravTl] [-o &lt;ODB&gt;] [--wipe] [&lt;DB&gt;]</title>
2219   <para>Check and repair the registry database. If no option is given a read only check of the database is done. Among others an interactive or automatic repair mode may be chosen with one of the following options
2221   <variablelist>
2222     <varlistentry><term>-r|--repair</term>
2223     <listitem><para>
2224       Interactive repair mode, ask a lot of questions.
2225     </para></listitem>
2226     </varlistentry>
2228     <varlistentry><term>-a|--auto</term>
2229     <listitem><para>
2230       Noninteractive repair mode, use default answers.
2231     </para></listitem>
2232     </varlistentry>
2234     <varlistentry><term>-v|--verbose</term>
2235       <listitem><para>
2236         Produce more output.
2237       </para></listitem>
2238     </varlistentry>
2240     <varlistentry><term>-T|--test</term>
2241       <listitem><para>
2242         Dry run, show what changes would be made but don't touch anything.
2243       </para></listitem>
2244     </varlistentry>
2246     <varlistentry><term>-l|--lock</term>
2247       <listitem><para>
2248         Lock the database while doing the check.
2249       </para></listitem>
2250     </varlistentry>
2252    <varlistentry><term>--reg-version={1,2,3}</term>
2253       <listitem><para>
2254         Specify the format of the registry database. If not given it defaults to
2255         the value of the binary or, if an registry.tdb is explizitly stated at
2256         the commandline, to the value found in the INFO/version record.
2257       </para></listitem>
2258     </varlistentry>
2260     <varlistentry><term>[--db] &lt;DB&gt;</term>
2261       <listitem><para>
2262         Check the specified database.
2263       </para></listitem>
2264     </varlistentry>
2266     <varlistentry><term>-o|--output &lt;ODB&gt;</term>
2267       <listitem><para>
2268         Create a new registry database &lt;ODB&gt; instead of modifying the
2269         input. If &lt;ODB&gt; is already existing --wipe may be used to
2270         overwrite it.
2271       </para></listitem>
2272     </varlistentry>
2274    <varlistentry><term>--wipe</term>
2275       <listitem><para>
2276         Replace the registry database instead of modifying the input or
2277         overwrite an existing output database.
2278       </para></listitem>
2279     </varlistentry>
2281     <varlistentry><term></term>
2282       <listitem><para>
2283       </para></listitem>
2284     </varlistentry>
2285   </variablelist>
2286   </para>
2287 </refsect3>
2289 </refsect2>
2291 <refsect2>
2292 <title>EVENTLOG</title>
2294 <para>Starting with version 3.4.0 net can read, dump, import and export native
2295 win32 eventlog files (usually *.evt). evt files are used by the native Windows eventviewer tools.
2296 </para>
2298 <para>
2299 The import and export of evt files can only succeed when <parameter>eventlog list</parameter> is used in
2300 <emphasis>smb.conf</emphasis> file.
2301 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2302 </para>
2304 <para>The eventlog commands are:
2305 <simplelist>
2306 <member>net eventlog dump - Dump a eventlog *.evt file on the screen.</member>
2307 <member>net eventlog import - Import a eventlog *.evt into the samba internal
2308 tdb based representation of eventlogs.</member>
2309 <member>net eventlog export - Export the samba internal tdb based representation
2310 of eventlogs into an eventlog *.evt file.</member>
2311 </simplelist>
2312 </para>
2314 <refsect3>
2315 <title>EVENTLOG DUMP <replaceable>filename</replaceable></title>
2317 <para>
2318 Prints a eventlog *.evt file to standard output.
2319 </para>
2320 </refsect3>
2322 <refsect3>
2323 <title>EVENTLOG IMPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
2325 <para>
2326 Imports a eventlog *.evt file defined by <replaceable>filename</replaceable> into the
2327 samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>.
2328 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
2329 defined in smb.conf.
2330 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2331 </para>
2333 </refsect3>
2335 <refsect3>
2336 <title>EVENTLOG EXPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
2338 <para>
2339 Exports the samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>
2340 to a eventlog *.evt file defined by <replaceable>filename</replaceable>.
2341 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
2342 defined in smb.conf.
2343 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
2344 </para>
2346 </refsect3>
2348 </refsect2>
2350 <refsect2>
2351 <title>DOM</title>
2353 <para>Starting with version 3.2.0 Samba has support for remote join and unjoin APIs, both client and server-side. Windows supports remote join capabilities since Windows 2000.
2354 </para>
2355 <para>In order for Samba to be joined or unjoined remotely an account must be used that is either member of the Domain Admins group, a member of the local Administrators group or a user that is granted the SeMachineAccountPrivilege privilege.
2356 </para>
2358 <para>The client side support for remote join is implemented in the net dom commands which are:
2359 <simplelist>
2360 <member>net dom join - Join a remote computer into a domain.</member>
2361 <member>net dom unjoin - Unjoin a remote computer from a domain.</member>
2362 <member>net dom renamecomputer - Renames a remote computer joined to a domain.</member>
2363 </simplelist>
2364 </para>
2366 <refsect3>
2367 <title>DOM JOIN <replaceable>domain=DOMAIN</replaceable> <replaceable>ou=OU</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2369 <para>
2370 Joins a computer into a domain. This command supports the following additional parameters:
2371 </para>
2373 <itemizedlist>
2375 <listitem><para><replaceable>DOMAIN</replaceable> can be a NetBIOS domain name (also known as short domain name) or a DNS domain name for Active Directory Domains. As in Windows, it is also possible to control which Domain Controller to use. This can be achieved by appending the DC name using the \ separator character. Example: MYDOM\MYDC. The <replaceable>DOMAIN</replaceable> parameter cannot be NULL.</para></listitem>
2377 <listitem><para><replaceable>OU</replaceable> can be set to a RFC 1779 LDAP DN, like <emphasis>ou=mymachines,cn=Users,dc=example,dc=com</emphasis> in order to create the machine account in a non-default LDAP container. This optional parameter is only supported when joining Active Directory Domains.</para></listitem>
2379 <listitem><para><replaceable>ACCOUNT</replaceable> defines a domain account that will be used to join the machine to the domain. This domain account needs to have sufficient privileges to join machines.</para></listitem>
2381 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2383 <listitem><para><replaceable>REBOOT</replaceable> is an optional parameter that can be set to reboot the remote machine after successful join to the domain.</para></listitem>
2385 </itemizedlist>
2387 <para>
2388 Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to join. These additional parameters include: -S computer and -U user.
2389 </para>
2390 <para>
2391         Example:
2392         net dom join -S xp -U XP\\administrator%secret domain=MYDOM account=MYDOM\\administrator password=topsecret reboot.
2393 </para>
2394 <para>
2395 This example would connect to a computer named XP as the local administrator using password secret, and join the computer into a domain called MYDOM using the MYDOM domain administrator account and password topsecret. After successful join, the computer would reboot.
2396 </para>
2398 </refsect3>
2400 <refsect3>
2401 <title>DOM UNJOIN <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2403 <para>
2404 Unjoins a computer from a domain. This command supports the following additional parameters:
2405 </para>
2407 <itemizedlist>
2409 <listitem><para><replaceable>ACCOUNT</replaceable> defines a domain account that will be used to unjoin the machine from the domain. This domain account needs to have sufficient privileges to unjoin machines.</para></listitem>
2411 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2413 <listitem><para><replaceable>REBOOT</replaceable> is an optional parameter that can be set to reboot the remote machine after successful unjoin from the domain.</para></listitem>
2415 </itemizedlist>
2417 <para>
2418 Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to unjoin. These additional parameters include: -S computer and -U user.
2419 </para>
2420 <para>
2421         Example:
2422         net dom unjoin -S xp -U XP\\administrator%secret account=MYDOM\\administrator password=topsecret reboot.
2423 </para>
2424 <para>
2425 This example would connect to a computer named XP as the local administrator using password secret, and unjoin the computer from the domain using the MYDOM domain administrator account and password topsecret. After successful unjoin, the computer would reboot.
2426 </para>
2428 </refsect3>
2430 <refsect3>
2431 <title>DOM RENAMECOMPUTER <replaceable>newname=NEWNAME</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
2433 <para>
2434 Renames a computer that is joined to a domain. This command supports the following additional parameters:
2435 </para>
2437 <itemizedlist>
2439 <listitem><para><replaceable>NEWNAME</replaceable> defines the new name of the machine in the domain.</para></listitem>
2441 <listitem><para><replaceable>ACCOUNT</replaceable> defines a domain account that will be used to rename the machine in the domain. This domain account needs to have sufficient privileges to rename machines.</para></listitem>
2443 <listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
2445 <listitem><para><replaceable>REBOOT</replaceable> is an optional parameter that can be set to reboot the remote machine after successful rename in the domain.</para></listitem>
2447 </itemizedlist>
2449 <para>
2450 Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to rename in the domain. These additional parameters include: -S computer and -U user.
2451 </para>
2452 <para>
2453         Example:
2454         net dom renamecomputer -S xp -U XP\\administrator%secret newname=XPNEW account=MYDOM\\administrator password=topsecret reboot.
2455 </para>
2456 <para>
2457 This example would connect to a computer named XP as the local administrator using password secret, and rename the joined computer to XPNEW using the MYDOM domain administrator account and password topsecret. After successful rename, the computer would reboot.
2458 </para>
2460 </refsect3>
2462 </refsect2>
2464 <refsect2>
2465 <title>G_LOCK</title>
2467 <para>Manage global locks.</para>
2469 <refsect3>
2470 <title>G_LOCK DO <replaceable>lockname</replaceable> <replaceable>timeout</replaceable> <replaceable>command</replaceable></title>
2472 <para>
2473 Execute a shell command under a global lock. This might be useful to define the
2474 order in which several shell commands will be executed. The locking information
2475 is stored in a file called <filename>g_lock.tdb</filename>. In setups with CTDB
2476 running, the locking information will be available on all cluster nodes.
2477 </para>
2479 <itemizedlist>
2480 <listitem><para><replaceable>LOCKNAME</replaceable> defines the name of the global lock.</para></listitem>
2481 <listitem><para><replaceable>TIMEOUT</replaceable> defines the timeout.</para></listitem>
2482 <listitem><para><replaceable>COMMAND</replaceable> defines the shell command to execute.</para></listitem>
2483 </itemizedlist>
2484 </refsect3>
2486 <refsect3>
2487 <title>G_LOCK LOCKS</title>
2489 <para>
2490 Print a list of all currently existing locknames.
2491 </para>
2492 </refsect3>
2494 <refsect3>
2495 <title>G_LOCK DUMP <replaceable>lockname</replaceable></title>
2497 <para>
2498 Dump the locking table of a certain global lock.
2499 </para>
2500 </refsect3>
2502 </refsect2>
2504 <refsect2>
2505 <title>HELP [COMMAND]</title>
2507 <para>Gives usage information for the specified command.</para>
2509 </refsect2>
2511 </refsect1>
2513 <refsect1>
2514         <title>VERSION</title>
2516         <para>This man page is complete for version 3 of the Samba 
2517         suite.</para>
2518 </refsect1>
2520 <refsect1>
2521         <title>AUTHOR</title>
2522         
2523         <para>The original Samba software and related utilities 
2524         were created by Andrew Tridgell. Samba is now developed
2525         by the Samba Team as an Open Source project similar 
2526         to the way the Linux kernel is developed.</para>
2528         <para>The net manpage was written by Jelmer Vernooij.</para>
2529         
2530 </refsect1>
2532 </refentry>