Prepare Directory Proxy Server and a directory server for communication.
This tool performs several functions that update a directory server to be used as an external server by the Directory Proxy Server. If you use the create-initial-proxy-config tool to define and prepare directory server instances use of this tool is unnecessary.
Among other functions, this tool creates the proxy user account, sets the correct password, and configures the account with required privileges. If necessary you are prompted for manager credentials in order that the tool can perform any required modifications to the external server.
When using this tool, specify the LDAP connection options to establish a connection to the external server. Other options are used to specify information about the Directory Proxy Server which this tool uses to configure the external server.
If a secure connection will be used by the Directory Proxy Server to communicate with the external server you can supply the path and password of the truststore to have this tool populate the Directory Proxy Server's truststore with the server certificate of the external server.
prepare-external-server --hostname server.example.com --port 1389 \ --proxyBindPassword password --baseDN dc=example,dc=com
prepare-external-server --hostname server.example.com --port 1636 --useSSL \ --proxyBindPassword password --trustStorePath /path/to/truststore \ --baseDN dc=example,dc=com
-V
--version
Description | Display Directory Proxy Server version information |
-H
--help
Description | Display general usage information |
--help-ldap
Description | Display help for using LDAP options |
--help-sasl
Description | Display help for using SASL options |
--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 |
-D {bindDN}
--bindDN {bindDN}
Description | DN used to bind to the server |
Default Value | cn=Directory Manager |
Required | No |
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 |
-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 |
-h {host}
--hostname {host}
Description | External server hostname or IP address |
Default Value | localhost |
Required | No |
Multi-Valued | No |
-p {port}
--port {port}
Description | External server port number |
Default Value | 389 |
Required | No |
Multi-Valued | No |
-n
--no-prompt
Description | Perform an installation in non-interactive mode. When this mode is used, this tool will require additional options. See the examples below |
-Q
--quiet
Description | Use quiet mode |
--proxyBindDN {bindDN}
Description | User account DN used by this Directory Proxy Server to access the server to be prepared |
Default Value | cn=Proxy User,cn=Root DNs,cn=config |
Required | No |
Multi-Valued | No |
--proxyBindPassword {bindPassword}
Description | User account password used by this Directory Proxy Server to access the server to be prepared |
Required | No |
Multi-Valued | No |
--proxyBindPasswordFile {bindPasswordFile}
Description | Path to file containing the user account password used by this Directory Proxy Server to access the server to be prepared |
Required | No |
Multi-Valued | No |
--baseDN {baseDN}
Description | DN of the server serving as a base DN for the proxy server |
Required | Yes |
Multi-Valued | Yes |
--replicationSetName {setName}
Description | The name of the replication set to which this server will be assigned when configuring a server for entry balancing |
Required | No |
Multi-Valued | No |
--proxyTrustStorePath {truststorePath}
Description | Path to the truststore to which this tool should add the prepared server's certificate. You must also specify a password to the truststore |
Required | No |
Multi-Valued | No |
--proxyTrustStorePassword {truststorePassword}
Description | Password for the specified truststore. A truststore password is required in order for this tool to add the prepared server's certificate to the Directory Proxy Server truststore |
Required | No |
Multi-Valued | No |
--proxyTrustStorePasswordFile {path}
Description | Path to file containing the password for the specified truststore. A truststore password is required in order for this tool to add the prepared server's certificate to the Directory Proxy Server truststore |
Required | No |
Multi-Valued | No |