<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! http://creativecommons.org/licenses/by-nc-nd/3.0/
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at
! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2011-2013 ForgeRock AS
!
-->
<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'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xi='http://www.w3.org/2001/XInclude'>
<xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
<refmeta>
<refentrytitle><application>uninstall</application></refentrytitle>
<xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
</refmeta>
<refnamediv>
<refname>uninstall</refname>
<refpurpose>remove OpenDJ directory server software</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>uninstall</command>
<arg>-a</arg>
<arg>-b</arg>
<arg>-c</arg>
<arg>-d</arg>
<arg>-e</arg>
<arg>-f</arg>
<arg>-i</arg>
<arg>-L</arg>
<arg>-l</arg>
<arg>-I adminUID</arg>
<arg>-n</arg>
<sbr/><sbr/>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="s-remote"]/*[not(@name="sc-port")])'/>
<sbr/><sbr/>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="s-auth"]/*[not(@name="sc-dn")])'/>
<sbr/><sbr/>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="s-props"]/*)'/>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="s-misc"]/*[@name="sc-quiet"
or @name="sc-verbose"])'/>
<sbr/><sbr/>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="s-general"]/*)'/>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
This utility can be used to uninstall directory server components.
</para>
</refsection>
<refsection>
<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 <option>--no-prompt</option> 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, --log-files</option></term>
<listitem>
<para>
Remove log files.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l, --server-libraries</option></term>
<listitem>
<para>
Remove Server Libraries and Administrative Tools.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>LDAP Connection Options</title>
<variablelist>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="l-remote"]/*[not(@name="lc-port")])'/>
<varlistentry>
<term><option>-I, --adminUID</option> <replaceable
class="parameter">adminUID</replaceable></term>
<listitem>
<para>
User ID of the Global Administrator to use to bind to the server
(Default: admin).
</para>
</listitem>
</varlistentry>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="l-auth"]/*[not(@name="lc-dn")])'/>
</variablelist>
</refsection>
<refsection>
<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>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="l-props"]/*)'/>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-quiet"
or @name="lc-verbose"])'/>
</variablelist>
</refsection>
<refsection>
<title>General Options</title>
<variablelist>
<xi:include href="common.xml"
xpointer='xpointer(//para[@name="l-general"]/*)'/>
</variablelist>
</refsection>
<refsection>
<title>Examples</title>
<informalexample>
<para>
The following command removes OpenDJ directory server without interaction.
</para>
<literallayout><prompt
>$ </prompt><command>uninstall -a --cli -I admin -w password -n</command></literallayout>
<screen>
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:
$INSTALL_ROOT/lib
See /var/.../opends-uninstall-3...0.log for a detailed log of this operation.
</screen>
<literallayout><prompt
>$ </prompt><command>rm -rf $INSTALL_ROOT</command></literallayout>
</informalexample>
</refsection>
<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
</refentry>