manage-topology

Description

Tool to manage 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.

Examples

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

manage-topology add-server --retryTimeoutSeconds 120 --hostname localhost \
     --port 1636 --bindDN "cn=Directory Manager" --bindPassword password \
     --useSSL --remoteServerHostname localhost --remoteServerPort 2636 \
     --remoteServerBindDN "cn=Directory Manager" \
     --remoteServerBindPassword password \
     --remoteServerConnectionSecurity useSsl --adminUID admin \
     --adminPassword password

manage-topology add-server --topologyFilePath topology.json \
     --bindDN "cn=Directory Manager" --bindPassword password --useSSL \
     --remoteServerHostname localhost --remoteServerPort 2636 \
     --remoteServerBindDN "cn=Directory Manager" \
     --remoteServerBindPassword password \
     --remoteServerConnectionSecurity useSsl --adminUID admin \
     --adminPassword password

manage-topology remove-server --retryTimeoutSeconds 120 --hostname localhost \
     --port 1636 --bindDN "cn=Directory Manager" --bindPassword password \
     --useSSL

Subcommands

Add this Data Sync Server server instance to an existing topology of servers. If the server is a already a member of the topology of which the remote server is a member, then this operation is a no-op

Add one of the provided server instances to an existing topology of servers of which the other server is already a member. This command is idempotent, which means that it has no effect when re-run if the servers are already members of the same topology. If the server being added is a member of a different multi-server topology, then it must first be removed from its existing topology before it can be added to the remote server's topology

manage-topology add-server --retryTimeoutSeconds 120 --hostname localhost \
     --port 1636 --bindDN "cn=Directory Manager" --bindPassword password \
     --useSSL --remoteServerHostname localhost --remoteServerPort 2636 \
     --remoteServerBindDN "cn=Directory Manager" \
     --remoteServerBindPassword password \
     --remoteServerConnectionSecurity useSsl --adminUID admin \
     --adminPassword password

manage-topology add-server --topologyFilePath topology.json \
     --bindDN "cn=Directory Manager" --bindPassword password --useSSL \
     --remoteServerHostname localhost --remoteServerPort 2636 \
     --remoteServerBindDN "cn=Directory Manager" \
     --remoteServerBindPassword password \
     --remoteServerConnectionSecurity useSsl --adminUID admin \
     --adminPassword password

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

Remove the provided Data Sync Server server instance from its current topology. The server instance must be online for the command to work

If the server instance is defunct or offline, then the remove-defunct-server tool must be used to remove it. If the server is a single-instance topology, i.e. it is not a member of any topology, then this command is a no-op

manage-topology remove-server --retryTimeoutSeconds 120 --hostname localhost \
     --port 1636 --bindDN "cn=Directory Manager" --bindPassword password \
     --useSSL

Arguments

-V
--version

-H
--help

--help-debug

-Z
--useSSL

-q
--useStartTLS

--useNoSecurity

--topologyFilePath {topologyFilePath}

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {bindDN}
--bindDN {bindDN}

-w {bindPassword}
--bindPassword {bindPassword}

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

-o {name=value}
--saslOption {name=value}

-X
--trustAll

-P {truststorePath}
--trustStorePath {truststorePath}

-T {truststorePassword}
--trustStorePassword {truststorePassword}

-U {path}
--trustStorePasswordFile {path}

--trustStoreFormat {trustStoreFormat}

--keyStoreFormat {keyStoreFormat}

--propertiesFilePath {propertiesFilePath}

--noPropertiesFile

--script-friendly

--ignoreWarnings

--retryTimeoutSeconds {retryTimeoutSeconds}

--help-subcommands