7321N/A<?xml version="1.0" encoding="UTF-8"?>
7321N/A<!--
7321N/A ! CCPL HEADER START
7321N/A !
7321N/A ! This work is licensed under the Creative Commons
7321N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
7321N/A ! To view a copy of this license, visit
7321N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
7321N/A ! or send a letter to Creative Commons, 444 Castro Street,
7321N/A ! Suite 900, Mountain View, California, 94041, USA.
7321N/A !
7321N/A ! You can also obtain a copy of the license at
7321N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
7321N/A ! See the License for the specific language governing permissions
7321N/A ! and limitations under the License.
7321N/A !
7321N/A ! If applicable, add the following below this CCPL HEADER, with the fields
7321N/A ! enclosed by brackets "[]" replaced with your own identifying information:
7321N/A ! Portions Copyright [yyyy] [name of copyright owner]
7321N/A !
7321N/A ! CCPL HEADER END
7321N/A !
7321N/A ! Copyright 2011-2014 ForgeRock AS
7321N/A !
7321N/A-->
7321N/A<refentry xml:id='uninstall-1'
7321N/A xmlns='http://docbook.org/ns/docbook'
7321N/A version='5.0' xml:lang='en'
7321N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
7321N/A xsi:schemaLocation='http://docbook.org/ns/docbook
7321N/A http://docbook.org/xml/5.0/xsd/docbook.xsd'>
7321N/A <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
7321N/A <refmeta>
7321N/A <refentrytitle>uninstall</refentrytitle><manvolnum>1</manvolnum>
7321N/A <refmiscinfo class="software">OpenDJ</refmiscinfo>
7321N/A <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
7321N/A </refmeta>
7321N/A <refnamediv>
7321N/A <refname>uninstall</refname>
7321N/A <refpurpose>remove OpenDJ directory server software</refpurpose>
7321N/A </refnamediv>
7321N/A <refsynopsisdiv>
7321N/A <cmdsynopsis>
7321N/A <command>uninstall</command>
7321N/A <arg choice="opt">options</arg>
7321N/A </cmdsynopsis>
7321N/A </refsynopsisdiv>
7321N/A <refsect1>
7321N/A <title>Description</title>
7321N/A <para>This utility can be used to uninstall the directory server.</para>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>Options</title>
7321N/A <para>The following options are supported.</para>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><option>-a, --remove-all</option></term>
7321N/A <listitem>
7321N/A <para>Remove all components of the server (this option is not compatible
7321N/A with the rest of remove options)</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-b, --backup-files</option></term>
7321N/A <listitem>
7321N/A <para>Remove backup files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-c, --configuration-files</option></term>
7321N/A <listitem>
7321N/A <para>Remove configuration files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-d, --databases</option></term>
7321N/A <listitem>
7321N/A <para>Remove database contents</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-e, --ldif-files</option></term>
7321N/A <listitem>
7321N/A <para>Remove LDIF files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-f, --forceOnError</option></term>
7321N/A <listitem>
7321N/A <para>Specifies whether the uninstall should continue if there is an error
7321N/A updating references to this server in remote server instances or not. This
7321N/A option can only be used with the --no-prompt option.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-i, --cli</option></term>
7321N/A <listitem>
7321N/A <para>Specifies to use the command line install. If not specified the
7321N/A graphical interface will be launched. The rest of the options (excluding
7321N/A help and version) will only be taken into account if this option is
7321N/A specified</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-l, --server-libraries</option></term>
7321N/A <listitem>
7321N/A <para>Remove Server Libraries and Administrative Tools</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-L, --log-files</option></term>
7321N/A <listitem>
7321N/A <para>Remove log files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A <refsect2>
7321N/A <title>LDAP Connection Options</title>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><option>--connectTimeout {timeout}</option></term>
7321N/A <listitem>
7321N/A <para>Maximum length of time (in milliseconds) that can be taken to
7321N/A establish a connection. Use '0' to specify no time out.</para>
7321N/A <para>Default value: 30000</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-h, --referencedHostName {host}</option></term>
7321N/A <listitem>
7321N/A <para>The name of this host (or IP address) as it is referenced in remote
7321N/A servers for replication</para>
7321N/A <para>Default value: localhost.localdomain</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-I, --adminUID {adminUID}</option></term>
7321N/A <listitem>
7321N/A <para>User ID of the Global Administrator to use to bind to the
7321N/A server.</para>
7321N/A <para>Default value: admin</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
7321N/A <listitem>
7321N/A <para>Bind password file</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-K, --keyStorePath {keyStorePath}</option></term>
7321N/A <listitem>
7321N/A <para>Certificate key store path</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-N, --certNickname {nickname}</option></term>
7321N/A <listitem>
7321N/A <para>Nickname of certificate for SSL client authentication</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-o, --saslOption {name=value}</option></term>
7321N/A <listitem>
7321N/A <para>SASL bind options</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-P, --trustStorePath {trustStorePath}</option></term>
7321N/A <listitem>
7321N/A <para>Certificate trust store path</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
7321N/A <listitem>
7321N/A <para>Certificate trust store PIN</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
7321N/A <listitem>
7321N/A <para>Certificate key store PIN file</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-U, --trustStorePasswordFile {path}</option></term>
7321N/A <listitem>
7321N/A <para>Certificate trust store PIN file</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-w, --bindPassword {bindPassword}</option></term>
7321N/A <listitem>
7321N/A <para>Password to use to bind to the server</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
7321N/A <listitem>
7321N/A <para>Certificate key store PIN</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-X, --trustAll</option></term>
7321N/A <listitem>
7321N/A <para>Trust all server SSL certificates</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect2>
7321N/A <refsect2>
7321N/A <title>Utility Input/Output Options</title>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><option>-n, --no-prompt</option></term>
7321N/A <listitem>
7321N/A <para>Use non-interactive mode. If data in the command is missing, the
7321N/A user is not prompted and the tool will fail</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>--noPropertiesFile</option></term>
7321N/A <listitem>
7321N/A <para>No properties file will be used to get default command line
7321N/A argument values</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
7321N/A <listitem>
7321N/A <para>Path to the file containing default property values used for
7321N/A command line arguments</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-Q, --quiet</option></term>
7321N/A <listitem>
7321N/A <para>Run setup in quiet mode. Quiet mode will not output progress
7321N/A information to standard output</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-v, --verbose</option></term>
7321N/A <listitem>
7321N/A <para>Use verbose mode</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect2>
7321N/A <refsect2>
7321N/A <title>General Options</title>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><option>-V, --version</option></term>
7321N/A <listitem>
7321N/A <para>Display version information</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><option>-?, -H, --help</option></term>
7321N/A <listitem>
7321N/A <para>Display usage information</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect2>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>Exit Codes</title>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term>0</term>
7321N/A <listitem>
7321N/A <para>The command completed successfully.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term>&gt; 0</term>
7321N/A <listitem>
7321N/A <para>An error occurred.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A </refsect1>
7321N/A <refsect1>
7321N/A <title>Examples</title>
7321N/A <para>The following command removes OpenDJ directory server without
7321N/A interaction.</para>
7321N/A
7321N/A <screen>
7321N/A$ <userinput>/path/to/opendj/uninstall -a --cli -I admin -w password -n</userinput>
7321N/A
7321N/A<computeroutput>Stopping Directory Server ..... Done.
7321N/ADeleting Files under the Installation Path ..... Done.
7321N/A
7321N/AThe Uninstall Completed Successfully.
7321N/ATo complete the uninstallation, you must delete manually the following files
7321N/Aand directories:
7321N/A/path/to/opendj/lib
7321N/ASee /var/.../opends-uninstall-3...0.log for a detailed log of this operation.</computeroutput>
7321N/A
7321N/A$ <userinput>rm -rf /path/to/opendj</userinput>
7321N/A </screen>
7321N/A </refsect1>
7321N/A</refentry>