stop-broker

Description

Stop or restart the server.

This tool is 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 is 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.

Examples

stop-broker

stop-broker --task --hostname server1.example.com \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --stopReason "Scheduled offline maintenance" --start 20090315154500Z

stop-broker --task --restart --hostname 127.0.0.1 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password

Arguments

-V
--version

-H
--help

--help-ldap

--help-sasl

--help-debug

-Z
--useSSL

-q
--useStartTLS

--useNoSecurity

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {bindDN}
--bindDN {bindDN}

-w {bindPassword}
--bindPassword {bindPassword}

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

-o {name=value}
--saslOption {name=value}

-X
--trustAll

-P {trustStorePath}
--trustStorePath {trustStorePath}

-K {keyStorePath}
--keyStorePath {keyStorePath}

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

-N {nickname}
--certNickname {nickname}

--propertiesFilePath {propertiesFilePath}

--usePropertiesFile

--script-friendly

--task

-t {startTime}
--start {startTime}

--completionNotify {emailAddress}

--errorNotify {emailAddress}

--dependency {taskID}

--failedDependencyAction {action}

-Q
--quiet

-Y {authzID}
--proxyAs {authzID}

-r {stopReason}
--stopReason {stopReason}

-R
--restart

--delay {delayMS}

--stopTime {stopTime}