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.
stop-metrics-engine
stop-metrics-engine --task --hostname server1.example.com \ --bindDN uid=admin,dc=example,dc=com --bindPassword password \ --stopReason "Scheduled offline maintenance" --start 20090315154500Z
stop-metrics-engine --task --restart --hostname 127.0.0.1 \ --bindDN uid=admin,dc=example,dc=com --bindPassword password
-V
--version
Description | Display Metrics Engine 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 | Metrics Engine hostname or IP address |
Default Value | localhost |
Required | No |
Multi-Valued | No |
-p {port}
--port {port}
Description | Metrics Engine 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 |
-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 |
--usePropertiesFile
Description | Specify that a properties file will be used to get default command-line argument values |
--script-friendly
Description | Use script-friendly mode |
--task
Description | Indicates that this tool should be invoked as a task which runs inside the Metrics Engine rather than as a separate process. At present, this argument is optional, but in a future release it may be required for running as a task |
-t {startTime}
--start {startTime}
Description | Indicates the date/time, expressed in format 'YYYYMMDDhhmmss', when the operation starts when scheduled as a server task. A value of '0' causes the task 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 |
--completionNotify {emailAddress}
Description | Email address of a recipient to be notified when the task completes. This option may be specified more than once |
Required | No |
Multi-Valued | Yes |
--errorNotify {emailAddress}
Description | Email address of a recipient to be notified if an error occurs when this task executes. This option may be specified more than once |
Required | No |
Multi-Valued | Yes |
--dependency {taskID}
Description | ID of a task upon which this task depends. A task will not start execution until all its dependencies have completed execution |
Required | No |
Multi-Valued | Yes |
--failedDependencyAction {action}
Description | Action this task will take should one of its dependent tasks fail. The value must be one of the following: PROCESS,CANCEL,DISABLE. If not specified, the default value is CANCEL |
Required | No |
Multi-Valued | Yes |
-Q
--quiet
Description | Use quiet mode |
-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 |
--stopTime {stopTime}
Description | This argument is deprecated, please use the "--start" task scheduling argument instead |
Required | No |
Multi-Valued | No |