PingDirectory

Reloading the global indexes

The reload-index tool allows you to manually reload the PingDirectoryProxy server global indexes.

Use the reload-index tool to reload all configured indexes in the global index, including the relative distinguished name (RDN) index and all attribute indexes or to reload only the indexes you specify.

You might need to reload the index when:

  • The PingDirectoryProxy server fails to successfully load its global indexes on startup.

  • Changes are made to the set of indexed attributes.

  • Significant changes are made to the content in backend servers.

  • The integrity of the index is in question.

The reload-index tool schedules an operation to run within the PingDirectoryProxy server’s process. You must supply the LDAP connection information so that the tool can communicate with the server through its task interface. You can schedule tasks to run immediately or at a later time. After the tasks are scheduled, manage them using the manage-tasks tool.

Reloading all of the indexes

About this task

Reload all the indexes within the scope of the base distinguished name (DN) dc=example,dc=com. The task is performed as cn=Directory Manager on port 389 of the localhost server.

The existing index contents are erased before reloading.

Steps

  • To reload all of the indexes within the scope of the dc=example,dc=com base DN, run the reload-index tool.

    Example:

    $ bin/reload-index --task --bindPassword password --baseDN "dc=example,dc=com"

Reloading the RDN and UID index

About this task

To reload the RDN and unique identifier (UID) index in the background so that the existing contents of these indexes can continue to be used:

Steps

  • Run the reload-index tool with the --index rdn and --index uid options.

    Example:

    $ bin/reload-index --task --bindPassword password \
      --baseDN "dc=example,dc=com" --index rdn --index uid --background

Priming the backend server using the --fromDS option

About this task

You can force the PingDirectoryProxy server to prime from the backend directory server using the --fromDS option, which overrides the configuration of the prime-index-source property.

You can do this on a one-off basis if the global index appears to be growing too large.

To prime the backend server:

Steps

  • Run the reload-index tool with the --fromDS option.

    Example:

    $ bin/reload-index --bindPassword password --baseDN "dc=example,dc=com" --fromDS