Synchronization Server Documentation Index
Command-Line Tool Reference Home

create-sync-pipe-config

Description
Examples
Arguments

Description

Create an initial Synchronization Server configuration.

This tool can be used to generate a basic Synchronization Server configuration by prompting for basic information about your topology including directory server instances and credentials for communicating with them. This tool will record the configuration in a 'dsconfig' batch file and optionally allow you to apply the configuration to the local Synchronization Server.

Examples

Run the tool to generate a configuration and apply it to the local Synchronization Server available on port 1389:
create-sync-pipe-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 Synchronization 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

-h {host}
--hostname {host}

Description Address on which the local Synchronization Server is listening
Default Value localhost
Required No
Multi-Valued No

-p {port}
--port {port}

Description Synchronization 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 trust store path
Required No
Multi-Valued No

-T {trustStorePassword}
--trustStorePassword {trustStorePassword}

Description Certificate trust store PIN
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description Certificate trust store PIN file
Required No
Multi-Valued No

-K {keyStorePath}
--keyStorePath {keyStorePath}

Description Certificate key store path
Required No
Multi-Valued No

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

Description Certificate key store PIN
Required No
Multi-Valued No

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

Description Certificate key store 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

--syncServerTrustStorePath {trustStorePath}

Description Path to the Synchronization Server's trust store
Default Value config/truststore
Required No
Multi-Valued No

--syncServerTrustStorePassword {trustStorePassword}

Description Password to the Synchronization Server's trust store
Required No
Multi-Valued No

--syncServerTrustStorePasswordFile {path}

Description Path to file containing the password for the Synchronization Server's trust store
Default Value config/keystore.pin
Required No
Multi-Valued No