Tool for managing the topology registry.
The topology registry is a branch of the configuration DIT (cn=Topology,cn=config). It stores all metadata about server instances, including their instance and listener certificates, secret keys, server groups and administrative user accounts. In addition, it also stores information about the replication topology (replication server ID and replication domain ID) when replication is enabled among servers in a Directory topology. Last but not least, it stores the license key required to install the server. Changes to the topology registry on one server are automatically mirrored to other servers in the topology. The dsconfig tool, configuration API or the management console may be used to make changes to the topology registry. This tool allows some additional capability such as exporting the contents of the registry as a JSON file.
manage-topology export --hostname localhost --port 1636 \
--bindDN "cn=Directory Manager" --bindPassword password \
--exportFilePath topology.json
manage-topology export --topologyFilePath old-topology.json \
--bindDN "cn=Directory Manager" --bindPassword password \
--exportFilePath new-topology.json
Exports the properties of server instances in the topology registry in JSON format to the specified file. The exported file may then be used as input to topology-related tools to specify a collection of servers that already exist in the topology
manage-topology export --hostname localhost --port 1636 \
--bindDN "cn=Directory Manager" --bindPassword password \
--exportFilePath topology.json
manage-topology export --topologyFilePath old-topology.json \
--bindDN "cn=Directory Manager" --bindPassword password \
--exportFilePath new-topology.json
--exportFilePath {exportFilePath}
| Description | The file to which the topology registry should be exported |
| Required | Yes |
| Multi-Valued | No |
-V
--version
| Description | Display Directory Proxy Server version information |
-H
--help
| Description | Display general usage information |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
-Z
--useSSL
| Description | Use SSL for secure communication with the server |
-q
--useStartTLS
| Description | Use StartTLS to secure communication with the server |
--useNoSecurity
| Description | Use no security when communicating with the server |
--topologyFilePath {topologyFilePath}
| Description | The topology hosts file containing the list of hosts that are already in the topology. This can make deployment automation more fault-tolerant since it is not necessary for a specific server instance to be available. Instead, the command will succeed as long as a single instance in the topology is online. This option may be used in lieu of or in addition to the hostname/port options and will take precedence if specified with those options. A connection is attempted to be established to each host in the hosts file in sequential order. The first successful connection is used to perform the action, and the remaining hosts are ignored. The LDAP connection options specified on the command-line will be used for each server in the hosts file. The hosts file must be in JSON format and may be obtained by running the manage-topology export command on an online topology host using the hostname/port options |
| Required | No |
| Multi-Valued | No |
-h {host}
--hostname {host}
| Description | Fully qualified host name or IP address of the local Directory Proxy Server |
| Default Value | localhost |
| Required | No |
| Multi-Valued | No |
-p {port}
--port {port}
| Description | Directory Proxy Server port number |
| Default Value | 389 |
| Required | No |
| Multi-Valued | No |
-D {bindDN}
--bindDN {bindDN}
| Description | DN used to bind to the server |
| Default Value | cn=Directory Manager |
| Required | Yes |
| Multi-Valued | No |
-w {bindPassword}
--bindPassword {bindPassword}
| Description | Password used to bind to the server |
| Required | No |
| Multi-Valued | No |
-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}
| Description | Bind password file |
| Required | No |
| Multi-Valued | No |
-o {name=value}
--saslOption {name=value}
| Description | SASL bind options |
| Required | No |
| Multi-Valued | Yes |
-X
--trustAll
| Description | Trust all server SSL certificates |
-P {truststorePath}
--trustStorePath {truststorePath}
| Description | Certificate truststore path |
| Required | No |
| Multi-Valued | No |
-T {truststorePassword}
--trustStorePassword {truststorePassword}
| Description | Certificate truststore PIN |
| Required | No |
| Multi-Valued | No |
-U {path}
--trustStorePasswordFile {path}
| Description | Certificate truststore PIN file |
| Required | No |
| Multi-Valued | No |
--propertiesFilePath {propertiesFilePath}
| Description | Path to the file that contains default property values used for command-line arguments |
| Required | No |
| Multi-Valued | No |
--noPropertiesFile
| Description | Specify that no properties file will be used to get default command-line argument values |
--script-friendly
| Description | Use script-friendly mode |
--ignoreWarnings
| Description | Tool should continue should warnings occur when used non-interactively. This option should be used with caution |
--help-subcommands
| Description | Display all subcommands |