The list-backends command displays information about the available back ends.
The list-backends utility can be used to obtain information about the back ends defined in a directory server instance. Back ends are responsible for providing access to the server database.
The list-backends utility has three modes of operation:
No options. When invoked with no options, display the back-end IDs for all back ends configured in the server, along with the base DNs for those back ends.
With backend ID. When used with the --backendID, list all of the base DNs for the back end with the specified back-end ID.
With baseDN. When used with the --baseDN option, list the back-end ID of the back end that should be used to hold the entry with the given DN and also indicate whether that DN is one of the configured base DNs for that back end.
The following are available for use but are not required. The list-backends utility accepts an option in either its short form (for example, -b baseDN) or its long form equivalent (for example, --baseDN baseDN).
-b, --baseDN baseDN Specify the base DN from which the list-backends utility should list the back-end ID. The option also indicates whether the specified DN is a baseDN for that back end.
-n, --backendID backendID Specify the back-end ID from which the tool should display the associated base DN. This option can be used multiple times to display the base DNs for multiple back ends.
-?, -H, --help Display the command usage information and exit immediately without taking any other action.
-V, --version Display the directory server version information and exit rather than attempting to run this command.
The following examples show how to use the directory server commands. You can use the commands on any UNIX, Linux, or Windows system that has at least the Java SE 5 (at least Sun version 1.5.0_08, preferably the latest version of Java SE 6) runtime environment installed on its target system. See Directory Server System Requirements in Sun OpenDS Standard Edition 2.0 Installation Guide for more information.
The following command lists the current back ends on the directory server:
$ list-backends Backend ID Base DN ---------- ----------------- backup cn=backups config cn=config monitor cn=monitor schema cn=schema tasks cn=tasks userRoot dc=example,dc=com
The following command lists the back-end ID on the directory server:
$ list-backends --backendID monitor Backend ID Base DN ---------- ---------- monitor cn=monitor
The following command lists the base DN on the directory server:
$ list-backends --baseDN cn=backups The provided DN 'cn=backups' is a base DN for the back end 'backup'
An exit code of 0 indicates that the operation completed successfully. An exit code of 1 indicates that an error occurred during processing.
UNIX and Linux: install-dir/bin/list-backends