6330N/A<?xml version="1.0" encoding="UTF-8"?>
6330N/A<!--
6330N/A ! CCPL HEADER START
6330N/A !
6330N/A ! This work is licensed under the Creative Commons
6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
6330N/A ! To view a copy of this license, visit
6330N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6330N/A ! or send a letter to Creative Commons, 444 Castro Street,
6330N/A ! Suite 900, Mountain View, California, 94041, USA.
6330N/A !
6330N/A ! You can also obtain a copy of the license at
6330N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6330N/A ! See the License for the specific language governing permissions
6330N/A ! and limitations under the License.
6330N/A !
6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields
6330N/A ! enclosed by brackets "[]" replaced with your own identifying information:
6330N/A ! Portions Copyright [yyyy] [name of copyright owner]
6330N/A !
6330N/A ! CCPL HEADER END
6330N/A !
6330N/A ! Copyright 2011-2012 ForgeRock AS
6330N/A ! Portions Copyright 2013 Jens Elkner
6330N/A !
6330N/A-->
6330N/A<refentry xml:id="ldapmodify-1" xmlns="http://docbook.org/ns/docbook"
6330N/A version="5.0" xml:lang="en"
6330N/A xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6330N/A xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
6330N/A xmlns:xlink="http://www.w3.org/1999/xlink"
6330N/A xmlns:xi="http://www.w3.org/2001/XInclude">
6330N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6330N/A <refmeta>
6330N/A <refentrytitle><application>ldapmodify</application></refentrytitle>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A </refmeta>
6330N/A <refnamediv>
6330N/A <refname><application>ldapmodify</application></refname>
6330N/A <refpurpose>perform LDAP modify, add, delete, mod DN operations</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>ldapmodify</command>
6330N/A <arg>-a</arg>
6330N/A <arg>--postReadAttributes <replaceable class="parameter">attrList</replaceable></arg>
6330N/A <arg>--preReadAttributes <replaceable class="parameter">attrList</replaceable></arg>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//para[@name="s-ops"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="s-proto"]/*[not(@name="sc-policy")])'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-remote"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-auth"]/*)'/>
6331N/A <arg>-r</arg>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="s-misc"]/*[not(@name="sc-quiet"
6331N/A or @name="sc-script")])'/>
6330N/A <arg>--version</arg>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*[@name="sc-help"])'/>
6330N/A </cmdsynopsis>
6330N/A </refsynopsisdiv>
6330N/A <refsection>
6330N/A <title>Description</title>
6330N/A <para>
6330N/AThis utility can be used to perform LDAP modify, add, delete, and modify DN
6330N/Aoperations in the directory. When not using a file to specify modifications,
6330N/Aend your input with EOF (Ctrl+D on UNIX).
6330N/A </para>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Options</title>
6330N/A <para>The following options are supported.</para>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><option>-a, --defaultAdd</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ATreat records with no changetype as add operations.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--postReadAttributes</option> <replaceable
6330N/A class="parameter">attrList</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AUse the LDAP ReadEntry post-read control.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--preReadAttributes</option> <replaceable
6330N/A class="parameter">attrList</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AUse the LDAP ReadEntry pre-read control.</para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//para[@name="l-ops"]/*)'/>
6330N/A </variablelist>
6330N/A <refsection>
6330N/A <title>LDAP Connection Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="l-proto"]/*[not(@name="lc-policy")])'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-remote"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-auth"]/*)'/>
6331N/A <varlistentry>
6331N/A <term><option>-r, --useSASLExternal</option></term>
6331N/A <listitem>
6331N/A <para>
6331N/AUse the SASL EXTERNAL authentication mechanism.
6331N/A </para>
6331N/A </listitem>
6331N/A </varlistentry>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Utility Input/Output Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="l-misc"]/*[not(@name="lc-quiet"
6331N/A or @name="lc-script")])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>General Options</title>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><option>--version</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ADisplay version information.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-general"]/*[@name="lc-help"])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Examples</title>
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following example demonstrates use of the command to add an entry to the
6330N/Adirectory.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>cat newuser.ldif</command></literallayout>
6330N/A <screen>
6330N/Adn: uid=newuser,ou=People,dc=example,dc=com
6330N/Auid: newuser
6330N/AfacsimileTelephoneNumber: +1 408 555 1213
6330N/AobjectClass: person
6330N/AobjectClass: organizationalPerson
6330N/AobjectClass: inetOrgPerson
6330N/AobjectClass: posixAccount
6330N/AobjectClass: top
6330N/AgivenName: New
6330N/Acn: New User
6330N/Acn: Real Name
6330N/AtelephoneNumber: +1 408 555 1212
6330N/Asn: Jensen
6330N/AroomNumber: 1234
6330N/AhomeDirectory: /home/newuser
6330N/AuidNumber: 10389
6330N/Amail: newuser@example.com
6330N/Al: South Pole
6330N/Aou: Product Development
6330N/Aou: People
6330N/AgidNumber: 10636
6330N/A</screen>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>ldapmodify -p 1389 -a -f newuser.ldif \
6330N/A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</command></literallayout>
6330N/A <screen>
6330N/AProcessing ADD request for uid=newuser,ou=People,dc=example,dc=com
6330N/AADD operation successful for DN uid=newuser,ou=People,dc=example,dc=com
6330N/A</screen>
6330N/A </informalexample>
6330N/A
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following example demonstrates adding a Description attribute to the new
6330N/Auser's entry.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>cat newdesc.ldif</command></literallayout>
6330N/A <screen>
6330N/Adn: uid=newuser,ou=People,dc=example,dc=com
6330N/Achangetype: modify
6330N/Aadd: description
6330N/Adescription: A new user's entry
6330N/A</screen>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>ldapmodify -p 1389 -f newdesc.ldif \
6330N/A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</command></literallayout>
6330N/A <screen>
6330N/AProcessing MODIFY request for uid=newuser,ou=People,dc=example,dc=com
6330N/AMODIFY operation successful for DN uid=newuser,ou=People,dc=example,dc=com
6330N/A</screen>
6330N/A </informalexample>
6330N/A
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following example demonstrates changing the Description attribute for the
6330N/Anew user's entry.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>cat moddesc.ldif</command></literallayout>
6330N/A <screen>
6330N/Adn: uid=newuser,ou=People,dc=example,dc=com
6330N/Achangetype: modify
6330N/Areplace: description
6330N/Adescription: Another description
6330N/A</screen>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>ldapmodify -p 1389 -f moddesc.ldif \
6330N/A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</command></literallayout>
6330N/A <screen>
6330N/AProcessing MODIFY request for uid=newuser,ou=People,dc=example,dc=com
6330N/AMODIFY operation successful for DN uid=newuser,ou=People,dc=example,dc=com
6330N/A</screen>
6330N/A </informalexample>
6330N/A
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following example demonstrates deleting the new user's entry.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>cat deluser.ldif</command></literallayout>
6330N/A <screen>
6330N/Adn: uid=newuser,ou=People,dc=example,dc=com
6330N/Achangetype: delete
6330N/A</screen>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>ldapmodify -p 1389 -f deluser.ldif \
6330N/A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</command></literallayout>
6330N/A <screen>
6330N/AProcessing DELETE request for uid=newuser,ou=People,dc=example,dc=com
6330N/ADELETE operation successful for DN uid=newuser,ou=People,dc=example,dc=com
6330N/A</screen>
6330N/A </informalexample>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-ops"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6330N/A</refentry>