The Directory Proxy Server provides the following command-line utilities, which can be run directly in interactive, non-interactive, or script mode.
Command-Line Tools Description
authrate 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.
backup 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 File for more information.
base64 Encode raw data using the base64 algorithm or decode base64-encoded data back to its raw representation.
collect-support-data 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-initial-proxy-config Create an inital Directory Proxy Server configuration.
create-rc-script Create an Run Control (RC) script that may be used to start, stop, and restart the Directory Proxy Server on UNIX-based systems.
create-recurring-task 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-recurring-task-chain Create a chain of recurring tasks to run on the server.
dsconfig View and edit the Directory Proxy Server configuration.
dsjavaproperties 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/ to specify the desired JVM options and JAVA_HOME environment variable.
dump-dns Obtain a listing of all of the DNs for all entries below a specified base DN in the Directory Server.
enter-lockdown-mode Request that the Directory Proxy Server enter lockdown mode, during which it only processes operations requested by users holding the lockdown-mode privilege.
global-index-size 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.
ldap-diff Compare the contents of two LDAP directory server servers.
ldap-result-code Display and query LDAP result codes.
ldapcompare Perform LDAP compare operations in the Directory Proxy Server.
ldapdelete Perform LDAP delete operations in the Directory Proxy Server.
ldapmodify Perform LDAP modify, add, delete, and modify DN operations in the Directory Proxy Server.
ldappasswordmodify Perform LDAP password modify operations in the Directory Proxy Server.
ldapsearch Perform LDAP search operations in the Directory Proxy Server.
ldif-diff Compare the contents of two LDIF files, the output being an LDIF file needed to bring the source file in sync with the target.
ldifmodify Apply a set of modify, add, and delete operations against data in an LDIF file.
ldifsearch Perform search operations against data in an LDIF file.
leave-lockdown-mode Request that the Directory Proxy Server leave lockdown mode and resume normal operation.
list-backends List the backends and base DNs configured in the Directory Proxy Server.
make-ldif Generate LDIF data based on a definition in a template file.
manage-extension 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).
manage-tasks Access information about pending, running, and completed tasks scheduled in the Directory Proxy Server.
modrate Perform repeated modifications against an LDAP directory server.
move-subtree Move a subtree entries or a single entry from one server to another.
parallel-update Perform add, delete, modify, and modify DN operations concurrently using multiple threads.
prepare-external-server Prepare and a directory server for communication.
profile-viewer View information in data files captured by the Directory Proxy Server profiler.
reload-index Reload the contents of the global index.
remove-backup Safely remove a backup and optionally all of its dependent backups from the specified Directory Proxy Server backend.
remove-defunct-server Remove a server from this server's topology.
restore Restore a backup of the Directory Proxy Server backend.
revert-update Returns a server to the version before the last update was performed.
review-license Review and/or indicate your acceptance of the product license.
scramble-ldif Obscure the contents of a specified set of attributes in an LDIF file.
search-and-mod-rate Perform repeated searches against an LDAP directory server and modify each entry returned.
search-rate Perform repeated searches against an LDAP directory server.
server-state View information about the current state of the Directory Proxy Server process.
setup Perform the initial setup for the Directory Proxy Server instance.
start-server Start the Directory Proxy Server.
status Display basic server information.
stop-server Stop or restart the Directory Proxy Server.
subtree-accessibility List or update the a set of subtree accessibility restrictions defined in the Directory Server.
sum-file-sizes Calculate the sum of the sizes for a set of files.
summarize-access-log Generate a summary of one or more access logs to display a number of metrics about operations processed within the server.
uninstall Uninstall the Directory Proxy Server.
update 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-ldif Validate the contents of an LDIF file against the server schema.