| audit-data-security | Invoke data security audit processing in order to identify potential risks or other notable security characteristics contained in directory data |
| 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 | Back up one or more Directory Server backends |
| 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-rc-script | Create an RC script that may be used to start, stop, and restart the Directory Server on UNIX-based systems |
| dbtest | Inspect the contents of Directory Server local DB backends that store their information in Berkeley DB Java Edition databases. Only backends of type local DB can be inspected by this tool |
| dsconfig | View and edit the Directory Server configuration |
| dsframework | Manage administrative server groups or the global administrative user accounts that are used to configure servers within server groups |
| dsjavaproperties | Configure the JVM arguments used to run the Directory Server and associated tools |
| dsreplication | Manage data replication between two or more Directory Server instances |
| dump-dns | Obtain a listing of all of the DNs for all entries below a specified base DN in the Directory Server. |
| encode-password | Encode user passwords with a specified storage scheme or determine whether a given clear-text value matches a provided encoded password |
| encryption-settings | Manage the server encryption settings database |
| enter-lockdown-mode | Request that the Directory Server enter lockdown mode, during which it only processes operations requested by users holding the lockdown-mode privilege |
| export-ldif | Export data from a Directory Server backend in LDIF format |
| import-ldif | Import LDIF data into a Directory Server backend |
| ldap-diff | Compare the contents of two LDAP servers |
| ldap-result-code | Display and query LDAP result codes |
| ldapcompare | Perform LDAP compare operations in the Directory Server |
| ldapdelete | Perform LDAP delete operations in the Directory Server |
| ldapmodify | Perform LDAP modify, add, delete, and modify DN operations in the Directory Server |
| ldappasswordmodify | Perform LDAP password modify operations in the Directory Server |
| ldapsearch | Perform LDAP search operations in the Directory 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 to data in an LDIF file |
| ldifsearch | Perform search operations to data in an LDIF file |
| leave-lockdown-mode | Request that the Directory Server leave lockdown mode and resume normal operation |
| list-backends | List the backends and base DNs configured in the Directory Server |
| make-ldif | Generate LDIF data based on a definition in a template file |
| manage-account | Access and alter password policy state properties for user entries |
| manage-extension | Install or update UnboundID Directory Server extension bundles |
| manage-tasks | Access information about pending, running, and completed tasks scheduled in the Directory Server |
| migrate-ldap-schema | Migrate schema information from an existing LDAP server into an UnboundID Directory Server instance |
| migrate-sun-ds-config | Update an instance of the UnboundID Directory Server to match the configuration of an existing Sun Java System 5.x, 6.x, or 7.x directory instance |
| modrate | Perform repeated modifications against an LDAP directory server. |
| move-entry | Move one or more LDAP entries from one server to another |
| parallel-update | Perform add, delete, modify, and modify DN operations concurrently using multiple threads |
| profile-viewer | View information in data files captured by the Directory Server profiler |
| rebuild-index | Rebuild index data within a backend based on the Berkeley DB Java Edition. Note that this tool uses different approaches to rebuilding indexes based on whether it is running in online mode (as a task) rather than in offline mode. Running in offline mode will often provide significantly better performance. Also note that running in online mode will prevent the server from using that index while the rebuild is in progress, so some searches may behave differently while a rebuild is active than when it is not |
| remove-backup | Safely remove a backup and optionally all of its dependent backups from the specified Directory Server backend |
| restore | Restore a backup of a Directory Server backend |
| revert-update | This tool returns a server to the version before the last update was performed. Unlike the 'update' tool, this tool operates on the local instance from which it is invoked. This tool relies on files from the 'history' directory that are created during an update to restore the server to a prior state. It should be noted that this tool does not revert database files to prior states. Therefore, any changes made to the directory data between the time of the update and time of reversion will be lost. |
| 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. |
| searchrate | Perform repeated searches against an LDAP directory server. |
| server-state | View information about the current state of the Directory Server process |
| start-ds | Start the Directory Server |
| status | Display basic server information |
| stop-ds | Stop or restart the server |
| sum-file-sizes | Calculate the sum of the sizes for a set of files |
| summarize-access-log | Examine one or more access log files from an UnboundID Directory Server or Directory Proxy Server or from an Alcatel-Lucent 8661 Directory Server or Directory Proxy Server to display a number of metrics about operations processed within the server. |
| summarize-config | View a summary of the Directory Server configuration |
| uninstall | Uninstall the Directory Server. |
| update | To update a server to a newer version, download and unzip a 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. The 'revert-update' tool can be used to return the server to a previous version once an update has finished. Note that unlike the 'update' tool which operates on a remote server, 'revert-update' operates on the server root from which it is invoked. This tool copies the files that would be needed to return this installation to a prior version in the 'history' directory. These files can be removed if you are sure a reversion to the prior version will not be necessary. |
| validate-acis | This tool may be used to validate a set of access control definitions contained in an LDAP server (including Sun/Oracle DSEE instances) or an LDIF file to determine whether they are acceptable for use in the UnboundID Directory Server. Note that output generated by this tool will be LDIF, but each entry in the output will have exactly one ACI, so entries which have more than one ACI will appear multiple times in the output with different ACI values |
| validate-ldif | Validate the contents of an LDIF file against the server schema. |
| verify-index | Verify that indexes in a backend using the Berkeley DB Java Edition are consistent with the entry data contained in the database |