The stopServer command reads the configuration file for
the specified server process. This command sends a Java Management Extensions
(JMX) command to the server telling it to shut down.
By default, the stopServer command does not return control to the
command line until the server completes the shut down process. There is a
-nowait option to return immediately, as well as other options to control
the behavior of the stopServer command. For more information about
where to run this command, see the Using command
tools article.
If you are using the Windows platform and the you have
the application server running as a Windows service, the stopServer command
will start the associated Windows service and it will be responsible for starting
the application server.
Syntax
The command syntax is as follows:
stopServer <server> [options]
where
server is the name of the configuration directory of the server you want to stop.
This argument is required.
Parameters
The following options are available for
the stopServer command:
- -nowait
- Tells the stopServer command not to wait for successful shutdown
of the server process.
- -quiet
- Suppresses the progress information that the stopServer command
prints in normal mode.
- -logfile <fileName>
- Specifies the location of the log file to which trace information is written.
By default, the log file is named stopServer.log and is created in the logs directory.
- -profileName
- Defines the profile of the Application Server process in a multi-profile
installation. The -profileName option is not required for running in a single
profile environment. The default for this option is the default profile.
- -replacelog
- Replaces the log file instead of appending to the current log.
- -trace
- Generates trace information into a file for debugging purposes. The trace
output is written to the stopServer.log file which is located in the profile_root/logs/server directory.
- -timeout <seconds>
- Specifies the time to wait for server shutdown before timing out and returning
an error.
- -statusport <portNumber>
- Supports an administrator in setting the port number for server status
callback.
- -conntype <type>
- Specifies the Java Management Extensions (JMX) connector type to use for
connecting to the deployment manager. Valid types are SOAP or Remote Method
Invocation (RMI).
- -port <portNumber>
- Specifies the server Java Management Extensions (JMX) port to use explicitly,
so that you can avoid reading the configuration files to obtain the information.
- -username <name>
- Specifies the user name for authentication if security is enabled in
the server. Acts the same as the -user option.
- -user <name>
- Specifies the user name for authentication if security is enabled in the
server. Acts the same as the -username option.
- -password <password>
- Specifies the password for authentication if security is enabled in the
server.
Note: If you are running in a secure environment but have
not provided a user ID and password, you will receive the following error
message:
ADMN0022E: Access denied for the stop operation on Server MBean due
to insufficient or empty credentials.
To solve this problem, provide
the user ID and password information.
- -help
- Prints a usage statement.
- -?
- Prints a usage statement.
Usage scenario
The following examples demonstrate
correct syntax:
stopServer server1
stopServer server1 -nowait
stopServer server1 -trace (produces the stopserver.log file)