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.
The server process can be an application
server or an administrative agent server.
By default, the stopServer command does not return control to the
command line until the server completes the shutdown process. There
is a -nowait option to return immediately, and other options to control
the behavior of the stopServer command. For more information about
where to run this command, see the Using command-line tools topic.
If you are running the product on a Microsoft® Windows® operating
system, and you have the server running as a Windows operating system service, the stopServer
command stops the Windows service
that is responsible for starting the server.
If security is enabled, you
must use a user name and password with the stopServer command because
the command invokes an MBean method on the server.
The user name and password parameters are not
required with the stopServer command. The parameters are automatically
passed into the script that the Windows operating
system service uses to shutdown the system.
Avoid trouble: If message
ADMC0074E: Connection will be closed
due to unrecoverable error is displayed in the system log
file, a client might have attempted to send a user name, and password
to another server on which security is disabled. You can ignore this
message because the client automatically changes its security setting
to match the security setting for the server with which the client
is trying to communicate. The connection is eventually successfully completed.
However, security is now disabled for both the administrative client
and the receiving server.
gotcha
Syntax
The command syntax is one of the
following:
stopServer <server_name> [options]
whereserver_name is
the name of the configuration directory of the application server
or the DMZ Secure Proxy Server for IBM® WebSphere® Application Server that
you want to stop.
This argument is required.
stopServer <adminagent_name>
whereadminagent_name is
the name of the administrative agent that you want to stop.
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 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>
- An optional parameter that allows an administrator to set the
port number for server status callback. The tool opens this port
and waits for status callback from the server just before the server
has stopped. If the parameter is not set, an unused port is automatically
allocated.
- -port <portNumber>
- Specifies the server 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.
Avoid trouble: If you are running
in a secure environment but have not provided a user ID and password,
you 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.
gotcha
- -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)
stopServer adminagent