Perform the initial setup for a server instance.
This tool features both interactive and non-interactive modes for accepting the product license terms and initially configuring a server instance.
You can add a new Data Sync Server to an existing synchronization topology by specifying an existing 'master' Data Sync Server (see options under Set Up From Master Server Options). This feature copies configuration and administrative data, including references to Directory Server instances and other Data Sync Server instances, from the master server for use in the new server. The master server can be any Data Sync Server that has been set up and configured. The new server will serve as backup for the most recently registered server.
setup
setup --no-prompt --acceptLicense --ldapPort 389 --rootUserPassword password
-V
--version
| Description | Display Data Sync Server version information |
-H
--help
| Description | Display general usage information |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
-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 |
--acceptLicense
| Description | Indicate that you accept the terms of the product license defined in |
-Q
--quiet
| Description | Run setup in quiet mode. Quiet mode will not output progress information to standard output |
-v
--verbose
| Description | Use verbose mode |
--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 |
-h {host}
--localHostName {host}
| Description | Fully qualified host name or IP address of the local host |
| Default Value | ci-centos7-build-100-133.local |
| Required | No |
| Multi-Valued | No |
--listenAddress {host}
| Description | Address of a network interface on which the Data Sync Server will listen. If not specified the server listens on all available interfaces |
| Default Value | 0.0.0.0 |
| Required | No |
| Multi-Valued | Yes |
-p {port}
--ldapPort {port}
| Description | Port on which the Data Sync Server should listen for LDAP communication |
| Lower Bound | 1 |
| Upper Bound | 65535 |
| Required | No |
| Multi-Valued | No |
-x {jmxPort}
--jmxPort {jmxPort}
| Description | Port on which the Data Sync Server should listen for JMX communication |
| Lower Bound | 1 |
| Upper Bound | 65535 |
| Default Value | 1689 |
| Required | No |
| Multi-Valued | No |
-S
--skipPortCheck
| Description | Skip the check to determine whether the specified ports are usable |
-D {rootUserDN}
--rootUserDN {rootUserDN}
| Description | DN for the initial root user for the Data Sync Server |
| Default Value | cn=Directory Manager |
| Required | No |
| Multi-Valued | No |
-w {rootUserPassword}
--rootUserPassword {rootUserPassword}
| Description | Password for the initial root user for the Data Sync Server |
| Required | No |
| Multi-Valued | No |
-j {rootUserPasswordFile}
--rootUserPasswordFile {rootUserPasswordFile}
| Description | Path to a file containing the password for the initial root user for the Data Sync Server |
| Required | No |
| Multi-Valued | No |
--jvmTuningParameter {parameter}
| Description | JVM tuning parameters to use for configuring the JVM for this server. Must be one of NONE, AGGRESSIVE, SEMI_AGGRESSIVE, DISABLE_LARGE_PAGE_SUPPORT. See bin/dsjavaproperties --help for information about these parameters |
| Required | No |
| Multi-Valued | Yes |
--maxHeapSize {memory}
| Description | Explicitly specify the maximum amount of memory to be configured for this system. If omitted the value will be computed based on the presence of either the AGGRESSIVE or SEMI_AGGRESSIVE parameter specified by the --jvmTuningParameter option. The format for this value is the same as the -Xmx JVM option which is a number followed by a unit m or g |
| Required | No |
| Multi-Valued | No |
-O
--doNotStart
| Description | Do not start the server when the configuration is completed |
-q
--enableStartTLS
| Description | Enable StartTLS to allow secure communication with the server using the LDAP port |
-Z {port}
--ldapsPort {port}
| Description | Port on which the Data Sync Server should listen for LDAPS communication |
| Lower Bound | 1 |
| Upper Bound | 65535 |
| Required | No |
| Multi-Valued | No |
--generateSelfSignedCertificate
| Description | Generate a self-signed certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation |
--usePkcs11Keystore
| Description | Use a certificate in a PKCS11 token that the server should use when accepting SSL-based connections or performing StartTLS negotiation |
--useJavaKeystore {keystorePath}
| Description | Path of a Java Keystore (JKS) containing a certificate to be used as the server certificate |
| Required | No |
| Multi-Valued | No |
--usePkcs12Keystore {keystorePath}
| Description | Path of a PKCS12 keystore containing the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation |
| Required | No |
| Multi-Valued | No |
-W {keystorePassword}
--keyStorePassword {keystorePassword}
| Description | Certificate keystore password. A password is required when you want to use an existing certificate (JKS, PKCS12 or PKCS11) as server certificate |
| Required | No |
| Multi-Valued | No |
-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}
| Description | Certificate keystore password file. A password is required when you want to use an existing certificate (JKS, PKCS12 or PKCS11) as server certificate |
| Required | No |
| Multi-Valued | No |
-N {nickname}
--certNickname {nickname}
| Description | Nickname of the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation |
| Required | No |
| Multi-Valued | No |
--useJavaTruststore {truststorePath}
| Description | Path to a Java keystore to use for establishing trust |
| Required | No |
| Multi-Valued | No |
--usePkcs12Truststore {truststorePath}
| Description | Path to a PKCS12 keystore to use for establishing trust |
| Required | No |
| Multi-Valued | No |
-U {path}
--trustStorePasswordFile {path}
| Description | Truststore password file |
| Required | No |
| Multi-Valued | No |
-T {truststorePassword}
--trustStorePassword {truststorePassword}
| Description | Truststore password |
| Required | No |
| Multi-Valued | No |
--httpsPort {port}
| Description | Port on which the Data Sync Server should listen for HTTPS communication |
| Lower Bound | 1 |
| Upper Bound | 65535 |
| Required | No |
| Multi-Valued | No |
--instanceName {name}
| Description | A name for uniquely identifying this Data Sync Server among other instances in the environment. If not specified a default name will be computed using configured local host and port values |
| Required | No |
| Multi-Valued | No |
--masterHostName {host}
| Description | Host name of the master server from which configuration settings are copied during setup |
| Default Value | ci-centos7-build-100-133.local |
| Required | No |
| Multi-Valued | No |
--masterPort {port}
| Description | Port number of the master server |
| Lower Bound | 1 |
| Upper Bound | 65535 |
| Default Value | 389 |
| Required | No |
| Multi-Valued | No |
--masterUseStartTLS
| Description | Use StartTLS when connecting to the master server |
--masterUseSSL
| Description | Use SSL when connecting to the master server |
--masterUseNoSecurity
| Description | Do not secure connection with the master server |
--masterTrustAll
| Description | Automatically trust the master and other known server certificates without prompting |