<?xml version="1.0" encoding="UTF-8"?>

<refentry xml:id='uninstall-1'

xmlns='http://docbook.org/ns/docbook'

version='5.0' xml:lang='en'

xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

xsi:schemaLocation='http://docbook.org/ns/docbook

http://docbook.org/xml/5.0/xsd/docbook.xsd'>

<info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>

<refmeta>

<refentrytitle>uninstall</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="software">OpenDJ</refmiscinfo>

<refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>

</refmeta>

<refnamediv>

<refname>uninstall</refname>

<refpurpose>remove OpenDJ directory server software</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>uninstall</command>

<arg choice="opt">options</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>This utility can be used to uninstall the directory server.</para>

</refsect1>

<refsect1>

<title>Options</title>

<para>The following options are supported.</para>

<variablelist>

<varlistentry>

<term><option>-a, --remove-all</option></term>

<listitem>

<para>Remove all components of the server (this option is not compatible

with the rest of remove options)</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-b, --backup-files</option></term>

<listitem>

<para>Remove backup files</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-c, --configuration-files</option></term>

<listitem>

<para>Remove configuration files</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-d, --databases</option></term>

<listitem>

<para>Remove database contents</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-e, --ldif-files</option></term>

<listitem>

<para>Remove LDIF files</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-f, --forceOnError</option></term>

<listitem>

<para>Specifies whether the uninstall should continue if there is an error

updating references to this server in remote server instances or not. This

option can only be used with the --no-prompt option.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-i, --cli</option></term>

<listitem>

<para>Specifies to use the command line install. If not specified the

graphical interface will be launched. The rest of the options (excluding

help and version) will only be taken into account if this option is

specified</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-l, --server-libraries</option></term>

<listitem>

<para>Remove Server Libraries and Administrative Tools</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-L, --log-files</option></term>

<listitem>

<para>Remove log files</para>

</listitem>

</varlistentry>

</variablelist>

<refsect2>

<title>LDAP Connection Options</title>

<variablelist>

<varlistentry>

<term><option>--connectTimeout {timeout}</option></term>

<listitem>

<para>Maximum length of time (in milliseconds) that can be taken to

establish a connection. Use '0' to specify no time out.</para>

<para>Default value: 30000</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-h, --referencedHostName {host}</option></term>

<listitem>

<para>The name of this host (or IP address) as it is referenced in remote

servers for replication</para>

<para>Default value: localhost.localdomain</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-I, --adminUID {adminUID}</option></term>

<listitem>

<para>User ID of the Global Administrator to use to bind to the

server.</para>

<para>Default value: admin</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>

<listitem>

<para>Bind password file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-K, --keyStorePath {keyStorePath}</option></term>

<listitem>

<para>Certificate key store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-N, --certNickname {nickname}</option></term>

<listitem>

<para>Nickname of certificate for SSL client authentication</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-o, --saslOption {name=value}</option></term>

<listitem>

<para>SASL bind options</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-P, --trustStorePath {trustStorePath}</option></term>

<listitem>

<para>Certificate trust store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-T, --trustStorePassword {trustStorePassword}</option></term>

<listitem>

<para>Certificate trust store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>

<listitem>

<para>Certificate key store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-U, --trustStorePasswordFile {path}</option></term>

<listitem>

<para>Certificate trust store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-w, --bindPassword {bindPassword}</option></term>

<listitem>

<para>Password to use to bind to the server</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W, --keyStorePassword {keyStorePassword}</option></term>

<listitem>

<para>Certificate key store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-X, --trustAll</option></term>

<listitem>

<para>Trust all server SSL certificates</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>Utility Input/Output Options</title>

<variablelist>

<varlistentry>

<term><option>-n, --no-prompt</option></term>

<listitem>

<para>Use non-interactive mode. If data in the command is missing, the

user is not prompted and the tool will fail</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--noPropertiesFile</option></term>

<listitem>

<para>No properties file will be used to get default command line

argument values</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--propertiesFilePath {propertiesFilePath}</option></term>

<listitem>

<para>Path to the file containing default property values used for

command line arguments</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-Q, --quiet</option></term>

<listitem>

<para>Run setup in quiet mode. Quiet mode will not output progress

information to standard output</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-v, --verbose</option></term>

<listitem>

<para>Use verbose mode</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>General Options</title>

<variablelist>

<varlistentry>

<term><option>-V, --version</option></term>

<listitem>

<para>Display version information</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-?, -H, --help</option></term>

<listitem>

<para>Display usage information</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

</refsect1>

<refsect1>

<title>Exit Codes</title>

<variablelist>

<varlistentry>

<term>0</term>

<listitem>

<para>The command completed successfully.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>&gt; 0</term>

<listitem>

<para>An error occurred.</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>Examples</title>

<para>The following command removes OpenDJ directory server without

interaction.</para>

<screen>

$ <userinput>/path/to/opendj/uninstall -a --cli -I admin -w password -n</userinput>

<computeroutput>Stopping Directory Server ..... Done.

Deleting Files under the Installation Path ..... Done.

The Uninstall Completed Successfully.

To complete the uninstallation, you must delete manually the following files

and directories:

/path/to/opendj/lib

See /var/.../opends-uninstall-3...0.log for a detailed log of this operation.</computeroutput>

$ <userinput>rm -rf /path/to/opendj</userinput>

</screen>

</refsect1>

</refentry>