man-upgrade.xml revision ae57abea41b1a1c805fee27ffcfeabc0ae07e969
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! CCPL HEADER START
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! This work is licensed under the Creative Commons
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! To view a copy of this license, visit
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! http://creativecommons.org/licenses/by-nc-nd/3.0/
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! or send a letter to Creative Commons, 444 Castro Street,
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! Suite 900, Mountain View, California, 94041, USA.
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! You can also obtain a copy of the license at
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! See the License for the specific language governing permissions
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! and limitations under the License.
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! If applicable, add the following below this CCPL HEADER, with the fields
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! enclosed by brackets "[]" replaced with your own identifying information:
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! Portions Copyright [yyyy] [name of copyright owner]
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! CCPL HEADER END
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch ! Copyright 2011-2014 ForgeRock AS
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch xsi:schemaLocation='http://docbook.org/ns/docbook
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <refentrytitle>upgrade</refentrytitle><manvolnum>1</manvolnum>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <refmiscinfo class="software">OpenDJ</refmiscinfo>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <refpurpose>upgrade OpenDJ configuration & application data</refpurpose>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </refnamediv>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <refsynopsisdiv>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <cmdsynopsis>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </cmdsynopsis>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </refsynopsisdiv>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>This utility upgrades OpenDJ configuration (schema, directory server
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch configuration, and other configuration files) and application data (primarily
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch directory data) so that it is compatible with the binary files and scripts
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch that are installed.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>The <command>upgrade</command> command thus performs only part of the
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch upgrade process, which includes the following phases for a single
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch server.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <orderedlist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Get and unpack a newer version of OpenDJ directory server
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch software.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Stop the current OpenDJ directory server.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Overwrite existing binary and script files with those of the
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch newer version, and then run this utility, the <command>upgrade</command>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch command, before restarting OpenDJ.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Start the upgraded OpenDJ directory server.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </orderedlist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>The <command>upgrade</command> command <emphasis>does not back up
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch OpenDJ before you upgrade, nor does it restore OpenDJ if the
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <command>upgrade</command> command fails</emphasis>. In order to revert a
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch failed upgrade, make sure you back up OpenDJ directory server before you
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch overwrite existing binary and script files.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>By default, the <command>upgrade</command> command requests
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch confirmation before making important configuration changes. You can use
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch the <option>--no-prompt</option> option to run the command
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch non-interactively.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>When using the <option>--no-prompt</option> option, if the
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <command>upgrade</command> command cannot complete because it requires
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch confirmation for a potentially very long or critical task, then it exits
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch with an error and a message about how to finish making the changes. You can
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch add the <option>--force</option> option to force a non-interactive upgrade
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch to continue in this case, also performing long running and critical
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch tasks.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>After upgrading, see the resulting <filename>upgrade.log</filename>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch file for a full list of operations performed.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>The following options are supported.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Automatically accepts the product license if there is one in the
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch delivery.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Forces a non-interactive upgrade to continue even if it requires
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch user interaction. In particular, long running or critical upgrade tasks,
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch such as re-indexing, which require user confirmation will be skipped. This
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch option may only be used with the <option>--no-prompt</option> option.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Ignores any errors which occur during the upgrade. This option
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch should be used with caution and may be useful in automated deployments
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch where potential errors are known in advance and resolved after the upgrade
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch has completed.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Use non-interactive mode. Prompt for any required information
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch rather than fail.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>The command completed successfully.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>The command was run in non-interactive mode, but could not complete
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch because confirmation was required to run a long or critical task.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>See the error message or the log for details.</para>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </varlistentry>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch </variablelist>
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>See the <citetitle>Installation Guide</citetitle> for an example
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch upgrade process for OpenDJ directory server installed from the cross-platform
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch xlink:href="install-guide#upgrade-zip-example"
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Upgrading From
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch <para>Native packages (.deb, .rpm) perform more of the upgrade process,
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch stopping OpenDJ if it is running, overwriting older files with newer files,
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch running this utility, and starting OpenDJ if it was running when you upgraded
8fe8f97e688779add9cd042a9db4ddb7b117cce2Stephan Bosch the package(s).</para>