6330N/A<?
xml version="1.0" encoding="UTF-8"?>
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 ! or send a letter to Creative Commons, 444 Castro Street, 6330N/A ! Suite 900, Mountain View, California, 94041, USA. 6330N/A ! You can also obtain a copy of the license at 6330N/A ! See the License for the specific language governing permissions 6330N/A ! and limitations under the License. 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 ! Copyright 2011-2012 ForgeRock AS 6330N/A ! Portions Copyright 2013 Jens Elkner 6330N/A <
productname>OpenDJ</
productname>
6330N/A <
productnumber>@VERS_FULL@</
productnumber>
6330N/A <
title>Tools Reference</
title>
6330N/A <
copyright><
year>2011-2012</
year><
holder>ForgeRock AS</
holder></
copyright>
6330N/A <
copyright><
year>2013</
year><
holder>Jens Elkner</
holder></
copyright>
6330N/A<
manvolnum name='v1m'><
remark 6330N/A os="solaris">1M</
remark><
remark 6330N/A<
manvolnum name='crontab'><
remark 6330N/A os="solaris">1</
remark><
remark 6330N/A<
manvolnum name='v5'><
remark 6330N/A os="solaris;linux;bsd">5</
remark>
6330N/A <
title>Environment Variables</
title>
6330N/ASee <
citerefentry><
refentrytitle>opendj</
refentrytitle><
manvolnum>5</
manvolnum>
6330N/A<
refsection name='exit-0-gt0'>
6330N/A <
term><
errorcode>0</
errorcode></
term>
6330N/A <
para>The command completed successfully.</
para>
6330N/A <
term><
errorcode>> 0</
errorcode></
term>
6330N/A <
para>An error occurred.</
para>
6330N/A<
refsection name='exit-ops'>
6330N/A <
term><
errorcode>0</
errorcode></
term>
6330N/AThe command completed successfully.
6330N/A <
term><
replaceable class="parameter">ldap-error</
replaceable></
term>
6330N/AAn LDAP error occurred while processing the operation. LDAP result codes are
6330N/AAlso see the additional information for details.
6330N/A <
term><
errorcode>89</
errorcode></
term>
6330N/AAn error occurred while parsing the command-line arguments.
6330N/A<
citerefentry><
refentrytitle>opendj</
refentrytitle><
xi:
include xpointer='xpointer(//manvolnum[@name="v5"])'/></
citerefentry>.
6330N/A <
arg name='sc-assert'>--assertionFilter <
replaceable class="parameter">filter</
replaceable></
arg>
6330N/A <
arg>-f <
replaceable class="parameter">file</
replaceable></
arg>
6330N/A <
arg>-J <
replaceable class="parameter">ctrlOIDstr</
replaceable></
arg>
6331N/A <
arg name='sc-authz'>-Y <
replaceable class="parameter">authzId</
replaceable></
arg>
6330N/A <
varlistentry name='lc-assert'>
6330N/A <
term><
option>--assertionFilter</
option> <
replaceable 6330N/A class="parameter">filter</
replaceable></
term>
6330N/AUse the LDAP assertion control with the provided filter.
6330N/A <
term><
option>-c, --continueOnError</
option></
term>
6330N/AContinue processing even if there are errors.
6330N/A <
term><
option>-f, --filename</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/ALDIF file containing one DN per line of entries to apply to this operation.
6330N/A <
term><
option>-J, --control</
option> <
replaceable 6330N/A class="parameter">controloid[:criticality[:value|::b64value|:<filePath]]</
replaceable></
term>
6330N/AUse a request control with the provided information.
6330N/A <
term><
option>-n, --dry-run</
option></
term>
6330N/AShow what would be done but do not perform any operation.
6331N/A <
varlistentry name='lc-authz'>
6330N/A <
term><
option>-Y, --proxyAs</
option> <
replaceable 6330N/A class="parameter">authzID</
replaceable></
term>
6330N/AUse the proxied authorization control with the given authorization ID.
6330N/A <
group name='sc-ssl-tls'><
arg choice="plain">-Z</
arg><
arg choice="plain">-q</
arg></
group>
6331N/A <
arg name="sc-policy">--usePasswordPolicyControl</
arg>
6331N/A <
arg name='sc-lver'>-V <
replaceable class="parameter">ldapVers</
replaceable></
arg>
6330N/A <
term><
option>-E, --reportAuthzID</
option></
term>
6330N/AUse the authorization identity control.
6330N/A <
varlistentry name='lc-ssl'>
6330N/A <
term><
option>-Z, --useSSL</
option></
term>
6330N/AUse SSL for secure communication with the server.
6330N/A <
varlistentry name='lc-tls'>
6330N/A <
term><
option>-q, --useStartTLS</
option></
term>
6330N/AUse StartTLS to secure communication with the server.
6331N/A <
varlistentry name="lc-policy">
6330N/A <
term><
option>--usePasswordPolicyControl</
option></
term>
6330N/AUse the password policy request control.
6331N/A <
varlistentry name="lc-lver">
6330N/A <
term><
option>-V, --ldapVersion</
option> <
replaceable 6330N/A class="parameter">version</
replaceable></
term>
6330N/ALDAP protocol version number (Default: 3).
6330N/A <
arg>-h <
replaceable class="parameter">host</
replaceable></
arg>
6331N/A <
arg name="sc-port">-p <
replaceable class="parameter">port</
replaceable></
arg>
6330N/A <
arg name='sc-contimeout'>--connectTimeout <
replaceable class="parameter">millis</
replaceable></
arg>
6330N/A <
term><
option>-h, --hostname</
option> <
replaceable 6330N/A class="parameter">host</
replaceable></
term>
6330N/AServer hostname or IP address to connect to (Default: 127.0.0.1).
6331N/A <
varlistentry name='lc-port'>
6330N/A <
term><
option>-p, --port</
option> <
replaceable 6330N/A class="parameter">port</
replaceable></
term>
6330N/APort number of the server to connect to (Default: 389 (client tools), 4444 (admin tools)).
6330N/A <
varlistentry name='lc-contimeout'>
6330N/A <
term><
option>--connectTimeout</
option> <
replaceable class="parameter">millis</
replaceable></
term>
6330N/AMaximum length of time (in milliseconds) that can be taken to establish a
6330N/Aconnection. Use '0' to specify no time out (Default: 30000)
6330N/A <
arg name='sc-dn'>-D <
replaceable class="parameter">bindDN</
replaceable></
arg>
6331N/A <
arg name='sc-pw' choice="plain">-w <
replaceable class="parameter">bindPw</
replaceable></
arg>
6331N/A <
arg name='sc-pf' choice="plain">-j <
replaceable class="parameter">bindPwFile</
replaceable></
arg>
6330N/A <
arg name="sc-sasl">-o <
replaceable class="parameter">name=value</
replaceable></
arg>
6330N/A <
arg name="sc-alias">-N <
replaceable class="parameter">certNickname</
replaceable></
arg>
6331N/A <
arg>-K <
replaceable class="parameter">ksPath</
replaceable></
arg>
6331N/A <
arg choice="plain">-W <
replaceable class="parameter">ksPw</
replaceable></
arg>
6331N/A <
arg choice="plain">-u <
replaceable class="parameter">ksPwFile</
replaceable></
arg>
6331N/A <
arg>-P <
replaceable class="parameter">tsPath</
replaceable></
arg>
6331N/A <
arg choice="plain">-T <
replaceable class="parameter">tsPw</
replaceable></
arg>
6331N/A <
arg choice="plain">-U <
replaceable class="parameter">tsPwFile</
replaceable></
arg>
6330N/A <
arg name='sc-tAll'>-X</
arg>
6330N/A <
varlistentry name='lc-dn'>
6330N/A <
term><
option>-D, --bindDN</
option> <
replaceable 6330N/A class="parameter">bindDN</
replaceable></
term>
6330N/ADN to use to bind to the server (Default: cn=Directory Manager).
6330N/A <
varlistentry name='lc-pw'>
6330N/A <
term><
option>-w, --bindPassword</
option> <
replaceable 6330N/A class="parameter">password</
replaceable></
term>
6330N/AAdmin password to use for binding to the server. Use a dash
6330N/A<
replaceable class="parameter">password</
replaceable> to get asked for the
6330N/Apassword when needed. Specifying a password on the command line is a security
6330N/Aproblem, because it would be visible to other users
e.g. using the <
citerefentry 6330N/A><
refentrytitle>ps</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry> command.
6330N/A <
varlistentry name='lc-pf'>
6330N/A <
term><
option>-j, --bindPasswordFile</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/AName of the file which contains the password for binding to the server.
6330N/A <
varlistentry name="lc-sasl">
6330N/A <
term><
option>-o, --saslOption</
option> <
replaceable 6330N/A class="parameter">name=value</
replaceable></
term>
6330N/A <
varlistentry name="lc-alias">
6330N/A <
term><
option>-N, --certNickname</
option> <
replaceable 6330N/A class="parameter">alias</
replaceable></
term>
6330N/AAlias of the certificate to use for client authentication via
SSL/
TLS.
6330N/A <
term><
option>-K, --keyStorePath</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/AFilename of the certificate key store to use.
6330N/A <
term><
option>-W, --keyStorePassword</
option> <
replaceable 6330N/A class="parameter">password</
replaceable></
term>
6330N/APIN to use for accessing the certificate key store.
6330N/A <
term><
option>-u, --keyStorePasswordFile</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/AName of the file which contains the PIN for accessing the certificate key store.
6330N/A <
term><
option>-P, --trustStorePath</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/AFilename of the certificate trust store to use.
6330N/A <
term><
option>-T, --trustStorePassword</
option> <
replaceable 6330N/A class="parameter">password</
replaceable></
term>
6330N/APIN to use for accessing the certificate trust store.
6330N/A <
term><
option>-U, --trustStorePasswordFile</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/AName of the file which contains the PIN for accessing the certificate trust
6330N/A <
varlistentry name='lc-tAll'>
6330N/A <
term><
option>-X, --trustAll</
option></
term>
6330N/ATrust all server SSL certificates.
6330N/A <
arg name='sc-time'>-t <
replaceable class="parameter">YYYYMMDDhhmmss</
replaceable></
arg>
6330N/A <
arg>--recurringTask <
replaceable class="parameter">cronPattern</
replaceable></
arg>
6330N/A <
arg>--completionNotify <
replaceable class="parameter">emailAddr</
replaceable></
arg>
6330N/A <
arg>--errorNotify <
replaceable class="parameter">emailAddr</
replaceable></
arg>
6330N/A <
arg>--dependency <
replaceable class="parameter">taskId</
replaceable></
arg>
6330N/A <
arg>--failedDependencyAction <
replaceable class="parameter">action</
replaceable></
arg>
6330N/A <
varlistentry name='lc-stop'>
6330N/A <
term><
option>-t, --stopTime</
option> <
replaceable 6330N/A class="parameter">dateTime</
replaceable></
term>
6330N/ASet the date and time at which this operation should be executed as a server
6330N/Atask. Format: YYYYMMDDhhmmssZ for UTC time or YYYYMMDDhhmmss for local time.
6330N/AA value of '0' will cause the operation to be scheduled for immediate
6330N/Aexecution. After scheduling the task this utility exits immediately.
6330N/A <
term><
option>-t, --start</
option> <
replaceable 6330N/A class="parameter">dateTime</
replaceable></
term>
6330N/ASet the date and time at which this operation should be executed as a server
6330N/Atask. Format: YYYYMMDDhhmmssZ for UTC time or YYYYMMDDhhmmss for local time.
6330N/AA value of '0' will cause the operation to be scheduled for immediate
6330N/Aexecution. After scheduling the task this utility exits immediately.
6330N/A <
term><
option>--recurringTask</
option> <
replaceable 6330N/A class="parameter">schedulePattern</
replaceable></
term>
6330N/AIndicates the task is recurring and will be scheduled according to the value
6330N/Aargument expressed in <
citerefentry><
refentrytitle>crontab</
refentrytitle>
6330N/A<
xi:
include xpointer='xpointer(//manvolnum[@name="crontab"])'/>
6330N/A <
term><
option>--completionNotify</
option> <
replaceable 6330N/A class="parameter">emailAddress</
replaceable></
term>
6330N/AEmail address of a recipient to be notified when the task completes. This option
6330N/Amay be specified more than once.
6330N/A <
term><
option>--errorNotify</
option> <
replaceable 6330N/A class="parameter">emailAddress</
replaceable></
term>
6330N/AEmail address of a recipient to be notified if an error occurs when this task
6330N/Aexecutes. This option may be specified more than once.
6330N/A <
term><
option>--dependency</
option> <
replaceable 6330N/A class="parameter">taskId</
replaceable></
term>
6330N/AID of a task upon which this task depends. A task will not start execution until
6330N/Aall its dependencies have completed execution.
6330N/A <
term><
option>--failedDependencyAction</
option> <
replaceable 6330N/A class="parameter">action</
replaceable></
term>
6330N/AAction this task will take should one if its dependent tasks fail. The value
6330N/Amust be one of PROCESS, CANCEL, DISABLE. If not specified defaults to CANCEL.
6330N/A <
arg>--propertiesFilePath <
replaceable class="parameter">file</
replaceable></
arg>
6330N/A <
arg>--noPropertiesFile</
arg>
6330N/A <
term><
option>--noPropertiesFile</
option></
term>
6330N/ANo properties file will be used to get default command line argument values.
6330N/A <
term><
option>--propertiesFilePath</
option> <
replaceable 6330N/A class="parameter">file</
replaceable></
term>
6330N/APath to the file containing default property values used for command line
6330N/A<
para name='s-misc'>
<!-- usually i/o --> 6330N/A <
arg name='sc-quiet'>-Q</
arg>
6330N/A <
arg name='sc-verbose'>-v</
arg>
6330N/A <
arg name='sc-script'>-s</
arg>
6330N/A <
arg name='sc-enc'>-i <
replaceable class="parameter">encoding</
replaceable></
arg>
6330N/A <
varlistentry name='lc-quiet'>
6330N/A <
term><
option>-Q, --quiet</
option></
term>
6330N/AUse quiet mode (do not write progress information to standard output).
6330N/A <
varlistentry name='lc-verbose'>
6330N/A <
term><
option>-v, --verbose</
option></
term>
6330N/A <
varlistentry name='lc-script'>
6330N/A <
term><
option>-s, --script-friendly</
option></
term>
6330N/A <
varlistentry name='lc-enc'>
6330N/A <
term><
option>-i, --encoding</
option> <
replaceable 6330N/A class="parameter">encoding</
replaceable></
term>
6330N/AUse the specified character set for command-line input.
6330N/A <
arg name='sc-help'>-H</
arg>
6330N/A <
term><
option>-V, --version</
option></
term>
6330N/ADisplay version information.
6330N/A <
varlistentry name='lc-help'>
6330N/A <
term><
option>-H, --help</
option></
term>