man-rebuild-index.xml revision 62da52c144e8d6ba69f611c45deeeb4f985ea24c
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! CCPL HEADER START
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! This work is licensed under the Creative Commons
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! To view a copy of this license, visit
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac ! or send a letter to Creative Commons, 444 Castro Street,
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac ! Suite 900, Mountain View, California, 94041, USA.
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! You can also obtain a copy of the license at
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! See the License for the specific language governing permissions
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac ! and limitations under the License.
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac ! If applicable, add the following below this CCPL HEADER, with the fields
3437829f938dbb44527d91fbbc5f430a1243c5a5JnRouvignac ! enclosed by brackets "[]" replaced with your own identifying information:
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! Portions Copyright [yyyy] [name of copyright owner]
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! CCPL HEADER END
2cacab200fb387e290386593d9b2fca2e7beef33csovant ! Copyright 2011-2013 ForgeRock AS
2cacab200fb387e290386593d9b2fca2e7beef33csovant xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
2cacab200fb387e290386593d9b2fca2e7beef33csovant xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
a36d934612ff23d33c1ff20f05d59db05abeca26madiot <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
98de9af32a09c74f74a861cbd85ccb715dc2290amadiot <refentrytitle>rebuild-index</refentrytitle><manvolnum>1</manvolnum>
98de9af32a09c74f74a861cbd85ccb715dc2290amadiot <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
a36d934612ff23d33c1ff20f05d59db05abeca26madiot <refnamediv>
a36d934612ff23d33c1ff20f05d59db05abeca26madiot <refpurpose>rebuild index after configuration change</refpurpose>
a36d934612ff23d33c1ff20f05d59db05abeca26madiot </refnamediv>
98de9af32a09c74f74a861cbd85ccb715dc2290amadiot <refsynopsisdiv>
98de9af32a09c74f74a861cbd85ccb715dc2290amadiot <cmdsynopsis>
a36d934612ff23d33c1ff20f05d59db05abeca26madiot </cmdsynopsis>
a36d934612ff23d33c1ff20f05d59db05abeca26madiot </refsynopsisdiv>
a36d934612ff23d33c1ff20f05d59db05abeca26madiot <para>This utility can be used to rebuild index data within a backend based
2cacab200fb387e290386593d9b2fca2e7beef33csovant on the Berkeley DB Java Edition.</para>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </refsect1>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Base DN of a backend supporting indexing. Rebuild is performed on
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant indexes within the scope of the given base DN.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <para>Indicates that indexes do not need rebuilding because they are known
2cacab200fb387e290386593d9b2fca2e7beef33csovant to be empty and forcefully marks them as valid. <emphasis>This is an
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant advanced option which must only be used in cases where a degraded index is
2cacab200fb387e290386593d9b2fca2e7beef33csovant known to be empty and does not therefore need rebuilding.</emphasis> This
d81f6d00c343633159fc5ea08599d145135612c0ludovicp situation typically arises when an index is created for an attribute which
2cacab200fb387e290386593d9b2fca2e7beef33csovant has just been added to the schema.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp <para>Names of index(es) to rebuild. For an attribute index this is
d81f6d00c343633159fc5ea08599d145135612c0ludovicp simply an attribute name. At least one index must be specified for
d81f6d00c343633159fc5ea08599d145135612c0ludovicp rebuild. Cannot be used with the <option>--rebuildAll</option>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp or <option>--rebuildDegraded</option> options.</para>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp </listitem>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp </varlistentry>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp <varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <para>Rebuild all indexes, including any DN2ID, DN2URI, VLV and
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant extensible indexes. Cannot be used with the <option>--index</option>
2cacab200fb387e290386593d9b2fca2e7beef33csovant or <option>--rebuildDegraded</option> options.</para>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <para>Rebuild all degraded indexes, including any DN2ID, DN2URI, VLV and
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant extensible indexes. Cannot be used with the <option>--index</option>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>--tmpdirectory {directory}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Path to temporary directory for index scratch files during index
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant rebuilding.</para>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </variablelist>
07437026ccf420c104734aa780e9bdf71117f650gary.williams <title>Task Backend Connection Options</title>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <variablelist>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
6031e9c7eb72435516a6828deb2e97533ed0382dludovicp <term><option>--connectTimeout {timeout}</option></term>
f5aaa49dba43db0e99f06476534a8749820515dbcsovant <para>Maximum length of time (in milliseconds) that can be taken to
2cacab200fb387e290386593d9b2fca2e7beef33csovant establish a connection. Use '0' to specify no time out.</para>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </varlistentry>
6031e9c7eb72435516a6828deb2e97533ed0382dludovicp <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Directory server hostname or IP address</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>-K, --keyStorePath {keyStorePath}</option></term>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>-N, --certNickname {nickname}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Nickname of certificate for SSL client authentication</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <term><option>-o, --saslOption {name=value}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Directory server administration port number</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <term><option>-P, --trustStorePath {trustStorePath}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift </varlistentry>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <varlistentry>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift </varlistentry>
f5aaa49dba43db0e99f06476534a8749820515dbcsovant <varlistentry>
f5aaa49dba43db0e99f06476534a8749820515dbcsovant <term><option>-U, --trustStorePasswordFile {path}</option></term>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>-w, --bindPassword {bindPassword}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Use <option>-w -</option> to have the command prompt for the
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant password, rather than enter the password on the command line.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsect2>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <variablelist>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <varlistentry>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <term><option>--completionNotify {emailAddress}</option></term>
2cacab200fb387e290386593d9b2fca2e7beef33csovant <para>Email address of a recipient to be notified when the task
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant completes. This option may be specified more than once.</para>
2cacab200fb387e290386593d9b2fca2e7beef33csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp <varlistentry>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp <term><option>--dependency {taskID}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>ID of a task upon which this task depends. A task will not start
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift execution until all its dependencies have completed execution.</para>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp </listitem>
d81f6d00c343633159fc5ea08599d145135612c0ludovicp </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>--errorNotify {emailAddress}</option></term>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <para>Email address of a recipient to be notified if an error occurs
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift when this task executes. This option may be specified more than
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>--failedDependencyAction {action}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Action this task will take should one if its dependent tasks fail.
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant The value must be one of PROCESS, CANCEL, DISABLE. If not specified
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant defaults to CANCEL.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>--recurringTask {schedulePattern}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Indicates the task is recurring and will be scheduled according
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant to the value argument expressed in crontab(5) compatible time/date
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant pattern.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>-t, --start {startTime}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Indicates the date/time at which this operation will start when
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC
2cacab200fb387e290386593d9b2fca2e7beef33csovant time or YYYYMMDDhhmmss for local time. A value of '0' will cause the
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant task to be scheduled for immediate execution. When this option is
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant specified the operation will be scheduled to start at the specified
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant time after which this utility will exit immediately.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsect2>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>No properties file will be used to get default command line
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant argument values</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>Path to the file containing default property values used for
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant command line arguments</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsect2>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </variablelist>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <variablelist>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <varlistentry>
62ecec3a82a8b838ee76c1f6610902d8fd7015cbmatthew_swift <para>The command completed successfully.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>An error occurred while parsing the command-line arguments.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </listitem>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </varlistentry>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </variablelist>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsect1>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <para>The following example schedules a task to start immediately that
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant rebuilds the <literal>cn</literal> (common name) index.</para>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant <screen>$ rebuild-index -p 4444 -h opendj.example.com -D "cn=Directory Manager"
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant -w password -b dc=example,dc=com -i cn -t 0
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovantRebuild Index task 20110607160349596 scheduled to start Jun 7, 2011 4:03:49 PM</screen>
23f633e1b8cc53fdac740eca4ab7e0341890bba2csovant </refsect1>