From: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Date: Thu, 27 Feb 2025 02:31:50 +0000 (+1300)
Subject: manpages: samba-tool domain functionalprep
X-Git-Tag: tevent-0.17.0~560
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=60ea60384722018153b6f8ebf3b7b5bf8e7f6f16;p=thirdparty%2Fsamba.git

manpages: samba-tool domain functionalprep

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Rowland Penny <rpenny@samba.org>
---

diff --git a/docs-xml/manpages/samba-tool.8.xml b/docs-xml/manpages/samba-tool.8.xml
index 40d06b825a6..08865910a90 100644
--- a/docs-xml/manpages/samba-tool.8.xml
+++ b/docs-xml/manpages/samba-tool.8.xml
@@ -2013,6 +2013,59 @@
 	<para>Dumps Kerberos keys of the domain into a keytab.</para>
 </refsect3>
 
+<refsect3>
+	<title>domain functionalprep [options]</title>
+	<para>Prepare a domain for functional level upgrade. If <constant>--functional-level</constant> is not used, the latest supported version is used (currently 2016).</para>
+	<para>
+	  There are two aspects to this preparation, relating to the forest and the domain. By default both are run.
+	  If either of <constant>--forest-prep</constant> or <constant>--domain-prep</constant> are used, only the corresponding preparation is made.
+	  If both arguments are used together, all preparation is done, just as when neither is used.
+	</para>
+	<variablelist>
+		<varlistentry>
+			<term>-H, --URL</term>
+			<listitem><para>
+				LDB URL for database or target server.
+			</para></listitem>
+		</varlistentry>
+		<varlistentry>
+			<term>--functional-level [2008_R2|2012|2012_R2|2016]</term>
+			<listitem><para>
+			  The functional level to prepare for. The default is 2016.
+			</para></listitem>
+		</varlistentry>
+		<varlistentry>
+			<term>--forest-prep</term>
+			<listitem><para>
+				Run forest preparation only (unless --domain-prep is also used).
+			</para></listitem>
+		</varlistentry>
+		<varlistentry>
+			<term>--domain-prep</term>
+			<listitem><para>
+				Run domain preparation only (unless --forest-prep is also used).
+			</para></listitem>
+		</varlistentry>
+		<?ignore
+		  <!-- these are ignored by the tool, so let's not document them. -->
+		<varlistentry>
+			<term>-q, --quiet</term>
+			<listitem><para>
+				Be quieter.
+			</para></listitem>
+		</varlistentry>
+		<varlistentry>
+			<term>-v, --verbose</term>
+			<listitem><para>
+				Be more verbose.
+			</para></listitem>
+			</varlistentry>
+		?>
+	</variablelist>
+
+
+</refsect3>
+
 <refsect3>
 	<title>domain info <replaceable>ip_address</replaceable> [options]</title>
 	<para>Print basic info about a domain and the specified DC.