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

<refentry

xmlns:xi="http://www.w3.org/2001/XInclude"

xmlns:xlink="http://www.w3.org/1999/xlink">

<info name='info'>

<date>April, 2013</date>

<productname>OpenDJ</productname>

<productnumber>@VERS_FULL@</productnumber>

<title>Tools Reference</title>

<copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright>

<copyright><year>2013</year><holder>Jens Elkner</holder></copyright>

</info>

<manvolnum name='v1m'><remark

os="solaris">1M</remark><remark

os="linux;bsd">8</remark>

</manvolnum>

<manvolnum name='crontab'><remark

os="solaris">1</remark><remark

os="linux;bsd">1</remark>

</manvolnum>

<manvolnum name='v5'><remark

os="solaris;linux;bsd">5</remark>

</manvolnum>

<refsection name='env'>

<title>Environment Variables</title>

<para>

See <citerefentry><refentrytitle>opendj</refentrytitle><manvolnum>5</manvolnum>

</citerefentry>.

</para>

</refsection>

<refsection name='exit-0-gt0'>

<title>Exit Status</title>

<variablelist>

<varlistentry>

<term><errorcode>0</errorcode></term>

<listitem>

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

</listitem>

</varlistentry>

<varlistentry>

<term><errorcode>&gt; 0</errorcode></term>

<listitem>

<para>An error occurred.</para>

</listitem>

</varlistentry>

</variablelist>

</refsection>

<refsection name='exit-ops'>

<title>Exit Codes</title>

<variablelist>

<varlistentry>

<term><errorcode>0</errorcode></term>

<listitem>

<para>

The command completed successfully.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><replaceable class="parameter">ldap-error</replaceable></term>

<listitem>

<para>

An LDAP error occurred while processing the operation. LDAP result codes are

described in <link

xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC 4511</link>.

Also see the additional information for details.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><errorcode>89</errorcode></term>

<listitem>

<para>

An error occurred while parsing the command-line arguments.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsection>

<refsection name='seeAlso'>

<title>See Also</title>

<para>

<citerefentry><refentrytitle>opendj</refentrytitle><xi:include xpointer='xpointer(//manvolnum[@name="v5"])'/></citerefentry>.

</para>

</refsection>

<para name='s-ops'>

<arg name='sc-assert'>--assertionFilter <replaceable class="parameter">filter</replaceable></arg>

<arg>-c</arg>

<arg>-f <replaceable class="parameter">file</replaceable></arg>

<arg>-J <replaceable class="parameter">ctrlOIDstr</replaceable></arg>

<arg>-n</arg>

<arg name='sc-authz'>-Y <replaceable class="parameter">authzId</replaceable></arg>

</para>

<para name='l-ops'>

<varlistentry name='lc-assert'>

<term><option>--assertionFilter</option> <replaceable

class="parameter">filter</replaceable></term>

<listitem>

<para>

Use the LDAP assertion control with the provided filter.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-c, --continueOnError</option></term>

<listitem>

<para>

Continue processing even if there are errors.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-f, --filename</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

LDIF file containing one DN per line of entries to apply to this operation.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-J, --control</option> <replaceable

class="parameter">controloid[:criticality[:value|::b64value|:&lt;filePath]]</replaceable></term>

<listitem>

<para>

Use a request control with the provided information.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-n, --dry-run</option></term>

<listitem>

<para>

Show what would be done but do not perform any operation.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-authz'>

<term><option>-Y, --proxyAs</option> <replaceable

class="parameter">authzID</replaceable></term>

<listitem>

<para>

Use the proxied authorization control with the given authorization ID.

</para>

</listitem>

</varlistentry>

</para>

<para name='s-proto'>

<arg>-E</arg>

<group name='sc-ssl-tls'><arg choice="plain">-Z</arg><arg choice="plain">-q</arg></group>

<arg name="sc-policy">--usePasswordPolicyControl</arg>

<arg name='sc-lver'>-V <replaceable class="parameter">ldapVers</replaceable></arg>

</para>

<para name='l-proto'>

<varlistentry>

<term><option>-E, --reportAuthzID</option></term>

<listitem>

<para>

Use the authorization identity control.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-ssl'>

<term><option>-Z, --useSSL</option></term>

<listitem>

<para>

Use SSL for secure communication with the server.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-tls'>

<term><option>-q, --useStartTLS</option></term>

<listitem>

<para>

Use StartTLS to secure communication with the server.

</para>

</listitem>

</varlistentry>

<varlistentry name="lc-policy">

<term><option>--usePasswordPolicyControl</option></term>

<listitem>

