man-ldapdelete.xml revision 6330
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse<?xml version="1.0" encoding="UTF-8"?>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse<!--
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! CCPL HEADER START
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse !
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! This work is licensed under the Creative Commons
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! To view a copy of this license, visit
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! http://creativecommons.org/licenses/by-nc-nd/3.0/
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! or send a letter to Creative Commons, 444 Castro Street,
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! Suite 900, Mountain View, California, 94041, USA.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse !
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse ! You can also obtain a copy of the license at
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse ! See the License for the specific language governing permissions
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse ! and limitations under the License.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse !
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! If applicable, add the following below this CCPL HEADER, with the fields
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! enclosed by brackets "[]" replaced with your own identifying information:
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! Portions Copyright [yyyy] [name of copyright owner]
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse !
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! CCPL HEADER END
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse !
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! Copyright 2011-2012 ForgeRock AS
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse ! Portions Copyright 2013 Jens Elkner
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse !
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse-->
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse<refentry xml:id="ldapdelete-1" xmlns="http://docbook.org/ns/docbook"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse version="5.0" xml:lang="en"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xmlns:xlink="http://www.w3.org/1999/xlink"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xmlns:xi="http://www.w3.org/2001/XInclude">
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <refmeta>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <refentrytitle><application>ldapdelete</application></refentrytitle>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse </refmeta>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <refnamediv>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <refname><application>ldapdelete</application></refname>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <refpurpose>perform LDAP delete operations</refpurpose>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse </refnamediv>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <refsynopsisdiv>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <cmdsynopsis>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <command>ldapdelete</command>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <arg>-x</arg>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <sbr/><sbr/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <xi:include href="common.xml"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xpointer='xpointer(//para[@name="s-ops"]/*[not(@name="sc-assert")])'/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <sbr/><sbr/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <xi:include href="common.xml"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xpointer='xpointer(//para[@name="s-proto"]/*)'/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <sbr/><sbr/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <xi:include href="common.xml"
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse xpointer='xpointer(//para[@name="s-remote"]/*)'/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <sbr/><sbr/>
d86ef5503dcbc38e87c0e03cd3e1f16458cb6323rse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="s-auth"]/*)'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <sbr/><sbr/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="s-props"]/*)'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="s-misc"]/*[not(@name="sc-quiet"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse or @name="sc-script")])'/>
60c1c6006c048e5009ae91fa2ba4cd35e5f78e10rse <arg>--version</arg>
60c1c6006c048e5009ae91fa2ba4cd35e5f78e10rse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="s-general"]/*[@name="sc-help"])'/>
a943533fd4d91d114af622731a405407990c4fb1rse <sbr/><sbr/>
a943533fd4d91d114af622731a405407990c4fb1rse <arg><replaceable class="parameter">DN</replaceable></arg>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </cmdsynopsis>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </refsynopsisdiv>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <title>Description</title>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseThis utility can be used to perform LDAP delete operations in the directory.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <title>Options</title>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <para>The following options are supported.</para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <variablelist>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <varlistentry>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <term><option>-x, --deleteSubtree</option></term>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <listitem>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseDelete the specified entry and all entries below it.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </listitem>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </varlistentry>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="l-ops"]/*[not(@name="lc-assert")])'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </variablelist>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <title>LDAP Connection Options</title>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <variablelist>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="l-proto"]/*)'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml"
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse xpointer='xpointer(//para[@name="l-remote"]/*)'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml"
4e9f75b8d841732981a37f823eb84569740047d5wrowe xpointer='xpointer(//para[@name="l-auth"]/*)'/>
4e9f75b8d841732981a37f823eb84569740047d5wrowe </variablelist>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <refsection>
18143536ed43585115bd6c44497b333d07403aa4rbb <title>Utility Input/Output Options</title>
18143536ed43585115bd6c44497b333d07403aa4rbb <variablelist>
18143536ed43585115bd6c44497b333d07403aa4rbb <xi:include href="common.xml"
18143536ed43585115bd6c44497b333d07403aa4rbb xpointer='xpointer(//para[@name="l-props"]/*)'/>
18143536ed43585115bd6c44497b333d07403aa4rbb <xi:include href="common.xml"
18143536ed43585115bd6c44497b333d07403aa4rbb xpointer='xpointer(//para[@name="l-misc"]/*[not(@name="lc-quiet"
18143536ed43585115bd6c44497b333d07403aa4rbb or @name="lc-script")])'/>
18143536ed43585115bd6c44497b333d07403aa4rbb </variablelist>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </refsection>
18143536ed43585115bd6c44497b333d07403aa4rbb <refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <title>General Options</title>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <variablelist>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <varlistentry>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <term><option>--version</option></term>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <listitem>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseDisplay version information.
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </para>
a943533fd4d91d114af622731a405407990c4fb1rse </listitem>
a943533fd4d91d114af622731a405407990c4fb1rse </varlistentry>
a943533fd4d91d114af622731a405407990c4fb1rse <xi:include href="common.xml"
a943533fd4d91d114af622731a405407990c4fb1rse xpointer='xpointer(//para[@name="l-general"]/*[@name="lc-help"])'/>
a943533fd4d91d114af622731a405407990c4fb1rse </variablelist>
a943533fd4d91d114af622731a405407990c4fb1rse </refsection>
22889d69e2b1dc1197419786bc1294498e124803wrowe </refsection>
a943533fd4d91d114af622731a405407990c4fb1rse <refsection>
a943533fd4d91d114af622731a405407990c4fb1rse <title>Examples</title>
bb0b94431dc9a1591a0a38a6c48925c6d9213c83rse <informalexample>
d1bb6e2664788e0437acc18e877562c9a796d7cerse <para>
7933d4a963def02417113b6798d87a36395053b0rseThe following command deletes a user entry from the directory.
a943533fd4d91d114af622731a405407990c4fb1rse </para>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <literallayout><prompt
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse>$ </prompt><command>ldapdelete -p 1389 -D "cn=Directory Manager" \
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse -w password uid=bjensen,ou=people,dc=example,dc=com</command></literallayout>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <screen>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseProcessing DELETE request for uid=bjensen,ou=people,dc=example,dc=com
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseDELETE operation successful for DN uid=bjensen,ou=people,dc=example,dc=com
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse</screen>
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin </informalexample>
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin <informalexample>
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin <para>
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martinThe following command deletes the ou=Groups entry and all entries underneath
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martinou=Groups.
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin </para>
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin <literallayout><prompt
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin>$ </prompt><command>ldapdelete -p 1389 -D "cn=Directory Manager" \
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin -w password -x ou=groups,dc=example,dc=com</command></literallayout>
fe46444c8f32f00d040ebefa94bcd0c05ab15ab9martin <screen>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseProcessing DELETE request for ou=groups,dc=example,dc=com
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrseDELETE operation successful for DN ou=groups,dc=example,dc=com
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse</screen>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </informalexample>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse </refsection>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-ops"])'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse</refentry>
cc003103e52ff9d5fe9bed567ef9438613ab4fbfrse