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

<refentry xml:id="ldapdelete-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>ldapdelete</application></refentrytitle>

<xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>

</refmeta>

<refnamediv>

<refname><application>ldapdelete</application></refname>

<refpurpose>perform LDAP delete operations</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>ldapdelete</command>

<arg>-x</arg>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-ops"]/*[not(@name="sc-assert"

or @name="sc-authz")])'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-proto"]/*[@name="sc-ssl-tls"

or @name="sc-lver"])'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-remote"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-auth"]/*)'/>

<arg>-r</arg>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-props"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-misc"]/*[not(@name="sc-quiet"

or @name="sc-script")])'/>

<arg>--version</arg>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-general"]/*[@name="sc-help"])'/>

<sbr/><sbr/>

<arg><replaceable class="parameter">DN</replaceable></arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsection>

<title>Description</title>

<para>

This utility can be used to perform LDAP delete operations in the directory.

</para>

</refsection>

<refsection>

<title>Options</title>

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

<variablelist>

<varlistentry>

<term><option>-x, --deleteSubtree</option></term>

<listitem>

<para>

Delete the specified entry and all entries below it.

</para>

</listitem>

</varlistentry>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-ops"]/*[not(@name="lc-assert"

or @name="lc-authz")])'/>

</variablelist>

<refsection>

<title>LDAP Connection Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-proto"]/*[@name="lc-ssl"

or @name="lc-tls" or @name="lc-lver"])'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-remote"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-auth"]/*)'/>

<varlistentry>

<term><option>-r, --useSASLExternal</option></term>

<listitem>

<para>

Use the SASL EXTERNAL authentication mechanism.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsection>

<refsection>

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

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-props"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-misc"]/*[not(@name="lc-quiet"

or @name="lc-script")])'/>

</variablelist>

</refsection>

<refsection>

<title>General Options</title>

<variablelist>

<varlistentry>

<term><option>--version</option></term>

<listitem>

<para>

Display version information.

</para>

</listitem>

</varlistentry>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-general"]/*[@name="lc-help"])'/>

</variablelist>

</refsection>

</refsection>

<refsection>

<title>Examples</title>

<informalexample>

<para>

The following command deletes a user entry from the directory.

</para>

<literallayout><prompt

>$ </prompt><command>ldapdelete -p 1389 -D "cn=Directory Manager" \

-w password uid=bjensen,ou=people,dc=example,dc=com</command></literallayout>

<screen>

Processing DELETE request for uid=bjensen,ou=people,dc=example,dc=com

DELETE operation successful for DN uid=bjensen,ou=people,dc=example,dc=com

</screen>

</informalexample>

<informalexample>

<para>

The following command deletes the ou=Groups entry and all entries underneath

ou=Groups.

</para>

<literallayout><prompt

>$ </prompt><command>ldapdelete -p 1389 -D "cn=Directory Manager" \

-w password -x ou=groups,dc=example,dc=com</command></literallayout>

<screen>

Processing DELETE request for ou=groups,dc=example,dc=com

DELETE operation successful for DN ou=groups,dc=example,dc=com

</screen>

</informalexample>

</refsection>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-ops"])'/>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>

</refentry>