<para>

Use the password policy request control.

</para>

</listitem>

</varlistentry>

<varlistentry name="lc-lver">

<term><option>-V, --ldapVersion</option> <replaceable

class="parameter">version</replaceable></term>

<listitem>

<para>

LDAP protocol version number (Default: 3).

</para>

</listitem>

</varlistentry>

</para>

<para name='s-remote'>

<arg>-h <replaceable class="parameter">host</replaceable></arg>

<arg name="sc-port">-p <replaceable class="parameter">port</replaceable></arg>

<arg name='sc-contimeout'>--connectTimeout <replaceable class="parameter">millis</replaceable></arg>

</para>

<para name='l-remote'>

<varlistentry>

<term><option>-h, --hostname</option> <replaceable

class="parameter">host</replaceable></term>

<listitem>

<para>

Server hostname or IP address to connect to (Default: 127.0.0.1).

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-port'>

<term><option>-p, --port</option> <replaceable

class="parameter">port</replaceable></term>

<listitem>

<para>

Port number of the server to connect to (Default: 389 (client tools), 4444 (admin tools)).

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-contimeout'>

<term><option>--connectTimeout</option> <replaceable class="parameter">millis</replaceable></term>

<listitem>

<para>

Maximum length of time (in milliseconds) that can be taken to establish a

connection. Use '0' to specify no time out (Default: 30000)

</para>

</listitem>

</varlistentry>

</para>

<para name='s-auth'>

<arg name='sc-dn'>-D <replaceable class="parameter">bindDN</replaceable></arg>

<group name="sc-pw-pf">

<arg name='sc-pw' choice="plain">-w <replaceable class="parameter">bindPw</replaceable></arg>

<arg name='sc-pf' choice="plain">-j <replaceable class="parameter">bindPwFile</replaceable></arg>

</group>

<arg name="sc-sasl">-o <replaceable class="parameter">name=value</replaceable></arg>

<arg name="sc-alias">-N <replaceable class="parameter">certNickname</replaceable></arg>

<arg>-K <replaceable class="parameter">ksPath</replaceable></arg>

<group name="sc-ksPW">

<arg choice="plain">-W <replaceable class="parameter">ksPw</replaceable></arg>

<arg choice="plain">-u <replaceable class="parameter">ksPwFile</replaceable></arg>

</group>

<arg>-P <replaceable class="parameter">tsPath</replaceable></arg>

<group name="sc-tsPW">

<arg choice="plain">-T <replaceable class="parameter">tsPw</replaceable></arg>

<arg choice="plain">-U <replaceable class="parameter">tsPwFile</replaceable></arg>

</group>

<arg name='sc-tAll'>-X</arg>

</para>

<para name='l-auth'>

<varlistentry name='lc-dn'>

<term><option>-D, --bindDN</option> <replaceable

class="parameter">bindDN</replaceable></term>

<listitem>

<para>

DN to use to bind to the server (Default: cn=Directory Manager).

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-pw'>

<term><option>-w, --bindPassword</option> <replaceable

class="parameter">password</replaceable></term>

<listitem>

<para>

Admin password to use for binding to the server. Use a dash

(<literal>-</literal>) as

<replaceable class="parameter">password</replaceable> to get asked for the

password when needed. Specifying a password on the command line is a security

problem, because it would be visible to other users e.g. using the <citerefentry

><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> command.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-pf'>

<term><option>-j, --bindPasswordFile</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

Name of the file which contains the password for binding to the server.

</para>

</listitem>

</varlistentry>

<varlistentry name="lc-sasl">

<term><option>-o, --saslOption</option> <replaceable

class="parameter">name=value</replaceable></term>

<listitem>

<para>

SASL bind options.

</para>

</listitem>

</varlistentry>

<varlistentry name="lc-alias">

<term><option>-N, --certNickname</option> <replaceable

class="parameter">alias</replaceable></term>

<listitem>

<para>

Alias of the certificate to use for client authentication via SSL/TLS.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-K, --keyStorePath</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

Filename of the certificate key store to use.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W, --keyStorePassword</option> <replaceable

class="parameter">password</replaceable></term>

<listitem>

<para>

PIN to use for accessing the certificate key store.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-u, --keyStorePasswordFile</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

Name of the file which contains the PIN for accessing the certificate key store.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-P, --trustStorePath</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

Filename of the certificate trust store to use.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-T, --trustStorePassword</option> <replaceable

class="parameter">password</replaceable></term>

<listitem>

<para>

PIN to use for accessing the certificate trust store.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-U, --trustStorePasswordFile</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

