Stop or restart the server.
This tool can be used to stop or restart the local instance of the server (by omitting LDAP connection options), or a remote server (by interacting with it over LDAP). In addition, this tool can be used to schedule the server for shutdown at a later time using the server's task interface.
This tool features the ability to perform an 'in-core' restart of the server, meaning that the server reinitializes itself without shutting down the JVM instance in which the server is running. This allows the server to restart much more quickly than it would if restarted using a hard restart. To perform an 'in-core' restart of the server, provide LDAP connection options, including the loopback interface (127.0.0.1), for the --hostname option when restarting the local instance.
stop-sync-server
stop-sync-server --hostname server1.example.com \
--bindDN uid=admin,dc=example,dc=com --bindPassword password \
--stopReason "Scheduled offline maintenance" --stopTime 20090315154500Z
stop-sync-server --restart --hostname 127.0.0.1 \
--bindDN uid=admin,dc=example,dc=com --bindPassword password
-V
--version
| Description | Display Synchronization Server version information |
-H
--help
| Description | Display general usage information |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
--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}
--hostname {host}
| Description | Synchronization Server hostname or IP address |
| Default Value | 127.0.0.1 |
| Required | No |
| Multi-Valued | No |
-p {port}
--port {port}
| Description | Synchronization Server port number |
| Lower Bound | 1 |
| Upper Bound | 65535 |
| Required | No |
| Multi-Valued | No |
-Z
--useSSL
| Description | Use SSL for secure communication with the server |
-q
--useStartTLS
| Description | Use StartTLS for secure communication with the server |
-D {bindDN}
--bindDN {bindDN}
| Description | DN used to bind to the server |
| 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 |
-Y {authzID}
--proxyAs {authzID}
| Description | Use the proxied authorization control with the given authorization ID |
| Required | No |
| Multi-Valued | No |
-r {stopReason}
--stopReason {stopReason}
| Description | The reason the server is being stopped or restarted |
| Required | No |
| Multi-Valued | No |
-R
--restart
| Description | Attempts to automatically restart the server once it has stopped |
--delay {delayMS}
| Description | The delay in milliseconds to wait after generating the alert notification and before actually beginning the shutdown process. This will only be used when the shutdown process is invoked as a task |
| Lower Bound | 0 |
| Required | No |
| Multi-Valued | No |
-t {stopTime}
--stopTime {stopTime}
| Description | Indicates the date/time at which this operation will start when scheduled as a server task, expressed in format 'YYYYMMDDhhmmss'. A value of '0' causes the shutdown to be scheduled for immediate execution. When this option is specified, the operation is scheduled to start at the specified time, after which this utility will exit immediately |
| Required | No |
| Multi-Valued | No |
-X
--trustAll
| Description | Trust all server SSL certificates |
-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 |
-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 |
-Q
--quiet
| Description | Use quiet mode |