server stop command
The server stop
command stops the named Open Liberty server.
Normal server stop includes a quiesce stage before the server shuts down. This quiesce stage allows time for shutdown preparation, such as stopping inbound listeners but allowing existing requests to complete. The maximum length for the quiesce stage is 30 seconds. Applying the --force
option to the stop command skips the quiesce stage. The --force
option has no effect if server stop was already initiated. If you use the --force
option, you might see unexpected exceptions in the messages.log
file that occur after the server received the server stop
command.
The server stop
command also includes a 30 second waiting period for confirmation that the server is stopped. You can customize this waiting period with the --timeout
option.
Usage examples
Stop the myserver
server with the quiesce stage:
server stop myserver
Force the myserver
server to stop without the quiesce stage:
server stop myserver --force
Set the amount of time to wait for the myserver
server to stop. This sets the timeout value to 1 minute. The default timeout value is 30 seconds.
server stop myserver --timeout=1m
Syntax
Run the command from the path_to_liberty/wlp/bin
directory.
server stop serverName [options]
- serverName
The name of the server to run the command against. If no server is specified, the action is performed against the default server instance,
defaultServer
, if it exists.- options
One or more optional parameters.
Options
Option | Description |
---|---|
--force | Skips the quiesce stage before the server is shut down. |
--timeout | Specifies the maximum amount of time that the server stop --timeout=45 The following example shows how to set the timeout value to 3 minutes and 20 seconds. server stop --timeout=3m20s |
Exit codes
The following exit codes are available for the server stop
command and the equivalent executable JAR file ws-server.jar
:
Code | Explanation |
---|---|
0 | This code indicates successful completion of the requested operation. |
1 | This code indicates invocation of a redundant operation, such as starting a started server or stopping a stopper server. 1 might also be returned if the JVM options that were used are not valid. |
2 | This code indicates that the server does not exist. |
>=20 | Exit codes that are greater than or equal to 20 indicate that an error occurred while performing the request. Messages are printed and captured in log files with more information about the error. |