Name of the file which contains the PIN for accessing the certificate trust

store.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-tAll'>

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

<listitem>

<para>

Trust all server SSL certificates.

</para>

</listitem>

</varlistentry>

</para>

<para name='s-task'>

<arg name='sc-time'>-t <replaceable class="parameter">YYYYMMDDhhmmss</replaceable></arg>

<arg>--recurringTask <replaceable class="parameter">cronPattern</replaceable></arg>

<arg>--completionNotify <replaceable class="parameter">emailAddr</replaceable></arg>

<arg>--errorNotify <replaceable class="parameter">emailAddr</replaceable></arg>

<arg>--dependency <replaceable class="parameter">taskId</replaceable></arg>

<arg>--failedDependencyAction <replaceable class="parameter">action</replaceable></arg>

</para>

<para name='l-task'>

<varlistentry name='lc-stop'>

<term><option>-t, --stopTime</option> <replaceable

class="parameter">dateTime</replaceable></term>

<listitem>

<para>

Set the date and time at which this operation should be executed as a server

task. Format: YYYYMMDDhhmmssZ for UTC time or YYYYMMDDhhmmss for local time.

A value of '0' will cause the operation to be scheduled for immediate

execution. After scheduling the task this utility exits immediately.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-t, --start</option> <replaceable

class="parameter">dateTime</replaceable></term>

<listitem>

<para>

Set the date and time at which this operation should be executed as a server

task. Format: YYYYMMDDhhmmssZ for UTC time or YYYYMMDDhhmmss for local time.

A value of '0' will cause the operation to be scheduled for immediate

execution. After scheduling the task this utility exits immediately.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--recurringTask</option> <replaceable

class="parameter">schedulePattern</replaceable></term>

<listitem>

<para>

Indicates the task is recurring and will be scheduled according to the value

argument expressed in <citerefentry><refentrytitle>crontab</refentrytitle>

<xi:include xpointer='xpointer(//manvolnum[@name="crontab"])'/>

</citerefentry> compatible time/date pattern.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--completionNotify</option> <replaceable

class="parameter">emailAddress</replaceable></term>

<listitem>

<para>

Email address of a recipient to be notified when the task completes. This option

may be specified more than once.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--errorNotify</option> <replaceable

class="parameter">emailAddress</replaceable></term>

<listitem>

<para>

Email address of a recipient to be notified if an error occurs when this task

executes. This option may be specified more than once.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--dependency</option> <replaceable

class="parameter">taskId</replaceable></term>

<listitem>

<para>

ID of a task upon which this task depends. A task will not start execution until

all its dependencies have completed execution.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--failedDependencyAction</option> <replaceable

class="parameter">action</replaceable></term>

<listitem>

<para>

Action this task will take should one if its dependent tasks fail. The value

must be one of PROCESS, CANCEL, DISABLE. If not specified defaults to CANCEL.

</para>

</listitem>

</varlistentry>

</para>

<para name='s-props'>

<arg>--propertiesFilePath <replaceable class="parameter">file</replaceable></arg>

<arg>--noPropertiesFile</arg>

</para>

<para name='l-props'>

<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</option> <replaceable

class="parameter">file</replaceable></term>

<listitem>

<para>

Path to the file containing default property values used for command line

arguments.

</para>

</listitem>

</varlistentry>

</para>

<para name='s-misc'> <!-- usually i/o -->

<arg name='sc-quiet'>-Q</arg>

<arg name='sc-verbose'>-v</arg>

<arg name='sc-script'>-s</arg>

<arg name='sc-enc'>-i <replaceable class="parameter">encoding</replaceable></arg>

</para>

<para name='l-misc'>

<varlistentry name='lc-quiet'>

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

<listitem>

<para>

Use quiet mode (do not write progress information to standard output).

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-verbose'>

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

<listitem>

<para>

Use verbose mode.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-script'>

<term><option>-s, --script-friendly</option></term>

<listitem>

<para>

Use script-friendly mode.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-enc'>

<term><option>-i, --encoding</option> <replaceable

class="parameter">encoding</replaceable></term>

<listitem>

<para>

Use the specified character set for command-line input.

</para>

</listitem>

</varlistentry>

</para>

<para name='s-general'>

<arg>-V</arg>

<arg name='sc-help'>-H</arg>

</para>

<para name='l-general'>

<varlistentry>

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

<listitem>

<para>

Display version information.

</para>

</listitem>

</varlistentry>

<varlistentry name='lc-help'>

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

<listitem>

<para>

Display usage information.

</para>

</listitem>

</varlistentry>

</para>

</refentry>