Directory Proxy Server Documentation Index
Command-Line Tool Reference Home

create-initial-proxy-config

Description
Examples
Arguments

Description

Create an initial Directory Proxy Server configuration.

This tool is used to configure a basic Directory Proxy Server. The tool will prompt for basic information about your topology including directory server instances, their locations, and the credentials for communicating with them. This tool will record the configuration in a dsconfig batch file and apply the configuration to the local Directory Proxy Server.

The following assumptions are made about the topology to expedite setup:

1) All servers will be accessible via a single user account
2) All servers support the same communication security type
3) All servers are Ping Identity, Nokia 8661, Sun
Java System 5.x, 6.x, or 7.x, or Red Hat (including Fedora and 389)
directory servers

If your topology does not meet these assumptions, use this tool to define a basic configuration and then use the 'dsconfig' tool or the Administrative Console to customize the configuration.

Examples

Run the tool to generate a configuration and apply it to the local Directory Proxy Server available on port 1389:
create-initial-proxy-config --port 1389 --bindDN "cn=Directory Manager" \
     --bindPassword password

For examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help

Arguments

-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

--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

--dry-run

Description Generate a dsconfig batch file that may be used for initial configuration, but do not apply it to the local server

-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

-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 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

-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

-K {keystorePath}
--keyStorePath {keystorePath}

Description Certificate keystore path
Required No
Multi-Valued No

-W {keystorePassword}
--keyStorePassword {keystorePassword}

Description Certificate keystore PIN
Required No
Multi-Valued No

-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}

Description Certificate keystore PIN file
Required No
Multi-Valued No

-N {nickname}
--certNickname {nickname}

Description Nickname of the certificate for SSL client authentication
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