Page created: 6 Nov 2019 |
Page updated: 25 Mar 2020
The Directory Proxy Server provides the following command-line utilities, which can be run directly in interactive, non-interactive, or script mode.
|Perform repeated authentications against an LDAP directory server, where each authentication consists of a search to find a user followed by a bind to verify the credentials for that user.
|Run full or incremental backups on one or more Directory Proxy Server backends. This utility also supports the use of a properties file to pass predefined command-line arguments. See Managing the tools.properties File for more information.
|Encode raw data using the base64 algorithm or decode base64-encoded data back to its raw representation.
|Collect and package system information useful in troubleshooting problems. The information is packaged as a ZIP archive that can be sent to a technical support representative.
|Create an inital Directory Proxy Server configuration.
|Create an Run Control (RC) script that may be used to start, stop, and restart the Directory Proxy Server on UNIX-based systems.
|Create a recurring task to run on the server. Tasks can be created for backups, LDIF exports, a statically defined task, or a third-party task.
|Create a chain of recurring tasks to run on the server.
|View and edit the Directory Proxy Server configuration.
|Configure the JVM arguments used to run the Directory Proxy Server and associated tools. Before launching the command, edit the properties file located in config/java.properties to specify the desired JVM options and JAVA_HOME environment variable.
|Obtain a listing of all of the DNs for all entries below a specified base DN in the Directory Server.
|Request that the Directory Proxy Server enter lockdown mode, during
which it only processes operations requested by users holding the
|Estimates the size in memory of one or more global indexes from the actual number of keys, the configured number of keys and the average key size.
|Compare the contents of two LDAP directory server servers.
|Display and query LDAP result codes.
|Perform LDAP compare operations in the Directory Proxy Server.
|Perform LDAP delete operations in the Directory Proxy Server.
|Perform LDAP modify, add, delete, and modify DN operations in the Directory Proxy Server.
|Perform LDAP password modify operations in the Directory Proxy Server.
|Perform LDAP search operations in the Directory Proxy Server.
|Compare the contents of two LDIF files, the output being an LDIF file needed to bring the source file in sync with the target.
|Apply a set of modify, add, and delete operations against data in an LDIF file.
|Perform search operations against data in an LDIF file.
|Request that the Directory Proxy Server leave lockdown mode and resume normal operation.
|List the backends and base DNs configured in the Directory Proxy Server.
|Generate LDIF data based on a definition in a template file.
|Install or update extension bundles. An extension bundle is a package of extension(s) that utilize the Server SDK to extend the functionality of the PingDirectoryProxy Server. Extension bundles are installed from a zip archive or file system directory. The Directory Proxy Server will be restarted if running to activate the extension(s).
|Access information about pending, running, and completed tasks scheduled in the Directory Proxy Server.
|Perform repeated modifications against an LDAP directory server.
|Move a subtree entries or a single entry from one server to another.
|Perform add, delete, modify, and modify DN operations concurrently using multiple threads.
|Prepare and a directory server for communication.
|View information in data files captured by the Directory Proxy Server profiler.
|Reload the contents of the global index.
|Safely remove a backup and optionally all of its dependent backups from the specified Directory Proxy Server backend.
|Remove a server from this server's topology.
|Restore a backup of the Directory Proxy Server backend.
|Returns a server to the version before the last update was performed.
|Review and/or indicate your acceptance of the product license.
|Obscure the contents of a specified set of attributes in an LDIF file.
|Perform repeated searches against an LDAP directory server and modify each entry returned.
|Perform repeated searches against an LDAP directory server.
|View information about the current state of the Directory Proxy Server process.
|Perform the initial setup for the Directory Proxy Server instance.
|Start the Directory Proxy Server.
|Display basic server information.
|Stop or restart the Directory Proxy Server.
|List or update the a set of subtree accessibility restrictions defined in the Directory Server.
|Calculate the sum of the sizes for a set of files.
|Generate a summary of one or more access logs to display a number of metrics about operations processed within the server.
|Uninstall the Directory Proxy Server.
|Update the Directory Proxy Server to a newer version by downloading and unzipping the new server install package on the same host as the server you wish to update. Then, use the update tool from the new server package to update the older version of the server. Before upgrading a server, you should ensure that it is capable of starting without severe or fatal errors. During the update process, the server is stopped if running, then the update performed, and a check is made to determine if the newly updated server starts without major errors. If it cannot start cleanly, the update will be backed out and the server returned to its prior state. See the revert-update tool for information on reverting an update.
|Validate the contents of an LDIF file against the server schema.