Reload the contents of the global index.
Reloads the contents of the global index for a given base DN. It is possible to reload all configured indexes in the global index (which includes the rdn index and all attribute indexes), or reload only those indexes specified by name.
This tool schedules an operation to run within the Directory Proxy Server's process. LDAP connection options must be supplied that allow this tool to communicate with the server through its task interface. Tasks can be scheduled to run immediately or at a later time (see Task Scheduling Options below). Once scheduled, tasks can be managed using the manage-tasks tool.
reload-index --bindPassword password --baseDN dc=example,dc=com
reload-index --bindPassword password --baseDN dc=example,dc=com --index rdn \ --index uid --background --fromDS
-V
--version
Description | Display Directory Proxy Server version information |
-H
--help
Description | Display general usage information |
--help-ldap
Description | Display help for using LDAP options |
--help-sasl
Description | Display help for using SASL options |
--help-debug
Description | Display help for using debug options |
Advanced | Yes |
-Z
--useSSL
Description | Use SSL for secure communication with the server |
-q
--useStartTLS
Description | Use StartTLS to secure communication with the server |
--useNoSecurity
Description | Use no security when communicating with the server |
-h {host}
--hostname {host}
Description | Directory Proxy Server hostname or IP address |
Default Value | localhost |
Required | No |
Multi-Valued | No |
-p {port}
--port {port}
Description | Directory Proxy Server port number |
Default Value | 389 |
Required | No |
Multi-Valued | No |
-D {bindDN}
--bindDN {bindDN}
Description | DN used to bind to the server |
Default Value | cn=Directory Manager |
Required | No |
Multi-Valued | No |
-w {bindPassword}
--bindPassword {bindPassword}
Description | Password used to bind to the server |
Required | No |
Multi-Valued | No |
-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}
Description | Bind password file |
Required | No |
Multi-Valued | No |
-o {name=value}
--saslOption {name=value}
Description | SASL bind options |
Required | No |
Multi-Valued | Yes |
-X
--trustAll
Description | Trust all server SSL certificates |
-P {truststorePath}
--trustStorePath {truststorePath}
Description | Certificate truststore path |
Required | No |
Multi-Valued | No |
-T {truststorePassword}
--trustStorePassword {truststorePassword}
Description | Certificate truststore PIN |
Required | No |
Multi-Valued | No |
-U {path}
--trustStorePasswordFile {path}
Description | Certificate truststore PIN file |
Required | No |
Multi-Valued | No |
-K {keystorePath}
--keyStorePath {keystorePath}
Description | Certificate keystore path |
Required | No |
Multi-Valued | No |
-W {keystorePassword}
--keyStorePassword {keystorePassword}
Description | Certificate keystore PIN |
Required | No |
Multi-Valued | No |
-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}
Description | Certificate keystore PIN file |
Required | No |
Multi-Valued | No |
-N {nickname}
--certNickname {nickname}
Description | Nickname of the certificate for SSL client authentication |
Required | No |
Multi-Valued | No |
--propertiesFilePath {propertiesFilePath}
Description | Path to the file that contains default property values used for command-line arguments |
Required | No |
Multi-Valued | No |
--usePropertiesFile
Description | Specify that a properties file will be used to get default command-line argument values |
--script-friendly
Description | Use script-friendly mode |
--task
Description | Indicates that this tool should be invoked as a task which runs inside the Directory Proxy Server rather than as a separate process. At present, this argument is optional, but in a future release it may be required for running as a task |
-t {startTime}
--start {startTime}
Description | Indicates the date/time, expressed in format 'YYYYMMDDhhmmss', when the operation starts when scheduled as a server task. A value of '0' causes the task to be scheduled for immediate execution. When this option is specified, the operation is scheduled to start at the specified time, after which this utility will exit immediately |
Required | No |
Multi-Valued | No |
--startAlert
Description | Generate an administrative alert when the task starts running |
--successAlert
Description | Generate an administrative alert when the task completes successfully |
--errorAlert
Description | Generate an administrative alert when the task fails to complete successfully |
--startNotify {emailAddress}
Description | Email address of a recipient to be notified when this task starts running |
Required | No |
Multi-Valued | Yes |
--completionNotify {emailAddress}
Description | Email address of a recipient to be notified when the task completes, regardless of whether it succeeded or failed |
Required | No |
Multi-Valued | Yes |
--successNotify {emailAddress}
Description | Email address of a recipient to be notified when this task completes successfully |
Required | No |
Multi-Valued | Yes |
--errorNotify {emailAddress}
Description | Email address of a recipient to be notified if an error occurs when this task executes |
Required | No |
Multi-Valued | Yes |
--dependency {taskID}
Description | ID of a task upon which this task depends. A task will not start execution until all its dependencies have completed execution |
Required | No |
Multi-Valued | Yes |
--failedDependencyAction {action}
Description | Action this task will take should one of its dependent tasks fail. The value must be one of the following: PROCESS,CANCEL,DISABLE. If not specified, the default value is CANCEL |
Required | No |
Multi-Valued | Yes |
-Q
--quiet
Description | Use quiet mode |
-b {baseDN}
--baseDN {baseDN}
Description | Base DN of an entry balancing request processor |
Required | Yes |
Multi-Valued | No |
-i {index}
--index {index}
Description | Name of an index to reload, which is either an attribute name, or 'rdn' for the RDN index |
Required | No |
Multi-Valued | Yes |
--background
Description | Indicates that the index contents are to be loaded in the background to a separate memory area so that the existing contents can continue to be used during the reload. This option should only be used when there is sufficient free memory available to the global index. If this option is not specified, the existing index contents are erased before reloading |
--fromDS
Description | Indicates that the index contents are to be loaded only from Directory Servers regardless of the configured prime index source |
--searchEntryPerSecond {ratePerSecond}
Description | Target reload rate for backend directory servers that do not support the stream values operation. The rate is specified in terms of the number of search result entries accepted per second by the Directory Proxy Server. The value zero means the rate is not limited. If this option is not specified then the configuration setting is used |
Lower Bound | 0 |
Required | No |
Multi-Valued | No |