<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
- <refmiscinfo class="version">3.2</refmiscinfo>
+ <refmiscinfo class="version">3.6</refmiscinfo>
</refmeta>
<arg choice="opt">-P</arg>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-V</arg>
+ <arg choice="opt">--request-timeout seconds</arg>
</cmdsynopsis>
</refsynopsisdiv>
<variablelist>
&stdarg.help;
+ &stdarg.kerberos;
<varlistentry>
<term>-w target-workgroup</term>
</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>--request-timeout 30</term>
+ <listitem><para>
+ Let client requests timeout after 30 seconds the default is 10
+ seconds.
+ </para></listitem>
+ </varlistentry>
+
&stdarg.server.debug;
</variablelist>
</refsect1>
<title>RAP PRINTQ</title>
<refsect3>
-<title>RAP PRINTQ LIST <replaceable>QUEUE_NAME</replaceable></title>
+<title>RAP PRINTQ INFO <replaceable>QUEUE_NAME</replaceable></title>
<para>Lists the specified print queue and print jobs on the server.
If the <replaceable>QUEUE_NAME</replaceable> is omitted, all
<refsect3>
<title>GROUPMAP MODIFY</title>
-<para>Update en existing group entry.</para>
+<para>Update an existing group entry.</para>
<para>
<programlisting>
<para>Add a interdomain trust account for <replaceable>DOMAIN</replaceable>.
This is in fact a Samba account named <replaceable>DOMAIN$</replaceable>
with the account flag <constant>'I'</constant> (interdomain trust account).
+This is required for incoming trusts to work. It makes Samba be a
+trusted domain of the foreign (trusting) domain.
+Users of the Samba domain will be made available in the foreign domain.
If the command is used against localhost it has the same effect as
<command>smbpasswd -a -i DOMAIN</command>. Please note that both commands
expect a appropriate UNIX account.
<title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title>
<para>
-Establish a trust relationship to a trusting domain.
+Establish a trust relationship to a trusted domain.
Interdomain account must already be created on the remote PDC.
+This is required for outgoing trusts to work. It makes Samba be a
+trusting domain of a foreign (trusted) domain.
+Users of the foreign domain will be made available in our domain.
+You'll need winbind and a working idmap config to make them
+appear in your system.
</para>
</refsect3>
<refsect3>
<title>RPC TRUSTDOM LIST</title>
-<para>List all current interdomain trust relationships.</para>
+<para>List all interdomain trust relationships.</para>
+
+</refsect3>
+</refsect2>
+
+<refsect2>
+<title>RPC TRUST</title>
+
+<refsect3>
+<title>RPC TRUST CREATE</title>
+
+<para>Create a trust object by calling lsaCreateTrustedDomainEx2.
+The can be done on a single server or on two servers at once with the
+possibility to use a random trust password.</para>
+
+<variablelist><title>Options:</title>
+<varlistentry>
+<term>otherserver</term>
+<listitem><para>Domain controller of the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>otheruser</term>
+<listitem><para>Admin user in the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>otherdomainsid</term>
+<listitem><para>SID of the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>other_netbios_domain</term>
+<listitem><para>NetBIOS (short) name of the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>otherdomain</term>
+<listitem><para>DNS (full) name of the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>trustpw</term>
+<listitem><para>Trust password</para></listitem>
+</varlistentry>
+</variablelist>
+
+<variablelist><title>Examples:</title>
+<varlistentry>
+<term>Create a trust object on srv1.dom1.dom for the domain dom2</term>
+<listitem><literallayout>
+net rpc trust create \
+ otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
+ other_netbios_domain=dom2 \
+ otherdomain=dom2.dom \
+ trustpw=12345678 \
+ -S srv1.dom1.dom
+</literallayout></listitem>
+</varlistentry>
+<varlistentry>
+<term>Create a trust relationship between dom1 and dom2</term>
+<listitem><literallayout>
+net rpc trust create \
+ otherserver=srv2.dom2.test \
+ otheruser=dom2adm \
+ -S srv1.dom1.dom
+</literallayout></listitem>
+</varlistentry>
+</variablelist>
+</refsect3>
+
+<refsect3>
+<title>RPC TRUST DELETE</title>
+
+<para>Delete a trust trust object by calling lsaDeleteTrustedDomain.
+The can be done on a single server or on two servers at once.</para>
+
+<variablelist><title>Options:</title>
+<varlistentry>
+<term>otherserver</term>
+<listitem><para>Domain controller of the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>otheruser</term>
+<listitem><para>Admin user in the second domain</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>otherdomainsid</term>
+<listitem><para>SID of the second domain</para></listitem>
+</varlistentry>
+</variablelist>
+<variablelist><title>Examples:</title>
+<varlistentry>
+<term>Delete a trust object on srv1.dom1.dom for the domain dom2</term>
+<listitem><literallayout>
+net rpc trust delete \
+ otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
+ -S srv1.dom1.dom
+</literallayout></listitem>
+</varlistentry>
+<varlistentry>
+<term>Delete a trust relationship between dom1 and dom2</term>
+<listitem><literallayout>
+net rpc trust delete \
+ otherserver=srv2.dom2.test \
+ otheruser=dom2adm \
+ -S srv1.dom1.dom
+</literallayout></listitem>
+</varlistentry>
+</variablelist>
</refsect3>
+</refsect2>
+
+<refsect2>
<refsect3>
<title>RPC RIGHTS</title>
Timeout before system will be shut down. An interactive
user of the system can use this time to cancel the shutdown.
</para></listitem>
-</varlistentry>'>
+</varlistentry>
<varlistentry>
<term>-C message</term>
<para>Export users, aliases and groups from remote server to
local server. You need to run this against the PDC, from a Samba machine joined as a BDC.
</para>
+</refsect2>
+
+<refsect2>
+<title>RPC VAMPIRE KEYTAB</title>
+
+<para>Dump remote SAM database to local Kerberos keytab file.
+</para>
+</refsect2>
+
+<refsect2>
+<title>RPC VAMPIRE LDIF</title>
+<para>Dump remote SAM database to local LDIF file or standard output.
+</para>
</refsect2>
<refsect2>
</refsect2>
+<refsect2>
+<title>SAM RIGHTS LIST</title>
+
+<para>
+List all available privileges.
+</para>
+
+</refsect2>
+
+<refsect2>
+<title>SAM RIGHTS GRANT <NAME> <PRIVILEGE></title>
+
+<para>
+Grant one or more privileges to a user.
+</para>
+
+</refsect2>
+
+<refsect2>
+<title>SAM RIGHTS REVOKE <NAME> <PRIVILEGE></title>
+
+<para>
+Revoke one or more privileges from a user.
+</para>
+
+</refsect2>
+
<refsect2>
<title>SAM SHOW <NAME></title>
</refsect2>
<refsect2>
-<title>IDMAP SECRET <DOMAIN>|ALLOC <secret></title>
+<title>IDMAP SECRET <DOMAIN> <secret></title>
<para>
Store a secret for the specified domain, used primarily for domains
</refsect2>
+<refsect2>
+
+<title>IDMAP DELETE [-f] [--db=<DB>] <ID></title>
+
+<para>
+Delete a mapping sid <-> gid or sid <-> uid from the IDMAP database.
+The mapping is given by <ID> which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
+Use -f to delete an invalid partial mapping <ID> -> xx
+</para>
+<para>
+ Use "smbcontrol all idmap ..." to notify running smbd instances.
+ See the <citerefentry><refentrytitle>smbcontrol</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry> manpage for details.
+</para>
+</refsect2>
+
+<refsect2>
+
+<title>IDMAP CHECK [-v] [-r] [-a] [-T] [-f] [-l] [--db=<DB>]</title>
+
+<para>
+ Check and repair the IDMAP 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:
+
+ <variablelist>
+ <varlistentry><term>-r|--repair</term>
+ <listitem><para>
+ Interactive repair mode, ask a lot of questions.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-a|--auto</term>
+ <listitem><para>
+ Noninteractive repair mode, use default answers.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-v|--verbose</term>
+ <listitem><para>
+ Produce more output.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-f|--force</term>
+ <listitem><para>
+ Try to apply changes, even if they do not apply cleanly.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-T|--test</term>
+ <listitem><para>
+ Dry run, show what changes would be made but don't touch anything.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-l|--lock</term>
+ <listitem><para>
+ Lock the database while doing the check.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>--db <DB></term>
+ <listitem><para>
+ Check the specified database.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry><term></term>
+ <listitem><para>
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ It reports about the finding of the following errors:
+
+ <variablelist>
+ <varlistentry><term>Missing reverse mapping:</term>
+ <listitem><para>
+ A record with mapping A->B where there is no B->A. Default action
+ in repair mode is to "fix" this by adding the reverse mapping.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>Invalid mapping:</term>
+ <listitem><para>
+ A record with mapping A->B where B->C. Default action
+ is to "delete" this record.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>Missing or invalid HWM:</term>
+ <listitem><para>
+ A high water mark is not at least equal to the largest ID in the
+ database. Default action is to "fix" this by setting it to the
+ largest ID found +1.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>Invalid record:</term>
+ <listitem><para>
+ Something we failed to parse. Default action is to "edit" it
+ in interactive and "delete" it in automatic mode.
+ </para></listitem>
+ </varlistentry>
+</variablelist>
+</para>
+</refsect2>
+
+
<refsect2>
<title>USERSHARE</title>
<para>The usershare commands are:
<simplelist>
-<member>net usershare add sharename path [comment] [acl] [guest_ok=[y|n]] - to add or change a user defined share.</member>
+<member>net usershare add sharename path [comment [acl] [guest_ok=[y|n]]] - to add or change a user defined share.</member>
<member>net usershare delete sharename - to delete a user defined share.</member>
<member>net usershare info [-l|--long] [wildcard sharename] - to print info about a user defined share.</member>
<member>net usershare list [-l|--long] [wildcard sharename] - to list user defined shares.</member>
</refsect2>
<refsect2>
-<title>CONF</title>
+<title>[RPC] CONF</title>
<para>Starting with version 3.2.0, a Samba server can be configured by data
stored in registry. This configuration data can be edited with the new "net
-conf" commands.
+conf" commands. There is also the possiblity to configure a remote Samba server
+by enabling the RPC conf mode and specifying the the address of the remote server.
</para>
<para>
activated by setting <parameter>registry shares</parameter> to
<quote>yes</quote> in the [global] section and global configuration options are
activated by setting <smbconfoption name="include">registry</smbconfoption> in
-the [global] section.
+the [global] section for a mixed configuration or by setting
+<smbconfoption name="config backend">registry</smbconfoption> in the [global]
+section for a registry-only configuration.
See the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> manpage for details.
</para>
<para>The conf commands are:
<simplelist>
-<member>net conf list - Dump the complete configuration in smb.conf like
+<member>net [rpc] conf list - Dump the complete configuration in smb.conf like
format.</member>
-<member>net conf import - Import configuration from file in smb.conf
+<member>net [rpc] conf import - Import configuration from file in smb.conf
format.</member>
-<member>net conf listshares - List the registry shares.</member>
-<member>net conf drop - Delete the complete configuration from
+<member>net [rpc] conf listshares - List the registry shares.</member>
+<member>net [rpc] conf drop - Delete the complete configuration from
registry.</member>
-<member>net conf showshare - Show the definition of a registry share.</member>
-<member>net conf addshare - Create a new registry share.</member>
-<member>net conf delshare - Delete a registry share.</member>
-<member>net conf setparm - Store a parameter.</member>
-<member>net conf getparm - Retrieve the value of a parameter.</member>
-<member>net conf delparm - Delete a parameter.</member>
+<member>net [rpc] conf showshare - Show the definition of a registry share.</member>
+<member>net [rpc] conf addshare - Create a new registry share.</member>
+<member>net [rpc] conf delshare - Delete a registry share.</member>
+<member>net [rpc] conf setparm - Store a parameter.</member>
+<member>net [rpc] conf getparm - Retrieve the value of a parameter.</member>
+<member>net [rpc] conf delparm - Delete a parameter.</member>
+<member>net [rpc] conf getincludes - Show the includes of a share definition.</member>
+<member>net [rpc] conf setincludes - Set includes for a share.</member>
+<member>net [rpc] conf delincludes - Delete includes from a share definition.</member>
</simplelist>
</para>
<refsect3>
-<title>CONF LIST</title>
+<title>[RPC] CONF LIST</title>
<para>
Print the configuration data stored in the registry in a smb.conf-like format to
</refsect3>
<refsect3>
-<title>CONF IMPORT <replaceable>[--test|-T]</replaceable> <replaceable>filename</replaceable> <replaceable>[section]</replaceable></title>
+<title>[RPC] CONF IMPORT <replaceable>[--test|-T]</replaceable> <replaceable>filename</replaceable> <replaceable>[section]</replaceable></title>
<para>
This command imports configuration from a file in smb.conf format.
</refsect3>
<refsect3>
-<title>CONF LISTSHARES</title>
+<title>[RPC] CONF LISTSHARES</title>
<para>
List the names of the shares defined in registry.
</refsect3>
<refsect3>
-<title>CONF DROP</title>
+<title>[RPC] CONF DROP</title>
<para>
Delete the complete configuration data from registry.
</refsect3>
<refsect3>
-<title>CONF SHOWSHARE <replaceable>sharename</replaceable></title>
+<title>[RPC] CONF SHOWSHARE <replaceable>sharename</replaceable></title>
<para>
Show the definition of the share or section specified. It is valid to specify
</refsect3>
<refsect3>
-<title>CONF ADDSHARE <replaceable>sharename</replaceable> <replaceable>path</replaceable> [<replaceable>writeable={y|N}</replaceable> [<replaceable>guest_ok={y|N}</replaceable> [<replaceable>comment</replaceable>]]] </title>
+<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>
<para>Create a new share definition in registry.
The sharename and path have to be given. The share name may
</refsect3>
<refsect3>
-<title>CONF DELSHARE <replaceable>sharename</replaceable></title>
+<title>[RPC] CONF DELSHARE <replaceable>sharename</replaceable></title>
<para>
Delete a share definition from registry.
</refsect3>
<refsect3>
-<title>CONF SETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> <replaceable>value</replaceable></title>
+<title>[RPC] CONF SETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable> <replaceable>value</replaceable></title>
<para>
Store a parameter in registry. The section may be global or a sharename.
</refsect3>
<refsect3>
-<title>CONF GETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
+<title>[RPC] CONF GETPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
<para>
Show a parameter stored in registry.
</refsect3>
<refsect3>
-<title>CONF DELPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
+<title>[RPC] CONF DELPARM <replaceable>section</replaceable> <replaceable>parameter</replaceable></title>
<para>
Delete a parameter stored in registry.
</refsect3>
<refsect3>
-<title></title>
+<title>[RPC] CONF GETINCLUDES <replaceable>section</replaceable></title>
+
+<para>
+Get the list of includes for the provided section (global or share).
+</para>
+
+<para>
+Note that due to the nature of the registry database and the nature of include directives,
+the includes need special treatment: Parameters are stored in registry by the parameter
+name as valuename, so there is only ever one instance of a parameter per share.
+Also, a specific order like in a text file is not guaranteed. For all real
+parameters, this is perfectly ok, but the include directive is rather a meta
+parameter, for which, in the smb.conf text file, the place where it is specified
+between the other parameters is very important. This can not be achieved by the
+simple registry smbconf data model, so there is one ordered list of includes
+per share, and this list is evaluated after all the parameters of the share.
+</para>
+
+<para>
+Further note that currently, only files can be included from registry
+configuration. In the future, there will be the ability to include configuration
+data from other registry keys.
+</para>
+</refsect3>
+
+<refsect3>
+<title>[RPC] CONF SETINCLUDES <replaceable>section</replaceable> [<replaceable>filename</replaceable>]+</title>
+
+<para>
+Set the list of includes for the provided section (global or share) to the given
+list of one or more filenames. The filenames may contain the usual smb.conf
+macros like %I.
+</para>
+</refsect3>
+
+<refsect3>
+<title>[RPC] CONF DELINCLUDES <replaceable>section</replaceable></title>
+
+<para>
+Delete the list of includes from the provided section (global or share).
+</para>
+</refsect3>
+
+</refsect2>
+
+<refsect2>
+<title>REGISTRY</title>
+<para>
+Manipulate Samba's registry.
+</para>
+
+<para>The registry commands are:
+<simplelist>
+<member>net registry enumerate - Enumerate registry keys and values.</member>
+<member>net registry enumerate_recursive - Enumerate registry key and its subkeys.</member>
+<member>net registry createkey - Create a new registry key.</member>
+<member>net registry deletekey - Delete a registry key.</member>
+<member>net registry deletekey_recursive - Delete a registry key with subkeys.</member>
+<member>net registry getvalue - Print a registry value.</member>
+<member>net registry getvalueraw - Print a registry value (raw format).</member>
+<member>net registry setvalue - Set a new registry value.</member>
+<member>net registry increment - Increment a DWORD registry value under a lock.
+</member>
+<member>net registry deletevalue - Delete a registry value.</member>
+<member>net registry getsd - Get security descriptor.</member>
+<member>net registry getsd_sdd1 - Get security descriptor in sddl format.
+</member>
+<member>net registry setsd_sdd1 - Set security descriptor from sddl format
+string.</member>
+<member>net registry import - Import a registration entries (.reg) file.
+</member>
+<member>net registry export - Export a registration entries (.reg) file.
+</member>
+<member>net registry convert - Convert a registration entries (.reg) file.
+</member>
+<member>net registry check - Check and reapair a registry database.
+</member>
+</simplelist>
+</para>
+
+<refsect3>
+ <title>REGISTRY ENUMERATE <replaceable>key</replaceable> </title>
+ <para>Enumerate subkeys and values of <emphasis>key</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY ENUMERATE_RECURSIVE <replaceable>key</replaceable> </title>
+ <para>Enumerate values of <emphasis>key</emphasis> and its subkeys.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY CREATEKEY <replaceable>key</replaceable> </title>
+ <para>Create a new <emphasis>key</emphasis> if not yet existing.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY DELETEKEY <replaceable>key</replaceable> </title>
+ <para>Delete the given <emphasis>key</emphasis> and its
+ values from the registry, if it has no subkeys.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY DELETEKEY_RECURSIVE <replaceable>key</replaceable> </title>
+ <para>Delete the given <emphasis>key</emphasis> and all of its
+ subkeys and values from the registry.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY GETVALUE <replaceable>key</replaceable> <!--
+ --><replaceable>name</replaceable></title>
+
+ <para>Output type and actual value of the value <emphasis>name</emphasis>
+ of the given <emphasis>key</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY GETVALUERAW <replaceable>key</replaceable> <!--
+ --><replaceable>name</replaceable></title>
+ <para>Output the actual value of the value <emphasis>name</emphasis>
+ of the given <emphasis>key</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY SETVALUE <replaceable>key</replaceable> <!--
+ --><replaceable>name</replaceable> <replaceable>type</replaceable> <!--
+ --><replaceable>value</replaceable> ...<!--
+ --></title>
+
+ <para>Set the value <emphasis>name</emphasis>
+ of an existing <emphasis>key</emphasis>.
+ <emphasis>type</emphasis> may be one of
+ <emphasis>sz</emphasis>, <emphasis>multi_sz</emphasis> or
+ <emphasis>dword</emphasis>.
+ In case of <emphasis>multi_sz</emphasis> <replaceable>value</replaceable> may
+ be given multiple times.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY INCREMENT <replaceable>key</replaceable> <!--
+ --><replaceable>name</replaceable> <replaceable>[inc]</replaceable><!--
+ --></title>
+
+ <para>Increment the DWORD value <emphasis>name</emphasis>
+ of <emphasis>key</emphasis> by <replaceable>inc</replaceable>
+ while holding a g_lock.
+ <emphasis>inc</emphasis> defaults to 1.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY DELETEVALUE <replaceable>key</replaceable> <!--
+ --><replaceable>name</replaceable></title>
+
+ <para>Delete the value <emphasis>name</emphasis>
+ of the given <emphasis>key</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY GETSD <replaceable>key</replaceable></title>
+
+ <para>Get the security descriptor of the given <emphasis>key</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY GETSD_SDDL <replaceable>key</replaceable></title>
+
+ <para>Get the security descriptor of the given <emphasis>key</emphasis> as a
+ Security Descriptor Definition Language (SDDL) string.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY SETSD_SDDL <replaceable>key</replaceable><!--
+ --><replaceable>sd</replaceable></title>
+
+ <para>Set the security descriptor of the given <emphasis>key</emphasis> from a
+ Security Descriptor Definition Language (SDDL) string <emphasis>sd</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY IMPORT <replaceable>file</replaceable><!--
+ --><replaceable> [--precheck <check-file>] [opt]</replaceable></title>
+ <para>Import a registration entries (.reg) <emphasis>file</emphasis>.</para>
+ <para>The following options are available:</para>
+ <variablelist>
+ <varlistentry><term>--precheck <replaceable>check-file</replaceable></term>
+ <listitem><para>
+ This is a mechanism to check the existence or non-existence of
+ certain keys or values specified in a precheck file before applying
+ the import file.
+ The import file will only be applied if the precheck succeeds.
+ </para>
+ <para>
+ The check-file follows the normal registry file syntax with the
+ following semantics:
+ </para>
+ <itemizedlist>
+ <listitem><para><value name>=<value> checks whether the
+ value exists and has the given value.</para></listitem>
+ <listitem><para><value name>=- checks whether the value does
+ not exist.</para></listitem>
+ <listitem><para>[key] checks whether the key exists.</para>
+ </listitem>
+ <listitem><para>[-key] checks whether the key does not exist.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY EXPORT <replaceable>key</replaceable><!--
+ --><replaceable>file</replaceable><!--
+ --><replaceable>[opt]</replaceable></title>
+
+ <para>Export a <emphasis>key</emphasis> to a registration entries (.reg)
+ <emphasis>file</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY CONVERT <replaceable>in</replaceable> <!--
+ --><replaceable>out</replaceable> <!--
+ --><replaceable>[[inopt] outopt]</replaceable></title>
+
+ <para>Convert a registration entries (.reg) file <emphasis>in</emphasis>.
+ </para>
+</refsect3>
+
+<refsect3>
+ <title>REGISTRY CHECK [-ravTl] [-o <ODB>] [--wipe] [<DB>]</title>
+ <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
+
+ <variablelist>
+ <varlistentry><term>-r|--repair</term>
+ <listitem><para>
+ Interactive repair mode, ask a lot of questions.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-a|--auto</term>
+ <listitem><para>
+ Noninteractive repair mode, use default answers.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-v|--verbose</term>
+ <listitem><para>
+ Produce more output.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-T|--test</term>
+ <listitem><para>
+ Dry run, show what changes would be made but don't touch anything.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-l|--lock</term>
+ <listitem><para>
+ Lock the database while doing the check.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>--reg-version={1,2,3}</term>
+ <listitem><para>
+ Specify the format of the registry database. If not given it defaults to
+ the value of the binary or, if an registry.tdb is explizitly stated at
+ the commandline, to the value found in the INFO/version record.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>[--db] <DB></term>
+ <listitem><para>
+ Check the specified database.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-o|--output <ODB></term>
+ <listitem><para>
+ Create a new registry database <ODB> instead of modifying the
+ input. If <ODB> is already existing --wipe may be used to
+ overwrite it.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>--wipe</term>
+ <listitem><para>
+ Replace the registry database instead of modifying the input or
+ overwrite an existing output database.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term></term>
+ <listitem><para>
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+</refsect3>
+
+</refsect2>
+
+<refsect2>
+<title>CONNECTIONS</title>
+<para>
+Manipulate Samba's connections database.
+</para>
+
+<para>The registry commands are:
+<simplelist>
+<member>net connections cleanup - Remove orphaned entries from the connections database.</member>
+</simplelist>
+</para>
+
+<refsect3>
+ <title>CONNECTIONS CLEANUP [-avT]</title>
+ <para> Remove orphaned entries from the connections database. This may be necessary if restarting smbd isn't an option.
+ <variablelist>
+ <varlistentry><term>-a|--auto</term>
+ <listitem><para>
+ Noninteractive mode, don't ask.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-v|--verbose</term>
+ <listitem><para>
+ Produce more output.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>-T|--test</term>
+ <listitem><para>
+ Dry run, show what changes would be made but don't touch anything.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+</refsect3>
+
+</refsect2>
+
+<refsect2>
+<title>EVENTLOG</title>
+
+<para>Starting with version 3.4.0 net can read, dump, import and export native
+win32 eventlog files (usually *.evt). evt files are used by the native Windows eventviewer tools.
+</para>
+
+<para>
+The import and export of evt files can only succeed when <parameter>eventlog list</parameter> is used in
+<emphasis>smb.conf</emphasis> file.
+See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
+</para>
+
+<para>The eventlog commands are:
+<simplelist>
+<member>net eventlog dump - Dump a eventlog *.evt file on the screen.</member>
+<member>net eventlog import - Import a eventlog *.evt into the samba internal
+tdb based representation of eventlogs.</member>
+<member>net eventlog export - Export the samba internal tdb based representation
+of eventlogs into an eventlog *.evt file.</member>
+</simplelist>
+</para>
+
+<refsect3>
+<title>EVENTLOG DUMP <replaceable>filename</replaceable></title>
+
+<para>
+Prints a eventlog *.evt file to standard output.
+</para>
+</refsect3>
+
+<refsect3>
+<title>EVENTLOG IMPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
+
+<para>
+Imports a eventlog *.evt file defined by <replaceable>filename</replaceable> into the
+samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>.
+<replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
+defined in smb.conf.
+See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
+</para>
+
+</refsect3>
+
+<refsect3>
+<title>EVENTLOG EXPORT <replaceable>filename</replaceable> <replaceable>eventlog</replaceable></title>
+
+<para>
+Exports the samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>
+to a eventlog *.evt file defined by <replaceable>filename</replaceable>.
+<replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
+defined in smb.conf.
+See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
+</para>
+
+</refsect3>
+
+</refsect2>
+
+<refsect2>
+<title>DOM</title>
+
+<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.
+</para>
+<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.
+</para>
+
+<para>The client side support for remote join is implemented in the net dom commands which are:
+<simplelist>
+<member>net dom join - Join a remote computer into a domain.</member>
+<member>net dom unjoin - Unjoin a remote computer from a domain.</member>
+<member>net dom renamecomputer - Renames a remote computer joined to a domain.</member>
+</simplelist>
+</para>
+
+<refsect3>
+<title>DOM JOIN <replaceable>domain=DOMAIN</replaceable> <replaceable>ou=OU</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
+
+<para>
+Joins a computer into a domain. This command supports the following additional parameters:
+</para>
+
+<itemizedlist>
+
+<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>
+
+<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>
+
+<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>
+
+<listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
+
+<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>
+
+</itemizedlist>
+
+<para>
+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.
+</para>
+<para>
+ Example:
+ net dom join -S xp -U XP\\administrator%secret domain=MYDOM account=MYDOM\\administrator password=topsecret reboot.
+</para>
+<para>
+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.
+</para>
+
+</refsect3>
+
+<refsect3>
+<title>DOM UNJOIN <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
+
+<para>
+Unjoins a computer from a domain. This command supports the following additional parameters:
+</para>
+
+<itemizedlist>
+
+<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>
+
+<listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
+
+<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>
+
+</itemizedlist>
+
+<para>
+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.
+</para>
+<para>
+ Example:
+ net dom unjoin -S xp -U XP\\administrator%secret account=MYDOM\\administrator password=topsecret reboot.
+</para>
+<para>
+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.
+</para>
+
+</refsect3>
+
+<refsect3>
+<title>DOM RENAMECOMPUTER <replaceable>newname=NEWNAME</replaceable> <replaceable>account=ACCOUNT</replaceable> <replaceable>password=PASSWORD</replaceable> <replaceable>reboot</replaceable></title>
+
+<para>
+Renames a computer that is joined to a domain. This command supports the following additional parameters:
+</para>
+
+<itemizedlist>
+
+<listitem><para><replaceable>NEWNAME</replaceable> defines the new name of the machine in the domain.</para></listitem>
+
+<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>
+
+<listitem><para><replaceable>PASSWORD</replaceable> defines the password for the domain account defined with <replaceable>ACCOUNT</replaceable>.</para></listitem>
+
+<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>
+
+</itemizedlist>
+
+<para>
+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.
+</para>
+<para>
+ Example:
+ net dom renamecomputer -S xp -U XP\\administrator%secret newname=XPNEW account=MYDOM\\administrator password=topsecret reboot.
+</para>
+<para>
+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.
+</para>
+
+</refsect3>
+
+</refsect2>
+
+<refsect2>
+<title>G_LOCK</title>
+
+<para>Manage global locks.</para>
+
+<refsect3>
+<title>G_LOCK DO <replaceable>lockname</replaceable> <replaceable>timeout</replaceable> <replaceable>command</replaceable></title>
+
+<para>
+Execute a shell command under a global lock. This might be useful to define the
+order in which several shell commands will be executed. The locking information
+is stored in a file called <filename>g_lock.tdb</filename>. In setups with CTDB
+running, the locking information will be available on all cluster nodes.
+</para>
+
+<itemizedlist>
+<listitem><para><replaceable>LOCKNAME</replaceable> defines the name of the global lock.</para></listitem>
+<listitem><para><replaceable>TIMEOUT</replaceable> defines the timeout.</para></listitem>
+<listitem><para><replaceable>COMMAND</replaceable> defines the shell command to execute.</para></listitem>
+</itemizedlist>
+</refsect3>
+
+<refsect3>
+<title>G_LOCK LOCKS</title>
+
+<para>
+Print a list of all currently existing locknames.
+</para>
+</refsect3>
+
+<refsect3>
+<title>G_LOCK DUMP <replaceable>lockname</replaceable></title>
<para>
+Dump the locking table of a certain global lock.
</para>
</refsect3>
<refsect1>
<title>VERSION</title>
- <para>This man page is complete for version 3.0 of the Samba
+ <para>This man page is complete for version 3 of the Samba
suite.</para>
</refsect1>
git.samba.org / mat / samba.git / blobdiff